isFlippedIso

From RPTools Wiki
Jump to navigation Jump to search

 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 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.