isFlippedIso: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page IsFlippedIso to isFlippedIso: Converting page titles to lowercase) |
No edit summary |
||
Line 11: | Line 11: | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
isFlippedIso() - current token | isFlippedIso() - current token | ||
isFlippedIso( | isFlippedIso(tokenRef) - specify token by name or ID | ||
isFlippedIso( | isFlippedIso(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 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''' |
Revision as of 15:44, 17 May 2024
Note: This refers to a proposed change that has not been implemented in the main code base yet.
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 tokenid
or Token Name of the token to checkmap
- 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.