getWithState: Difference between revisions
Jump to navigation
Jump to search
(New page: ==Function getWithState== {{ProposedChange}} {{TrustedOnlyFunction}} Gets a string list containing the ids of all the tokens on the current [[Map:ma...) |
No edit summary |
||
| Line 7: | Line 7: | ||
===Usage=== | ===Usage=== | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: ids = getWithState()] | [h: ids = getWithState(state)] | ||
[h: ids = getWithState(delim)] | [h: ids = getWithState(state, delim)] | ||
</source> | </source> | ||
Revision as of 23:59, 1 December 2008
Function getWithState
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 ids of all the tokens on the current map that have the specified token state set.
Usage
[h: ids = getWithState(state)]
[h: ids = 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 ','.
Examples
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]