getWithStateNames

From RPTools Wiki
Jump to navigation Jump to search

Function getWithStateNames

This function can only be called from a trusted macro


Gets a string list containing the names of all the tokens on the current map that have the specified token state set.

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]
Retrieved from "https://wiki.rptools.info/index.php?title=getWithStateNames&oldid=285"