getTokenFacing: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 4: | Line 4: | ||
|version=1.3b51 | |version=1.3b51 | ||
|description= | |description= | ||
Gets the facing angle for the specified or current token. | 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).<br /> | ||
Note that [[math#atan2_r|math.atan2_r]] can be used to calculate facing from a direction given in two coordinate pairs. | |||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getTokenFacing() | getTokenFacing() | ||
getTokenFacing(id) | getTokenFacing(id) | ||
getTokenFacing(id, mapname) | getTokenFacing(id, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|id|The id of the token to get the facing from, defaults to the current token.}}{{TrustedParameter}} | {{param|id|The id of the token to get the facing from, defaults to the current token.}}{{TrustedParameter}} | ||
| Line 20: | Line 21: | ||
|example= | |example= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: switchToken("Mage")] | [h: switchToken("Mage")] | ||
[r: token.name]: [r: r = getTokenFacing()]<br> | [r: token.name]: [r: r = getTokenFacing()]<br> | ||
| Line 29: | Line 30: | ||
[h: switchToken("Troll")] | [h: switchToken("Troll")] | ||
[r: token.name]: [r: r = getTokenFacing()] | [r: token.name]: [r: r = getTokenFacing()] | ||
</ | </syntaxhighlight> | ||
'''Returns:'''<br /> | '''Returns:'''<br /> | ||
[[File: | [[File:GetTokenFacing.png]] | ||
|also= | |also= | ||
[[getTokenRotation]] | [[setTokenFacing]]<br />[[getTokenRotation]] | ||
|changes= | |changes= | ||
Revision as of 21:03, 14 March 2023
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.
Note that math.atan2_r can be used to calculate facing from a direction given in two coordinate pairs.
Usage
getTokenFacing()
getTokenFacing(id)
getTokenFacing(id, mapname)Parameters
id- The id 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.
Returns
The angle in degrees or "" if no facing has been set
Example
[h: switchToken("Mage")]
[r: token.name]: [r: r = getTokenFacing()]<br>
[h: switchToken("Elf")]
[r: token.name]: [r: r = getTokenFacing()]<br>
[h: switchToken("Hero")]
[r: token.name]: [r: r = getTokenFacing()]<br>
[h: switchToken("Troll")]
[r: token.name]: [r: r = getTokenFacing()]Returns:
See Also
Version Changes
- 1.5.4 - Added
mapnameparameter option.