getTokenPortrait: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page getTokenPortrait to GetTokenPortrait without leaving a redirect: Converting page title to first-letter uppercase) |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getTokenPortrait() | getTokenPortrait() | ||
getTokenPortrait(size) | getTokenPortrait(size) | ||
getTokenPortrait(size, id) | getTokenPortrait(size, id) | ||
getTokenPortrait(size, id, mapname) | getTokenPortrait(size, id, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 19: | Line 19: | ||
|examples= | |examples= | ||
To display the image for the current [[Token]]. | To display the image for the current [[Token]]. | ||
< | <syntaxhighlight 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.}} | ||
}} | }} | ||
Latest revision as of 21:11, 14 March 2023
getTokenPortrait() Function
Returns the asset id of the portrait image for the for the Current Token.
Usage
getTokenPortrait()
getTokenPortrait(size)
getTokenPortrait(size, id)
getTokenPortrait(size, id, mapname)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.
<img src='[r:getTokenPortrait()]'></img>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.