getExposedTokenNames: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Verisimilar (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
= | {{MacroFunction | ||
|name=getExposedTokenNames | |||
|trusted=true | |||
Gets a list containing the names of all of the [[Token:token|token]]s on the current [[Map:map|map]] that have been exposed, (i.e. not covered by [[Map:fog of war|fog of war]]). The type of the value returned depends on the delimiter parameter. | |description=Gets a list containing the names of all of the [[Token:token|token]]s on the current [[Map:map|map]] that have been exposed, (i.e. not covered by [[Map:fog of war|fog of war]]). 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 ',' is used. | * If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of ',' is used. | ||
* If the delimiter ''"json"'' then a [[Macros:json array|json array]] is returned. | * If the delimiter ''"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: list = getExposedTokenNames()] | [h: list = getExposedTokenNames()] | ||
| Line 15: | Line 15: | ||
If delim is specified then it is used as the delimiter that separates the [[Token:token|token]] names. | If delim is specified then it is used as the delimiter that separates the [[Token:token|token]] names. | ||
|example= | |||
The following example will print out the names of all the [[Token:token|token]]s on the current [[Map:map|map]] not covered by [[Map:fog of war|fog of war]]. | The following example will print out the names of all the [[Token:token|token]]s on the current [[Map:map|map]] not covered by [[Map:fog of war|fog of war]]. | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
| Line 21: | Line 21: | ||
[r: foreach(name, names, "<br>"): name] | [r: foreach(name, names, "<br>"): name] | ||
</source> | </source> | ||
|changes= | |||
* '''1.3b49''' - Added ''"json"'' delimiter option. | |||
}} | |||
[[Category:Token Find Function]] | |||
Revision as of 02:56, 7 March 2009
getExposedTokenNames() Function
Note: This function can only be used in a Trusted Macro
Gets a list containing the names of all of the tokens on the current map that have been exposed, (i.e. not covered by fog of war). 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 "json" then a json array is returned.
- Otherwise a string list is returned with the delimiter passed in.
Usage
[h: list = getExposedTokenNames()]
[h: list = getExposedTokenNames(delim)]If delim is specified then it is used as the delimiter that separates the token names.
Example
The following example will print out the names of all the tokens on the current map not covered by fog of war.
[h: names = getExposedTokenNames()]
[r: foreach(name, names, "<br>"): name]
Version Changes
- 1.3b49 - Added "json" delimiter option.