flipTokenIso: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page FlipTokenIso to flipTokenIso: Converting page titles to lowercase) |
No edit summary |
||
| Line 11: | Line 11: | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
flipTokenIso() - current token | flipTokenIso() - current token | ||
flipTokenIso( | flipTokenIso(tokenRef) - specify token by name or ID | ||
flipTokenIso( | flipTokenIso(tokenRef, map) - specify token and map | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|token|Name | {{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token}} | ||
{{param|map|Map the token is located on}} | {{param|map|Map the token is located on}} | ||
{{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.}} | |||
'''Returns''' | '''Returns''' | ||
Revision as of 02:35, 13 May 2024
Note: This refers to a proposed change that has not been implemented in the main code base yet.
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() - current token
flipTokenIso(tokenRef) - specify token by name or ID
flipTokenIso(tokenRef, map) - specify token and mapParameters
tokenRef- Either the tokenidor Token Name of the tokenmap- Map the token is located on
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.