getWithStateNames

From RPTools Wiki
Revision as of 00:00, 2 December 2008 by Craig (talk | contribs) (New page: ==Function getWithStateNames== {{ProposedChange}} {{TrustedOnlyFunction}} Gets a string list containing the names of all the tokens on the current [...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Function getWithStateNames

 Note: This refers to a proposed change that has not been implemented in the main code base yet.

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]