getVisibleTokens: Difference between revisions
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") |
||
Line 10: | Line 10: | ||
<!-- The above 'nbsp' is needed to close the DIV --> | <!-- The above 'nbsp' is needed to close the DIV --> | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getVisibleTokens() | getVisibleTokens() | ||
</source> | </source> | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getVisibleTokens(delim) | getVisibleTokens(delim) | ||
</source> | </source> | ||
|examples= | |examples= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: tokens = getVisibleTokens()] | [h: tokens = getVisibleTokens()] | ||
</source> | </source> | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: tokens = getVisibleTokens("json")] | [h: tokens = getVisibleTokens("json")] | ||
</source> | </source> |
Revision as of 20:48, 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
<syntaxhighlight lang="mtmacro" line> getVisibleTokens() </source> <syntaxhighlight lang="mtmacro" line> getVisibleTokens(delim) </source>
Examples
<syntaxhighlight lang="mtmacro" line>
[h: tokens = getVisibleTokens()] </source>
<syntaxhighlight lang="mtmacro" line>
[h: tokens = getVisibleTokens("json")]
Version Changes
- 1.3b51 - No longer a trusted function.