getName: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getName() | getName() | ||
getName( | getName(tokenRef) | ||
getName( | getName(tokenRef, mapRef) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param| | {{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to name, defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
{{param| | {{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= | |example= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[TokenList = getTokens("json")] | [h: TokenList = getTokens("json")] | ||
[foreach(Token, TokenList, "<br>", "json"): getName(Token) + "'s ID is " + Token] | [r, foreach(Token, TokenList, "<br>", "json"): getName(Token) + "'s ID is " + Token] | ||
</ | </syntaxhighlight> | ||
|changes= | |changes= | ||
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.
getName() Function
• Introduced in version 1.3b40
Returns the name of a Token.
Usage
getName()
getName(tokenRef)
getName(tokenRef, mapRef)Parameters
tokenRef- Either the tokenidor 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.
Example
[h: TokenList = getTokens("json")]
[r, foreach(Token, TokenList, "<br>", "json"): getName(Token) + "'s ID is " + Token]
Version Changes
- 1.3b51 - Added
idparameter option. - 1.5.4 - Added
mapnameparameter option.