getVisibleTokenNames: Difference between revisions
Jump to navigation
Jump to search
m (→Usage) |
m (→Examples) |
||
| Line 19: | Line 19: | ||
===Examples=== | ===Examples=== | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: tokens = | [h: tokens = getVisibleTokenNames()] | ||
</source> | </source> | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: tokens = | [h: tokens = getVisibleTokenNames("json")] | ||
</source> | </source> | ||
Revision as of 15:54, 22 February 2009
Function getVisibleTokenNames
This function can only be called from a trusted macro
Introduced in MapTool 1.3b49
This function 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")]