getName: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(New page: ==Function getName== Returns the name of the current Token:token. <source lang="mtmacro" line> [h: macros = getName()] </source>)
 
m (Text replacement - "source>" to "syntaxhighlight>")
 
(9 intermediate revisions by 6 users not shown)
Line 1: Line 1:
==Function getName==
{{stub}}
Returns the name of the current [[Token:token|token]].
{{MacroFunction
|name=getName
|version=1.3b40
|description=
Returns the name of a [[Token]].


<source lang="mtmacro" line>
|usage=
[h: macros = getName()]
<syntaxhighlight lang="mtmacro" line>
</source>
getName()
getName(id)
getName(id, mapname)
</syntaxhighlight>
'''Parameters'''
{{param|id|The token {{code|id}} of the token to name, defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
 
|example=
<syntaxhighlight lang="mtmacro" line>
[TokenList = getTokens("json")]
[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]]

Latest revision as of 19:36, 14 March 2023

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

getName() Function

Introduced in version 1.3b40
Returns the name of a Token.

Usage

getName()
getName(id)
getName(id, mapname)

Parameters

  • id - The token id of the token to name, defaults to the Current Token.

     Note: This parameter can only be used in a Trusted Macro

  • mapname - The name of the map to find the token. Defaults to the current map.

Example

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


Version Changes

  • 1.3b51 - Added id parameter option.
  • 1.5.4 - Added mapname parameter option.