setTokenImage: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page SetTokenImage to setTokenImage: Converting page titles to lowercase) |
No edit summary |
||
| Line 6: | Line 6: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setTokenImage(assetId) | setTokenImage(assetId) | ||
setTokenImage(assetId, id) | setTokenImage(assetId, id) | ||
setTokenImage(assetId, id, mapname) | setTokenImage(assetId, id, mapname) | ||
</ | </syntaxhighlight> | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setTokenImage(imageToken) | setTokenImage(imageToken) | ||
setTokenImage(imageToken, id) | setTokenImage(imageToken, id) | ||
setTokenImage(imageToken, id, mapname) | setTokenImage(imageToken, id, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|assetId|The Asset ID for an image.}} | {{param|assetId|The Asset ID for an image.}} | ||
| Line 23: | Line 23: | ||
|example= | |example= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: setTokenImage(tblImage("elfImages", 1))] | [h: setTokenImage(tblImage("elfImages", 1))] | ||
[h: setTokenImage("image:Elf-Dead")] | [h: setTokenImage("image:Elf-Dead")] | ||
</ | </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.}} | ||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Revision as of 20:30, 14 March 2023
setTokenImage() Function
• Introduced in version 1.3b48
Sets the image for the for the Current Token. The function accepts an Asset ID or an Image Token name. You can get Asset IDs from macro functions such as tblImage() or getTokenImage(). Image Tokens are special tokens whose name starts with "image:".
Usage
setTokenImage(assetId)
setTokenImage(assetId, id)
setTokenImage(assetId, id, mapname)setTokenImage(imageToken)
setTokenImage(imageToken, id)
setTokenImage(imageToken, id, mapname)Parameters
assetId- The Asset ID for an image.imageToken- The name of an image token e.g. "image:myimage"id- OPTIONAL: The tokenidof the token for which you want to set the image, defaults to the Current Token.mapname- OPTIONAL: The name of the map to find the token. Defaults to the current map.
Example
[h: setTokenImage(tblImage("elfImages", 1))]
[h: setTokenImage("image:Elf-Dead")]
Version Changes
- 1.5.4 - Added
idandmapnameparameter options.