getTokenHandout: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "source>" to "syntaxhighlight>") |
No edit summary |
||
| Line 8: | Line 8: | ||
getTokenHandout() | getTokenHandout() | ||
getTokenHandout(size) | getTokenHandout(size) | ||
getTokenHandout(size, | getTokenHandout(size, tokenRef) | ||
getTokenHandout(size, | getTokenHandout(size, tokenRef, mapname) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{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| | {{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|mapname|OPTIONAL: The name of the map to find the token. Defaults to the current map.}} | {{param|mapname|OPTIONAL: The name 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= | |example= | ||
Revision as of 19:06, 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, mapname)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.mapname- OPTIONAL: The name 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.