getVisibleTokenNames: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "source>" to "syntaxhighlight>")
m (Text replacement - "<source" to "<syntaxhighlight")
 
Line 10: Line 10:
<!-- The above 'nbsp' is needed so the DIV is closed -->
<!-- The above 'nbsp' is needed so the DIV is closed -->
|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: tokens = getVisibleTokenNames()]
[h: tokens = getVisibleTokenNames()]
[h: tokens = getVisibleTokenNames(delim)]
[h: tokens = getVisibleTokenNames(delim)]
Line 16: Line 16:


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


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

Latest revision as of 21:13, 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

[h: tokens = getVisibleTokenNames()]
[h: tokens = getVisibleTokenNames(delim)]

Examples

[h: tokens = getVisibleTokenNames()]
[h: tokens = getVisibleTokenNames("json")]

Version Changes

  • 1.3b51 - No longer a trusted function.