flipTokenIso
(Redirected from FlipTokenIso)
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 map
Parameters
tokenRef
- Either the tokenid
or 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.