strPropFromVars: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(New page: ==Function strPropFromVars== Creates a property string from the names and values of the variables listed in the varList string. ===Usage=== <source lang="mtmacro" line> [h: strPropFromVar...)
 
No edit summary
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
==Function strPropFromVars==
{{MacroFunction
|name=strPropFromVars
|description=
Creates a property string from the names and values of the variables listed in the varList string.
Creates a property string from the names and values of the variables listed in the varList string.


===Usage===
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro">
[h: strPropFromVars(varList) ]
[h: strPropFromVars(varList, varStyle) ]
[h: strPropFromVars(varList, varStyle) ]
</source>
[h: strPropFromVars(varList, varStyle, delim) ]
* varStyle is either "SUFFIXED" or "UNSUFFIXED". When fetching the values of the variables, the "SUFFIXED" option will look for variables with underscores appended to the given names. The output property string does not contain the underscores.
</syntaxhighlight>
'''Parameters'''
{{param|varList|A list of variable names, separated by ",".}}
{{param|varStyle|Either "SUFFIXED" or "UNSUFFIXED". The "SUFFIXED" option will look for variables with underscores appended to the given names. Defaults to "UNSUFFIXED".}}
{{param|delim|The delimiter for the return string. Defaults to ";". }}


===Examples===
|examples=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[H: props = "a=3 ; b=bob ; c=cow ; "]
[H: props = "a=3 ; b=bob ; c=cow ; "]
[H: varsFromStrProp(props, "SUFFIXED")] <!-- creates variables a_, b_, c_ -->
[H: varsFromStrProp(props, "SUFFIXED")] <!-- creates variables a_, b_, c_ -->
[strPropFromVars("c,a,b", "SUFFIXED")]
[strPropFromVars("c,a,b", "SUFFIXED")]
</source>
</syntaxhighlight>
(returns "c=cow ; a=3 ; b=bob ; "):
'''Returns'''
<syntaxhighlight lang="mtmacro">
"c=cow ; a=3 ; b=bob"
</syntaxhighlight>
 
|also=
{{func|varsFromStrProp}}
|changes=
{{change|1.5.4|Made {{code|varStyle}} optional.}}
 
}}
[[Category:String Property List Function]]

Latest revision as of 17:36, 14 March 2023

strPropFromVars() Function

Creates a property string from the names and values of the variables listed in the varList string.

Usage

[h: strPropFromVars(varList) ]
[h: strPropFromVars(varList, varStyle) ]
[h: strPropFromVars(varList, varStyle, delim) ]

Parameters

  • varList - A list of variable names, separated by ",".
  • varStyle - Either "SUFFIXED" or "UNSUFFIXED". The "SUFFIXED" option will look for variables with underscores appended to the given names. Defaults to "UNSUFFIXED".
  • delim - The delimiter for the return string. Defaults to ";".

Examples

[H: props = "a=3 ; b=bob ; c=cow ; "]
[H: varsFromStrProp(props, "SUFFIXED")] <!-- creates variables a_, b_, c_ -->
[strPropFromVars("c,a,b", "SUFFIXED")]

Returns

"c=cow ; a=3 ; b=bob"

See Also

Version Changes

  • 1.5.4 - Made varStyle optional.