getVisibleTokens: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
(Applied Template:MacroFunction)
Line 1: Line 1:
==Function getVisibleTokens==
{{MacroFunction
{{TrustedOnlyFunction}}
|name=getVisibleTokens
 
|trusted=true
 
|version=1.3b49
'''Introduced in MapTool 1.3b49'''
|description=
 
This function returns a [[Macros:string list|string list]] or [[Macros:json array|json array]] of [[Token: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.
This function returns a [[Macros:string list|string list]] or [[Macros:json array|json array]] of [[Token: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 ',' 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 ''"json"'' then a [[Macros:json array|json array]] is returned.
* If the delimiter {{code|json}} then a [[Macros:json array|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.


 
|usage=
===Usage===
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: tokens = getVisibleTokens()]
[h: tokens = getVisibleTokens()]
Line 17: Line 15:
</source>
</source>


 
|examples=
===Examples===
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: tokens = getVisibleTokens()]
[h: tokens = getVisibleTokens()]
Line 27: Line 24:
[h: tokens = getVisibleTokens("json")]
[h: tokens = getVisibleTokens("json")]
</source>
</source>
}}
[[Category:Token Find Function]]

Revision as of 04:22, 8 March 2009

getVisibleTokens() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 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")]