archetype-ecs 1.3.1 → 2.0.0

package/dist/src/EntityManager.d.ts

@@ -0,0 +1,52 @@
+import { type ComponentDef } from './ComponentRegistry.js';
+export type EntityId = number;
+export interface FieldRef {
+    readonly _sym: symbol;
+    readonly _field: string;
+}
+export interface ArchetypeView {
+    readonly id: number;
+    readonly entityIds: EntityId[];
+    readonly count: number;
+    readonly snapshotEntityIds: EntityId[] | null;
+    readonly snapshotCount: number;
+    field(ref: FieldRef): any;
+    fieldStride(ref: FieldRef): number;
+    snapshot(ref: FieldRef): any;
+}
+export interface SerializedData {
+    nextId: number;
+    entities: EntityId[];
+    components: Record<string, Record<string, unknown>>;
+}
+export interface EntityManager {
+    createEntity(): EntityId;
+    destroyEntity(id: EntityId): void;
+    addComponent(entityId: EntityId, type: ComponentDef, data?: any): void;
+    removeComponent(entityId: EntityId, type: ComponentDef): void;
+    getComponent(entityId: EntityId, type: ComponentDef): any;
+    get(entityId: EntityId, fieldRef: FieldRef): any;
+    set(entityId: EntityId, fieldRef: FieldRef, value: any): void;
+    hasComponent(entityId: EntityId, type: ComponentDef): boolean;
+    query(include: ComponentDef[], exclude?: ComponentDef[]): EntityId[];
+    getAllEntities(): EntityId[];
+    createEntityWith(...args: unknown[]): EntityId;
+    count(include: ComponentDef[], exclude?: ComponentDef[]): number;
+    forEach(include: ComponentDef[], callback: (view: ArchetypeView) => void, exclude?: ComponentDef[]): void;
+    onAdd(type: ComponentDef, callback: (entityId: EntityId) => void): () => void;
+    onRemove(type: ComponentDef, callback: (entityId: EntityId) => void): () => void;
+    flushHooks(): void;
+    enableTracking(filterComponent: ComponentDef): void;
+    flushChanges(): {
+        created: Set<EntityId>;
+        destroyed: Set<EntityId>;
+    };
+    flushSnapshots(): void;
+    serialize(symbolToName: Map<symbol, string>, stripComponents?: ComponentDef[], skipEntitiesWith?: ComponentDef[], options?: {
+        serializers?: Map<string, (data: unknown) => unknown>;
+    }): SerializedData;
+    deserialize(data: SerializedData, nameToSymbol: Record<string, ComponentDef>, options?: {
+        deserializers?: Map<string, (data: unknown) => unknown>;
+    }): void;
+}
+export declare function createEntityManager(): EntityManager;