getVisibleTokenNames: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
(Removed trusted.)
Line 1: Line 1:
{{MacroFunction
{{MacroFunction
|name=getVisibleTokenNames
|name=getVisibleTokenNames
|trusted=true
|version=1.3b49
|version=1.3b49
|description=
|description=
Line 23: Line 22:
[h: tokens = getVisibleTokenNames("json")]
[h: tokens = getVisibleTokenNames("json")]
</source>
</source>
|changes=
{{change|1.3b51|No longer a trusted function.}}
}}
}}
[[Category:Find Function]]
[[Category:Find Function]]
[[Category:Token Function]]
[[Category:Token Function]]

Revision as of 21:49, 22 March 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.