getVisibleTokens: Difference between revisions
Jump to navigation
Jump to search
(New page: ==Function getVisibleTokens== {{TrustedOnlyFunction}} '''Introduced in MapTool 1.3b49''' This function returns a Macros:string list or Macros:json array of Token:token id...) |
No edit summary |
||
| Line 8: | Line 8: | ||
* If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of ',' is used. | * If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of ',' is used. | ||
* If the delimiter ''"json"'' then a [[Macros:json array|json array]] is returned. | * If the delimiter ''"json"'' then a [[Macros:json array|json array]] is returned. | ||
* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed | * Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | ||
Revision as of 12:35, 24 December 2008
Function getVisibleTokens
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 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
[h: tokens = getVisibleTokens()]
[h: tokens = getVisibleTokens(delim)]
Examples
[h: tokens = getVisibleTokens()]
[h: tokens = getVisibleTokens("json")]