getWithStateNames: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page GetWithStateNames to getWithStateNames: Converting page titles to lowercase) |
No edit summary |
||
| Line 11: | Line 11: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getWithStateNames(state) | getWithStateNames(state) | ||
getWithStateNames(state, delim) | getWithStateNames(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 20: | Line 20: | ||
|example= | |example= | ||
You can use the following code to print out the names of all of the [[Token:token|token]]s on the current [[Map:map|map]] with the "Dead" [[Token:state| token state]] set. | You can use the following code to print out the names of all of the [[Token:token|token]]s on the current [[Map:map|map]] with the "Dead" [[Token:state| token state]] set. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: names = getWithStateNames("Dead")] | [h: names = getWithStateNames("Dead")] | ||
[foreach(name, names, "<br>"): name] | [foreach(name, names, "<br>"): name] | ||
</ | </syntaxhighlight> | ||
|changes= | |changes= | ||
Revision as of 15:59, 15 March 2023
getWithStateNames() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b48
Gets a list containing the names 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
getWithStateNames(state)
getWithStateNames(state, delim)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 names of all of the tokens on the current map with the "Dead" token state set.
[h: names = getWithStateNames("Dead")]
[foreach(name, names, "<br>"): name]
Version Changes
- 1.3b49 - Added
jsondelimiter option.