foreach (roll option): Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page Foreach (roll option) to foreach (roll option): Converting page titles to lowercase)
m (Text replacement - "source>" to "syntaxhighlight>")
Line 12: Line 12:
[FOREACH(var, list, output_separator): body]
[FOREACH(var, list, output_separator): body]
[FOREACH(var, list, output_separator, list_separator): body]
[FOREACH(var, list, output_separator, list_separator): body]
</source>
</syntaxhighlight>


{{code|output_separator}} default value is {{code|","}}<br>
{{code|output_separator}} default value is {{code|","}}<br>
Line 22: Line 22:
[h: enemyList="Orcs, Goblins, Ogres, Trolls"]
[h: enemyList="Orcs, Goblins, Ogres, Trolls"]
[FOREACH(enemy, enemyList, "<br>"): "You really hate " + enemy]
[FOREACH(enemy, enemyList, "<br>"): "You really hate " + enemy]
</source>
</syntaxhighlight>


====JSON Array Example====
====JSON Array Example====
Line 28: Line 28:
[h: enemyList = json.append("","Orcs, Goblins, Ogres, Trolls")]
[h: enemyList = json.append("","Orcs, Goblins, Ogres, Trolls")]
[FOREACH (enemy, enemyList, "<br>"): "You really hate " + enemy]
[FOREACH (enemy, enemyList, "<br>"): "You really hate " + enemy]
</source>
</syntaxhighlight>


====JSON Object Example====
====JSON Object Example====
Line 35: Line 35:
[h: enemyList = json.set("","Orcs", "Bob, Dave", "Goblins", "Graham", "Ogres", "Philip, Emanual", "Trolls", "Ig, Og, Ug")]
[h: enemyList = json.set("","Orcs", "Bob, Dave", "Goblins", "Graham", "Ogres", "Philip, Emanual", "Trolls", "Ig, Og, Ug")]
[FOREACH (enemy, enemyList, "<br>"): "You really hate " + enemy]
[FOREACH (enemy, enemyList, "<br>"): "You really hate " + enemy]
</source>
</syntaxhighlight>


All the above will output:
All the above will output:
Line 53: Line 53:
     }
     }
]
]
</source>
</syntaxhighlight>


output:
output:
Line 69: Line 69:
}
}
]
]
</source>
</syntaxhighlight>


output:
output:

Revision as of 16:59, 14 March 2023

FOREACH Option

Introduced: Version 1.3.b46

Iterates over the contents of a string list in the format "item1, item2, item3". Can also be used easily with JSON arrays and JSON objects. String Property Lists can be processed with a couple of extra functions.

Usage

<source lang="mtmacro" line> [FOREACH(var, list): body] [FOREACH(var, list, output_separator): body] [FOREACH(var, list, output_separator, list_separator): body] </syntaxhighlight>

output_separator default value is ","
list_separator default value is ",". Some examples of other useful separators: nothing "", space " " and break "<br>".

Examples

String List Example

<source lang="mtmacro" line> [h: enemyList="Orcs, Goblins, Ogres, Trolls"] [FOREACH(enemy, enemyList, "
"): "You really hate " + enemy] </syntaxhighlight>

JSON Array Example

<source lang="mtmacro" line> [h: enemyList = json.append("","Orcs, Goblins, Ogres, Trolls")] [FOREACH (enemy, enemyList, "
"): "You really hate " + enemy] </syntaxhighlight>

JSON Object Example

(Note that using foreach with a JSON object will result in only the keys being returned as vars). <source lang="mtmacro" line> [h: enemyList = json.set("","Orcs", "Bob, Dave", "Goblins", "Graham", "Ogres", "Philip, Emanual", "Trolls", "Ig, Og, Ug")] [FOREACH (enemy, enemyList, "
"): "You really hate " + enemy] </syntaxhighlight>

All the above will output:

You really hate Orcs
You really hate Goblins
You really hate Ogres
You really hate Trolls

Using with [code():] and output_separator

To use roll options with your FOREACH loop, you will need to use [code():] roll option. In this example I have separated the results with the string " then ". <source lang="mtmacro"> [h: enemyList="Orcs; Goblins; Ogres; Trolls"] [FOREACH(enemy, enemyList, " then ", ";"), CODE:

   {
   [r: enemy]
   }

] </syntaxhighlight>

output:

Orcs then Goblins then Ogres then Trolls

String Property List Example

<source lang="mtmacro" line> [h: enemyStrProp = json.toStrProp(json.set("","Orcs", "Bob, Dave", "Goblins", "Graham", "Ogres", "Philip, Emanual", "Trolls", "Ig, Og, Ug"))] [FOREACH(enemy, enemyStrProp, "
", ";"), code: { [h: enemyList = stringToList(enemy, "=")] [h: name = listGet(enemyList, 0)] [h: value = listDelete(enemyList, 0)] [r: "You really hate " + name + " who are " + value] } ] </syntaxhighlight>

output:

You really hate Orcs who are Bob, Dave
You really hate Goblins who are Graham
You really hate Ogres who are Philip, Emanual
You really hate Trolls who are Ig, Og, Ug

See Also

json.append(), json.set(), [code():], stringToList(), listGet(), listDelete()