getExposedTokens: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "<source" to "<syntaxhighlight") |
No edit summary |
||
| Line 3: | Line 3: | ||
|trusted=true | |trusted=true | ||
|version=1.3b48 | |version=1.3b48 | ||
|description=Gets a list containing the ids of all of the [[Token:token|token]]s on the current [[Map:map|map]] that have been exposed, (i.e. not covered by [[ | |description=Gets a list containing the ids of all of the [[Token:token|token]]s on the current [[Map:map|map]] that have been exposed, (i.e. not covered by [[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 [[JSON Array]] is returned. | * If the delimiter ''"json"'' then a [[JSON Array]] is returned. | ||
| Line 18: | Line 18: | ||
|example= | |example= | ||
The following example will print out the ids of all the [[Token:token|token]]s on the current [[Map:map|map]] not covered by [[ | The following example will print out the ids of all the [[Token:token|token]]s on the current [[Map:map|map]] not covered by [[Fog of War|fog of war]]. | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
[h: ids = getExposedTokens()] | [h: ids = getExposedTokens()] | ||
Revision as of 16:54, 20 April 2023
getExposedTokens() 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 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
getExposedTokenNames()
getExposedTokenNames(delim)If delim is specified then it is used as the delimiter that separates the token ids.
Example
The following example will print out the ids of all the tokens on the current map not covered by fog of war.
[h: ids = getExposedTokens()]
[r: foreach(id, ids "<br>"): id]
Version Changes
- 1.3b49 - Added "json" delimiter option.