getTokenHandout: Difference between revisions

Latest revision as of 23:59, 11 May 2024

getTokenHandout() Function

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

Usage

getTokenHandout()
getTokenHandout(size)
getTokenHandout(size, tokenRef)
getTokenHandout(size, tokenRef, mapRef)

Parameters

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

Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

Example

To display the image for the current Token.

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

Version Changes

1.5.4 - Added id and mapname parameter options.

@@ 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, tokenRef)
+getTokenHandout(size, tokenRef, mapRef)
+</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|tokenRef|OPTIONAL: Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token for which you want to retrieve the token handout image, defaults to the [[Current Token]]. }}
-</source>
+{{param|mapRef|OPTIONAL: The Name or ID of the map to find the token.  Defaults to the current map.}}
+{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}}
+|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]]