isFlippedX: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=isFlippedX |proposed=true |trusted=true |version=1.10.0 |compatibility=1.10.0 |description= Get the horizontal flipped status for the current token image...")
 
No edit summary
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{MacroFunction
{{MacroFunction
|name=isFlippedX
|name=isFlippedX
|proposed=true
|trusted=true
|trusted=true
|version=1.10.0
|version=1.10.0
Line 11: Line 10:
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
isFlippedX() - current token
isFlippedX() - current token
isFlippedX(token) - specify token by name or ID
isFlippedX(tokenRef) - specify token by name or ID
isFlippedX(token, map) - specify token and map  
isFlippedX(tokenRef, map) - specify token and map  
</syntaxhighlight>
</syntaxhighlight>


'''Parameters'''
'''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 check}}
{{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 40: Line 40:
* '''1.10.0''' - Added function.
* '''1.10.0''' - Added function.
}}
}}
[[Category:Token Function]]

Latest revision as of 15:45, 17 May 2024

isFlippedX() 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
Get the horizontal flipped status for the current token image.

Usage

isFlippedX() - current token
isFlippedX(tokenRef) - specify token by name or ID
isFlippedX(tokenRef, map) - specify token and map

Parameters

  • tokenRef - Either the token id or Token Name of the token to check
  • map - 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

Get the horizontal flipped status for the current token.
[h: flipped = isFlippedX()]

Clear flipped status.

[h, if(isFlippedX() == 1):flipTokenX()]

See Also

Version Changes

  • 1.10.0 - Added function.