@needle-tools/engine 5.1.0-canary.c111c4f → 5.1.0-canary.d110b1f

package/dist/needle-engine.d.ts

@@ -2946,7 +2946,7 @@ export declare class Canvas extends UIRootComponent implements ICanvas {
     private _receivers;
     registerEventReceiver(receiver: ICanvasEventReceiver): void;
     unregisterEventReceiver(receiver: ICanvasEventReceiver): void;
-    onEnterXR(args: NeedleXREventArgs): Promise<void>;
+    onEnterXR(args: NeedleXREventArgs): void;
     onLeaveXR(args: NeedleXREventArgs): void;
     onBeforeRenderRoutine: () => void;
     onAfterRenderRoutine: () => void;
@@ -3623,7 +3623,7 @@ declare class ColorSerializer extends TypeSerializer {
     onSerialize(data: any): any | void;
 }
 
-export declare const colorSerializer: ColorSerializer;
+export declare let colorSerializer: ColorSerializer;
 
 /**
  * Utility method to check if two materials were created from the same glTF material
@@ -4097,7 +4097,7 @@ declare class ComponentSerializer extends TypeSerializer {
     findObjectForGuid(guid: string, root: Object3D): any;
 }
 
-export declare const componentSerializer: ComponentSerializer;
+export declare let componentSerializer: ComponentSerializer;
 
 declare type ComponentType = "button" | "thumbstick" | "squeeze" | "touchpad";
 
@@ -4460,13 +4460,14 @@ export declare class Context implements IContext {
      * Use `setCurrentCamera` for updating the main camera.
      */
     /**
-     * Typed proxy providing direct access to scene components by node and component name.
-     * Types are auto-generated from your GLB assets by the `needle:dts-generator` Vite plugin
-     * and written to `src/generated/needle-bindings.d.ts` on every dev-server start and GLB change.
+     * Access your scene's full hierarchy, objects, and components directly by name — with full autocomplete.
+     * Types are generated automatically from your GLB files when the dev server starts.
      *
-     * Each property access traverses the live scene graph on demand — no caching, always fresh.
-     * This is a convenience shorthand for `getComponent` lookups; the same result can be
-     * achieved manually via `scene.getObjectByName(name)` + `getComponent(node, Type)`.
+     * You can store references to objects or components for later use.
+     * Note that the scene hierarchy can change at runtime (e.g. when objects are added, removed, or re-parented),
+     * in which case stored references may become stale.
+     *
+     * @experimental This API may change in future versions.
      *
      * @example
      * // Toggle auto-rotate on the orbit camera
@@ -4475,12 +4476,6 @@ export declare class Context implements IContext {
      * @example
      * // Change the background color
      * ctx.sceneData.Camera.Camera.backgroundColor = new RGBAColor(1, 0, 0, 1);
-     *
-     * @example
-     * // Equivalent manual approach (without sceneData)
-     * const node = ctx.scene.getObjectByName("Camera");
-     * const orbit = getComponent(node, OrbitControls);
-     * if (orbit) orbit.autoRotate = true;
      */
     get sceneData(): SceneData;
     get mainCamera(): Camera_2;
@@ -4504,19 +4499,21 @@ export declare class Context implements IContext {
     connection: NetworkConnection;
     /**  @deprecated AssetDatabase is deprecated */
     assets: AssetDatabase;
-    /** All registered lights in the scene, maintained by the Light component */
-    readonly lights: Set<ILight>;
+    /** All registered lights in the scene, maintained by the Light component.
+     * @see mainLight for accessing the main directional light in the scene
+     */
+    readonly lights: ILight[];
     /** The brightest registered directional light, or null if none are registered
      * @see lights
      */
     get mainLight(): ILight | null;
     /** @deprecated Use sceneLighting */
-    get rendererData(): RendererData;
+    private get rendererData();
     /** Access the scene lighting manager to control lighting settings in the context */
-    sceneLighting: RendererData;
-    addressables: Addressables;
-    lightmaps: ILightDataRegistry;
-    players: PlayerViewManager;
+    readonly sceneLighting: RendererData;
+    readonly addressables: Addressables;
+    readonly lightmaps: ILightDataRegistry;
+    readonly players: PlayerViewManager;
     /** Access the LODs manager to control LOD behavior in the context */
     readonly lodsManager: LODsManager;
     /** Access the needle menu to add or remove buttons to the menu element */
@@ -5923,19 +5920,6 @@ export declare class EnvironmentScene extends Scene {
     createAreaLightMaterial(intensity: number): MeshBasicMaterial;
 }
 
-export declare const euler: EulerSerializer;
-
-declare class EulerSerializer extends TypeSerializer {
-    constructor();
-    onDeserialize(data: any, _context: SerializationContext): Euler | undefined;
-    onSerialize(data: any, _context: SerializationContext): {
-        x: any;
-        y: any;
-        z: any;
-        order: any;
-    };
-}
-
 /**
  * EventList manages a list of callbacks that can be invoked together.
  * Used for Unity-style events that can be configured in the editor (Unity or Blender).
@@ -6068,7 +6052,7 @@ declare class EventListSerializer extends TypeSerializer {
     onDeserialize(data: EventListData, context: SerializationContext): EventList<any> | undefined | null;
 }
 
-export declare const eventListSerializer: EventListSerializer;
+export declare let eventListSerializer: EventListSerializer;
 
 /**
  * [EventSystem](https://engine.needle.tools/docs/api/EventSystem) is responsible for managing and dispatching input events to UI components within the scene.
@@ -8460,10 +8444,20 @@ export declare class InheritVelocityModule {
     applyCurrent(vel: Vector3 | Vector3_2, t01: number, lerpFactor: number): void;
 }
 
+/* Excluded from this release type: initAddressableSerializers */
+
+/** Register all builtin serializers and prototype patches.
+ * Must be called from {@link initEngine} so the registrations survive tree-shaking
+ * when the package declares `sideEffects: false`.
+ */
+export declare function initBuiltinSerializers(): void;
+
 /** Register the Rapier physics backend. Called from {@link initEngine}
  * to ensure it runs regardless of tree-shaking. */
 export declare function initPhysics(): void;
 
+/* Excluded from this release type: initVolumeParameterSerializer */
+
 /**
  * Handles all input events including mouse, touch, keyboard, and XR controllers.
  * Access via `this.context.input` from any component.
@@ -9967,19 +9961,6 @@ export declare class Light extends Component implements ILight {
     get shadowResolution(): number;
     set shadowResolution(val: number);
     private _shadowResolution?;
-    /**
-     * Number of shadow cascade levels (only used when `useCascades` is true)
-     */
-    cascades: number;
-    /**
-     * Cascade split mode (only used when `useCascades` is true):
-     * - `practical` — balanced (default, recommended)
-     * - `logarithmic` — more resolution close up
-     * - `uniform` — equal splits
-     */
-    cascadeMode: "practical" | "logarithmic" | "uniform";
-    private _csm?;
-    private _csmHelper?;
     /**
      * Whether this light's illumination is entirely baked into lightmaps
      */
@@ -10001,7 +9982,6 @@ export declare class Light extends Component implements ILight {
     awake(): void;
     onEnable(): void;
     onDisable(): void;
-    onBeforeRender(): void;
     /**
      * Creates the appropriate three.js light based on the configured light type
      * and applies all settings like shadows, intensity, and color.
@@ -10022,11 +10002,6 @@ export declare class Light extends Component implements ILight {
      * When the rig is scaled, world-space distances change proportionally
      * causing lights to appear brighter or dimmer due to distance falloff. */
     private applyXRScale;
-    /**
-     * Creates and initializes a CSM instance for this directional light.
-     * CSM manages its own cascade DirectionalLights internally.
-     */
-    private createCSM;
     /**
      * Configures a directional light by adding and positioning its target
      * @param dirLight The directional light to set up
@@ -11067,15 +11042,13 @@ export declare type MouseButtonName = "left" | "right" | "middle";
 /* Excluded from this release type: nameofFactory */
 
 /**
- * Global proxy for the primary Needle Engine context.
- * Resolves lazily on property access via `ContextRegistry.Current` —
- * safe to import at module level, including in SSR environments
- * (returns a silent error proxy when no context is active).
+ * Quick access to the current Needle Engine context from anywhere — no need to pass `ctx` around.
+ * Use it in React/Svelte/Vue components, button handlers, or plain JavaScript.
  *
- * Use this outside of Needle component lifecycle (e.g. in Svelte/React/Vue
- * components, button handlers, or vanilla JS) instead of threading `ctx` around.
+ * Safe to import at module level, including in SSR environments.
+ * For pages with multiple `<needle-engine>` elements, use `ctx` directly instead.
  *
- * For multiple `<needle-engine>` elements on the same page, use `ctx` directly.
+ * @experimental This API may change in future releases.
  *
  * @example
  * import { needle } from "@needle-tools/engine";
@@ -12238,6 +12211,8 @@ export declare class NeedleXRSession implements INeedleXRSession {
     private readonly _xr_update_scripts;
     /** scripts that are in the scene but inactive (e.g. disabled parent gameObject) */
     private readonly _inactive_scripts;
+    /** tracks scripts that have received onEnterXR — prevents spurious onLeaveXR calls */
+    private readonly _scripts_in_xr;
     private readonly _controllerAdded;
     private readonly _controllerRemoved;
     private readonly _originalCameraWorldPosition?;
@@ -12857,7 +12832,7 @@ export declare interface NetworkEventMap {
  * @see {@link RoomEvents} for room lifecycle events
  * @see {@link isLocalNetwork} for local network detection
  * @link https://engine.needle.tools/docs/how-to-guides/networking/
- * @summary Networking configuration
+ * @summary Configures the websocket server URL for multiplayer networking
  * @category Networking
  * @group Components
  */
@@ -13078,7 +13053,7 @@ declare class ObjectSerializer extends TypeSerializer {
     onDeserialize(data: ObjectData | string | null, context: SerializationContext): Object3D<Object3DEventMap> | Component | null | undefined;
 }
 
-export declare const objectSerializer: ObjectSerializer;
+export declare let objectSerializer: ObjectSerializer;
 
 declare type ObjectToNodeMap = {
     [uuid: string]: number;
@@ -23547,23 +23522,8 @@ export declare class OrbitControls extends Component implements ICameraControlle
 
 
 declare module 'three' {
-    interface SkinnedMesh {
-        staticGenerator?: StaticGeometryGenerator;
-        staticGeometry?: BufferGeometry;
-        staticGeometryLastUpdate?: number;
-    }
-    interface Mesh {
-        acceleratedRaycast?: any;
-    }
-    interface SkinnedMesh {
-        /** @deprecated use autoUpdateMeshBvhInterval */
-        autoUpdateMeshBVH?: boolean;
-        /**
-         * Interval in milliseconds to automatically update the mesh BVH. When set to >= 0 the BVH will be updated every x milliseconds.
-         * @default undefined (disabled)
-         */
-        autoUpdateMeshBvhInterval?: number;
-        bvhNeedsUpdate?: boolean;
+    interface Vector3 {
+        slerp(end: Vector3, t: number): Vector3;
     }
 }
 
@@ -23709,7 +23669,22 @@ declare module 'three' {
 
 
 declare module 'three' {
-    interface Vector3 {
-        slerp(end: Vector3, t: number): Vector3;
+    interface SkinnedMesh {
+        staticGenerator?: StaticGeometryGenerator;
+        staticGeometry?: BufferGeometry;
+        staticGeometryLastUpdate?: number;
+    }
+    interface Mesh {
+        acceleratedRaycast?: any;
+    }
+    interface SkinnedMesh {
+        /** @deprecated use autoUpdateMeshBvhInterval */
+        autoUpdateMeshBVH?: boolean;
+        /**
+         * Interval in milliseconds to automatically update the mesh BVH. When set to >= 0 the BVH will be updated every x milliseconds.
+         * @default undefined (disabled)
+         */
+        autoUpdateMeshBvhInterval?: number;
+        bvhNeedsUpdate?: boolean;
     }
 }