getExposedTokenNames: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
mNo edit summary
Line 25: Line 25:
* '''1.3b49''' - Added ''"json"'' delimiter option.
* '''1.3b49''' - Added ''"json"'' delimiter option.
}}
}}
[[Category:Token Find Function]]
[[Category:Find Function]]
[[Category:Token Function]]

Revision as of 21:14, 8 March 2009

getExposedTokenNames() Function

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

Gets a list containing the names 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.
  • 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 names.

Example

The following example will print out the names of all the tokens on the current map not covered by fog of war.
[h: names = getExposedTokenNames()]
[r: foreach(name, names, "<br>"): name]


Version Changes

  • 1.3b49 - Added "json" delimiter option.