@relu-interactives/spatial-ecs 0.2.10 → 0.2.12

package/dist/{System-AV2_87Zr.d.cts → System-CHCucemW.d.cts}

@@ -127,7 +127,7 @@ type EntityInput = {
     type: "entity";
     value: EntityId | null;
 };
-type ComponentKind = "Animation" | "Audio" | "Camera" | "Environment" | "EntityType" | "Image" | "ImageTarget" | "ImageTargetAnchor" | "Light" | "Material" | "Mesh" | "MeshGeometry" | "Model" | "Name" | "Object3DRef" | "ParentId" | "Physics" | "Postprocessing" | "Script" | "Selectable" | "SelectionTransformState" | "Sprite" | "Transform" | "Video";
+type ComponentKind = "Animation" | "Audio" | "Camera" | "Environment" | "EntityType" | "Image" | "ImageTarget" | "ImageTargetAnchor" | "InstancedMesh" | "InstanceSlot" | "Light" | "Material" | "Mesh" | "MeshGeometry" | "Model" | "Name" | "Object3DRef" | "ParentId" | "Physics" | "Postprocessing" | "Script" | "Selectable" | "SelectionTransformState" | "Sprite" | "Transform" | "Video";
 /**
  * Inspector field that lets the user drag an entity and optionally pick a
  * component from it.
@@ -253,7 +253,29 @@ declare class ObjectManagementSystem implements EcsSystem {
     createComponentNow(kind: EcsComponentFactoryKind, world: World, entityId: EntityId, ...args: any[]): unknown;
     requestCreate(kind: EcsEntityKind, payload?: CreatePayload, onCreated?: (entityId: EntityId) => void): void;
     createNow(kind: EcsEntityKind, world: World, payload?: CreatePayload): EntityId;
-    deleteEntity(world: World, entityId: EntityId): boolean;
+    /**
+     * Removes an entity from the ECS world and its associated `Object3D` from the
+     * THREE.js scene graph.
+     *
+     * @param world - The world the entity belongs to.
+     * @param entityId - The entity to remove.
+     * @param dispose - When `true`, traverses the entity's `Object3D` subtree and
+     *   calls `.dispose()` on every `BufferGeometry` and `Material` found. Pass
+     *   `true` when the entity will not be reused and you want to free GPU memory
+     *   immediately (e.g. dynamically spawned objects). Defaults to `false`.
+     * @returns `true` if the entity existed and was removed; `false` if the entity
+     *   was not found.
+     *
+     * @example
+     * ```ts
+     * // Remove from scene, keep GPU resources (safe if geometry is shared)
+     * objects.deleteEntity(world, entityId);
+     *
+     * // Remove from scene and free GPU memory (use for one-off spawned objects)
+     * objects.deleteEntity(world, entityId, true);
+     * ```
+     */
+    deleteEntity(world: World, entityId: EntityId, dispose?: boolean): boolean;
     setParent(world: World, entityId: EntityId, parentId: EntityId | null, options?: {
         preserveWorldTransform?: boolean;
     }): boolean;

package/dist/{System-AV2_87Zr.d.ts → System-CHCucemW.d.ts}

@@ -127,7 +127,7 @@ type EntityInput = {
     type: "entity";
     value: EntityId | null;
 };
-type ComponentKind = "Animation" | "Audio" | "Camera" | "Environment" | "EntityType" | "Image" | "ImageTarget" | "ImageTargetAnchor" | "Light" | "Material" | "Mesh" | "MeshGeometry" | "Model" | "Name" | "Object3DRef" | "ParentId" | "Physics" | "Postprocessing" | "Script" | "Selectable" | "SelectionTransformState" | "Sprite" | "Transform" | "Video";
+type ComponentKind = "Animation" | "Audio" | "Camera" | "Environment" | "EntityType" | "Image" | "ImageTarget" | "ImageTargetAnchor" | "InstancedMesh" | "InstanceSlot" | "Light" | "Material" | "Mesh" | "MeshGeometry" | "Model" | "Name" | "Object3DRef" | "ParentId" | "Physics" | "Postprocessing" | "Script" | "Selectable" | "SelectionTransformState" | "Sprite" | "Transform" | "Video";
 /**
  * Inspector field that lets the user drag an entity and optionally pick a
  * component from it.
@@ -253,7 +253,29 @@ declare class ObjectManagementSystem implements EcsSystem {
     createComponentNow(kind: EcsComponentFactoryKind, world: World, entityId: EntityId, ...args: any[]): unknown;
     requestCreate(kind: EcsEntityKind, payload?: CreatePayload, onCreated?: (entityId: EntityId) => void): void;
     createNow(kind: EcsEntityKind, world: World, payload?: CreatePayload): EntityId;
-    deleteEntity(world: World, entityId: EntityId): boolean;
+    /**
+     * Removes an entity from the ECS world and its associated `Object3D` from the
+     * THREE.js scene graph.
+     *
+     * @param world - The world the entity belongs to.
+     * @param entityId - The entity to remove.
+     * @param dispose - When `true`, traverses the entity's `Object3D` subtree and
+     *   calls `.dispose()` on every `BufferGeometry` and `Material` found. Pass
+     *   `true` when the entity will not be reused and you want to free GPU memory
+     *   immediately (e.g. dynamically spawned objects). Defaults to `false`.
+     * @returns `true` if the entity existed and was removed; `false` if the entity
+     *   was not found.
+     *
+     * @example
+     * ```ts
+     * // Remove from scene, keep GPU resources (safe if geometry is shared)
+     * objects.deleteEntity(world, entityId);
+     *
+     * // Remove from scene and free GPU memory (use for one-off spawned objects)
+     * objects.deleteEntity(world, entityId, true);
+     * ```
+     */
+    deleteEntity(world: World, entityId: EntityId, dispose?: boolean): boolean;
     setParent(world: World, entityId: EntityId, parentId: EntityId | null, options?: {
         preserveWorldTransform?: boolean;
     }): boolean;

