exposePCOnlyArea

From RPTools Wiki
Jump to navigation Jump to search

exposePCOnlyArea() Function

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

Introduced in version 1.3b76
Clears Fog of War (FOW) where PC tokens can see and establishes/restores FOW everywhere they cannot. This works the same as the hotkey Meta-Shift-O. Note that the keystroke may be different for locales other than U.S. English. This function is often used in combination with the onTokenMove event.

Usage

exposePCOnlyArea()
exposePCOnlyArea(mapRef)

Parameters

  • mapRef - Optional. Name or ID of the map.

Example

<!-- Expose areas that can be seen by PC tokens on current map. -->
[h: exposePCOnlyArea()]
<!-- Expose areas that can be seen by PC tokens on named map. -->
[h: exposePCOnlyArea("Cliffs of Insanity")]