@relu-interactives/spatial-ecs 0.2.2

package/dist/index.d.cts

@@ -0,0 +1,283 @@
+import { E as EcsSystem, C as Component, W as WorldEntityView, T as TransformComponent, b as World, c as ComponentClass, d as ParentLookup, e as EcsEntityKind, O as ObjectManagementSystem } from './System-rXAmagXA.cjs';
+export { A as AssetInput, f as CheckboxInput, g as ColorInput, h as ComponentFactory, i as ComponentInput, j as ComponentKind, D as DropdownInput, k as DropdownOption, l as EcsComponentFactoryKind, m as EcsEntityEditorKind, n as EntityId, o as EntityInput, F as FloatInput, I as InputSystem, p as IntersectionResult, K as KeyboardKey, q as KeyboardKeys, M as MouseButton, R as RenderSystem, S as SelectionListener, r as SliderInput, s as TextInput, t as ToggleInput, u as TransformSyncSystem, v as Vec3, w as Vector2Input, x as Vector3Input } from './System-rXAmagXA.cjs';
+import * as THREE from 'three';
+import { P as Object3DRef } from './Video-CDemv74U.cjs';
+export { a7 as AnimationStateCallbacks, a8 as AnimationStateMachine, a9 as AnimationStateManager, aa as StateMachine } from './Video-CDemv74U.cjs';
+export { i as CoreComponents } from './index-B4-YyUNR.cjs';
+export { AnimationSystem, AudioSystem, CameraSyncSystem, EnvironmentSyncSystem, LightSyncSystem, MaterialSyncSystem, MeshGeometrySystem, ObjectVisibilitySystem, PhysicsSyncSystem, PostprocessingSyncSystem, ScriptBehaviourSystem, SelectionContext, VideoSystem } from './systems/index.cjs';
+export { createAnimationComponent, createAudioComponent, createCameraComponent, createEntityTypeComponent, createEnvironmentComponent, createImageComponent, createImageTargetAnchorComponent, createImageTargetComponent, createLightComponent, createMaterialComponent, createMeshComponent, createMeshGeometryComponent, createModelComponent, createNameComponent, createObject3DRefComponent, createParentIdComponent, createPhysicsComponent, createPostprocessingComponent, createScriptComponent, createSelectableComponent, createSelectionTransformStateComponent, createSpriteComponent, createTransformComponent, createVideoComponent, registerDefaultComponentFactories, registerDefaultFactories } from './factories/index.cjs';
+import '@dimforge/rapier3d-compat';
+
+interface CustomEcsSystem extends EcsSystem {
+    data: Component | Record<string, unknown>;
+}
+
+/**
+ * Base class for all user-authored scripts attached to an entity through a
+ * `ScriptComponent`. Subclass `Behaviour` to drive per-frame logic on a single
+ * entity with full access to the {@link World}, the entity's
+ * {@link TransformComponent}, and its three.js {@link Object3DRef}.
+ *
+ * @remarks
+ * Scripts are dispatched by `ScriptBehaviourSystem` once per frame in this
+ * order: {@link Behaviour.init} (first frame only) → {@link Behaviour.onUpdate}.
+ * Override {@link Behaviour.onUpdate} for per-frame logic — never override
+ * {@link Behaviour.update}, which is the engine-managed entry point.
+ *
+ * **Editor scripts**: By default, `Behaviour` subclasses do not run inside the
+ * editor. Set `executeInEditor: true` on the script entry in the inspector to
+ * enable the full lifecycle (`init` → `onUpdate` → `dispose`) while the editor
+ * is open. This gives direct access to the Three.js scene, camera, and renderer
+ * via {@link World.getScene}, {@link World.getCamera}, and
+ * {@link World.getRenderer} — useful for custom shaders, procedural geometry,
+ * grass, and any Three.js feature the editor's object palette does not expose.
+ * Avoid mutating ECS component state every frame in editor mode, as it creates
+ * undo history entries on every tick.
+ *
+ * The runtime recognizes a script by its **default export** plus the
+ * inherited static marker `__reluBehaviourClass`. Do not override the marker.
+ *
+ * @example
+ * ```ts
+ * import { Behaviour, type Component } from "@relu-interactives/spatial-ecs";
+ *
+ *
+ * export default class Spinner extends Behaviour {
+ *   data: {
+ *    speed: number;
+ *    axis: "x" | "y" | "z";
+ *  };
+ *
+ *   init() {
+ *     this.data.speed ??= 1;
+ *     this.data.axis ??= "y";
+ *   }
+ *
+ *   onUpdate() {
+ *     this.transform.rotation[this.data.axis] += this.data.speed * this.deltaTime;
+ *   }
+ * }
+ * ```
+ *
+ * @see {@link World}
+ * @see {@link TransformComponent}
+ * @see {@link Object3DRef}
+ *
+ * @category Scripting
+ */
+declare class Behaviour implements CustomEcsSystem {
+    /**
+     * Static marker used by `ScriptBehaviourSystem` to detect `Behaviour`
+     * subclasses across bundle-identity splits (esbuild may produce a second
+     * copy of the package when scripts are bundled, breaking `instanceof`).
+     * Inherited by every subclass via the prototype chain.
+     *
+     * @internal
+     */
+    static readonly __reluBehaviourClass: true;
+    /**
+     * Inspector-bound payload from the entity's `ScriptComponent`. Override the
+     * type on subclasses with `declare data: MyDataShape` to get type safety
+     * inside hooks. Saved with the project so values persist across reloads.
+     */
+    data: Component | Record<string, unknown>;
+    /** Numeric id of the entity this script is attached to. */
+    entityId: number;
+    /** View of the owning entity (id + components) at construction time. */
+    entity: WorldEntityView;
+    /**
+     * Live three.js object wrapper for the entity. May be `null` for entities
+     * with no scene presence; helpers on this class return `null` in that case.
+     */
+    threeRef: Object3DRef;
+    /**
+     * The entity's {@link TransformComponent}. Mutating `position`, `rotation`,
+     * or `scale` here is picked up the same frame by `TransformSyncSystem`.
+     */
+    transform: TransformComponent;
+    /**
+     * The owning {@link World}. Refreshed each frame in {@link Behaviour.update}.
+     * Use it to query other entities or components.
+     */
+    world: World;
+    /**
+     * Seconds elapsed since the last frame. Set by the engine before each
+     * {@link Behaviour.onUpdate}.
+     */
+    deltaTime: number;
+    /**
+     * Engine-managed constructor. Hosts (`ScriptBehaviourSystem`) instantiate
+     * subclasses with the owning world, the entity id, and the script's `data`
+     * payload. User code should not call this directly.
+     *
+     * @param world - The owning ECS world.
+     * @param entityId - The entity this script is bound to.
+     * @param component - The `ScriptComponent.data` payload, or any object that
+     *   should be exposed to the script as `this.data`.
+     */
+    constructor(world: World, entityId: number, component: Component | Record<string, unknown>);
+    /**
+     * Engine-managed per-frame entry point. Refreshes {@link Behaviour.deltaTime}
+     * and delegates to {@link Behaviour.onUpdate}.
+     *
+     * @remarks Do **not** override this method — override
+     * {@link Behaviour.onUpdate} instead.
+     *
+     * @param world - The owning world (may differ from the constructor world
+     *   after hot reload).
+     * @param deltaTime - Seconds since the last frame.
+     */
+    update(world: World, deltaTime: number): void;
+    /**
+     * Optional cleanup hook invoked when the script is detached or the entity
+     * is destroyed. Override to release timers, listeners, or other resources.
+     *
+     * @param world - The owning world at disposal time.
+     */
+    dispose?(world: World): void;
+    /**
+     * Returns the entity's world-space position as a new `THREE.Vector3`, or
+     * `null` if the entity has no scene presence.
+     */
+    getWorldPosition(): THREE.Vector3 | null;
+    /**
+     * Returns the entity's forward direction in world space (the +Z axis of its
+     * world matrix), or `null` if the entity has no scene presence.
+     */
+    getWorldDirection(): THREE.Vector3 | null;
+    /**
+     * Returns a unit vector pointing from this entity toward the given world
+     * position, or `null` if the entity has no scene presence.
+     *
+     * @param targetPosition - Destination point in world space.
+     */
+    directionTo(targetPosition: THREE.Vector3): THREE.Vector3 | null;
+    /**
+     * Returns the world-space distance from this entity to the given position,
+     * or `null` if the entity has no scene presence.
+     *
+     * @param targetPosition - Destination point in world space.
+     */
+    distanceTo(targetPosition: THREE.Vector3): number | null;
+    /**
+     * Linearly interpolates the entity's position toward `targetPosition` and
+     * writes the result back through {@link TransformComponent}. No-op if the
+     * entity has no scene presence.
+     *
+     * @param targetPosition - Destination point in world space.
+     * @param alpha - Interpolation factor in [0, 1]. Multiply by `deltaTime`
+     *   for frame-rate-independent smoothing.
+     */
+    lerpTo(targetPosition: THREE.Vector3, alpha: number): void;
+    /**
+     * Spherically interpolates the entity's rotation toward `targetRotation`
+     * and writes the result back through {@link TransformComponent}. No-op if
+     * the entity has no scene presence.
+     *
+     * @param targetRotation - Destination orientation as a quaternion.
+     * @param alpha - Interpolation factor in [0, 1].
+     */
+    slerpTo(targetRotation: THREE.Quaternion, alpha: number): void;
+    /**
+     * Rotates the entity to face `targetPosition` in world space and writes the
+     * resulting orientation back through {@link TransformComponent}. No-op if
+     * the entity has no scene presence.
+     *
+     * @param targetPosition - Point in world space to face.
+     */
+    lookAt(targetPosition: THREE.Vector3): void;
+    /** Returns every component currently attached to this entity. */
+    getComponents(): Component[];
+    /**
+     * Returns the entity's component of the given class, or `null` if it has
+     * no such component.
+     *
+     * @typeParam T - Concrete component type.
+     * @param componentClass - Component class constructor to look up.
+     *
+     * @example
+     * ```ts
+     * const mesh = this.getComponent(MeshComponent);
+     * if (mesh) console.log(mesh.geometryRef);
+     * ```
+     */
+    getComponent<T extends Component>(componentClass: ComponentClass<T>): T | null;
+    /**
+     * Returns the latest {@link WorldEntityView} snapshot for this entity, or
+     * `null` if it was destroyed.
+     */
+    getEntity(): WorldEntityView | null;
+    /**
+     * Resolves the entity's parent from the {@link ParentId} component, if any.
+     *
+     * @returns A {@link ParentLookup} with the parent component reference and
+     *   the parent entity view (or `null` if the entity is at the root).
+     */
+    getParent(): ParentLookup;
+    /**
+     * Returns every direct child entity of this one (entities whose
+     * {@link ParentId} matches `entityId`).
+     */
+    getChildren(): WorldEntityView[];
+    /**
+     * Called once before the first {@link Behaviour.onUpdate}. Override to
+     * default and validate {@link Behaviour.data}, cache references, or set
+     * initial state.
+     *
+     * @remarks
+     * Also called in editor mode when `executeInEditor` is `true` on the script
+     * entry.
+     */
+    protected init(): void;
+    /**
+     * Called every frame while the script is enabled. Override with the
+     * script's main per-frame logic.
+     *
+     * @remarks
+     * Also called every frame in editor mode when `executeInEditor` is `true`.
+     * Access the Three.js scene with `this.world.getScene()` for editor-only
+     * rendering work such as custom shaders or procedural geometry.
+     */
+    protected onUpdate(): void;
+    /** Called when the editor selects this entity. Optional UX hook. */
+    onSelect(): void;
+    /** Called when the editor deselects this entity. Optional UX hook. */
+    onDeselect(): void;
+    /**
+     * Called when an image-tracking target this entity depends on becomes
+     * visible. Optional AR hook.
+     *
+     * @param target - The newly-visible target entity view.
+     */
+    onTargetFound(target: WorldEntityView): void;
+    /**
+     * Called when an image-tracking target this entity depends on is lost.
+     * Optional AR hook.
+     *
+     * @param target - The target entity view that became invisible.
+     */
+    onTargetLost(target: WorldEntityView): void;
+}
+
+type EcsWorldComponentSnapshot = {
+    component: string;
+    entries: Array<{
+        entityId: number;
+        value: unknown;
+    }>;
+};
+type EcsWorldStateSnapshotLike = {
+    selectedEntityId?: number | null;
+    entities: number[];
+    components: EcsWorldComponentSnapshot[];
+};
+type HydrateWorldFromSnapshotResult = {
+    restoredCount: number;
+    selectedEntityId: number | null;
+};
+declare const HYDRATABLE_ENTITY_KINDS: Set<EcsEntityKind>;
+
+declare function hydrateWorldFromSnapshotDetailed(snapshot: EcsWorldStateSnapshotLike | null | undefined, world: World, objectManagementSystem: ObjectManagementSystem): HydrateWorldFromSnapshotResult;
+declare function hydrateWorldFromSnapshot(snapshot: EcsWorldStateSnapshotLike | null | undefined, world: World, objectManagementSystem: ObjectManagementSystem): number;
+
+export { Behaviour, Component, EcsEntityKind, EcsSystem, type EcsWorldComponentSnapshot, type EcsWorldStateSnapshotLike, HYDRATABLE_ENTITY_KINDS, type HydrateWorldFromSnapshotResult, ObjectManagementSystem, ParentLookup, World, WorldEntityView, hydrateWorldFromSnapshot, hydrateWorldFromSnapshotDetailed };

