getTokenHandout: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 6: | Line 6: | ||
|usage= | |usage= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getTokenHandout() | |||
getTokenHandout(size) | |||
getTokenHandout(size, id) | |||
getTokenHandout(size, id, mapname) | |||
</source> | </source> | ||
'''Parameters''' | |||
{{param|size|OPTIONAL: The size the image should be returned as. If a blank string "", no size adjustment is done. Defaults to "".}} | |||
{{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]]. }} | |||
{{param|mapname|OPTIONAL: The name of the map to find the token. Defaults to the current map.}} | |||
|example= | |example= | ||
| Line 14: | Line 22: | ||
<img src='[r:getTokenHandout()]'></img> | <img src='[r:getTokenHandout()]'></img> | ||
</source> | </source> | ||
|changes={{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Revision as of 04:12, 15 August 2019
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.