getRawProperty: Difference between revisions

From RPTools Wiki
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)
m (Text replacement - "<source" to "<syntaxhighlight")
 
(2 intermediate revisions by 2 users not shown)
Line 7: Line 7:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getRawProperty(prop)
getRawProperty(prop)
getRawProperty(prop, id)
getRawProperty(prop, id)
getRawProperty(prop, id, mapname)
getRawProperty(prop, id, mapname)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|prop|The name of the property to return.}}
{{param|prop|The name of the property to return.}}

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.