getExposedTokens: Difference between revisions

Latest revision as of 17:04, 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.

@@ Line 1: / Line 1: @@
-==Function getExposedTokens==
+{{MacroFunction
-{{TrustedOnlyFunction}}
+|name=getExposedTokens
+|trusted=true
-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 [[Map:fog of war|fog of war]]). The type of the value returned depends on the delimiter parameter.
+|version=1.3b48
+|description=Gets a list containing the ids of all of the [[Token:token|token]]s on the current [[Introduction to Mapping|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 ''"json"'' then a [[Macros:json array|json array]] is returned. '''(as of MapTool 1.3b49)'''
+* If the delimiter ''"json"'' then a [[JSON Array]] is returned.
 * Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in.
+&nbsp;
+|usage=
-===Usage===
+<syntaxhighlight lang="mtmacro" line>
-<source lang="mtmacro" line>
+getExposedTokenNames()
-[h: list = getExposedTokenNames()]
+getExposedTokenNames(delim)
-[h: list = getExposedTokenNames(delim)]
+</syntaxhighlight>
-</source>
 If delim is specified then it is used as the delimiter that separates the [[Token:token|token]] ids.
-===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 [[Map:fog of war|fog of war]].
+The following example will print out the ids of all the [[Token:token|token]]s on the current [[Introduction to Mapping|map]] not covered by [[Fog of War|fog of war]].
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-[h: names = getExposedTokens()]
+[h: ids = getExposedTokens()]
 [r: foreach(id, ids "<br>"): id]
-</source>
+</syntaxhighlight>
+|changes=
+* '''1.3b49''' - Added ''"json"'' delimiter option.
+}}
+[[Category:Find Function]]