getVisibleTokenNames: Difference between revisions

Revision as of 22:03, 4 April 2009

getVisibleTokenNames() Function

• Introduced in version 1.3b49

This function 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 3: / Line 3: @@
 |version=1.3b49
 |description=
-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.
+This function 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 [[Macros:json array|json array]] is returned.
+* 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.