getTokenName: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=getTokenName |description= Returns the name of the currently selected token. |usage= <syntaxhighlight lang="mtmacro" line> getTokenName() </syntaxhighlight> '''Parameters''' None. |examples= <syntaxhighlight lang="mtmacro" line> [h: z = getZoom()] [r:getTokenName())] </syntaxhighlight> |also= }} Category:Token Function")
 
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 7: Line 7:
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getTokenName()
getTokenName()
getTokenName(tokenRef)
</syntaxhighlight>
</syntaxhighlight>
}}


'''Parameters'''
'''Parameters'''
None.
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token, 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.}}


|examples=
|examples=

Latest revision as of 23:59, 29 August 2024

getTokenName() Function

Returns the name of the currently selected token.

Usage

getTokenName()
getTokenName(tokenRef)


Parameters

  • tokenRef - Either the token id or Token Name of the token, 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.