setTokenHandout: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
|version=1.3b77 | |version=1.3b77 | ||
|description= | |description= | ||
Sets the handout image for the for the [[Current Token]]. The image can come from several sources. It can be an [[ | Sets the handout image for the for the [[Current Token]]. The image can come from several sources. It can be an [[Asset ID]] (like from [[Macros:Functions:tblImage |tblImage()]] or[[Macros:Functions:getTokenImage|getTokenImage()]].) or a [[Image Token]]. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setTokenHandout(assetId) | setTokenHandout(assetId) | ||
setTokenHandout(assetId, id) | setTokenHandout(assetId, id) | ||
setTokenHandout(assetId, id, | setTokenHandout(assetId, id, mapRef) | ||
</ | </syntaxhighlight> | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setTokenHandout(tokenImageName) | setTokenHandout(tokenImageName) | ||
setTokenHandout(tokenImageName, id) | setTokenHandout(tokenImageName, id) | ||
setTokenHandout(tokenImageName, id, | setTokenHandout(tokenImageName, id, mapRef) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|id|OPTIONAL: The token {{code|id}} of the token for which you want to set the handout, defaults to the [[Current Token]]. }} | {{param|id|OPTIONAL: The token {{code|id}} of the token for which you want to set the handout, defaults to the [[Current Token]]. }} | ||
{{param| | {{param|mapRef|OPTIONAL: The Name or ID of the map to find the token. Defaults to the current map.}} | ||
|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]] | ||
Latest revision as of 23:59, 21 April 2023
setTokenHandout() Function
• Introduced in version 1.3b77
Sets the handout image for the for the Current Token. The image can come from several sources. It can be an Asset ID (like from tblImage() orgetTokenImage().) or a Image Token.
Usage
setTokenHandout(assetId)
setTokenHandout(assetId, id)
setTokenHandout(assetId, id, mapRef)setTokenHandout(tokenImageName)
setTokenHandout(tokenImageName, id)
setTokenHandout(tokenImageName, id, mapRef)Parameters
id- OPTIONAL: The tokenidof the token for which you want to set the handout, defaults to the Current Token.mapRef- OPTIONAL: The Name or ID of the map to find the token. Defaults to the current map.
Version Changes
- 1.5.4 - Added
idandmapnameparameter options.