getTokenHandout: Difference between revisions

Revision as of 20:48, 14 March 2023

Returns the asset id of the handout image for the for the Current Token.

getTokenHandout()
getTokenHandout(size)
getTokenHandout(size, id)
getTokenHandout(size, id, mapname)

Parameters

size - OPTIONAL: The size the image should be returned as. If a blank string "", no size adjustment is done. Defaults to "".
id - OPTIONAL: The token id of the token for which you want to retrieve the token handout image, defaults to the Current Token.
mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.

To display the image for the current Token.

<img src='[r:getTokenHandout()]'></img>

@@ Line 1: / Line 1: @@
-==Function getTokenHandout==
+{{MacroFunction
+|name=getTokenHandout
+|description=
+Returns the [[Asset ID|asset id]] of the handout image for the for the [[Current Token]].
-Returns the [[asset id]] of the handout image for the for the [[Token:Current Token|Current Token]].
+|usage=
+<syntaxhighlight lang="mtmacro" line>
+getTokenHandout()
+getTokenHandout(size)
+getTokenHandout(size, id)
+getTokenHandout(size, id, mapname)
+</syntaxhighlight>
-===Usage===
+'''Parameters'''
-<source lang="mtmacro" line>
+{{param|size|OPTIONAL: The size the image should be returned as. If a blank string "", no size adjustment is done. Defaults to "".}}
-[h: assetId = getTokenImage()]
+{{param|id|OPTIONAL: The token {{code|id}} of the token for which you want to retrieve the token handout image, defaults to the [[Current Token]]. }}
-</source>
+{{param|mapname|OPTIONAL: The name of the map to find the token.  Defaults to the current map.}}
+|example=
-===Examples===
+To display the image for the current [[Token]].
-To display the image for the current [[Token:token|token]].
+<syntaxhighlight lang="mtmacro" line>
-<source lang="mtmacro" line>
+<img src='[r:getTokenHandout()]'></img>
-<img src='[r:getTokenImage()]'></img>
+</syntaxhighlight>
-</source>
+|changes={{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}}
+}}
+[[Category:Token Function]]