setLabel: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Updated with recent version changes.)
Line 1: Line 1:
{{stub|Examples of usage.}}
{{MacroFunction
{{MacroFunction
|name=setLabel
|name=setLabel
|version=1.3b48
|description=
|description=
Sets the [[Token:label|label]] of the [[Token:Current Token|Current Token]].  
Sets the [[Token Label]] of a specific [[Token]].  


|usage=
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: setLabel(str)]
setLabel(label)
</source>
</source>
<source lang="mtmacro" line>
setLabel(label, id)
</source>
'''Parameters'''
{{param|label|The string that the [[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]]
[[Category:Token Function]]

Revision as of 05:12, 31 March 2009

 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.