isFlippedX

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

flipTokenX(), flipTokenY(), flipTokenIso(), isFlippedIso(), isFlippedY()

Version Changes

• 1.10.0 - Added function.