getRawProperty: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) (Initial write-up.) |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
(6 intermediate revisions by 5 users not shown) | |||
Line 4: | Line 4: | ||
|version=1.3b51 | |version=1.3b51 | ||
|description= | |description= | ||
Gets the unevaluated value of a property, returns {{code|""}} if the property is empty. This will not return the property's default value. | Gets the unevaluated value of a [[Token:token property|token property]], returns {{code|""}} if the property is empty. This will not return the property's default value. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getRawProperty(prop) | getRawProperty(prop) | ||
getRawProperty(prop, id) | getRawProperty(prop, id) | ||
</ | getRawProperty(prop, id, mapname) | ||
</syntaxhighlight> | |||
'''Parameters''' | '''Parameters''' | ||
{{param|prop|The name of the property to return.}} | |||
{{param|id|The id of the token to retrieve the property from.}} | |||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|changes= | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:Property Function]] | [[Category:Property Function]][[Category:Token Function]] |
Latest revision as of 21:23, 14 March 2023
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
getRawProperty() Function
• Introduced in version 1.3b51
Gets the unevaluated value of a token property, returns
""
if the property is empty. This will not return the property's default value.Usage
getRawProperty(prop)
getRawProperty(prop, id)
getRawProperty(prop, id, mapname)
Parameters
prop
- The name of the property to return.id
- The id of the token to retrieve the property from.mapname
- The name of the map to find the token. Defaults to the current map.
Version Changes
- 1.5.4 - Added
mapname
parameter option.