getWithStateNames: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) mNo edit summary |
No edit summary |
||
| (7 intermediate revisions by 4 users not shown) | |||
| Line 2: | Line 2: | ||
|name=getWithStateNames | |name=getWithStateNames | ||
|trusted=true | |trusted=true | ||
|version=1.3b48 | |||
|description= | |description= | ||
Gets a list containing the names of all the [[Token:token|token]]s on the current [[ | Gets a list containing the names 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 [[ | * If the delimiter {{code|json}} then a [[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= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getWithStateNames(state) | |||
getWithStateNames(state, delim) | |||
</ | </syntaxhighlight> | ||
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|","}}. | 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= | |example= | ||
You can use the following code to print out the names of all of the [[Token:token|token]]s on the current [[ | You can use the following code to print out the names of all of the [[Token:token|token]]s on the current [[Introduction to Mapping|map]] with the "Dead" [[Token:state| token state]] set. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: names = getWithStateNames("Dead")] | [h: names = getWithStateNames("Dead")] | ||
[foreach(name, names, "<br>"): name] | [foreach(name, names, "<br>"): name] | ||
</ | </syntaxhighlight> | ||
|changes= | |changes= | ||
| Line 28: | Line 30: | ||
[[Category:Find Function]] | [[Category:Find Function]] | ||
[[Category:State Function]] | [[Category:State Function]] | ||
Latest revision as of 23:59, 20 April 2023
getWithStateNames() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b48
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
getWithStateNames(state)
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.