package/dist/index.d.ts

@@ -0,0 +1,283 @@
+import { E as EcsSystem, C as Component, W as WorldEntityView, T as TransformComponent, b as World, c as ComponentClass, d as ParentLookup, e as EcsEntityKind, O as ObjectManagementSystem } from './System-rXAmagXA.js';
+export { A as AssetInput, f as CheckboxInput, g as ColorInput, h as ComponentFactory, i as ComponentInput, j as ComponentKind, D as DropdownInput, k as DropdownOption, l as EcsComponentFactoryKind, m as EcsEntityEditorKind, n as EntityId, o as EntityInput, F as FloatInput, I as InputSystem, p as IntersectionResult, K as KeyboardKey, q as KeyboardKeys, M as MouseButton, R as RenderSystem, S as SelectionListener, r as SliderInput, s as TextInput, t as ToggleInput, u as TransformSyncSystem, v as Vec3, w as Vector2Input, x as Vector3Input } from './System-rXAmagXA.js';
+import * as THREE from 'three';
+import { P as Object3DRef } from './Video-ChKV1UI7.js';
+export { a7 as AnimationStateCallbacks, a8 as AnimationStateMachine, a9 as AnimationStateManager, aa as StateMachine } from './Video-ChKV1UI7.js';
+export { i as CoreComponents } from './index-BZUOKeTO.js';
+export { AnimationSystem, AudioSystem, CameraSyncSystem, EnvironmentSyncSystem, LightSyncSystem, MaterialSyncSystem, MeshGeometrySystem, ObjectVisibilitySystem, PhysicsSyncSystem, PostprocessingSyncSystem, ScriptBehaviourSystem, SelectionContext, VideoSystem } from './systems/index.js';
+export { createAnimationComponent, createAudioComponent, createCameraComponent, createEntityTypeComponent, createEnvironmentComponent, createImageComponent, createImageTargetAnchorComponent, createImageTargetComponent, createLightComponent, createMaterialComponent, createMeshComponent, createMeshGeometryComponent, createModelComponent, createNameComponent, createObject3DRefComponent, createParentIdComponent, createPhysicsComponent, createPostprocessingComponent, createScriptComponent, createSelectableComponent, createSelectionTransformStateComponent, createSpriteComponent, createTransformComponent, createVideoComponent, registerDefaultComponentFactories, registerDefaultFactories } from './factories/index.js';
+import '@dimforge/rapier3d-compat';
+
+interface CustomEcsSystem extends EcsSystem {
+    data: Component | Record<string, unknown>;
+}
+
+/**
+ * Base class for all user-authored scripts attached to an entity through a
+ * `ScriptComponent`. Subclass `Behaviour` to drive per-frame logic on a single
+ * entity with full access to the {@link World}, the entity's
+ * {@link TransformComponent}, and its three.js {@link Object3DRef}.
+ *
+ * @remarks
+ * Scripts are dispatched by `ScriptBehaviourSystem` once per frame in this
+ * order: {@link Behaviour.init} (first frame only) → {@link Behaviour.onUpdate}.
+ * Override {@link Behaviour.onUpdate} for per-frame logic — never override
+ * {@link Behaviour.update}, which is the engine-managed entry point.
+ *
+ * **Editor scripts**: By default, `Behaviour` subclasses do not run inside the
+ * editor. Set `executeInEditor: true` on the script entry in the inspector to
+ * enable the full lifecycle (`init` → `onUpdate` → `dispose`) while the editor
+ * is open. This gives direct access to the Three.js scene, camera, and renderer
+ * via {@link World.getScene}, {@link World.getCamera}, and
+ * {@link World.getRenderer} — useful for custom shaders, procedural geometry,
+ * grass, and any Three.js feature the editor's object palette does not expose.
+ * Avoid mutating ECS component state every frame in editor mode, as it creates
+ * undo history entries on every tick.
+ *
+ * The runtime recognizes a script by its **default export** plus the
+ * inherited static marker `__reluBehaviourClass`. Do not override the marker.
+ *
+ * @example
+ * ```ts
+ * import { Behaviour, type Component } from "@relu-interactives/spatial-ecs";
+ *
+ *
+ * export default class Spinner extends Behaviour {
+ *   data: {
+ *    speed: number;
+ *    axis: "x" | "y" | "z";
+ *  };
+ *
+ *   init() {
+ *     this.data.speed ??= 1;
+ *     this.data.axis ??= "y";
+ *   }
+ *
+ *   onUpdate() {
+ *     this.transform.rotation[this.data.axis] += this.data.speed * this.deltaTime;
+ *   }
+ * }
+ * ```
+ *
+ * @see {@link World}
+ * @see {@link TransformComponent}
+ * @see {@link Object3DRef}
+ *
+ * @category Scripting
+ */
+declare class Behaviour implements CustomEcsSystem {
+    /**
+     * Static marker used by `ScriptBehaviourSystem` to detect `Behaviour`
+     * subclasses across bundle-identity splits (esbuild may produce a second
+     * copy of the package when scripts are bundled, breaking `instanceof`).
+     * Inherited by every subclass via the prototype chain.
+     *
+     * @internal
+     */
+    static readonly __reluBehaviourClass: true;
+    /**
+     * Inspector-bound payload from the entity's `ScriptComponent`. Override the
+     * type on subclasses with `declare data: MyDataShape` to get type safety
+     * inside hooks. Saved with the project so values persist across reloads.
+     */
+    data: Component | Record<string, unknown>;
+    /** Numeric id of the entity this script is attached to. */
+    entityId: number;
+    /** View of the owning entity (id + components) at construction time. */
+    entity: WorldEntityView;
+    /**
+     * Live three.js object wrapper for the entity. May be `null` for entities
+     * with no scene presence; helpers on this class return `null` in that case.
+     */
+    threeRef: Object3DRef;
+    /**
+     * The entity's {@link TransformComponent}. Mutating `position`, `rotation`,
+     * or `scale` here is picked up the same frame by `TransformSyncSystem`.
+     */
+    transform: TransformComponent;
+    /**
+     * The owning {@link World}. Refreshed each frame in {@link Behaviour.update}.
+     * Use it to query other entities or components.
+     */
+    world: World;
+    /**
+     * Seconds elapsed since the last frame. Set by the engine before each
+     * {@link Behaviour.onUpdate}.
+     */
+    deltaTime: number;
+    /**
+     * Engine-managed constructor. Hosts (`ScriptBehaviourSystem`) instantiate
+     * subclasses with the owning world, the entity id, and the script's `data`
+     * payload. User code should not call this directly.
+     *
+     * @param world - The owning ECS world.
+     * @param entityId - The entity this script is bound to.
+     * @param component - The `ScriptComponent.data` payload, or any object that
+     *   should be exposed to the script as `this.data`.
+     */
+    constructor(world: World, entityId: number, component: Component | Record<string, unknown>);
+    /**
+     * Engine-managed per-frame entry point. Refreshes {@link Behaviour.deltaTime}
+     * and delegates to {@link Behaviour.onUpdate}.
+     *
+     * @remarks Do **not** override this method — override
+     * {@link Behaviour.onUpdate} instead.
+     *
+     * @param world - The owning world (may differ from the constructor world
+     *   after hot reload).
+     * @param deltaTime - Seconds since the last frame.
+     */
+    update(world: World, deltaTime: number): void;
+    /**
+     * Optional cleanup hook invoked when the script is detached or the entity
+     * is destroyed. Override to release timers, listeners, or other resources.
+     *
+     * @param world - The owning world at disposal time.
+     */
+    dispose?(world: World): void;
+    /**
+     * Returns the entity's world-space position as a new `THREE.Vector3`, or
+     * `null` if the entity has no scene presence.
+     */
+    getWorldPosition(): THREE.Vector3 | null;
+    /**
+     * Returns the entity's forward direction in world space (the +Z axis of its
+     * world matrix), or `null` if the entity has no scene presence.
+     */
+    getWorldDirection(): THREE.Vector3 | null;
+    /**
+     * Returns a unit vector pointing from this entity toward the given world
+     * position, or `null` if the entity has no scene presence.
+     *
+     * @param targetPosition - Destination point in world space.
+     */
+    directionTo(targetPosition: THREE.Vector3): THREE.Vector3 | null;
+    /**
+     * Returns the world-space distance from this entity to the given position,
+     * or `null` if the entity has no scene presence.
+     *
+     * @param targetPosition - Destination point in world space.
+     */
+    distanceTo(targetPosition: THREE.Vector3): number | null;
+    /**
+     * Linearly interpolates the entity's position toward `targetPosition` and
+     * writes the result back through {@link TransformComponent}. No-op if the
+     * entity has no scene presence.
+     *
+     * @param targetPosition - Destination point in world space.
+     * @param alpha - Interpolation factor in [0, 1]. Multiply by `deltaTime`
+     *   for frame-rate-independent smoothing.
+     */
+    lerpTo(targetPosition: THREE.Vector3, alpha: number): void;
+    /**
+     * Spherically interpolates the entity's rotation toward `targetRotation`
+     * and writes the result back through {@link TransformComponent}. No-op if
+     * the entity has no scene presence.
+     *
+     * @param targetRotation - Destination orientation as a quaternion.
+     * @param alpha - Interpolation factor in [0, 1].
+     */
+    slerpTo(targetRotation: THREE.Quaternion, alpha: number): void;
+    /**
+     * Rotates the entity to face `targetPosition` in world space and writes the
+     * resulting orientation back through {@link TransformComponent}. No-op if
+     * the entity has no scene presence.
+     *
+     * @param targetPosition - Point in world space to face.
+     */
+    lookAt(targetPosition: THREE.Vector3): void;
+    /** Returns every component currently attached to this entity. */
+    getComponents(): Component[];
+    /**
+     * Returns the entity's component of the given class, or `null` if it has
+     * no such component.
+     *
+     * @typeParam T - Concrete component type.
+     * @param componentClass - Component class constructor to look up.
+     *
+     * @example
+     * ```ts
+     * const mesh = this.getComponent(MeshComponent);
+     * if (mesh) console.log(mesh.geometryRef);
+     * ```
+     */
+    getComponent<T extends Component>(componentClass: ComponentClass<T>): T | null;
+    /**
+     * Returns the latest {@link WorldEntityView} snapshot for this entity, or
+     * `null` if it was destroyed.
+     */
+    getEntity(): WorldEntityView | null;
+    /**
+     * Resolves the entity's parent from the {@link ParentId} component, if any.
+     *
+     * @returns A {@link ParentLookup} with the parent component reference and
+     *   the parent entity view (or `null` if the entity is at the root).
+     */
+    getParent(): ParentLookup;
+    /**
+     * Returns every direct child entity of this one (entities whose
+     * {@link ParentId} matches `entityId`).
+     */
+    getChildren(): WorldEntityView[];
+    /**
+     * Called once before the first {@link Behaviour.onUpdate}. Override to
+     * default and validate {@link Behaviour.data}, cache references, or set
+     * initial state.
+     *
+     * @remarks
+     * Also called in editor mode when `executeInEditor` is `true` on the script
+     * entry.
+     */
+    protected init(): void;
+    /**
+     * Called every frame while the script is enabled. Override with the
+     * script's main per-frame logic.
+     *
+     * @remarks
+     * Also called every frame in editor mode when `executeInEditor` is `true`.
+     * Access the Three.js scene with `this.world.getScene()` for editor-only
+     * rendering work such as custom shaders or procedural geometry.
+     */
+    protected onUpdate(): void;
+    /** Called when the editor selects this entity. Optional UX hook. */
+    onSelect(): void;
+    /** Called when the editor deselects this entity. Optional UX hook. */
+    onDeselect(): void;
+    /**
+     * Called when an image-tracking target this entity depends on becomes
+     * visible. Optional AR hook.
+     *
+     * @param target - The newly-visible target entity view.
+     */
+    onTargetFound(target: WorldEntityView): void;
+    /**
+     * Called when an image-tracking target this entity depends on is lost.
+     * Optional AR hook.
+     *
+     * @param target - The target entity view that became invisible.
+     */
+    onTargetLost(target: WorldEntityView): void;
+}
+
+type EcsWorldComponentSnapshot = {
+    component: string;
+    entries: Array<{
+        entityId: number;
+        value: unknown;
+    }>;
+};
+type EcsWorldStateSnapshotLike = {
+    selectedEntityId?: number | null;
+    entities: number[];
+    components: EcsWorldComponentSnapshot[];
+};
+type HydrateWorldFromSnapshotResult = {
+    restoredCount: number;
+    selectedEntityId: number | null;
+};
+declare const HYDRATABLE_ENTITY_KINDS: Set<EcsEntityKind>;
+
+declare function hydrateWorldFromSnapshotDetailed(snapshot: EcsWorldStateSnapshotLike | null | undefined, world: World, objectManagementSystem: ObjectManagementSystem): HydrateWorldFromSnapshotResult;
+declare function hydrateWorldFromSnapshot(snapshot: EcsWorldStateSnapshotLike | null | undefined, world: World, objectManagementSystem: ObjectManagementSystem): number;
+
+export { Behaviour, Component, EcsEntityKind, EcsSystem, type EcsWorldComponentSnapshot, type EcsWorldStateSnapshotLike, HYDRATABLE_ENTITY_KINDS, type HydrateWorldFromSnapshotResult, ObjectManagementSystem, ParentLookup, World, WorldEntityView, hydrateWorldFromSnapshot, hydrateWorldFromSnapshotDetailed };