exposePCOnlyArea: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
| name=exposePCOnlyArea | | name=exposePCOnlyArea | ||
| Line 5: | Line 4: | ||
|trusted=true | |trusted=true | ||
| description= | | description= | ||
Clears Fog of War (FOW) where PC tokens can see and establishes/restores FOW everywhere they cannot. | 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. | This function is often used in combination with the [[onTokenMove]] event. | ||
| usage= | | usage= | ||
<source lang="mtmacro"> | <source lang="mtmacro"> | ||
exposePCOnlyArea() | exposePCOnlyArea() | ||
exposePCOnlyArea(mapname) | |||
</source> | </source> | ||
'''Parameters''' | |||
{{param|mapname|Optional map name }} | |||
<source lang="mtmacro" > | |example= | ||
exposePCOnlyArea( | <source lang="mtmacro" line> | ||
<!-- 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")] | |||
</source> | </source> | ||
}} | }} | ||
[[Category:Miscellaneous Function]] | [[Category:Miscellaneous Function]] | ||
[[Category:FoW]] | [[Category:FoW]] | ||
Revision as of 15:57, 13 August 2019
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")]