setLabel: Difference between revisions
Jump to navigation
Jump to search
(New page: ==Function setLabel== Sets the Token:label of the Token:Current Token. ===Usage=== <source lang="mtmacro" line> [h: setLabel(str)] </source>) |
No edit summary |
||
| (7 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
= | {{stub|Examples of usage.}} | ||
Sets the [[Token | {{MacroFunction | ||
|name=setLabel | |||
|version=1.3b48 | |||
|description= | |||
Sets the [[Introduction_to_Mapping#Changing_a_Token.27s_Name.2C_GM_Name.2C_and_Label|Token Label]] of a specific [[Token]]. | |||
== | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setLabel(label) | |||
</ | </syntaxhighlight> | ||
<syntaxhighlight lang="mtmacro" line> | |||
setLabel(label, id) | |||
</syntaxhighlight> | |||
'''Parameters''' | |||
{{param|label|The string that the [[Introduction_to_Mapping#Changing_a_Token.27s_Name.2C_GM_Name.2C_and_Label|Token Label]] is set to.}} | |||
{{param|id|The token {{code|id}} of the token that has its label set, defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
|also= | |||
{{func|getLabel}} | |||
|changes= | |||
{{change|1.3b51|Add {{code|id}} parameter option.}} | |||
}} | |||
[[Category:Token Function]] | |||
Latest revision as of 23:59, 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.
setLabel() Function
• Introduced in version 1.3b48
Sets the Token Label of a specific Token.
Usage
setLabel(label)setLabel(label, id)Parameters
label- The string that the Token Label is set to.id- The tokenidof the token that has its label set, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
See Also
Version Changes
- 1.3b51 - Add
idparameter option.