getTokenImage: Difference between revisions
Jump to navigation
Jump to search
True Hitoare (talk | contribs) m (Reformatted usage to conform to more standard design) |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| (8 intermediate revisions by 4 users not shown) | |||
| Line 5: | Line 5: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getTokenImage() | getTokenImage() | ||
getTokenImage(size) | getTokenImage(size) | ||
</ | getTokenImage(size, id) | ||
getTokenImage(size, id, mapname) | |||
</syntaxhighlight> | |||
'''Parameters''' | |||
{{param|size|OPTIONAL: The size in pixels 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 image, defaults to the [[Current Token]]. }} | |||
{{param|mapname|OPTIONAL: The name of the map to find the token. Defaults to the current map.}} | |||
|examples= | |examples= | ||
To display the image for the current [[Token:token|token]]. | To display the image for the current [[Token:token|token]]. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
<img src='[r:getTokenImage()]'></img> | <img src='[r:getTokenImage()]'></img> | ||
</ | </syntaxhighlight> | ||
To get the image of any [[Token:token|token]] using its id and the | To get the image of any [[Token:token|token]] using its id and the token roll option. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h, token(tokenId): imgAsset = getTokenImage()] | [h, token(tokenId): imgAsset = getTokenImage()] | ||
</ | </syntaxhighlight> | ||
|changes={{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}} | |||
|also= | |||
[[getImage|getImage]], [[getTokenHandout|getTokenHandout]], [[getTokenPortrait|getTokenPortrait]] | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest revision as of 19:36, 14 March 2023
getTokenImage() Function
Returns the asset id of the image for the for the Current Token.
Usage
getTokenImage()
getTokenImage(size)
getTokenImage(size, id)
getTokenImage(size, id, mapname)Parameters
size- OPTIONAL: The size in pixels 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 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:getTokenImage()]'></img>To get the image of any token using its id and the token roll option.
[h, token(tokenId): imgAsset = getTokenImage()]See Also
Version Changes
- 1.5.4 - Added
idandmapnameparameter options.