setProperty: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Added version.)
m (Updated with recent version changes.)
Line 1: Line 1:
{{stub|Examples of usage.}}
{{MacroFunction
{{MacroFunction
|name=setProperty
|name=setProperty
|version=1.3b48
|version=1.3b48
|description=
|description=
Sets the value of a [[Token:property| token property]] of the [[Token:Current Token|Current Token]].  
Sets the value of a [[Token Property]] on a [[Token]].  


|usage=
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
setProperty(name, value)
setProperty(property, value)
</source>
</source>
<source lang="mtmacro" line>
setProperty(property, value, id)
</source>
'''Parameters'''
{{param|property|The property that has its value set.}}
{{param|value|The value that the property is set to.}}
{{param|id|The token {{code|id}} of the token which has its property set, defaults to the [[Current Token]]. {{TrustedParameter}} }}
|also=
[[getProperty|getProperty()]],
[[resetProperty|resetProperty()]],
[[isPropertyEmpty|isPropertyEmpty()]]
|changes=
{{change|1.3b51|Added {{code|id}} parameter option.}}
}}
}}
[[Category:Property Function]]
[[Category:Property Function]]

Revision as of 04:21, 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.

setProperty() Function

Introduced in version 1.3b48
Sets the value of a Token Property on a Token.

Usage

setProperty(property, value)
setProperty(property, value, id)

Parameters

  • property - The property that has its value set.
  • value - The value that the property is set to.
  • id - The token id of the token which has its property set, defaults to the Current Token.

     Note: This parameter can only be used in a Trusted Macro


See Also

Version Changes

  • 1.3b51 - Added id parameter option.