getName: Difference between revisions
Jump to navigation
Jump to search
m (Added id parameter and usage example.) |
No edit summary |
||
| Line 9: | Line 9: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getName() | getName() | ||
getName(id) | getName(id) | ||
getName(id, mapname) | |||
</source> | </source> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|id|The token {{code|id}} of the token to name, defaults to the [[Current Token]]. {{TrustedParameter}} }} | {{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= | |example= | ||
| Line 24: | Line 24: | ||
|changes= | |changes= | ||
{{change|1.3b51|Added {{code|id}} parameter option.}} | {{change|1.3b51|Added {{code|id}} parameter option.}} | ||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Revision as of 04:19, 15 August 2019
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 tokenidof 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
idparameter option. - 1.5.4 - Added
mapnameparameter option.