getWithStateNames

Function getWithStateNames

This function can only be called from a trusted macro

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. (as of MapTool 1.3b49)
• Otherwise a string list is returned with the delimiter passed in.

Usage

[h: ids = getWithStateNames(state)]
[h: ids = 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 ','.

Examples

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]