setTokenFacing: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 8: Line 8:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setTokenFacing(angle)
setTokenFacing(angle)
</source>
<source lang="mtmacro" line>
setTokenFacing(angle, id)
setTokenFacing(angle, id)
</source>
setTokenFacing(angle, id, mapname)
</syntaxhighlight>
'''Parameters'''
'''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|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|mapname|The name of the map to find the token.  Defaults to the current map.}}


|changes=
{{change|1.5.4|Added {{code|mapname}} parameter option.}}
}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Latest revision as of 20:31, 14 March 2023

 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, id)
setTokenFacing(angle, id, mapname)

Parameters

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


Version Changes

  • 1.5.4 - Added mapname parameter option.