setStrProp: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
m (Added missing delimiter usage/parameter.)
Line 8: Line 8:
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setStrProp(propList, key, value)
setStrProp(propList, key, value)
setStrProp(propList, key, value, delim)
</syntaxhighlight>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|propList|The [[String Property List]] affected by this function.}}
{{param|propList|The [[String Property List]] affected by this function.}}
{{param|key|The key in the specified [[String Property List]] that will have its value set.}}
{{param|key|The key in the specified [[String Property List]] that will have its value set.}}
{{param|value|The value that the specified key will be set to.}}  
{{param|value|The value that the specified key will be set to.}}
{{param|delim|Delimiter between fields (default is ";").}}  


|examples=
|examples=

Revision as of 16:20, 14 November 2024

setStrProp() Function

Introduced in version 1.3b42
Returns a String Property List with the key set to the value passed in.

Usage

setStrProp(propList, key, value)
setStrProp(propList, key, value, delim)

Parameters

  • propList - The String Property List affected by this function.
  • key - The key in the specified String Property List that will have its value set.
  • value - The value that the specified key will be set to.
  • delim - Delimiter between fields (default is ";").

Examples

Add a new key to an existing String Property List:
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]
[h: weapon = setStrProp(weapon, "value", 10)]
[r: weapon]

Returns "name=longsword ; damage=1d8 ; maxdamage=8 ; value=10 ; "

Change the value of a key in an existing String Property List:

[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]
[h: weapon = setStrProp(weapon, "damage", "1d6")]
[r: weapon]
Returns "name=longsword ; damage=1d6 ; maxdamage=8 ; "

See Also