foreach (roll option): Difference between revisions
Jump to navigation
Jump to search
(→Usage) |
m (Tweaking typography and link handling) |
||
| Line 3: | Line 3: | ||
'''Introduced''': Version 1.3.b46 | '''Introduced''': Version 1.3.b46 | ||
Iterates over the contents of a string list in the format " | Iterates over the contents of a string list in the format {{code|"item1, item2, item3"}}. | ||
Can also be used easily with JSON arrays and JSON objects. | Can also be used easily with [[Introduction_to_JSON_Datatypes|JSON arrays and JSON objects]]. | ||
String Property | [[String Property List]]s can be processed with a couple of extra functions. | ||
====Usage==== | ====Usage==== | ||
| Line 15: | Line 15: | ||
{{code|output_separator}} default value is {{code|null}}<br> | {{code|output_separator}} default value is {{code|null}}<br> | ||
{{code|list_separator}} default value is {{code|","}} | {{code|list_separator}} default value is {{code|","}}. Some examples of other useful separators: ''nothing'' {{code|""}}, ''space'' {{code|" "}} and ''break'' {{code|"<br>"}}. | ||
Some examples of other useful | |||
===Examples=== | ===Examples=== | ||
| Line 47: | Line 45: | ||
====Using with [code():] and output_separator==== | ====Using with [code():] and output_separator==== | ||
To use roll options with your FOREACH loop, you will need to use {{ | To use roll options with your {{code|FOREACH}} loop, you will need to use {{roll|code}} roll option. In this example I have separated the results with the string {{code|" then "}}. | ||
<source lang="mtmacro"> | <source lang="mtmacro"> | ||
[h: enemyList="Orcs; Goblins; Ogres; Trolls"] | [h: enemyList="Orcs; Goblins; Ogres; Trolls"] | ||
Revision as of 07:21, 4 October 2012
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
[FOREACH(var, list): body]
[FOREACH(var, list, output_separator): body]
[FOREACH(var, list, output_separator, list_separator): body]output_separator default value is null
list_separator default value is ",". Some examples of other useful separators: nothing "", space " " and break "<br>".
Examples
String List Example
[h: enemyList="Orcs, Goblins, Ogres, Trolls"]
[FOREACH(enemy, enemyList, "<br>"): "You really hate " + enemy]JSON Array Example
[h: enemyList = json.append("","Orcs, Goblins, Ogres, Trolls")]
[FOREACH (enemy, enemyList, "<br>"): "You really hate " + enemy]JSON Object Example
(Note that using foreach with a JSON object will result in only the keys being returned as vars).
[h: enemyList = json.set("","Orcs", "Bob, Dave", "Goblins", "Graham", "Ogres", "Philip, Emanual", "Trolls", "Ig, Og, Ug")]
[FOREACH (enemy, enemyList, "<br>"): "You really hate " + enemy]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 ".
[h: enemyList="Orcs; Goblins; Ogres; Trolls"]
[FOREACH(enemy, enemyList, " then ", ";"), CODE:
{
[r: enemy]
}
]output:
Orcs then Goblins then Ogres then Trolls
String Property List Example
[h: enemyStrProp = json.toStrProp(json.set("","Orcs", "Bob, Dave", "Goblins", "Graham", "Ogres", "Philip, Emanual", "Trolls", "Ig, Og, Ug"))]
[FOREACH(enemy, enemyStrProp, "<br>", ";"), code:
{
[h: enemyList = stringToList(enemy, "=")]
[h: name = listGet(enemyList, 0)]
[h: value = listDelete(enemyList, 0)]
[r: "You really hate " + name + " who are " + value]
}
]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()