getWithStateNames: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) (Applied Template:MacroFunction) |
|||
| Line 1: | Line 1: | ||
= | {{MacroFunction | ||
|name=getWithStateNames | |||
|trusted=true | |||
|description= | |||
Gets a 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. The type of the value returned depends on the delimiter parameter. | Gets a 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. The type of the value returned depends on the delimiter parameter. | ||
* If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of | * If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of {{code|","}} is used. | ||
* If the delimiter | * If the delimiter {{code|json}} then a [[Macros:json array|json array]] is returned. | ||
* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | * Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | ||
|usage= | |||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: ids = getWithStateNames(state)] | [h: ids = getWithStateNames(state)] | ||
| Line 14: | Line 14: | ||
</source> | </source> | ||
If delim is specified then it is used to separate the values in the list, if it is not specified then it defaults to | If {{code|delim}} is specified then it is used to separate the values in the list, if it is not specified then it defaults to {{code|","}}. | ||
|example= | |||
You can use the following code to print out the names of all of the [[Token:token|token]]s on the current [[Map:map|map]] with the "Dead" [[Token:state| token state]] set. | You can use the following code to print out the names of all of the [[Token:token|token]]s on the current [[Map:map|map]] with the "Dead" [[Token:state| token state]] set. | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
| Line 22: | Line 22: | ||
[foreach(name, names, "<br>"): name] | [foreach(name, names, "<br>"): name] | ||
</source> | </source> | ||
|changes= | |||
* '''1.3b49''' - Added {{code|json}} delimiter option. | |||
}} | |||
[[Category:Token Find Function]] | |||
Revision as of 04:29, 8 March 2009
getWithStateNames() Function
Note: This function can only be used in a Trusted Macro
Gets a list containing the names 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
jsonthen a json array is returned. - Otherwise a string list is returned with the delimiter passed in.
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 ",".
Example
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]
Version Changes
- 1.3b49 - Added
jsondelimiter option.