getVisibleTokenNames: 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 1: | Line 1: | ||
==Function | ==Function getVisibleTokenNames== | ||
{{TrustedOnlyFunction}} | {{TrustedOnlyFunction}} | ||
| Line 5: | Line 5: | ||
'''Introduced in MapTool 1.3b49''' | '''Introduced in MapTool 1.3b49''' | ||
This function returns a [[Macros:string list|string list]] or [[Macros:json array|json array]] of [[Token:token | This function returns a [[Macros:string list|string list]] or [[Macros:json array|json array]] of [[Token:token]] names 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 ',' 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. | ||
Revision as of 09:51, 24 December 2008
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 int.
Usage
[h: tokens = getVisibleTokens()]
[h: tokens = getVisibleTokens(delim)]
Examples
[h: tokens = getVisibleTokens()]
[h: tokens = getVisibleTokens("json")]