State-driven lighting

Resolve complete light and glow recipes from state and topology.

Generated from the reviewed SDK 0.1.0 contract snapshot. Unreviewed workspace changes are not included.

Public exports

Import from @scape/sdk.

GizmoLightingState, gizmoLightingError, resolveGizmoLighting.

Type declarations

These declarations preserve source comments and related types. Import only the public exports listed above; module-relative paths below describe how the package is organized.

import type { GizmoEnvironment } from './travel.js';
import { type ObjectDefinition } from './api.js';
import { type GizmoLight } from './light.js';
import { type GizmoGlow } from './glow.js';
/** Complete lighting for one state. Missing or null effects are off. */
export interface GizmoLightingState {
    light?: GizmoLight | null;
    glow?: GizmoGlow | null;
}
/** Validate every callback result before it reaches a renderer or an accepted action. */
export declare function gizmoLightingError(value: unknown): string | null;
/** Pure state evaluation; clocks and frame animation belong to the host. */
export declare function resolveGizmoLighting(definition: ObjectDefinition, state: unknown, environment?: GizmoEnvironment): GizmoLightingState;

Usage and limits

See Gizmo guides, working examples, and limits for lifecycle, validation and host behavior.

All SDK exports