isFlippedIso: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=isFlippedIso |proposed=true |trusted=true |version=1.10.0 |compatibility=1.10.0 |description= Flip the current token image in the Isomeric plane like the...")
 
No edit summary
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{MacroFunction
{{MacroFunction
|name=isFlippedIso
|name=isFlippedIso
|proposed=true
|trusted=true
|trusted=true
|version=1.10.0
|version=1.10.0
|compatibility=1.10.0
|compatibility=1.10.0
|description=
|description=
Flip the current token image in the Isomeric plane like the right-click menu option.
Get the isometric flipped status for the current token image.


|usage=
|usage=
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
isFlippedIso() - current token
isFlippedIso() - current token
isFlippedIso(token) - specify token by name or ID
isFlippedIso(tokenRef) - specify token by name or ID
isFlippedIso(token, map) - specify token and map  
isFlippedIso(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 34: Line 35:


|also=
|also=
{{func|flipTokenX}}, {{func|flipTokenY}}, {{func|flipTokenIso}}, {{func|isFlippedX}} {{func|isFlippedY}}
{{func|flipTokenX}}, {{func|flipTokenY}}, {{func|flipTokenIso}}, {{func|isFlippedX}}, {{func|isFlippedY}}


|changes=
|changes=
* '''1.10.0''' - Added function.
* '''1.10.0''' - Added function.
}}
}}
[[Category:Token Function]]

Latest revision as of 23:59, 29 August 2024

isFlippedIso() 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 isometric flipped status for the current token image.

Usage

isFlippedIso() - current token
isFlippedIso(tokenRef) - specify token by name or ID
isFlippedIso(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 isometric flipped status for the current token.
[h: flipped = isFlippedIso()]

Clear flipped status.

[h, if(isFlippedIso() == 1):flipTokenIso()]

See Also

Version Changes

  • 1.10.0 - Added function.