package/dist/{Video-D6mObK_5.d.ts → Video-ACTSfWjH.d.cts}

@@ -1,5 +1,5 @@
 import * as THREE from 'three';
-import { C as Component, e as EcsEntityKind, m as EcsEntityEditorKind, n as EntityId } from './System-AV2_87Zr.js';
+import { C as Component, e as EcsEntityKind, m as EcsEntityEditorKind, n as EntityId } from './System-CHCucemW.cjs';
 import * as RAPIER from '@dimforge/rapier3d-compat';
 
 interface StateMachine {
@@ -685,7 +685,7 @@ declare class InstancedMeshComponent extends Component {
      */
     instanceEntityIds: number[];
     /**
-     * Live runtime container managed by {@link InstancedMeshSystem}:
+     * Live runtime container managed by `InstancedMeshSystem`:
      * - For primitive kinds: a `THREE.InstancedMesh`.
      * - For `"model"` kind: a `THREE.Group` containing per-mesh `THREE.InstancedMesh` objects.
      * Excluded from snapshot serialization — do **not** read this in hydration code.

package/dist/{Video-Bn93p6XV.d.cts → Video-B9ZKmBIT.d.ts}

@@ -1,5 +1,5 @@
 import * as THREE from 'three';
-import { C as Component, e as EcsEntityKind, m as EcsEntityEditorKind, n as EntityId } from './System-AV2_87Zr.cjs';
+import { C as Component, e as EcsEntityKind, m as EcsEntityEditorKind, n as EntityId } from './System-CHCucemW.js';
 import * as RAPIER from '@dimforge/rapier3d-compat';
 
 interface StateMachine {
@@ -685,7 +685,7 @@ declare class InstancedMeshComponent extends Component {
      */
     instanceEntityIds: number[];
     /**
-     * Live runtime container managed by {@link InstancedMeshSystem}:
+     * Live runtime container managed by `InstancedMeshSystem`:
      * - For primitive kinds: a `THREE.InstancedMesh`.
      * - For `"model"` kind: a `THREE.Group` containing per-mesh `THREE.InstancedMesh` objects.
      * Excluded from snapshot serialization — do **not** read this in hydration code.

package/dist/{chunk-Y7KXYSPD.js → chunk-ON4E5E5O.js}

@@ -1,5 +1,5 @@
-import { resolveDracoDecoderPath, applyTransform } from './chunk-ODCWJHPS.js';
-import { AnimationComponent, ModelComponent, CameraComponent, Object3DRef, Environment, Postprocessing, TransformComponent, PhysicsComponent, LightComponent, MaterialComponent, DEFAULT_MESH_GEOMETRY_PARAMETERS, MeshGeometryComponent, InstancedMeshComponent, ParentId, ScriptComponent, AudioComponent, VideoComponent } from './chunk-AZR6SLQN.js';
+import { resolveDracoDecoderPath, applyTransform } from './chunk-PH43YHUT.js';
+import { AnimationComponent, ModelComponent, CameraComponent, Object3DRef, Environment, Postprocessing, TransformComponent, PhysicsComponent, LightComponent, MaterialComponent, DEFAULT_MESH_GEOMETRY_PARAMETERS, MeshGeometryComponent, InstancedMeshComponent, ParentId, ScriptComponent, AudioComponent, VideoComponent } from './chunk-XPCVEXMY.js';
 import { __name } from './chunk-OY7ZODZP.js';
 import * as THREE7 from 'three';
 import { DRACOLoader } from 'three/examples/jsm/loaders/DRACOLoader.js';
@@ -3619,5 +3619,5 @@ __name(_VideoSystem, "VideoSystem");
 var VideoSystem = _VideoSystem;
 
 export { AnimationSystem, AudioSystem, Behaviour, CameraSyncSystem, EnvironmentSyncSystem, InputSystem, InstancedMeshSystem, KeyboardKeys, LightSyncSystem, MaterialSyncSystem, MeshGeometrySystem, ObjectVisibilitySystem, PhysicsSyncSystem, PostprocessingSyncSystem, RenderSystem, ScriptBehaviourSystem, TransformSyncSystem, VideoSystem };
-//# sourceMappingURL=chunk-Y7KXYSPD.js.map
-//# sourceMappingURL=chunk-Y7KXYSPD.js.map
+//# sourceMappingURL=chunk-ON4E5E5O.js.map
+//# sourceMappingURL=chunk-ON4E5E5O.js.map