exposeFogAtWaypoints: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{MacroFunction |name= exposeFogAtWaypoints |trusted=true |version=1.5.0 |description= Returns a string indicating whether the '''Expose Fog At Waypoints''' option is set in t...") |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
|name= exposeFogAtWaypoints | |name= exposeFogAtWaypoints | ||
|trusted=true | |trusted=true | ||
|version=1. | |version=1.4.1.8 | ||
|description= | |description= | ||
Returns a string indicating whether the '''Expose Fog At Waypoints''' option is set in the MapTool menu. | Returns a string {{code|(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= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
exposeFogAtWaypoints() | exposeFogAtWaypoints() | ||
</ | </syntaxhighlight> | ||
''' | '''Parameters''' | ||
None. | None. | ||
|examples= | |examples= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: empty = exposeFogAtWaypoints()] | [h: empty = exposeFogAtWaypoints()] | ||
</ | </syntaxhighlight> | ||
'''Returns:''' | |||
* Disabled - Option is disabled. | |||
* Enabled - Option is enabled. | |||
|also= | |also= | ||
Latest revision as of 23:59, 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
exposeFogAtWaypoints()Parameters None.
Examples
[h: empty = exposeFogAtWaypoints()]Returns:
- Disabled - Option is disabled.
- Enabled - Option is enabled.