setTokenHandout: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Fixing wikilink)
No edit summary
Line 8: Line 8:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
setTokenHandout(assetId)
setTokenHandout(assetId)
setTokenHandout(assetId, id)
setTokenHandout(assetId, id, mapname)
</source>
</source>
<source lang="mtmacro" line>
<source lang="mtmacro" line>
setTokenHandout(tokenImageName)
setTokenHandout(tokenImageName)
setTokenHandout(tokenImageName, id)
setTokenHandout(tokenImageName, id, mapname)
</source>
</source>
'''Parameters'''
{{param|id|OPTIONAL: The token {{code|id}} of the token for which you want to set the handout, defaults to the [[Current Token]]. }}
{{param|mapname|OPTIONAL: The name of the map to find the token.  Defaults to the current map.}}
|changes={{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}}
}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Revision as of 04:00, 15 August 2019

setTokenHandout() Function

Introduced in version 1.3b77
Sets the handout image for the for the Current Token. The image can come from several sources. It can be an asset id (like from tblImage() orgetTokenImage().) or a Image Token.

Usage

setTokenHandout(assetId)
setTokenHandout(assetId, id)
setTokenHandout(assetId, id, mapname)
setTokenHandout(tokenImageName)
setTokenHandout(tokenImageName, id)
setTokenHandout(tokenImageName, id, mapname)

Parameters

  • id - OPTIONAL: The token id of the token for which you want to set the handout, defaults to the Current Token.
  • mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.


Version Changes

  • 1.5.4 - Added id and mapname parameter options.