setTokenFacing: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) mNo edit summary |
No edit summary |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 8: | Line 8: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setTokenFacing(angle) | setTokenFacing(angle) | ||
setTokenFacing(angle, tokenRef) | |||
setTokenFacing(angle, tokenRef, mapname) | |||
setTokenFacing(angle, | </syntaxhighlight> | ||
</ | |||
'''Parameters''' | '''Parameters''' | ||
{{param|angle|The angle as which to set the facing.}} | |||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to set the facing of, defaults to the current token. If this parameter is used, this function requires a trusted macro.}} | |||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
{{Note|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.}} | |||
|changes= | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest revision as of 19:03, 11 May 2024
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
setTokenFacing() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b51
Sets the facing angle of a token.
Usage
setTokenFacing(angle)
setTokenFacing(angle, tokenRef)
setTokenFacing(angle, tokenRef, mapname)Parameters
angle- The angle as which to set the facing.tokenRef- Either the tokenidor Token Name of the token to set the facing of, defaults to the current token. If this parameter is used, this function requires 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.
Version Changes
- 1.5.4 - Added
mapnameparameter option.