flipTokenY: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{MacroFunction |name=flipTokenY |proposed=true |trusted=true |version=1.10.0 |compatibility=1.10.0 |description= Flip the current token image vertically like the right-click...") |
No edit summary |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=flipTokenY | |name=flipTokenY | ||
|trusted=true | |trusted=true | ||
|version=1.10.0 | |version=1.10.0 | ||
| Line 11: | Line 10: | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
flipTokenY() - current token | flipTokenY() - current token | ||
flipTokenY( | flipTokenY(tokenRef) - specify token by name or ID | ||
flipTokenY( | flipTokenY(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''' | ||
| Line 44: | Line 44: | ||
* '''1.10.0''' - Added function. | * '''1.10.0''' - Added function. | ||
}} | }} | ||
[[Category:Token Function]] | |||
Latest revision as of 23:59, 13 May 2024
flipTokenY() 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 vertically like the right-click menu option.
Usage
flipTokenY() - current token
flipTokenY(tokenRef) - specify token by name or ID
flipTokenY(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/1 - new flipped status
Example
Flip the current token horizontally.
[h: flipTokenY()]Flip the "Stairs Down" token on map "Level 1".
[h: flipTokenY("Stairs Down", "Level 1")]Clear flipped status.
[h, if(isFlippedY() == 1):flipTokenY()]See Also
Version Changes
- 1.10.0 - Added function.