getTokenHandout: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 9: | Line 9: | ||
getTokenHandout(size) | getTokenHandout(size) | ||
getTokenHandout(size, tokenRef) | getTokenHandout(size, tokenRef) | ||
getTokenHandout(size, tokenRef, | getTokenHandout(size, tokenRef, mapRef) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 15: | Line 15: | ||
{{param|size|OPTIONAL: The size the image should be returned as. If a blank string "", no size adjustment is done. Defaults to "".}} | {{param|size|OPTIONAL: The size the image should be returned as. If a blank string "", no size adjustment is done. Defaults to "".}} | ||
{{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]]. }} | {{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]]. }} | ||
{{param| | {{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.}} | {{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.}} | ||
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 tokenidor 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
idandmapnameparameter options.