getRawProperty: Difference between revisions

Latest revision as of 23:59, 11 May 2024

This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

• 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.

getRawProperty(prop)
getRawProperty(prop, tokenRef)
getRawProperty(prop, tokenRef, mapRef)

Parameters

prop - The name of the property to return.
tokenRef - Either the token id or Token Name of the token to retrieve the property from.
mapRef - The Name or ID 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.

@@ Line 7: / Line 7: @@
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
 getRawProperty(prop)
-</source>
+getRawProperty(prop, tokenRef)
-<source lang="mtmacro" line>
+getRawProperty(prop, tokenRef, mapRef)
-getRawProperty(prop, id)
+</syntaxhighlight>
-</source>
 '''Parameters'''
-* {{code|prop}} - The name of the property to return.
+{{param|prop|The name of the property to return.}}
-* {{code|id}} - The id of the token to retrieve the property from.
+{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to retrieve the property from.}}
+{{param|mapRef|The Name or ID 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=
+{{change|1.5.4|Added {{code|mapname}} parameter option.}}
 }}
 [[Category:Property Function]][[Category:Token Function]]