getTokenRotation: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (11 intermediate revisions by 4 users not shown) | |||
| Line 7: | Line 7: | ||
Retrieves the angle of rotation for the token from the default position. Returned value is in degrees. | Retrieves the angle of rotation for the token from the default position. Returned value is in degrees. | ||
For Square, Round or Figure token types, this is the change in the facing indicator from the default of 0 degrees or no change in facing. Positive is CW and negative is CCW. Values will range from -270 to + | For Square, Round or Figure token types, this is the change in the facing indicator from the default of 0 degrees or no change in facing. Positive is CW and negative is CCW. Values will range from -270 to +89. | ||
For Top Down tokens, this is the rotation of the token image itself from the default of 0 degrees. | For Top Down tokens, this is the rotation of the token image itself from the default of 0 degrees. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getTokenRotation() | getTokenRotation() | ||
getTokenRotation(id) | getTokenRotation(id) | ||
</ | getTokenRotation(id, mapname) | ||
</syntaxhighlight> | |||
'''Parameters''' | '''Parameters''' | ||
{{param|id|The token id of the token to retrieve the rotation angle. Defaults to the [[Current Token]].}}{{TrustedParameter}} | {{param|id|The token id of the token to retrieve the rotation angle. Defaults to the [[Current Token]].}}{{TrustedParameter}} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
'''Result'''<br /> | '''Result'''<br /> | ||
The function returns the token's rotation as a numeric value measured in degrees. | The function returns the token's rotation as a numeric value measured in degrees. | ||
|example= | |example= | ||
Get the rotation for the four tokens shown below. | Get the rotation for the four tokens shown below. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: switchToken("Mage")] | [h: switchToken("Mage")] | ||
[r: token.name] - [r: r = getTokenRotation()]<br> | [r: token.name] - [r: r = getTokenRotation()]<br> | ||
| Line 31: | Line 34: | ||
[r: token.name] - [r: r = getTokenRotation()]<br> | [r: token.name] - [r: r = getTokenRotation()]<br> | ||
[h: switchToken("Troll")] | [h: switchToken("Troll")] | ||
[r: token.name] - [r: r = getTokenRotation()]</ | [r: token.name] - [r: r = getTokenRotation()]</syntaxhighlight> | ||
Returns: | Returns: | ||
[[File: | [[File:GetTokenRotation.png]] | ||
'''Relation to Token Facing''' | |||
When no facing has been set, [[getTokenFacing]] will return the blank string {{code|""}} but getTokenRotation will return 0. Consequently getTokenRotation does not require a check to ensure the result is usable for calculations. | |||
To convert from rotation to facing (or vice versa) these relations can be used: | |||
<syntaxhighlight lang="mtmacro" line> | |||
facing = -(rotation + 90) | |||
</syntaxhighlight> | |||
<syntaxhighlight lang="mtmacro" line> | |||
rotation = -(facing + 90) | |||
</syntaxhighlight> | |||
|also= | |also= | ||
[[ | [[setTokenFacing]] | ||
|changes= | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest revision as of 22:22, 5 June 2023
getTokenRotation() Function
• Introduced in version 1.5.0
Retrieves the angle of rotation for the token from the default position. Returned value is in degrees.
For Square, Round or Figure token types, this is the change in the facing indicator from the default of 0 degrees or no change in facing. Positive is CW and negative is CCW. Values will range from -270 to +89.
For Top Down tokens, this is the rotation of the token image itself from the default of 0 degrees.Usage
getTokenRotation()
getTokenRotation(id)
getTokenRotation(id, mapname)Parameters
id- The token id of the token to retrieve the rotation angle. 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.
Result
The function returns the token's rotation as a numeric value measured in degrees.
Example
Get the rotation for the four tokens shown below.
[h: switchToken("Mage")]
[r: token.name] - [r: r = getTokenRotation()]<br>
[h: switchToken("Elf")]
[r: token.name] - [r: r = getTokenRotation()]<br>
[h: switchToken("Hero")]
[r: token.name] - [r: r = getTokenRotation()]<br>
[h: switchToken("Troll")]
[r: token.name] - [r: r = getTokenRotation()]Returns:
Relation to Token Facing
When no facing has been set, getTokenFacing will return the blank string "" but getTokenRotation will return 0. Consequently getTokenRotation does not require a check to ensure the result is usable for calculations.
To convert from rotation to facing (or vice versa) these relations can be used:
facing = -(rotation + 90)rotation = -(facing + 90)See Also
Version Changes
- 1.5.4 - Added
mapnameparameter option.