exposePCOnlyArea: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "<source" to "<syntaxhighlight")
m (Text replacement - "source>" to "syntaxhighlight>")
Line 11: Line 11:
exposePCOnlyArea()
exposePCOnlyArea()
exposePCOnlyArea(mapname)
exposePCOnlyArea(mapname)
</source>
</syntaxhighlight>


'''Parameters'''
'''Parameters'''
Line 22: Line 22:
<!-- Expose areas that can be seen by PC tokens on named map. -->
<!-- Expose areas that can be seen by PC tokens on named map. -->
[h: exposePCOnlyArea("Cliffs of Insanity")]
[h: exposePCOnlyArea("Cliffs of Insanity")]
</source>
</syntaxhighlight>


}}
}}
[[Category:Miscellaneous Function]]
[[Category:Miscellaneous Function]]
[[Category:FoW]]
[[Category:FoW]]

Revision as of 18:13, 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

exposePCOnlyArea()
exposePCOnlyArea(mapname)

Parameters

  • mapname - Optional map name

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")]