getWithState
getWithState() Function
• 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
json then a JSON Array is returned.
- Otherwise a string list is returned with the delimiter passed in.
Usage
getWithState(state)
getWithState(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 ids of all of the tokens on the current map with the "Dead" token state set.
[h: ids = getWithState("Dead")][foreach(id, ids, "<br>"): id]
Version Changes
- 1.3b49 - Added
json delimiter option.
Token: A visual marker representing a character, monster, or NPCTrusted Macro: A macro run from a Library token or run by the GM, that cannot be edited by a player.Macro: A series of text instructions used to automate processes in MapTool.String List: A string containing a list of items in the format "item1, item2, item3,..."Map: An image file displayed in the map display area in MapTool. This image is shared among all connected players and the GM.State: A binary (i.e., it has two possible values, 1 or 0) variable that is set for a given token, frequently used for conditions or statuses that affect a particular character in a game.