# `StageSettings.lights`

> Contract 2.0.0 · package sha256 `a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e` · generated from `configurator-runtime.d.ts` by `services/onsite-scripter/scripts/build-contract-docs.mjs`; edit the source, not this file.

Property of [`StageSettings`](StageSettings.md) · stable · since 2.0.0 · called as `session.document.stage.lights`

```ts
lights?: 'default' | 'none' | {
  intensity: number;
};
```

The runtime's own rig: 'default', 'none' (the rig is off; a collection's light items still
shine), or scaled. The 'default' rig is 1.x's seeded rig, value for value
(viewer/controllers/scene.controller.ts:264-306 at eb5ce2afe), in [`LightSpec`](LightSpec.md)'s units: an
ambient (a `sky` with `sky` and [`ground`](StageSettings.ground.md) '#ffffff', intensity 0.3); a casting key, a `sun`
travelling (0.2, −5.9, −0.4) at intensity 0.3; and two `sun` fills travelling (0, −0.5, −1) and
(1.5, −0.5, −1) at intensity 1, all in world space. A golden pins it (spec section 9.6), so an
app that turns it off can restate the lights it keeps. While a light item casts the shadow
([`LightSpec`](LightSpec.md)), the key lights without one; `{ intensity }` scales all four.

**Default:** the document's, else 'default'

## Generic-API test (spec 3.1)

| Rule | Result |
| --- | --- |
| 1. Neutral name | pass: `lights` names no product |
| 2. A precedent | pass: [Babylon.js ImageProcessingConfiguration.exposure](https://github.com/BabylonJS/Babylon.js/blob/master/packages/dev/core/src/Materials/imageProcessingConfiguration.ts) (row `E6`); [Unity RenderSettings.ambientIntensity](https://docs.unity3d.com/ScriptReference/RenderSettings-ambientIntensity.html) (row `E6`); [Unity RenderSettings](https://docs.unity3d.com/ScriptReference/RenderSettings.html) (row `K28`) |
| 3. Two apps, or labs | pass: 28 apps (ledger: app-378d190f1b, app-4f16d2f6da, app-510d750508, app-59c5b5751e, app-b362a81c85, app-ceb4eccc72, app-fc07850558, app-fc306ec3dc; fleet cross-check: app-04c2774145, app-0c773a4ee3, app-37356bf09f, app-378d190f1b, app-4762caacdc, app-4f16d2f6da, app-4fd23bc869, app-510d750508 and 20 more) |
| 4. The cheaper fix first | decided per need in Appendix B: rows `E6`, `K28`, `K30` at tier stable (a member only where no rule, data, asset or app code serves the need) |