setTokenFacing: Difference between revisions

Latest revision as of 23:59, 11 May 2024

This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

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

• Introduced in version 1.3b51

Sets the facing angle of a token.

setTokenFacing(angle)
setTokenFacing(angle, tokenRef)
setTokenFacing(angle, tokenRef, mapRef)

Parameters

angle - The angle as which to set the facing.
tokenRef - Either the token id or 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.
mapRef - The Name or ID 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.

@@ Line 2: / Line 2: @@
 {{MacroFunction
 |name=setTokenFacing
+|trusted=true
 |version=1.3b51
 |description=
@@ Line 7: / Line 8: @@
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
 setTokenFacing(angle)
-</source>
+setTokenFacing(angle, tokenRef)
-<source lang="mtmacro" line>
+setTokenFacing(angle, tokenRef, mapRef)
-setTokenFacing(angle, id)
+</syntaxhighlight>
-</source>
 '''Parameters'''
-* {{code|angle}} - The angle as which to set the facing.
+{{param|angle|The angle as which to set the facing.}}
-* {{code|id}} - The id 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|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|mapRef|The Name or ID 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]]