getTokenPortrait: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page GetTokenPortrait to getTokenPortrait: Converting page titles to lowercase) |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| Line 10: | Line 10: | ||
getTokenPortrait(size, id) | getTokenPortrait(size, id) | ||
getTokenPortrait(size, id, mapname) | getTokenPortrait(size, id, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 21: | Line 21: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
<img src='[r:getTokenPortrait()]'></img> | <img src='[r:getTokenPortrait()]'></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.}} | ||
}} | }} | ||
Revision as of 20:00, 14 March 2023
getTokenPortrait() Function
Returns the asset id of the portrait image for the for the Current Token.
Usage
<source lang="mtmacro" line> getTokenPortrait() getTokenPortrait(size) getTokenPortrait(size, id) getTokenPortrait(size, id, mapname) </syntaxhighlight>
Parameters
size- OPTIONAL: The size the picture 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 image, defaults to the Current Token.mapname- OPTIONAL: The name of the map to find the token. Defaults to the current map.
Examples
To display the image for the current Token.
<source lang="mtmacro" line> <img src='[r:getTokenPortrait()]'></img>
</syntaxhighlight>Version Changes
- 1.5.4 - Added
idandmapnameparameter options.
Version Notes
In versions before v1.3b51 an attempt to retrieve a portrait image when none was present produced an error. In 1.3b51 and later builds the function returns an empty string if no portrait is associated with the image.