getLabel: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) No edit summary |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{stub|Examples of usage.}} | |||
{{MacroFunction | {{MacroFunction | ||
|name=getLabel | |name=getLabel | ||
|description=Returns the [[Token | |version=1.3b48 | ||
|description= | |||
Returns the [[Introduction_to_Mapping#Changing_a_Token.27s_Name.2C_GM_Name.2C_and_Label|Token Label]] for a specific [[Token]]. | |||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getLabel() | |||
</ | </syntaxhighlight> | ||
<syntaxhighlight lang="mtmacro" line> | |||
getLabel(id) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{param|id|The token {{code|id}} of the token that has its [[Introduction_to_Mapping#Changing_a_Token.27s_Name.2C_GM_Name.2C_and_Label|Token Label]] returned, defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
|also= | |||
{{func|setLabel}} | |||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest 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.
This article needs: Examples of usage.
getLabel() Function
• Introduced in version 1.3b48
Returns the Token Label for a specific Token.
Usage
getLabel()getLabel(id)Parameter
id- The tokenidof the token that has its Token Label returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
See Also
Version Changes
- 1.3b51 - Added
idparameter option.