getName: Difference between revisions

Latest revision as of 23:59, 22 October 2024

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

• Introduced in version 1.3b40

Returns the name of a Token.

getName()
getName(tokenRef)
getName(tokenRef, mapRef)

Parameters

tokenRef - Either the token id or Token Name of the token to name, defaults to the Current Token.
Note: This parameter can only be used in a Trusted Macro.
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.

[h: TokenList = getTokens("json")]
[r, foreach(Token, TokenList, "<br>", "json"): getName(Token) + "'s ID is " + Token]

@@ Line 1: / Line 1: @@
+{{stub}}
 {{MacroFunction
 |name=getName
-|description=Returns the name of the [[Current Token]].
+|version=1.3b40
+|description=
+Returns the name of a [[Token]].
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-[h: macros = getName()]
+getName()
-</source>
+getName(tokenRef)
+getName(tokenRef, mapRef)
+</syntaxhighlight>
+'''Parameters'''
+{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to name, defaults to the [[Current Token]]. {{TrustedParameter}} }}
+{{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.}}
+|example=
+<syntaxhighlight lang="mtmacro" line>
+[h: TokenList = getTokens("json")]
+[r, foreach(Token, TokenList, "<br>", "json"): getName(Token) + "'s ID is " + Token]
+</syntaxhighlight>
+|changes=
+{{change|1.3b51|Added {{code|id}} parameter option.}}
+{{change|1.5.4|Added {{code|mapname}} parameter option.}}
 }}
 [[Category:Token Function]]