From RPTools Wiki
Jump to navigation Jump to search

getTokenFacing() Function

Introduced in version 1.3b51
Gets the facing angle for the specified or current token. Values will range from -179 to +180. Default facing is -90 degrees or down, 0 degrees is to the right, +90 degrees is up, +180 degrees is to the left. The jump in the value range is the difference between "exactly left" (+180) and "almost exactly left, but tilted 1 degree down" (-179).
Note that math.atan2_r can be used to calculate facing from a direction given in two coordinate pairs.


getTokenFacing(tokenRef, mapname)


  • tokenRef - Either the token id or Token Name of the token to get the facing from, defaults to the current token.

     Note: This parameter can only be used in a Trusted Macro

  • mapname - The name of the map to find the token. Defaults to the current 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.

Returns The angle in degrees or "" if no facing has been set


[h: switchToken("Mage")]
[r:]: [r: r = getTokenFacing()]<br>
[h: switchToken("Elf")]
[r:]: [r: r = getTokenFacing()]<br>
[h: switchToken("Hero")]
[r:]: [r: r = getTokenFacing()]<br>
[h: switchToken("Troll")]
[r:]: [r: r = getTokenFacing()]


See Also

Version Changes

  • 1.5.4 - Added mapname parameter option.