getStrProp: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "<source" to "<syntaxhighlight")
 
(3 intermediate revisions by 2 users not shown)
Line 6: Line 6:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getStrProp(propList, key)
getStrProp(propList, key)
getStrProp(propList, key, default)
getStrProp(propList, key, default)
getStrProp(propList, key, default, delim)
getStrProp(propList, key, default, delim)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|proplist|String property list to extract data from.}}  
{{param|proplist|String property list to extract data from.}}  
Line 19: Line 19:
|example=
|example=
To get the name from a weapon [[Macros:string property list|string property list]]
To get the name from a weapon [[Macros:string property list|string property list]]
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]
Name of Weapon: [r: getStrProp(weapon, "name")]
Name of Weapon: [r: getStrProp(weapon, "name")]
</source>
</syntaxhighlight>
Returns {{code|Name of Weapon: longsword}}.
Returns {{code|Name of Weapon: longsword}}.


To get the minimum damage from a weapon [[Macros:string property list|string property list]] with a default value should the key not exist
To get the minimum damage from a weapon [[Macros:string property list|string property list]] with a default value should the key not exist
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]
Minimum damage of Weapon: [r: getStrProp(weapon, "mindamage", 1)]
Minimum damage of Weapon: [r: getStrProp(weapon, "mindamage", 1)]
</source>
</syntaxhighlight>
Returns {{code|Minimum damage of Weapon: 1}}.
Returns {{code|Minimum damage of Weapon: 1}}.


To get the damage from a weapon [[Macros:string property list|string property list]] where the field delimiter is a colon.  The default is '''1d3''' (note that a default value must be provided in order to specify the delimiter).
To get the damage from a weapon [[Macros:string property list|string property list]] where the field delimiter is a colon.  The default is '''1d3''' (note that a default value must be provided in order to specify the delimiter).
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: weapon = "name=longsword: damage=1d8: maxdamage=8"]
[h: weapon = "name=longsword: damage=1d8: maxdamage=8"]
Damage of Weapon: [r: getStrProp(weapon, "damage", "1d3", ":")]
Damage of Weapon: [r: getStrProp(weapon, "damage", "1d3", ":")]
</source>
</syntaxhighlight>
Returns {{code|Damage of Weapon: 1d8}}.
Returns {{code|Damage of Weapon: 1d8}}.



Latest revision as of 20:27, 14 March 2023

getStrProp() Function

Introduced in version 1.3b42
Returns the value associated with a key from the specified string property list.

Usage

getStrProp(propList, key)
getStrProp(propList, key, default)
getStrProp(propList, key, default, delim)

Parameters

  • proplist - String property list to extract data from.
  • key - Key within string to extract. This cannot include a space.
  • default - Value returned if the key is not found.
  • delim - Delimiter between fields (default is ";").

Example

To get the name from a weapon string property list
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]
Name of Weapon: [r: getStrProp(weapon, "name")]

Returns Name of Weapon: longsword.

To get the minimum damage from a weapon string property list with a default value should the key not exist

[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]
Minimum damage of Weapon: [r: getStrProp(weapon, "mindamage", 1)]

Returns Minimum damage of Weapon: 1.

To get the damage from a weapon string property list where the field delimiter is a colon. The default is 1d3 (note that a default value must be provided in order to specify the delimiter).

[h: weapon = "name=longsword: damage=1d8: maxdamage=8"]
Damage of Weapon: [r: getStrProp(weapon, "damage", "1d3", ":")]
Returns Damage of Weapon: 1d8.


Version Changes

  • 1.3b43 - Added the optional error parameter.