getVisibleTokenNames: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetVisibleTokenNames to getVisibleTokenNames: Converting page titles to lowercase)
m (Text replacement - "source>" to "syntaxhighlight>")
Line 13: Line 13:
[h: tokens = getVisibleTokenNames()]
[h: tokens = getVisibleTokenNames()]
[h: tokens = getVisibleTokenNames(delim)]
[h: tokens = getVisibleTokenNames(delim)]
</source>
</syntaxhighlight>


|examples=
|examples=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: tokens = getVisibleTokenNames()]
[h: tokens = getVisibleTokenNames()]
</source>
</syntaxhighlight>


<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: tokens = getVisibleTokenNames("json")]
[h: tokens = getVisibleTokenNames("json")]
</source>
</syntaxhighlight>


|changes=
|changes=

Revision as of 20:57, 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

<source lang="mtmacro" line> [h: tokens = getVisibleTokenNames()] [h: tokens = getVisibleTokenNames(delim)] </syntaxhighlight>

Examples

<source lang="mtmacro" line>

[h: tokens = getVisibleTokenNames()] </syntaxhighlight>

<source lang="mtmacro" line> [h: tokens = getVisibleTokenNames("json")]

</syntaxhighlight>

Version Changes

  • 1.3b51 - No longer a trusted function.