setLabel: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Updated with recent version changes.)
No edit summary
 
(4 intermediate revisions by 3 users not shown)
Line 4: Line 4:
|version=1.3b48
|version=1.3b48
|description=
|description=
Sets the [[Token Label]] of a specific [[Token]].  
Sets the [[Introduction_to_Mapping#Changing_a_Token.27s_Name.2C_GM_Name.2C_and_Label|Token Label]] of a specific [[Token]].  


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setLabel(label)
setLabel(label)
</source>
</syntaxhighlight>
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setLabel(label, id)
setLabel(label, id)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|label|The string that the [[Token Label]] is set to.}}
{{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}} }}
{{param|id|The token {{code|id}} of the token that has its label set, defaults to the [[Current Token]]. {{TrustedParameter}} }}



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 token id of 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 id parameter option.