getName: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetName to getName: Converting page titles to lowercase)
m (Text replacement - "<source" to "<syntaxhighlight")
Line 7: Line 7:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getName()
getName()
getName(id)
getName(id)
Line 17: Line 17:


|example=
|example=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[TokenList = getTokens("json")]
[TokenList = getTokens("json")]
[foreach(Token, TokenList, "<br>", "json"): getName(Token) + "'s ID is " + Token]
[foreach(Token, TokenList, "<br>", "json"): getName(Token) + "'s ID is " + Token]

Revision as of 18:38, 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

<syntaxhighlight lang="mtmacro" line> getName() getName(id) getName(id, mapname) </source> 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

<syntaxhighlight lang="mtmacro" line>

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

</source>


Version Changes

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