Skip to content

Scene Control Toggle

The module adds one tool to the Lighting scene-control palette:

PropertyValue
Tool nametokenlightcontrol-enable
TitleToggle Token Light Condition
Iconfa-solid fa-eye-low-vision
Order999 (appended to the end of the lighting tools)
TypeToggle
VisibilityGM only

The button’s active state is bound to the world enable setting, so the toggle persists across reloads and is shared between GM clients on the same world.

  1. Sets the enable setting to true on the world.
  2. Recalculates lighting for every eligible token on the active scene.
  1. Sets the enable setting to false on the world.
  2. Clears all module effects (Dark Lighting, Dim Lighting) from every eligible token on the active scene.
  3. Leaves flags.tokenlightcondition.lightLevel in place on each actor as the last-known value. Movement and light events stop triggering calculations.

The toolbar button only governs whether the calculation pipeline runs at all. It does not affect:

  • Add Token Effects (whether the Dark/Dim active effects are applied when the pipeline does run; the actor flag is still written either way).
  • Show TokenHUD (whether the HUD badge appears; this is a client setting and unaffected by the world toggle).

See Settings for Add Token Effects and Show TokenHUD behavior.

A player client never receives the toolbar button. All lighting calculations run on the GM client only, so disabling the toggle affects all connected clients.