getTokenDrawOrder: Difference between revisions

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


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getTokenDrawOrder()
getTokenDrawOrder()
</source>
getTokenDrawOrder(tokenRef)
<source lang="mtmacro" line>
getTokenDrawOrder(tokenRef, mapname)
getTokenDrawOrder(id)
</syntaxhighlight>
</source>
'''Parameter'''
'''Parameter'''
* {{code|id}} - The id of the token to get the draw order of, defaults to the current token.
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to return the draw order of, defaults to the [[Current Token]].}}
{{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.}}
 
|also=
{{func|setTokenDrawOrder}}
 
|changes=
{{change|1.5.8|Added {{code|mapname}} parameter option.}}


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

Latest revision as of 16:16, 14 May 2024

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

getTokenDrawOrder() Function

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

Usage

getTokenDrawOrder()
getTokenDrawOrder(tokenRef)
getTokenDrawOrder(tokenRef, mapname)

Parameter

  • tokenRef - Either the token id or Token Name of the token to return the draw order of, defaults to the Current Token.
  • 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.


See Also

Version Changes

  • 1.5.8 - Added mapname parameter option.