getExposedTokens: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 2: | Line 2: | ||
{{TrustedOnlyFunction}} | {{TrustedOnlyFunction}} | ||
Gets a | Gets a list containing the ids of all of the [[Token:token|token]]s on the current [[Map:map|map]] that have been exposed, (i.e. not covered by [[Map:fog of war|fog of war]]). 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 ''"json"'' then a [[Macros:json array|json array]] is returned. '''(as of MapTool 1.3b49)''' | |||
* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | |||
===Usage=== | ===Usage=== | ||
Revision as of 14:29, 24 December 2008
Function getExposedTokens
This function can only be called from a trusted macro
Gets a list containing the ids of all of the tokens on the current map that have been exposed, (i.e. not covered by fog of war). 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. (as of MapTool 1.3b49)
- Otherwise a string list is returned with the delimiter passed in.
Usage
[h: list = getExposedTokenNames()]
[h: list = getExposedTokenNames(delim)]If delim is specified then it is used as the delimiter that separates the token ids.
Example
The following example will print out the ids of all the tokens on the current map not covered by fog of war.
[h: names = getExposedTokens()]
[r: foreach(id, ids "<br>"): id]