flipTokenX: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Added page.)
 
No edit summary
Line 43: Line 43:
* '''1.10.0''' - Added function.
* '''1.10.0''' - Added function.
}}
}}
[[Category:Token Function]]

Revision as of 16:12, 9 August 2021

 Note: This refers to a proposed change that has not been implemented in the main code base yet.

flipTokenX() 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 horizontally like the right-click menu option.

Usage

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

Parameters

  • token - Name or ID of token to change
  • map - Map the token is located on

Returns 0

Example

Flip the current token horizontally.
[h: flipTokenX()]

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

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

Clear flipped status.

[h, if(isFlippedX() == 1):flipTokenX()]

See Also

Version Changes

  • 1.10.0 - Added function.