setTokenDrawOrder: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(New page: {{stub}} {{MacroFunction |name=setTokenDrawOrder |version=1.3b51 |description= Sets the draw order of a token. |usage= <source lang="mtmacro" line> setTokenDrawOrder(z) </source> <source ...)
 
No edit summary
 
(5 intermediate revisions by 3 users not shown)
Line 7: Line 7:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setTokenDrawOrder(z)
setTokenDrawOrder(z)
</source>
<source lang="mtmacro" line>
setTokenDrawOrder(z, id)
setTokenDrawOrder(z, id)
</source>
setTokenDrawOrder(z, id, mapRef)
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
* {{code|z}} - The Z coordinate to set the draw order to.
{{param|z|The Z coordinate to set the draw order to.}}
* {{code|id}} - The id of the token to set the draw order of, defaults to the current token.
{{param|id|The id or token name of the token to move, defaults to the [[Current Token]].}}
{{param|mapRef|The Name or ID of the map to find the token.  Defaults to the current map.}}
 
|also=
{{func|getTokenDrawOrder}}
 
|changes=
{{change|1.5.8|Added {{code|mapname}} parameter option.}}
 


}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Latest revision as of 23:59, 15 June 2023

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

setTokenDrawOrder() Function

Introduced in version 1.3b51
Sets the draw order of a token.

Usage

setTokenDrawOrder(z)
setTokenDrawOrder(z, id)
setTokenDrawOrder(z, id, mapRef)

Parameters

  • z - The Z coordinate to set the draw order to.
  • id - The id or token name of the token to move, defaults to the Current Token.
  • mapRef - The Name or ID of the map to find the token. Defaults to the current map.


See Also

Version Changes

  • 1.5.8 - Added mapname parameter option.