flipTokenIso: Difference between revisions
Jump to navigation
Jump to search
Full Bleed (talk | contribs) m (Update "map" to "mapRef" in Usage and Parameters. Standardized Usage to be like other wiki entries.) Tags: Reverted Visual edit |
m (Reverted edits by Full Bleed (talk) to last revision by Taustin) Tag: Rollback |
||
| Line 9: | Line 9: | ||
|usage= | |usage= | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
flipTokenIso() | flipTokenIso() - current token | ||
flipTokenIso(tokenRef) | flipTokenIso(tokenRef) - specify token by name or ID | ||
flipTokenIso(tokenRef, | flipTokenIso(tokenRef, map) - specify token and map | ||
</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| | {{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.}} | {{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 23:47, 25 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() - 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.