getRawProperty: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page getRawProperty to GetRawProperty without leaving a redirect: Converting page title to first-letter uppercase) |
No edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getRawProperty(prop) | getRawProperty(prop) | ||
getRawProperty(prop, | getRawProperty(prop, tokenRef) | ||
getRawProperty(prop, | getRawProperty(prop, tokenRef, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|prop|The name of the property to return.}} | {{param|prop|The name of the property to return.}} | ||
{{param|id| | {{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to retrieve the property from.}} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | {{param|mapname|The name of the map to find the token. Defaults to the current map.}} | ||
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}} | |||
|changes= | |changes= | ||
Latest revision as of 18:55, 11 May 2024
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, tokenRef)
getRawProperty(prop, tokenRef, mapname)Parameters
prop- The name of the property to return.tokenRef- Either the tokenidor Token Name of the token to retrieve the property from.mapname- The name of the map to find the token. Defaults to the current map.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.
Version Changes
- 1.5.4 - Added
mapnameparameter option.