getWithState

From RPTools Wiki
Jump to navigationJump to search

getWithState() Function

 Note: This function can only be used in a Trusted Macro

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.