getProperty: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(Corrected the parameter list.) |
||
| Line 14: | Line 14: | ||
getProperty(property, id) | getProperty(property, id) | ||
</source> | </source> | ||
'''Parameter''' | '''Parameter''' | ||
{{param|property|The property that has its value returned.}} | {{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}} }} | {{param|id|The token {{code|id}} or name of the token that has its property value returned, defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
{{param|name|The {{code|name}} of the token that has its property value returned, defaults to the [[Current Token]]. {{TrustedParameter}} }} | {{param|name|The {{code|name}} of the token that has its property value returned, defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
Revision as of 22:11, 23 August 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.
If the Token Property is empty (
NULL) or not defined, an empty string ("") is returned.Usage
getProperty(property)getProperty(property, id)Parameter
property- The property that has its value returned.id- The tokenidor name of the token that has its property value returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
name- Thenameof 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.