exposeFogAtWaypoints: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page ExposeFogAtWaypoints to exposeFogAtWaypoints: Converting page titles to lowercase) |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| Line 11: | Line 11: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
exposeFogAtWaypoints() | exposeFogAtWaypoints() | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
None. | None. | ||
| Line 18: | Line 18: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: empty = exposeFogAtWaypoints()] | [h: empty = exposeFogAtWaypoints()] | ||
</ | </syntaxhighlight> | ||
'''Returns:''' | '''Returns:''' | ||
Revision as of 17:05, 14 March 2023
exposeFogAtWaypoints() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.4.1.8
Returns a string
(Enabled/Disabled) indicating whether the Expose Fog At Waypoints option is set in the MapTool Map menu. This menu option toggles the setting for the currently displayed map.
This setting affects when automatic exposure of Fog of War (FoW) will be performed after a token has been moved. With it enabled, FoW will only be exposed at any waypoints set by the user along the tokens path plus the stopping point. If not enabled, FoW will be exposed from every cell along the token's path.Usage
<source lang="mtmacro" line> exposeFogAtWaypoints() </syntaxhighlight> Parameters None.
Examples
<source lang="mtmacro" line>
[h: empty = exposeFogAtWaypoints()] </syntaxhighlight>
Returns:
- Disabled - Option is disabled.
- Enabled - Option is enabled.