flipTokenX: Difference between revisions

Latest revision as of 09:58, 24 November 2024

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.

flipTokenX()
flipTokenX(tokenRef)
flipTokenX(tokenRef, mapRef)

Parameters

tokenRef - Either the token id or Token Name of the token to change
mapRef - The Name or ID of the map to find the token. Defaults to the current map.

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

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()]

@@ Line 1: / Line 1: @@
 {{MacroFunction
 |name=flipTokenX
-|proposed=true
 |trusted=true
 |version=1.10.0
@@ Line 10: / Line 9: @@
 |usage=
 <syntaxhighlight lang="mtmacro" line>
-flipTokenX() - current token
+flipTokenX()
-flipTokenX(token) - specify token by name or ID
+flipTokenX(tokenRef)
-flipTokenX(token, map) - specify token and map
+flipTokenX(tokenRef, mapRef)
 </syntaxhighlight>
 '''Parameters'''
-{{param|token|Name or ID of token to change}}
+{{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|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}}
+{{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'''
@@ Line 43: / Line 43: @@
 * '''1.10.0''' - Added function.
 }}
+[[Category:Token Function]]