exposePCOnlyArea: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page ExposePCOnlyArea to exposePCOnlyArea: Converting page titles to lowercase)
m (Text replacement - "<source" to "<syntaxhighlight")
Line 8: Line 8:
This function is often used in combination with the [[onTokenMove]] event.
This function is often used in combination with the [[onTokenMove]] event.
| usage=
| usage=
<source lang="mtmacro">
<syntaxhighlight lang="mtmacro">
exposePCOnlyArea()
exposePCOnlyArea()
exposePCOnlyArea(mapname)
exposePCOnlyArea(mapname)
Line 17: Line 17:


|example=
|example=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
<!-- Expose areas that can be seen by PC tokens on current map. -->
<!-- Expose areas that can be seen by PC tokens on current map. -->
[h: exposePCOnlyArea()]
[h: exposePCOnlyArea()]

Revision as of 17:18, 14 March 2023

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

<syntaxhighlight lang="mtmacro"> exposePCOnlyArea() exposePCOnlyArea(mapname) </source>

Parameters

  • mapname - Optional map name

Example

<syntaxhighlight lang="mtmacro" line>

[h: exposePCOnlyArea()] [h: exposePCOnlyArea("Cliffs of Insanity")]

</source>