getVisibleTokens: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Removed trusted.)
m (Correcting JSON Array link.)
Line 3: Line 3:
|version=1.3b49
|version=1.3b49
|description=
|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 [[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 {{code|","}} 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 {{code|json}} then a [[Macros:json array|json array]] is returned.
* If the delimiter {{code|json}} then a [[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.



Revision as of 22:03, 4 April 2009

getVisibleTokens() Function

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

getVisibleTokens()
getVisibleTokens(delim)

Examples

[h: tokens = getVisibleTokens()]


[h: tokens = getVisibleTokens("json")]

Version Changes

  • 1.3b51 - No longer a trusted function.