Scene Control Toggle
The button
Section titled “The button”The module adds one tool to the Lighting scene-control palette:
| Property | Value |
|---|---|
| Tool name | tokenlightcontrol-enable |
| Title | Toggle Token Light Condition |
| Icon | fa-solid fa-eye-low-vision |
| Order | 999 (appended to the end of the lighting tools) |
| Type | Toggle |
| Visibility | GM 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.
What flipping it does
Section titled “What flipping it does”Turning on
Section titled “Turning on”- Sets the
enablesetting totrueon the world. - Recalculates lighting for every eligible token on the active scene.
Turning off
Section titled “Turning off”- Sets the
enablesetting tofalseon the world. - Clears all module effects (Dark Lighting, Dim Lighting) from every eligible token on the active scene.
- Leaves
flags.tokenlightcondition.lightLevelin place on each actor as the last-known value. Movement and light events stop triggering calculations.
Relationship to other settings
Section titled “Relationship to other settings”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.
Behaviour when not GM
Section titled “Behaviour when not GM”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.