isFlippedY

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.

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

Usage

isFlippedY() - current token
isFlippedY(tokenRef) - specify token by name or ID
isFlippedY(tokenRef, map) - specify token and 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.


Parameters

  • tokenRef - Either the token id or Token Name of the token to check
  • map - Map the token is located on

Returns

0/1 - new flipped status

Example

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

Clear flipped status.

[h, if(isFlippedY() == 1):flipTokenY()]

See Also

Version Changes

  • 1.10.0 - Added function.