getWithState: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "source>" to "syntaxhighlight>") |
No edit summary |
||
| Line 4: | Line 4: | ||
|version=1.3b48 | |version=1.3b48 | ||
|description= | |description= | ||
Gets a list containing the ids of all the [[Token:token|token]]s on the current [[ | Gets a list containing the ids of all the [[Token:token|token]]s on the current [[Introduction to Mapping|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 {{code|","}} is used. | * 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 {{code|json}} then a [[JSON Array]] is returned. | * If the delimiter {{code|json}} then a [[JSON Array]] is returned. | ||
| Line 19: | Line 19: | ||
|example= | |example= | ||
You can use the following code to print out the ids of all of the [[Token:token|token]]s on the current [[ | You can use the following code to print out the ids of all of the [[Token:token|token]]s on the current [[Introduction to Mapping|map]] with the "Dead" [[Token:state| token state]] set. | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: ids = getWithState("Dead")] | [h: ids = getWithState("Dead")] | ||
Revision as of 17:07, 20 April 2023
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
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
Usage
<source lang="mtmacro" line> getWithState(state) getWithState(state, delim) </syntaxhighlight>
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.
<source lang="mtmacro" line>
[h: ids = getWithState("Dead")]
[foreach(id, ids, "
"): id]
Version Changes
- 1.3b49 - Added
jsondelimiter option.