getWithState: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page GetWithState to getWithState: Converting page titles to lowercase) |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| Line 14: | Line 14: | ||
getWithState(state) | getWithState(state) | ||
getWithState(state, delim) | getWithState(state, delim) | ||
</ | </syntaxhighlight> | ||
If {{code|delim}} is specified then it is used to separate the values in the list, if it is not specified then it defaults to {{code|","}}. | If {{code|delim}} is specified then it is used to separate the values in the list, if it is not specified then it defaults to {{code|","}}. | ||
| Line 23: | Line 23: | ||
[h: ids = getWithState("Dead")] | [h: ids = getWithState("Dead")] | ||
[foreach(id, ids, "<br>"): id] | [foreach(id, ids, "<br>"): id] | ||
</ | </syntaxhighlight> | ||
|changes= | |changes= | ||
Revision as of 20:55, 14 March 2023
getWithState() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b48
Gets a list containing the ids of all the tokens on the current map that have the specified token state set. The type of the value returned depends on the delimiter parameter.
- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
Usage
<source lang="mtmacro" line> getWithState(state) getWithState(state, delim) </syntaxhighlight>
If delim is specified then it is used to separate the values in the list, if it is not specified then it defaults to ",".
Example
You can use the following code to print out the ids of all of the tokens on the current map with the "Dead" token state set.
<source lang="mtmacro" line>
[h: ids = getWithState("Dead")]
[foreach(id, ids, "
"): id]
Version Changes
- 1.3b49 - Added
jsondelimiter option.