exposeFOW: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
| name=exposeFOW | | name=exposeFOW | ||
| version=1.3b76 | | version=1.3b76 | ||
|trusted=true | |trusted=true | ||
| description= | | description= | ||
Clears the Fog of War (FOW) for all selected tokens according to their sight settings. | Clears the Fog of War (FOW) for all '''selected''' tokens on the current map according to their sight settings. An optional map name parameter allows exposure on maps other than the current one. ''Note that tokens must be selected on that map on the client executing the macro.'' | ||
| usage= | | usage= | ||
<source lang="mtmacro" | <source lang="mtmacro"> | ||
exposeFOW() | exposeFOW() | ||
exposeFOW(mapname) | |||
</source> | </source> | ||
'''Parameters''' | '''Parameters''' | ||
{{param| | {{param|mapname|Optional map name.}} | ||
| example= | |||
<source lang="mtmacro" line> | |||
<!-- Expose FoW for selected tokens on current map. --> | |||
[h: exposeFOW()] | |||
<!-- Expose FoW for selected tokens on the named map. --> | |||
[h: exposeFOW("Pit of Despair")] | |||
</source> | |||
}} | }} | ||
[[Category:Miscellaneous Function]] [[Category:FoW]] | [[Category:Miscellaneous Function]] [[Category:FoW]] | ||
Revision as of 12:52, 1 August 2019
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 map name parameter allows exposure on maps other than the current one. Note that tokens must be selected on that map on the client executing the macro.
Usage
exposeFOW()
exposeFOW(mapname)Parameters
mapname- Optional map name.
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")]