getVisibleTokenNames

From RPTools Wiki
Revision as of 04:19, 8 March 2009 by Verisimilar (talk | contribs) (Applied Template:MacroFunction)
Jump to navigation Jump to search

getVisibleTokenNames() Function

 Note: This function can only be used in a Trusted Macro

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")]