flipTokenIso: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Full Bleed (talk | contribs) m (Update "map" to "mapRef" in Usage and Parameters. Standardized Usage to be like other wiki entries.) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 9: | Line 9: | ||
|usage= | |usage= | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
flipTokenIso() | flipTokenIso() | ||
flipTokenIso(tokenRef) | flipTokenIso(tokenRef) | ||
flipTokenIso(tokenRef, | flipTokenIso(tokenRef, mapRef) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token}} | {{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token}} | ||
{{param|map | {{param|mapRef|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.}} | {{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.}} | ||
Latest revision as of 10:02, 24 November 2024
flipTokenIso() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
• Last checked for compatibility with version 1.10.0
Flip the current token image in the Isomeric plane like the right-click menu option.
Usage
flipTokenIso()
flipTokenIso(tokenRef)
flipTokenIso(tokenRef, mapRef)Parameters
tokenRef- Either the tokenidor Token Name of the tokenmapRef- 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.
Returns
0/1 - new flipped status
Example
Flip the current token in the isometric plane.
[h: flipTokenIso()]Flip the "Stairs Down" token on map "Level 1".
[h: flipTokenIso("Stairs Down", "Level 1")]Clear flipped status.
[h, if(isFlippedIso() == 1):flipTokenIso()]See Also
Version Changes
- 1.10.0 - Added function.