getProperty: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) mNo edit summary |
Verisimilar (talk | contribs) m (Updated with recent version changes.) |
||
| Line 1: | Line 1: | ||
{{stub|Examples of usage.}} | |||
{{MacroFunction | {{MacroFunction | ||
|name=getProperty | |name=getProperty | ||
|version=1.3b48 | |version=1.3b48 | ||
|description=Returns the value of a [[Property | |description= | ||
Returns the value of a [[Token Property]] on a [[Token]]. | |||
|usage= | |usage= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getProperty( | getProperty(property) | ||
</source> | |||
<source lang="mtmacro" line> | |||
getProperty(property, id) | |||
</source> | </source> | ||
'''Parameter''' | '''Parameter''' | ||
{{param| | {{param|property|The property that has its value returned.}} | ||
{{param|id|The token {{code|id}} of the token that has its property value returned, defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
|also= | |also= | ||
[[ | [[setProperty|setProperty()]], | ||
[[resetProperty|resetProperty()]], | |||
[[isPropertyEmpty|isPropertyEmptyy()]] | |||
|changes= | |changes= | ||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
{{change|1.3b51|Changed to return the default value if the property has no value.}} | {{change|1.3b51|Changed to return the default value if the property has no value.}} | ||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Revision as of 04:28, 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.
getProperty() Function
• Introduced in version 1.3b48
Returns the value of a Token Property on a Token.
Usage
getProperty(property)getProperty(property, id)Parameter
property- The property that has its value returned.id- The tokenidof the token that has its property value 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. - 1.3b51 - Changed to return the default value if the property has no value.