exposeFogAtWaypoints

From RPTools Wiki
Jump to navigationJump to search

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.

See Also