@relu-interactives/spatial-ecs 0.8.0 → 0.10.0

package/dist/{System-DPMAW30g.d.ts → System-CADhPyQs.d.ts}

@@ -127,6 +127,106 @@ declare class SlotChooser {
     choose(id: string, slot: SoundSlot, now: number): SoundTake | null;
 }
 
+/**
+ * The volume groups every sound plays through: each sound's output goes to its
+ * bus instead of straight to the listener, so a game can turn music down
+ * without touching a single sound, and music dips while a voice plays.
+ */
+declare class AudioMixer {
+    readonly listener: THREE.AudioListener;
+    private readonly buses;
+    private readonly volumes;
+    private readonly routed;
+    constructor(listener: THREE.AudioListener);
+    /** The node a sound connects to for this bus. */
+    input(bus: AudioBus): GainNode;
+    /** Send a three.js sound through a bus. Does nothing when it's already there. */
+    route(sound: THREE.Audio<GainNode> | THREE.PositionalAudio, bus: AudioBus): void;
+    setVolume(bus: AudioBus, volume: number): void;
+    getVolume(bus: AudioBus): number;
+    /** Dip the music for `seconds`, then bring it back. A later duck replaces this one. */
+    duckMusic(seconds: number): void;
+    dispose(): void;
+}
+
+/** Options for {@link AudioSystem.playSlot}. */
+type PlaySlotOptions = {
+    /** Multiplies the slot's volume. */
+    volume?: number;
+    /** Play from this point in the world instead of everywhere. */
+    position?: {
+        x: number;
+        y: number;
+        z: number;
+    };
+};
+/**
+ * Reconciles `AudioComponent` state with the underlying THREE.js audio objects
+ * each frame.
+ *
+ * **Playback** — drives `play()`, `pause()`, and `stop()` on the THREE.js
+ * audio node based on the `isPlaying` / `isPaused` flags set by
+ * `AudioComponent.play()`, `.pause()`, and `.stop()`.
+ *
+ * **Option sync** — detects changes to `loop`, `pitch`, `volume`,
+ * `refDistance`, `distanceModel`, and `rolloffFactor` and applies them live.
+ * Changes take effect on the next frame, so scripts and inspector edits during
+ * runtime are reflected without reloading the scene.
+ *
+ * **Mixing** — every sound plays through a bus (`sfx`, `voice`, `music`) with
+ * its own volume, and music dips while a voice plays.
+ *
+ * **Sound banks** — {@link loadSoundBank} and {@link playSlot} play named
+ * sounds from a `.soundbank.json` asset, as a random take.
+ *
+ * Only active in **preview** mode (`isEditor: true` makes every update a
+ * no-op so the editor is unaffected).
+ *
+ * @category Systems
+ */
+declare class AudioSystem implements EcsSystem {
+    private readonly isEditor;
+    /** THREE.js `isPlaying` state captured at the end of the previous frame. */
+    private readonly prevPlayingState;
+    /** Snapshot of options applied in the previous frame, for change detection. */
+    private readonly prevOptions;
+    /** Tracks entities that were stopped due to invisibility. */
+    private readonly stoppedDueToInvisibility;
+    private world;
+    private mixer;
+    private readonly slots;
+    private readonly buffers;
+    private readonly chooser;
+    private voice;
+    constructor({ isEditor }?: {
+        isEditor?: boolean;
+    });
+    /** Scripts can load a bank in `init`, before this system's first update. */
+    attachWorld(world: World): void;
+    /** The mixer, made with the listener on first use. */
+    getMixer(): AudioMixer | null;
+    /** Set a bus's volume (`0` silent, `1` as mixed). */
+    setBusVolume(bus: AudioBus, volume: number): void;
+    getBusVolume(bus: AudioBus): number;
+    /**
+     * Fetch a `.soundbank.json` and decode its recordings. Its slots add to any
+     * loaded before, and a slot id used twice takes the later one.
+     * @param source an asset path, or a script's `AssetInput` field
+     */
+    loadSoundBank(source: string | {
+        path: string;
+    }): Promise<void>;
+    /**
+     * Play a named sound from a loaded bank. Returns whether it sounded: a slot's
+     * chance, cooldown and priority can each keep it quiet, and that's normal.
+     */
+    playSlot(id: string, options?: PlaySlotOptions): boolean;
+    update(world: World, _deltaTime: number): void;
+    /** Apply any changed options from the component to the THREE.js audio node. */
+    private _syncOptions;
+    dispose(_world: World): void;
+}
+
 /** Skybox rendering modes. `none` disables skybox rendering entirely. */
 type EnvironmentSkyboxType = "gradient" | "color" | "image" | "none";
 /** Gradient distribution applied when {@link EnvironmentSkyboxState.type} is `"gradient"`. */
