exposeFOW

From RPTools Wiki
Revision as of 15:23, 13 August 2019 by Phergus (talk | contribs)
Jump to navigation Jump to search

exposeFOW() Function

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

Introduced in version 1.3b76
Clears the Fog of War (FOW) for all selected tokens on the current map according to their sight settings. An optional mapName parameter allows exposure on maps other than the current map. Note that unless the optional tokens parameter is provided there must be tokens selected on the map.

Usage

exposeFOW()
exposeFOW(mapname)
exposeFOW(mapName,tokens)
exposeFOW(mapName,tokens, delim)

Parameters

  • mapname - Optional map name.
  • tokens - Optional delimited string list or JSON array of tokens.
  • delim - Delimiter for tokens parameter. Defaults to ",". Use "json" for a JSON array.

Example

<!-- Expose FoW for selected tokens on current map. -->
[h: exposeFOW()]
<!-- Expose FoW for selected tokens on the named map. -->
[h: exposeFOW("Pit of Despair")]
<!-- Expose FoW for indicated tokens on the named map. -->
[h: exposeFOW("Pit of Despair", "Westley, Count Rugen")]
<!-- Expose FoW for indicated tokens, in a list delimited by a colon (":"), on the named map. -->
[h: exposeFOW("Pit of Despair", "Westley:Count Rugen", ":")])]
<!-- Expose FoW for indicated tokens in a JSON array on the named map. -->
[h: exposeFOW("Pit of Despair",'["Westley", "Count Rugen"]', "json")]

| changes=

  • 1.5.4 - Added tokens and delim parameters.