flipTokenY

flipTokenY() 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

Flip the current token image vertically like the right-click menu option.

Usage

flipTokenY() - current token
flipTokenY(tokenRef) - specify token by name or ID
flipTokenY(tokenRef, map) - specify token and map

Parameters

• tokenRef - Either the token id or Token Name of the token to change
• 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

Flip the current token horizontally.

[h: flipTokenY()]

Flip the "Stairs Down" token on map "Level 1".

[h: flipTokenY("Stairs Down", "Level 1")]

Clear flipped status.

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

See Also

flipTokenX(), flipTokenIso(), isFlippedX(), isFlippedY(), isFlippedIso()

Version Changes

• 1.10.0 - Added function.