getVisibleTokens: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) (Removed trusted.) |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| (8 intermediate revisions by 4 users not shown) | |||
| Line 3: | Line 3: | ||
|version=1.3b49 | |version=1.3b49 | ||
|description= | |description= | ||
Returns a [[Macros:string list|string list]] or [[JSON Array]] of [[Glossary#Token Id|token id]]s for the [[Token:token|token]]s 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 [[Macros:string list|string list]] is returned with the default value of {{code|","}} is used. | * If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of {{code|","}} is used. | ||
* If the delimiter {{code|json}} then a [[ | * If the delimiter {{code|json}} then a [[JSON Array]] is returned. | ||
* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | * Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | ||
| |||
<!-- The above 'nbsp' is needed to close the DIV --> | |||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getVisibleTokens() | getVisibleTokens() | ||
</ | </syntaxhighlight> | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getVisibleTokens(delim) | getVisibleTokens(delim) | ||
</ | </syntaxhighlight> | ||
|examples= | |examples= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: tokens = getVisibleTokens()] | [h: tokens = getVisibleTokens()] | ||
</ | </syntaxhighlight> | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: tokens = getVisibleTokens("json")] | [h: tokens = getVisibleTokens("json")] | ||
</ | </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
jsonthen 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.