flipTokenX: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page flipTokenX to FlipTokenX without leaving a redirect: Converting page title to first-letter uppercase) |
No edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 11: | Line 11: | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
flipTokenX() - current token | flipTokenX() - current token | ||
flipTokenX( | flipTokenX(tokenRef) - specify token by name or ID | ||
flipTokenX( | flipTokenX(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 to change}} | ||
{{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''' | ||
Latest revision as of 02:36, 13 May 2024
Note: This refers to a proposed change that has not been implemented in the main code base yet.
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() - current token
flipTokenX(tokenRef) - specify token by name or ID
flipTokenX(tokenRef, map) - specify token and mapParameters
tokenRef- Either the tokenidor Token Name of the token to changemap- 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
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.