getVisibleTokenNames: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Correcting JSON Array link.)
mNo edit summary
Line 7: Line 7:
* If the delimiter {{code|json}} then a [[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.
* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in.
 


|usage=
|usage=

Revision as of 23:29, 2 March 2019

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.