getTokenHandout: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getTokenHandout() | getTokenHandout() | ||
getTokenHandout(size) | getTokenHandout(size) | ||
getTokenHandout(size, id) | getTokenHandout(size, id) | ||
getTokenHandout(size, id, mapname) | getTokenHandout(size, id, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 19: | Line 19: | ||
|example= | |example= | ||
To display the image for the current [[Token]]. | To display the image for the current [[Token]]. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
<img src='[r:getTokenHandout()]'></img> | <img src='[r:getTokenHandout()]'></img> | ||
</ | </syntaxhighlight> | ||
|changes={{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}} | |changes={{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}} | ||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest revision as of 20:48, 14 March 2023
getTokenHandout() Function
Returns the asset id of the handout image for the for the Current Token.
Usage
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 tokenidof 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.
Example
To display the image for the current Token.
<img src='[r:getTokenHandout()]'></img>
Version Changes
- 1.5.4 - Added
idandmapnameparameter options.