getProperty: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 4: | Line 4: | ||
|version=1.3b48 | |version=1.3b48 | ||
|description= | |description= | ||
Returns the value of a [[Token Property]] on a [[Token]]. | Returns the value of a [[Token Property]] on a [[Token]]. | ||
If the [[Token Property]] is empty ({{code|NULL}}) or not defined, an empty string ({{code|""}}) is returned. | |||
|usage= | |usage= |
Revision as of 23:15, 15 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 tokenid
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.
See Also
Version Changes
- 1.3b51 - Added
id
parameter option. - 1.3b51 - Changed to return the default value if the property has no value.