flipTokenX: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Full Bleed (talk | contribs) m (Updated "map" parameter to "mapRef" in Usage and Parameters.) |
||
| Line 9: | Line 9: | ||
|usage= | |usage= | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
flipTokenX() | flipTokenX() | ||
flipTokenX(tokenRef) | flipTokenX(tokenRef) | ||
flipTokenX(tokenRef, | flipTokenX(tokenRef, mapRef) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to change}} | {{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to change}} | ||
{{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 09:58, 24 November 2024
flipTokenX() 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 horizontally like the right-click menu option.
Usage
flipTokenX()
flipTokenX(tokenRef)
flipTokenX(tokenRef, mapRef)Parameters
tokenRef- Either the tokenidor Token Name of the token to changemapRef- 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
Example
Flip the current token horizontally.
[h: flipTokenX()]Flip the "Stairs Down" token on map "Level 1".
[h: flipTokenX("Stairs Down", "Level 1")]Clear flipped status.
[h, if(isFlippedX() == 1):flipTokenX()]See Also
Version Changes
- 1.10.0 - Added function.