StageSettings.ground ​

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 · stable · since 2.0.0 · called as session.document.stage.ground

ts
ground?: 'shadow' | 'none' | {
  shadow: {
    opacity?: number;
    sizeM?: number;
    y?: number;
    on?: Query;
  };
};

on: draw the ground's shadow on these parts (a floor). 'none' hides the runtime's ground and its shadow only, in a page document as in a layer: a shown light item that asks for a shadow (LightSpec.shadow) still casts it onto your floor items.

Default: the document's, else 'shadow'

Generic-API test (spec 3.1) ​

Rule Result
1. Neutral name pass: ground names no product
2. A precedent pass: glTF 2.0 metallic-roughness material (row K10); glTF KHR_materials_sheen (row K10); glTF KHR_materials_transmission (row K10); glTF KHR_materials_unlit (row K10); Unity Light.shadows (row K27); Babylon.js ShadowGenerator (row K27); and 1 more in coverage.json
3. Two apps, or labs pass: 28 apps (ledger: app-04c2774145, app-0c773a4ee3, app-37356bf09f, app-378d190f1b, app-4762caacdc, app-4f16d2f6da, app-4fd23bc869, app-510d750508 and 20 more; 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 K10, K27, K28 at tier stable (a member only where no rule, data, asset or app code serves the need)