getTokenImage: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (22 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
= | {{MacroFunction | ||
|name=getTokenImage | |||
|description= | |||
Returns the [[Asset ID|asset id]] of the image for the for the [[Current Token]]. | |||
|usage= | |||
<syntaxhighlight lang="mtmacro" line> | |||
getTokenImage() | |||
getTokenImage(size) | |||
getTokenImage(size, tokenRef) | |||
getTokenImage(size, tokenRef, mapRef) | |||
</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|tokenRef|OPTIONAL: Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token for which you want to retrieve the token image, defaults to the [[Current Token]]. }} | ||
{{param|mapRef|OPTIONAL: The Name or ID of the map to find the token. Defaults to the current map.}} | |||
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}} | |||
|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 token roll option. | |||
<syntaxhighlight lang="mtmacro" line> | |||
[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]] | |||
Latest revision as of 23:59, 9 May 2024
getTokenImage() Function
Returns the asset id of the image for the for the Current Token.
Usage
getTokenImage()
getTokenImage(size)
getTokenImage(size, tokenRef)
getTokenImage(size, tokenRef, mapRef)Parameters
size- OPTIONAL: The size in pixels the image should be returned as. If a blank string "", no size adjustment is done. Defaults to "".tokenRef- OPTIONAL: Either the tokenidor Token Name of the token for which you want to retrieve the token image, defaults to the Current Token.mapRef- OPTIONAL: The Name or ID of the map to find the token. Defaults to the current map.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.
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.