@relu-interactives/spatial-ecs 0.2.11 → 0.2.12

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

@@ -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-KTHuWc-i.d.ts → System-CHCucemW.d.ts}

@@ -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-BnrYbbzu.d.cts → 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-KTHuWc-i.cjs';
+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 {

package/dist/{Video-Ds_0Aj66.d.ts → 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-KTHuWc-i.js';
+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 {

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

@@ -1,4 +1,4 @@
-import { resolveDracoDecoderPath, applyTransform } from './chunk-OIOUWDOS.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';
@@ -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-UU6VYCIO.js.map
-//# sourceMappingURL=chunk-UU6VYCIO.js.map
+//# sourceMappingURL=chunk-ON4E5E5O.js.map
+//# sourceMappingURL=chunk-ON4E5E5O.js.map