setTokenHandout: Difference between revisions

Latest revision as of 23:59, 21 April 2023

• 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.

setTokenHandout(assetId)
setTokenHandout(assetId, id)
setTokenHandout(assetId, id, mapRef)

setTokenHandout(tokenImageName)
setTokenHandout(tokenImageName, id)
setTokenHandout(tokenImageName, id, mapRef)

Parameters

id - OPTIONAL: The token id of the token for which you want to set the handout, defaults to the Current Token.
mapRef - OPTIONAL: The Name or ID of the map to find the token. Defaults to the current map.

@@ Line 3: / Line 3: @@
 |version=1.3b77
 |description=
-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 [[Macros:Functions:tblImage |tblImage()]] or[[Macros:Functions:getTokenImage|getTokenImage()]].)  or a [[Image Token]].
+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 [[Macros:Functions:tblImage |tblImage()]] or[[Macros:Functions:getTokenImage|getTokenImage()]].)  or a [[Image Token]].
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
 setTokenHandout(assetId)
-</source>
+setTokenHandout(assetId, id)
-<source lang="mtmacro" line>
+setTokenHandout(assetId, id, mapRef)
+</syntaxhighlight>
+<syntaxhighlight lang="mtmacro" line>
 setTokenHandout(tokenImageName)
-</source>
+setTokenHandout(tokenImageName, id)
+setTokenHandout(tokenImageName, id, mapRef)
+</syntaxhighlight>
+'''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|mapRef|OPTIONAL: The Name or ID 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]]