getVisibleTokenNames: Difference between revisions

Latest revision as of 23:59, 14 March 2023

getVisibleTokenNames() Function

• Introduced in version 1.3b49

Returns a string list or JSON Array of Token:token names for the tokens that are visible to the player. 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: tokens = getVisibleTokenNames()]
[h: tokens = getVisibleTokenNames(delim)]

Examples

[h: tokens = getVisibleTokenNames()]

[h: tokens = getVisibleTokenNames("json")]

Version Changes

1.3b51 - No longer a trusted function.

@@ Line 1: / Line 1: @@
-==Function getVisibleTokenNames==
+{{MacroFunction
-{{TrustedOnlyFunction}}
+|name=getVisibleTokenNames
+|version=1.3b49
+|description=
+Returns a [[Macros:string list|string list]] or [[JSON Array]] of [[Token:token]] names for the [[Token:token|token]]s that are ''visible'' to the player. 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 {{code|json}} then a [[JSON Array]] is returned.
+* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in.
+&nbsp;
+<!-- The above 'nbsp' is needed so the DIV is closed -->
+|usage=
+<syntaxhighlight lang="mtmacro" line>
+[h: tokens = getVisibleTokenNames()]
+[h: tokens = getVisibleTokenNames(delim)]
+</syntaxhighlight>
+|examples=
+<syntaxhighlight lang="mtmacro" line>
+[h: tokens = getVisibleTokenNames()]
+</syntaxhighlight>
-'''Introduced in MapTool 1.3b49'''
+<syntaxhighlight lang="mtmacro" line>
+[h: tokens = getVisibleTokenNames("json")]
+</syntaxhighlight>
-This function returns a [[Macros:string list|string list]] or [[Macros:json array|json array]] of [[Token:token]] names for the [[Token:token|token]]s that are ''visible'' to the player. The type of the value returned depends on the delimiter parameter.
+|changes=
-* If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of ',' is used.
+{{change|1.3b51|No longer a trusted function.}}
-* 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 int.
+}}
-===Usage===
+[[Category:Find Function]]
-<source lang="mtmacro" line>
+[[Category:Token Function]]
-[h: tokens = getVisibleTokens()]
-[h: tokens = getVisibleTokens(delim)]
-</source>
-===Examples===
-<source lang="mtmacro" line>
-[h: tokens = getVisibleTokens()]
-</source>
-<source lang="mtmacro" line>
-[h: tokens = getVisibleTokens("json")]
-</source>