getWithStateNames: Difference between revisions

Latest revision as of 23:59, 20 April 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 json then 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 json delimiter option.

@@ Line 1: / Line 1: @@
-==Function getWithStateNames==
+{{MacroFunction
-{{TrustedOnlyFunction}}
+|name=getWithStateNames
+|trusted=true
+|version=1.3b48
-Gets a list containing the names of all the [[Token:token|token]]s on the current [[Map:map|map]] that have the specified [[Token:state | token state]] set. The type of the value returned depends on the delimiter parameter.
+|description=
-* If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of ',' is used.
+Gets a list containing the names of all the [[Token:token|token]]s on the current [[Introduction to Mapping|map]] that have the specified [[Token:state | token state]] set. The type of the value returned depends on the delimiter parameter.
-* If the delimiter ''"json"'' then a [[Macros:json array|json array]] is returned. '''(as of MapTool 1.3b49)'''
+* If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of {{code|","}} is used.
+* If the delimiter {{code|json}} then a [[JSON Array]] is returned.
 * Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in.
+&nbsp;
-===Usage===
+|usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-[h: ids = getWithStateNames(state)]
+getWithStateNames(state)
-[h: ids = getWithStateNames(state, delim)]
+getWithStateNames(state, delim)
-</source>
+</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 ','.
+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|","}}.
-===Examples===
+|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 [[Introduction to Mapping|map]] with the "Dead" [[Token:state| token state]] set.
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
 [h: names = getWithStateNames("Dead")]
 [foreach(name, names, "<br>"): name]
-</source>
+</syntaxhighlight>
+|changes=
+* '''1.3b49''' - Added {{code|json}} delimiter option.
+}}
+[[Category:Find Function]]
+[[Category:State Function]]