getWithStateNames: Difference between revisions
Jump to navigation
Jump to search
(New page: ==Function getWithStateNames== {{ProposedChange}} {{TrustedOnlyFunction}} Gets a string list containing the names of all the tokens on the current [...) |
|||
| Line 1: | Line 1: | ||
==Function getWithStateNames== | ==Function getWithStateNames== | ||
{{TrustedOnlyFunction}} | {{TrustedOnlyFunction}} | ||
Gets a [[Macros:string list|string list]] containing the names of all the [[Token:token|token]]s on the current [[Map:map|map]] that have the specified [[Token:state | token state]] set. | Gets a [[Macros:string list|string list]] containing the names of all the [[Token:token|token]]s on the current [[Map:map|map]] that have the specified [[Token:state | token state]] set. | ||
Revision as of 15:10, 6 December 2008
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]