getProperty: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Added example (right wiki syntax?)) |
||
Line 18: | Line 18: | ||
{{param|property|The property that has its value returned.}} | {{param|property|The property that has its value returned.}} | ||
{{param|id|The token {{code|id}} or name 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}} }} | ||
===Examples=== | |||
<source lang="mtmacro" line> | |||
The value of property 'Strength' is [r: getProperty("Strength")]. | |||
</source> | |||
This will output the following if '''Strength''' has the value '''18''': | |||
The value of property 'Strength' is 18. | |||
|also= | |also= |
Revision as of 23:19, 26 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
or 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.
Examples
The value of property 'Strength' is [r: getProperty("Strength")].
This will output the following if Strength has the value 18:
The value of property 'Strength' is 18.
See Also
Version Changes
- 1.3b51 - Added
id
parameter option. - 1.3b51 - Changed to return the default value if the property has no value.