getTokenDrawOrder: Difference between revisions

Latest revision as of 23:59, 14 May 2024

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

• Introduced in version 1.3b51

Gets the draw order of a token.

getTokenDrawOrder()
getTokenDrawOrder(tokenRef)
getTokenDrawOrder(tokenRef, mapRef)

Parameter

tokenRef - Either the token id or Token Name of the token to return the draw order of, defaults to the Current Token.
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 1: / Line 1: @@
 {{stub}}
 {{MacroFunction
-|name=getDrawOrder
+|name=getTokenDrawOrder
 |version=1.3b51
 |description=
@@ Line 7: / Line 7: @@
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-getDrawOrder()
+getTokenDrawOrder()
-</source>
+getTokenDrawOrder(tokenRef)
-<source lang="mtmacro" line>
+getTokenDrawOrder(tokenRef, mapRef)
-getDrawOrder(id)
+</syntaxhighlight>
-</source>
 '''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|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.}}
+|also=
+{{func|setTokenDrawOrder}}
+|changes=
+{{change|1.5.8|Added {{code|mapname}} parameter option.}}
 }}
 [[Category:Token Function]]