getExposedTokenNames

From RPTools Wiki
Revision as of 08:02, 28 October 2014 by Wolph42 (talk | contribs)
Jump to navigation Jump to search

getExposedTokenNames() Function

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

Introduced in version 1.3b48
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

getExposedTokenNames()
getExposedTokenNames(delim)

If delim is specified then it is used as the delimiter that separates the token names.

Example

This is exactly the same example as the one above, but then nested, so you can have the result in one line of code.
[h:tokExposed	= json.intersection(getTokenNames("json",'{layer:["TOKEN"]}'), getExposedTokenNames("json"))]


Version Changes

  • 1.3b49 - Added "json" delimiter option.
  • 1.3b91 - Apparently now tokens from ALL layers are returned, instead of TOKEN LAYER only. Added example to correct this.