getProperty: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| (9 intermediate revisions by 6 users not shown) | |||
| Line 5: | Line 5: | ||
|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. | If the [[Token Property]] is empty ({{code|NULL}}) or not defined, an empty string ({{code|""}}) is returned. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getProperty(property) | getProperty(property) | ||
getProperty(property, id) | getProperty(property, id) | ||
</ | getProperty(property, id, mapname) | ||
</syntaxhighlight> | |||
'''Parameter''' | '''Parameter''' | ||
{{param|property|The property that has its value returned.}} | {{param|property|The property that has its value returned. For referencing the literal name of the property (for instance, if you wish to get the property ''Constitution'' configured in Campaign Properties), enclose the property name in quotes. If using a variable whose ''value ''is the name of the property, do not enclose the variable name in quotes.}} | ||
{{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}} }} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|example= | |||
Getting a property using the literal property name. | |||
<syntaxhighlight lang="mtmacro" line> | |||
The value of property 'Strength' is [r: getProperty("Strength")]. | |||
</syntaxhighlight> | |||
This will output the following if '''Strength''' has the value '''18''': | |||
The value of property 'Strength' is 18. | |||
Getting a property using a variable. | |||
<syntaxhighlight lang="mtmacro" line> | |||
[h:desiredProperty = "Constitution"] | |||
The value of property 'Constitution' is [r: getProperty(desiredProperty)]. | |||
</syntaxhighlight> | |||
This will output the following if '''Constitution''' has the value '''12''': | |||
The value of property 'Constitution' is 12. | |||
|also= | |also= | ||
[[setProperty|setProperty()]], | [[setProperty|setProperty()]], | ||
| Line 27: | Line 43: | ||
{{change|1.3b51|Added {{code|id}} parameter option.}} | {{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.}} | ||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]][[Category:Property Function]] | ||
Latest revision as of 21:24, 14 March 2023
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)
getProperty(property, id, mapname)Parameter
property- The property that has its value returned. For referencing the literal name of the property (for instance, if you wish to get the property Constitution configured in Campaign Properties), enclose the property name in quotes. If using a variable whose value is the name of the property, do not enclose the variable name in quotes.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.
mapname- The name of the map to find the token. Defaults to the current map.
Example
Getting a property using the literal property name.
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.
Getting a property using a variable.
[h:desiredProperty = "Constitution"]
The value of property 'Constitution' is [r: getProperty(desiredProperty)].This will output the following if Constitution has the value 12:
The value of property 'Constitution' is 12.See Also
Version Changes
- 1.3b51 - Added
idparameter option. - 1.3b51 - Changed to return the default value if the property has no value.
- 1.5.4 - Added
mapnameparameter option.