@@ -687,6 +787,67 @@ type NetEntityView = {
     props: Record<string, string>;
 };
 type NetPose = Pick<NetEntityView, "x" | "y" | "z" | "qx" | "qy" | "qz" | "qw">;
+/** A sound-bank slot one player plays for everyone. */
+type NetSound = {
+    id: string;
+    volume?: number;
+    x?: number;
+    y?: number;
+    z?: number;
+};
+/** What sets up a direct voice connection between two players. */
+type VoiceSignal = {
+    kind: "offer" | "answer";
+    sdp: string;
+} | {
+    kind: "ice";
+    candidate: RTCIceCandidateInit;
+};
+type VoiceToRoom = {
+    t: "hello";
+} | {
+    t: "join";
+} | {
+    t: "leave";
+} | {
+    t: "mic";
+    on: boolean;
+} | {
+    t: "signal";
+    to: string;
+    signal: VoiceSignal;
+};
+type VoiceFromRoom = {
+    t: "caps";
+    available: boolean;
+    maxPeers: number;
+} | {
+    t: "welcome";
+    peers: {
+        id: string;
+        mic: boolean;
+    }[];
+    iceServers: RTCIceServer[];
+    /** Send through the relay only, so players never see each other's addresses. */
+    relayOnly: boolean;
+} | {
+    t: "refused";
+    reason: "off" | "full";
+} | {
+    t: "joined";
+    id: string;
+} | {
+    t: "left";
+    id: string;
+} | {
+    t: "mic";
+    id: string;
+    on: boolean;
+} | {
+    t: "signal";
+    from: string;
+    signal: VoiceSignal;
+};
 /** What a shared-world connection must do. `ColyseusTransport` is the real one. */
 interface NetworkTransport {
     readonly sessionId: string;
@@ -702,6 +863,9 @@ interface NetworkTransport {
     onMessage(cb: (name: string, payload: unknown, from: string) => void): void;
     /** The server overruled the owner's pose. */
     onCorrect(cb: (id: string, pose: NetPose) => void): void;
+    /** Another player played a sound for everyone. */
+    onSound(cb: (sound: NetSound, from: string) => void): void;
+    onVoice(cb: (message: VoiceFromRoom) => void): void;
     onClose(cb: () => void): void;
     /** Tell the room about the scene's shared objects; the first client's copy wins. */
     registerScene(entities: (NetPose & {
@@ -716,6 +880,8 @@ interface NetworkTransport {
     sendPose(id: string, pose: NetPose): void;
     setProp(id: string, key: string, json: string): void;
     send(name: string, payload: unknown): void;
+    sendSound(sound: NetSound): void;
+    sendVoice(message: VoiceToRoom): void;
     leave(): void;
 }
 /** Options for {@link NetworkHandle.spawn}. */
@@ -733,6 +899,42 @@ type NetSpawnOptions = {
     };
     props?: Record<string, NetValue>;
 };
+/** Someone else in voice chat. */
+interface VoicePeer {
+    readonly id: string;
+    /** The direct connection is up. */
+    readonly connected: boolean;
+    readonly talking: boolean;
+    /** They haven't muted their own mic. */
+    readonly micOn: boolean;
+    /** This player muted them. */
+    readonly muted: boolean;
+    readonly volume: number;
+}
+/** Voice chat: `this.network.voice`, `null` when the project doesn't have it on. */
+interface VoiceHandle {
+    /** The room offers voice and this page can use a mic. */
+    readonly available: boolean;
+    readonly state: "off" | "connecting" | "on";
+    readonly micMuted: boolean;
+    /** This player is talking right now. */
+    readonly talking: boolean;
+    /** Why the last attempt failed, in words for the player. */
+    readonly error: string;
+    readonly peers: VoicePeer[];
+    /** Hear each voice from its character, when there is one. On by default. */
+    positional: boolean;
+    /** Turn voice on. Call from a tap or key: that's what lets the browser ask for the mic. */
+    enable(): Promise<boolean>;
+    disable(): void;
+    setMicMuted(muted: boolean): Promise<void>;
+    /** Stop hearing someone. They aren't told. */
+    setPeerMuted(id: string, muted: boolean): void;
+    /** 0 to 2. */
+    setPeerVolume(id: string, volume: number): void;
+    /** Something above changed. Returns the way to stop listening. */
+    onChange(listener: () => void): () => void;
+}
 /** A Behaviour's view of the shared world: `this.network`, `null` in a single-player run. */
 interface NetworkHandle {
     readonly connected: boolean;
@@ -744,10 +946,17 @@ interface NetworkHandle {
     readonly isOwner: boolean;
     /** Everyone in the room, by session id. */
     readonly players: string[];
+    /** Voice chat, when the project has it on. */
+    readonly voice: VoiceHandle | null;
     /** Send to the room. Others hear it in `onMessage`, unless a server hook keeps it. */
     send(name: string, payload?: unknown): void;
     /** Listen for a message. Returns the way to stop. */
     onMessage(name: string, handler: (payload: unknown, from: string) => void): () => void;
+    /**
+     * Play a sound-bank slot here and for everyone in the room. Returns whether it
+     * sounded: a slot's chance and cooldown can keep it quiet, and then no one hears it.
+     */
+    playSlot(id: string, options?: PlaySlotOptions): boolean;
     /** Spawn a prefab everyone sees, owned by this client. */
     spawn(prefab: string | {
         path: string;
@@ -1402,84 +1611,6 @@ declare class TransformSyncSystem implements EcsSystem {
     update(world: World): void;
 }
 
-/** Options for {@link AudioSystem.playSlot}. */
-type PlaySlotOptions = {
-    /** Multiplies the slot's volume. */
-    volume?: number;
-    /** Play from this point in the world instead of everywhere. */
-    position?: {
-        x: number;
-        y: number;
-        z: number;
-    };
-};
-/**
- * Reconciles `AudioComponent` state with the underlying THREE.js audio objects
- * each frame.
- *
- * **Playback** — drives `play()`, `pause()`, and `stop()` on the THREE.js
- * audio node based on the `isPlaying` / `isPaused` flags set by
- * `AudioComponent.play()`, `.pause()`, and `.stop()`.
- *
- * **Option sync** — detects changes to `loop`, `pitch`, `volume`,
- * `refDistance`, `distanceModel`, and `rolloffFactor` and applies them live.
- * Changes take effect on the next frame, so scripts and inspector edits during
- * runtime are reflected without reloading the scene.
- *
- * **Mixing** — every sound plays through a bus (`sfx`, `voice`, `music`) with
- * its own volume, and music dips while a voice plays.
- *
- * **Sound banks** — {@link loadSoundBank} and {@link playSlot} play named
- * sounds from a `.soundbank.json` asset, as a random take.
- *
- * Only active in **preview** mode (`isEditor: true` makes every update a
- * no-op so the editor is unaffected).
- *
- * @category Systems
- */
-declare class AudioSystem implements EcsSystem {
-    private readonly isEditor;
-    /** THREE.js `isPlaying` state captured at the end of the previous frame. */
-    private readonly prevPlayingState;
-    /** Snapshot of options applied in the previous frame, for change detection. */
-    private readonly prevOptions;
-    /** Tracks entities that were stopped due to invisibility. */
-    private readonly stoppedDueToInvisibility;
-    private world;
-    private mixer;
-    private readonly slots;
-    private readonly buffers;
-    private readonly chooser;
-    private voice;
-    constructor({ isEditor }?: {
-        isEditor?: boolean;
-    });
-    /** Scripts can load a bank in `init`, before this system's first update. */
-    attachWorld(world: World): void;
-    /** The mixer, made with the listener on first use. */
-    private getMixer;
-    /** Set a bus's volume (`0` silent, `1` as mixed). */
-    setBusVolume(bus: AudioBus, volume: number): void;
-    getBusVolume(bus: AudioBus): number;
-    /**
-     * Fetch a `.soundbank.json` and decode its recordings. Its slots add to any
-     * loaded before, and a slot id used twice takes the later one.
-     * @param source an asset path, or a script's `AssetInput` field
-     */
-    loadSoundBank(source: string | {
-        path: string;
-    }): Promise<void>;
-    /**
-     * Play a named sound from a loaded bank. Returns whether it sounded: a slot's
-     * chance, cooldown and priority can each keep it quiet, and that's normal.
-     */
-    playSlot(id: string, options?: PlaySlotOptions): boolean;
-    update(world: World, _deltaTime: number): void;
-    /** Apply any changed options from the component to the THREE.js audio node. */
-    private _syncOptions;
-    dispose(_world: World): void;
-}
-
 /**
  * Runs each {@link IKComponent}'s chains after the animation: hands and feet
  * reach their target entities. Bones the animation doesn't drive would keep
@@ -1490,8 +1621,10 @@ declare class AudioSystem implements EcsSystem {
  */
 declare class IKSystem implements EcsSystem {
     private readonly runtimes;
-    private readonly reach;
-    /** How far a limb's end stayed from its target last frame, in metres (0 = reached). */
+    /**
+     * How far a limb's end stayed from its target last frame, in metres
+     * (0 = reached), or null if the limb's chain didn't run.
+     */
     getReachError(entityId: EntityId, limb: IKLimb): number | null;
     private restore;
     update(world: World): void;
@@ -1880,4 +2013,4 @@ interface EcsSystem {
     dispose?(world: World): void;
 }
 
-export { type EcsEntityKind as $, type TransformData as A, normalizeEnvironmentLighting as B, type ChromaKeyOptions as C, DEFAULT_ENVIRONMENT_LIGHTING as D, type EcsRenderer as E, normalizeIKChain as F, type NetworkTransport as G, type NetEntityView as H, type IKChain as I, type NetPose as J, type EcsSystem as K, type NetworkService as L, type EntityId as M, type NetValue as N, type NetworkHandle as O, type PostprocessingPipeline as P, type NetSpawnOptions as Q, type RenderBackend as R, type WorldEntityView$1 as S, TransformComponent as T, type SpawnPrefabSource as U, type Vec3$1 as V, World as W, type SpawnPrefabOptions as X, type PlaySlotOptions as Y, type ComponentClass as Z, type ParentLookup as _, type PostprocessingBuildContext as a, ObjectManagementSystem as a0, type SubtreeSnapshot as a1, type ExternalRefWarning as a2, type AudioBus as a3, type AssetInput as a4, AudioSystem as a5, type CheckboxInput as a6, type ColorInput as a7, type ComponentFactory as a8, type ComponentInput as a9, SlotChooser as aA, type SoundBankAsset as aB, type SoundSlot as aC, type SoundTake as aD, type TextInput as aE, type ToggleInput as aF, TransformSyncSystem as aG, type Vec3 as aH, type Vector2Input as aI, type Vector3Input as aJ, clearPrefabCache as aK, despawnPrefab as aL, findModelBone as aM, listModelBones as aN, loadPrefab as aO, parsePrefabAsset as aP, prefabFileVersionFor as aQ, remapSnapshotEntityIds as aR, setPrefabAssetUrlResolver as aS, soundBankFiles as aT, spawnPrefab as aU, type AnyComponent as aV, DEBUG_CHANGE_IGNORED_SYSTEMS as aW, type WorldHistorySnapshot as aX, cloneHistoryValue as aY, normalizeDebugValue as aZ, type ComponentKind as aa, type DropdownInput as ab, type DropdownOption as ac, type EcsComponentFactoryKind as ad, type EcsEntityEditorKind as ae, type EntityInput as af, type FloatInput as ag, IKSystem as ah, InputSystem as ai, type IntersectionResult as aj, type KeyboardKey as ak, KeyboardKeys as al, type ModelBoneInfo as am, type MouseButton as an, PREFAB_FILE_VERSION as ao, PREFAB_FILE_VERSION_NESTED as ap, type PrefabAsset as aq, type RemapSnapshotOptions as ar, RenderSystem as as, type ScriptErrorEvent as at, type ScriptErrorListener as au, type ScriptErrorPhase as av, type ScriptErrorReport as aw, type ScriptErrorSource as ax, type SelectionListener as ay, type SliderInput as az, type PostprocessingState as b, type RendererKind as c, Component as d, DEFAULT_ENVIRONMENT_STATE as e, DEFAULT_POSTPROCESSING_STATE as f, Environment as g, type EnvironmentFogState as h, type EnvironmentFogType as i, type EnvironmentGradientEffect as j, type EnvironmentLightingState as k, type EnvironmentSkyboxImageProjection as l, type EnvironmentSkyboxState as m, type EnvironmentSkyboxType as n, type EnvironmentState as o, type EnvironmentToneMapping as p, IKComponent as q, type IKLimb as r, type IKOptions as s, NetworkIdentityComponent as t, NetworkSpawnerComponent as u, NetworkTransformComponent as v, type NetworkTransformOptions as w, NetworkedPropsComponent as x, ParentId as y, Postprocessing as z };
+export { type WorldEntityView$1 as $, type TransformData as A, normalizeEnvironmentLighting as B, type ChromaKeyOptions as C, DEFAULT_ENVIRONMENT_LIGHTING as D, type EcsRenderer as E, normalizeIKChain as F, type NetworkTransport as G, type NetEntityView as H, type IKChain as I, type NetPose as J, type NetSound as K, type VoiceFromRoom as L, type VoiceToRoom as M, type NetValue as N, type VoiceHandle as O, type PostprocessingPipeline as P, type VoicePeer as Q, type RenderBackend as R, type EcsSystem as S, TransformComponent as T, type NetworkService as U, type Vec3$1 as V, World as W, type EntityId as X, type NetworkHandle as Y, type NetSpawnOptions as Z, type VoiceSignal as _, type PostprocessingBuildContext as a, spawnPrefab as a$, type SpawnPrefabSource as a0, type SpawnPrefabOptions as a1, type PlaySlotOptions as a2, type ComponentClass as a3, type ParentLookup as a4, type EcsEntityKind as a5, ObjectManagementSystem as a6, type SubtreeSnapshot as a7, type ExternalRefWarning as a8, type AssetInput as a9, type ScriptErrorEvent as aA, type ScriptErrorListener as aB, type ScriptErrorPhase as aC, type ScriptErrorReport as aD, type ScriptErrorSource as aE, type SelectionListener as aF, type SliderInput as aG, SlotChooser as aH, type SoundBankAsset as aI, type SoundSlot as aJ, type SoundTake as aK, type TextInput as aL, type ToggleInput as aM, TransformSyncSystem as aN, type Vec3 as aO, type Vector2Input as aP, type Vector3Input as aQ, clearPrefabCache as aR, despawnPrefab as aS, findModelBone as aT, listModelBones as aU, loadPrefab as aV, parsePrefabAsset as aW, prefabFileVersionFor as aX, remapSnapshotEntityIds as aY, setPrefabAssetUrlResolver as aZ, soundBankFiles as a_, type AudioBus as aa, AudioMixer as ab, AudioSystem as ac, type CheckboxInput as ad, type ColorInput as ae, type ComponentFactory as af, type ComponentInput as ag, type ComponentKind as ah, type DropdownInput as ai, type DropdownOption as aj, type EcsComponentFactoryKind as ak, type EcsEntityEditorKind as al, type EntityInput as am, type FloatInput as an, IKSystem as ao, InputSystem as ap, type IntersectionResult as aq, type KeyboardKey as ar, KeyboardKeys as as, type ModelBoneInfo as at, type MouseButton as au, PREFAB_FILE_VERSION as av, PREFAB_FILE_VERSION_NESTED as aw, type PrefabAsset as ax, type RemapSnapshotOptions as ay, RenderSystem as az, type PostprocessingState as b, type AnyComponent as b0, DEBUG_CHANGE_IGNORED_SYSTEMS as b1, type WorldHistorySnapshot as b2, cloneHistoryValue as b3, normalizeDebugValue as b4, type RendererKind as c, Component as d, DEFAULT_ENVIRONMENT_STATE as e, DEFAULT_POSTPROCESSING_STATE as f, Environment as g, type EnvironmentFogState as h, type EnvironmentFogType as i, type EnvironmentGradientEffect as j, type EnvironmentLightingState as k, type EnvironmentSkyboxImageProjection as l, type EnvironmentSkyboxState as m, type EnvironmentSkyboxType as n, type EnvironmentState as o, type EnvironmentToneMapping as p, IKComponent as q, type IKLimb as r, type IKOptions as s, NetworkIdentityComponent as t, NetworkSpawnerComponent as u, NetworkTransformComponent as v, type NetworkTransformOptions as w, NetworkedPropsComponent as x, ParentId as y, Postprocessing as z };

package/dist/{XRHandPose-G0Dl-F0w.d.ts → XRHandPose-BNSwd1y9.d.ts}

@@ -1,5 +1,5 @@
 import * as THREE from 'three';
-import { d as Component, a3 as AudioBus, $ as EcsEntityKind, ae as EcsEntityEditorKind, M as EntityId } from './System-DPMAW30g.js';
+import { d as Component, aa as AudioBus, a5 as EcsEntityKind, al as EcsEntityEditorKind, X as EntityId } from './System-CADhPyQs.js';
 import * as RAPIER from '@dimforge/rapier3d-compat';
 import { a as XrFinger, c as XrHandPoseDirection, b as XrHandPoseOrientation, X as XrHandPoseDefinition } from './handPose-DlcTtqgx.js';
 
@@ -1663,6 +1663,80 @@ declare class BoneAttachmentComponent extends Component {
     constructor(options?: BoneAttachmentOptions);
 }
 
+/**
+ * The style model for spatial UI.
+ *
+ * Every field here is optional and stays ABSENT until authored. A defaulted
+ * field would show up as a change on every instance of a prefab saved before
+ * it existed, pinning those instances against later prefab edits. Old flat
+ * fields (`backgroundColor`, `cornerRadius`…) stay as the fallback, so a scene
+ * saved before this model renders the same.
+ *
+ * Units are metres. Any colour or file string may be a token, `$name`, which
+ * resolves through `tokens` on the nearest panel above the widget. A theme
+ * therefore travels with a prefab, and editing one panel restyles a menu.
+ *
+ * Pure and free of three.js and the DOM.
+ */
+type UiColorStop = {
+    at: number;
+    color: string;
+};
+type UiPaint = {
+    kind: "solid";
+    color: string;
+}
+/** `angle` is in degrees and reads like CSS: 0 points up, 90 points right. */
+ | {
+    kind: "linear";
+    angle: number;
+    stops: UiColorStop[];
+} | {
+    kind: "radial";
+    stops: UiColorStop[];
+} | {
+    kind: "image";
+    src: string;
+    fit: "cover" | "contain" | "fill";
+    tint?: string;
+};
+type UiShadow = {
+    x: number;
+    y: number;
+    blur: number;
+    color: string;
+};
+type UiTextStyle = {
+    /** A font file in the project, such as one `add_font` bundled. */
+    font?: string;
+    weight?: number;
+    /** Letter spacing in metres. */
+    tracking?: number;
+    transform?: "upper" | "lower";
+    paint?: UiPaint;
+    maxLines?: number;
+    shadow?: UiShadow;
+};
+type UiStyle = {
+    fill?: UiPaint;
+    border?: {
+        width: number;
+        paint: UiPaint;
+    };
+    /** One radius, or top-left, top-right, bottom-right, bottom-left. */
+    radius?: number | [number, number, number, number];
+    shadows?: UiShadow[];
+    /** A thin highlight along the top inner edge. */
+    edge?: {
+        width: number;
+        color: string;
+    };
+    /** 0–1. Multiplies down the widget tree, so fading a panel fades its menu. */
+    opacity?: number;
+    text?: UiTextStyle;
+};
+type UiTokens = Record<string, string>;
+
 /** How a panel orients itself while the experience runs. */
 type UiFollowMode = "world" | "billboard";
 /** Optional initializer for {@link UIPanelComponent}. */
@@ -1676,6 +1750,8 @@ type UIPanelOptions = {
     borderColor?: string;
     pixelDensity?: number;
     follow?: UiFollowMode;
+    style?: UiStyle;
+    tokens?: UiTokens;
 };
 /**
  * A flat UI surface in the world — the backdrop menus and HUDs are built on.
@@ -1707,6 +1783,13 @@ declare class UIPanelComponent extends Component {
     /** Texture density in px/metre, clamped 256–2048 at render time. */
     pixelDensity: number;
     follow: UiFollowMode;
+    /** Modern styling; wins over the flat fields above. Absent until authored. */
+    style?: UiStyle;
+    /**
+     * Named values widgets under this panel use as `$name`. The nearest panel
+     * wins, so a theme travels with the panel and one edit restyles the menu.
+     */
+    tokens?: UiTokens;
     constructor(options?: UIPanelOptions);
 }
 
@@ -1724,6 +1807,8 @@ type UITextOptions = {
     valign?: UiTextVAlign;
     lineHeight?: number;
     padding?: number;
+    pixelDensity?: number;
+    style?: UiStyle;
 };
 /**
  * A block of text drawn onto a transparent canvas quad.
@@ -1752,9 +1837,18 @@ declare class UITextComponent extends Component {
     lineHeight: number;
     /** Inner padding in metres. */
     padding: number;
+    /**
+     * Texture density in px/metre, clamped 256–2048 at render time. Absent means
+     * the default: a defaulted field would count as a change on every instance
+     * of a prefab saved before it existed.
+     */
+    pixelDensity?: number;
+    /** Modern styling; wins over the flat fields above. Absent until authored. */
+    style?: UiStyle;
     constructor(options?: UITextOptions);
 }
 
+type UiIconPosition = "left" | "right";
 /** Optional initializer for {@link UIButtonComponent}. */
 type UIButtonOptions = {
     label?: string;
@@ -1769,6 +1863,10 @@ type UIButtonOptions = {
     cornerRadius?: number;
     borderWidth?: number;
     borderColor?: string;
+    pixelDensity?: number;
+    style?: UiStyle;
+    icon?: string;
+    iconPosition?: UiIconPosition;
 };
 /**
  * A pressable control.
@@ -1799,9 +1897,21 @@ declare class UIButtonComponent extends Component {
     cornerRadius: number;
     borderWidth: number;
     borderColor: string;
+    /**
+     * Texture density in px/metre, clamped 256–2048 at render time. Absent means
+     * the default: a defaulted field would count as a change on every instance
+     * of a prefab saved before it existed.
+     */
+    pixelDensity?: number;
+    /** Modern styling; wins over the flat fields above. Absent until authored. */
+    style?: UiStyle;
+    /** An image or SVG file drawn beside the label, tinted to the text colour. */
+    icon?: string;
+    iconPosition?: UiIconPosition;
     constructor(options?: UIButtonOptions);
 }
 
+type UiToggleVariant = "switch" | "checkbox" | "radio";
 /** Optional initializer for {@link UIToggleComponent}. */
 type UIToggleOptions = {
     value?: boolean;
@@ -1811,6 +1921,9 @@ type UIToggleOptions = {
     trackColor?: string;
     accentColor?: string;
     knobColor?: string;
+    pixelDensity?: number;
+    style?: UiStyle;
+    variant?: UiToggleVariant;
 };
 /**
  * An on/off switch.
@@ -1835,9 +1948,20 @@ declare class UIToggleComponent extends Component {
     /** Track colour while ON. */
     accentColor: string;
     knobColor: string;
+    /**
+     * Texture density in px/metre, clamped 256–2048 at render time. Absent means
+     * the default: a defaulted field would count as a change on every instance
+     * of a prefab saved before it existed.
+     */
+    pixelDensity?: number;
+    /** Modern styling; wins over the flat fields above. Absent until authored. */
+    style?: UiStyle;
+    /** How the control is drawn. Absent means `switch`. */
+    variant?: UiToggleVariant;
     constructor(options?: UIToggleOptions);
 }
 
+type UiSliderVariant = "slider" | "progress" | "ring";
 /** Optional initializer for {@link UISliderComponent}. */
 type UISliderOptions = {
     value?: number;
@@ -1849,6 +1973,11 @@ type UISliderOptions = {
     trackColor?: string;
     accentColor?: string;
     knobColor?: string;
+    pixelDensity?: number;
+    style?: UiStyle;
+    variant?: UiSliderVariant;
+    step?: number;
+    readOnly?: boolean;
 };
 /**
  * A draggable value control.
@@ -1876,6 +2005,20 @@ declare class UISliderComponent extends Component {
     /** Fill colour between min and the current value. */
     accentColor: string;
     knobColor: string;
+    /**
+     * Texture density in px/metre, clamped 256–2048 at render time. Absent means
+     * the default: a defaulted field would count as a change on every instance
+     * of a prefab saved before it existed.
+     */
+    pixelDensity?: number;
+    /** Modern styling; wins over the flat fields above. Absent until authored. */
+    style?: UiStyle;
+    /** How the value is drawn. `progress` and `ring` are read-only. */
+    variant?: UiSliderVariant;
+    /** Snap to multiples of this, measured from `min`. */
+    step?: number;
+    /** Shows the value but takes no input. */
+    readOnly?: boolean;
     constructor(options?: UISliderOptions);
 }
 
@@ -2043,4 +2186,4 @@ declare class XRHandPoseComponent extends Component {
     constructor(options?: XRHandPoseOptions);
 }
 
-export { ScriptComponent as $, AnimationComponent as A, BoneAttachmentComponent as B, CameraComponent as C, DEFAULT_COLLIDER_STATE as D, type EditableMeshObjectKind as E, type LightValueState as F, MaterialComponent as G, type MaterialTypeValue as H, ImageComponent as I, type MaterialValueState as J, MeshComponent as K, LightComponent as L, MODEL_NO_PATH_MESSAGE as M, MeshGeometryComponent as N, type MeshGeometryParameters as O, type MeshGeometryParametersByKind as P, ModelComponent as Q, type ModelLoadState as R, Name as S, Object3DRef as T, PhysicsComponent as U, type PhysicsState as V, type PlaneMeshParameters as W, type RadiusHeightMeshParameters as X, type RadiusMeshParameters as Y, type RigidbodyState as Z, type RigidbodyType as _, type AnimationComponentOptions as a, type ScriptEntry as a0, ScriptObjectComponent as a1, type ScriptObjectComponentInput as a2, type ScriptObjectRuntimeState as a3, Selectable as a4, SelectionTransformState as a5, SpriteComponent as a6, type TextureFilteringValue as a7, type TransformModeValue as a8, type TransformSpaceValue as a9, XRRigComponent as aA, type XRRigOptions as aB, type XrAttachPoint as aC, type XrDistanceGrabBehavior as aD, type XrEnvironmentPhysics as aE, type XrGrabGesture as aF, type XrGrabHands as aG, type XrGrabReach as aH, type XrHandPoseEntry as aI, type XrHandPreset as aJ, type XrInteractorSide as aK, type XrInteractorType as aL, type XrLocomotionMode as aM, type XrTrackingOrigin as aN, type XrTwoHandRotation as aO, createAttachPoint as aP, createHandPoseEntry as aQ, defaultMaterialValue as aR, handPoseDefinitionFor as aS, normalizePhysicsState as aT, setModelLoadState as aU, setPhysicsLiveRef as aV, type AnimationStateCallbacks as aW, AnimationStateMachine as aX, AnimationStateManager as aY, type StateMachine as aZ, UIButtonComponent as aa, type UIButtonOptions as ab, UIPanelComponent as ac, type UIPanelOptions as ad, UISliderComponent as ae, type UISliderOptions as af, UITextComponent as ag, type UITextOptions as ah, UIToggleComponent as ai, type UIToggleOptions as aj, type UiFollowMode as ak, type UiTextAlign as al, type UiTextVAlign as am, VRTeleportAreaComponent as an, type VRTeleportAreaOptions as ao, VideoComponent as ap, type VrTeleportShape as aq, XRAnchorComponent as ar, type XRAnchorOptions as as, XRHandPoseComponent as at, type XRHandPoseOptions as au, XRInteractableComponent as av, type XRInteractableOptions as aw, XRInteractorComponent as ax, type XRInteractorOptions as ay, XRInteractorSideComponent as az, AudioComponent as b, type BoneAttachmentOptions as c, type CameraComponentOptions as d, type CameraProjection as e, type CameraRuntimeType as f, type ColliderShape as g, type ColliderState as h, type CubeMeshParameters as i, DEFAULT_INSTANCED_MESH_PARAMETERS as j, DEFAULT_INSTANCE_TRANSFORM as k, DEFAULT_MESH_GEOMETRY_PARAMETERS as l, DEFAULT_PHYSICS_STATE as m, DEFAULT_POSE_CURLS as n, DEFAULT_POSE_DIRECTIONS as o, DEFAULT_RIGIDBODY_STATE as p, EntityType as q, ImageTarget as r, ImageTargetAnchor as s, type ImageTargetAnchorOptions as t, type ImageTargetReference as u, InstanceSlotComponent as v, type InstanceTransform as w, InstancedMeshComponent as x, type InstancedMeshKind as y, type LightShadowState as z };
+export { ScriptComponent as $, AnimationComponent as A, BoneAttachmentComponent as B, CameraComponent as C, DEFAULT_COLLIDER_STATE as D, type EditableMeshObjectKind as E, type LightValueState as F, MaterialComponent as G, type MaterialTypeValue as H, ImageComponent as I, type MaterialValueState as J, MeshComponent as K, LightComponent as L, MODEL_NO_PATH_MESSAGE as M, MeshGeometryComponent as N, type MeshGeometryParameters as O, type MeshGeometryParametersByKind as P, ModelComponent as Q, type ModelLoadState as R, Name as S, Object3DRef as T, PhysicsComponent as U, type PhysicsState as V, type PlaneMeshParameters as W, type RadiusHeightMeshParameters as X, type RadiusMeshParameters as Y, type RigidbodyState as Z, type RigidbodyType as _, type AnimationComponentOptions as a, AnimationStateManager as a$, type ScriptEntry as a0, ScriptObjectComponent as a1, type ScriptObjectComponentInput as a2, type ScriptObjectRuntimeState as a3, Selectable as a4, SelectionTransformState as a5, SpriteComponent as a6, type TextureFilteringValue as a7, type TransformModeValue as a8, type TransformSpaceValue as a9, XRInteractorComponent as aA, type XRInteractorOptions as aB, XRInteractorSideComponent as aC, XRRigComponent as aD, type XRRigOptions as aE, type XrAttachPoint as aF, type XrDistanceGrabBehavior as aG, type XrEnvironmentPhysics as aH, type XrGrabGesture as aI, type XrGrabHands as aJ, type XrGrabReach as aK, type XrHandPoseEntry as aL, type XrHandPreset as aM, type XrInteractorSide as aN, type XrInteractorType as aO, type XrLocomotionMode as aP, type XrTrackingOrigin as aQ, type XrTwoHandRotation as aR, createAttachPoint as aS, createHandPoseEntry as aT, defaultMaterialValue as aU, handPoseDefinitionFor as aV, normalizePhysicsState as aW, setModelLoadState as aX, setPhysicsLiveRef as aY, type AnimationStateCallbacks as aZ, AnimationStateMachine as a_, UIButtonComponent as aa, type UIButtonOptions as ab, UIPanelComponent as ac, type UIPanelOptions as ad, UISliderComponent as ae, type UISliderOptions as af, UITextComponent as ag, type UITextOptions as ah, UIToggleComponent as ai, type UIToggleOptions as aj, type UiFollowMode as ak, type UiIconPosition as al, type UiSliderVariant as am, type UiTextAlign as an, type UiTextVAlign as ao, type UiToggleVariant as ap, VRTeleportAreaComponent as aq, type VRTeleportAreaOptions as ar, VideoComponent as as, type VrTeleportShape as at, XRAnchorComponent as au, type XRAnchorOptions as av, XRHandPoseComponent as aw, type XRHandPoseOptions as ax, XRInteractableComponent as ay, type XRInteractableOptions as az, AudioComponent as b, type StateMachine as b0, type UiColorStop as b1, type UiPaint as b2, type UiShadow as b3, type UiStyle as b4, type UiTextStyle as b5, type UiTokens as b6, type BoneAttachmentOptions as c, type CameraComponentOptions as d, type CameraProjection as e, type CameraRuntimeType as f, type ColliderShape as g, type ColliderState as h, type CubeMeshParameters as i, DEFAULT_INSTANCED_MESH_PARAMETERS as j, DEFAULT_INSTANCE_TRANSFORM as k, DEFAULT_MESH_GEOMETRY_PARAMETERS as l, DEFAULT_PHYSICS_STATE as m, DEFAULT_POSE_CURLS as n, DEFAULT_POSE_DIRECTIONS as o, DEFAULT_RIGIDBODY_STATE as p, EntityType as q, ImageTarget as r, ImageTargetAnchor as s, type ImageTargetAnchorOptions as t, type ImageTargetReference as u, InstanceSlotComponent as v, type InstanceTransform as w, InstancedMeshComponent as x, type InstancedMeshKind as y, type LightShadowState as z };