getVisibleTokens: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetVisibleTokens to getVisibleTokens: Converting page titles to lowercase)
m (Text replacement - "source>" to "syntaxhighlight>")
 
(2 intermediate revisions by the same user not shown)
Line 10: Line 10:
<!-- The above 'nbsp' is needed to close the DIV -->
<!-- The above 'nbsp' is needed to close the DIV -->
|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getVisibleTokens()
getVisibleTokens()
</source>
</syntaxhighlight>
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getVisibleTokens(delim)
getVisibleTokens(delim)
</source>
</syntaxhighlight>


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




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


|changes=
|changes=

Latest revision as of 23:59, 14 March 2023

getVisibleTokens() Function

Introduced in version 1.3b49
Returns a string list or JSON Array of token ids 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

getVisibleTokens()
getVisibleTokens(delim)

Examples

[h: tokens = getVisibleTokens()]


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

Version Changes

  • 1.3b51 - No longer a trusted function.