@esengine/ecs-framework 2.1.25 → 2.1.26

package/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * @esengine/ecs-framework v2.1.25
+ * @esengine/ecs-framework v2.1.26
  * TypeScript definitions
  */
 /**
@@ -5748,5 +5748,355 @@ declare class Time {
     static checkEvery(interval: number, lastTime: number): boolean;
 }
 
-export { ArchetypeSystem, AsyncEventHandler$1 as AsyncEventHandler, BitMaskOptimizer, BitmapComponentIndex, Bits, Component, ComponentDataCollector, ComponentIndexManager, ComponentPool, ComponentPoolManager, ComponentStorage, ComponentTypeManager, Core, DebugManager, DirtyFlag, DirtyTrackingSystem, ECSEventType, ECSFluentAPI, EVENT_TYPES, Emitter, Entity, EntityDataCollector, EntityList, EntityManager, EntityProcessorList, EntityQueryBuilder, EntitySystem, EventBus, EventHandler$1 as EventHandler, EventPriority, EventTypeValidator, FuncPack, GlobalEventBus, GlobalManager, HashComponentIndex, IdentifierPool, IndexType, IndexUpdateBatcher, IntervalSystem, Matcher, NumberExtension, PassiveSystem, PerformanceDataCollector, PerformanceMonitor, PerformanceWarningType, Pool, PoolManager, ProcessingSystem, QuerySystem, Scene, SceneDataCollector, SystemDataCollector, TieredObjectPool, Time, Timer, TimerManager, TypeSafeEventSystem, TypeUtils, WebSocketManager, createECSAPI };
-export type { Archetype, ArchetypeQueryResult, ComponentType$1 as ComponentType, DirtyData, DirtyListener, EventListenerConfig, EventStats, IComponent, IComponentDebugData, IComponentEventData, ICoreConfig, IECSDebugConfig, IECSDebugData, IEntityDebugData, IEntityEventData, IEventBus, IEventData, IEventListenerConfig, IEventStats, IPerformanceDebugData, IPerformanceEventData, IPoolable, ISceneDebugData, ISceneEventData, ISystemBase, ISystemDebugData, ISystemEventData, ITimer, PerformanceData, PerformanceStats, PerformanceThresholds, PerformanceWarning, PoolStats };
+/**
+ * 可序列化接口
+ *
+ * 实现此接口的类可以被快照系统序列化和反序列化
+ */
+interface ISnapshotable {
+    /**
+     * 序列化对象到可传输的数据格式
+     *
+     * @returns 序列化后的数据
+     */
+    serialize(): any;
+    /**
+     * 从序列化数据恢复对象状态
+     *
+     * @param data - 序列化数据
+     */
+    deserialize(data: any): void;
+}
+/**
+ * 快照配置接口
+ */
+interface SnapshotConfig {
+    /** 是否包含在快照中 */
+    includeInSnapshot: boolean;
+    /** 压缩级别 (0-9) */
+    compressionLevel: number;
+    /** 同步优先级 (数字越大优先级越高) */
+    syncPriority: number;
+    /** 是否启用增量快照 */
+    enableIncremental: boolean;
+}
+/**
+ * 组件快照数据
+ */
+interface ComponentSnapshot {
+    /** 组件类型名称 */
+    type: string;
+    /** 组件ID */
+    id: number;
+    /** 序列化数据 */
+    data: any;
+    /** 是否启用 */
+    enabled: boolean;
+    /** 快照配置 */
+    config?: SnapshotConfig;
+}
+/**
+ * 实体快照数据
+ */
+interface EntitySnapshot {
+    /** 实体ID */
+    id: number;
+    /** 实体名称 */
+    name: string;
+    /** 是否启用 */
+    enabled: boolean;
+    /** 是否激活 */
+    active: boolean;
+    /** 标签 */
+    tag: number;
+    /** 更新顺序 */
+    updateOrder: number;
+    /** 组件快照列表 */
+    components: ComponentSnapshot[];
+    /** 子实体ID列表 */
+    children: number[];
+    /** 父实体ID */
+    parent?: number;
+    /** 快照时间戳 */
+    timestamp: number;
+}
+/**
+ * 场景快照数据
+ */
+interface SceneSnapshot {
+    /** 实体快照列表 */
+    entities: EntitySnapshot[];
+    /** 快照时间戳 */
+    timestamp: number;
+    /** 框架版本 */
+    version: string;
+    /** 快照类型 */
+    type: 'full' | 'incremental';
+    /** 基础快照ID（增量快照使用） */
+    baseSnapshotId?: string;
+}
+
+/**
+ * 快照管理器
+ *
+ * 负责创建和管理ECS系统的快照，支持完整快照和增量快照
+ */
+declare class SnapshotManager {
+    /** 默认快照配置 */
+    private static readonly DEFAULT_CONFIG;
+    /** 框架版本 */
+    private readonly version;
+    /** 最后快照时间戳 */
+    private lastSnapshotTime;
+    /** 快照缓存 */
+    private snapshotCache;
+    /** 最大缓存数量 */
+    private maxCacheSize;
+    /**
+     * 创建场景快照
+     *
+     * @param entities - 实体列表
+     * @param type - 快照类型
+     * @returns 场景快照
+     */
+    createSceneSnapshot(entities: Entity[], type?: 'full' | 'incremental'): SceneSnapshot;
+    /**
+     * 从快照恢复场景
+     *
+     * @param snapshot - 场景快照
+     * @param targetEntities - 目标实体列表（用于增量恢复）
+     * @param createMissingEntities - 是否创建缺失的实体
+     */
+    restoreFromSnapshot(snapshot: SceneSnapshot, targetEntities?: Entity[], createMissingEntities?: boolean): Entity[];
+    /**
+     * 从快照恢复实体列表
+     *
+     * @param snapshot - 场景快照
+     * @param targetEntities - 目标实体列表
+     * @param createMissingEntities - 是否创建缺失的实体
+     */
+    restoreEntitiesFromSnapshot(snapshot: SceneSnapshot, targetEntities: Entity[], createMissingEntities?: boolean): Entity[];
+    /**
+     * 从快照创建实体
+     */
+    private createEntityFromSnapshot;
+    /**
+     * 从快照创建组件
+     */
+    private createComponentFromSnapshot;
+    /**
+     * 获取组件类型
+     */
+    private getComponentType;
+    /**
+     * 创建快速快照（跳过变化检测）
+     *
+     * @param entities - 实体列表
+     * @returns 场景快照
+     */
+    createQuickSnapshot(entities: Entity[]): SceneSnapshot;
+    /**
+     * 创建增量快照
+     *
+     * @param entities - 实体列表
+     * @param baseSnapshot - 基础快照
+     * @param enableChangeDetection - 是否启用变化检测
+     * @returns 增量快照
+     */
+    createIncrementalSnapshot(entities: Entity[], baseSnapshot: SceneSnapshot, enableChangeDetection?: boolean): SceneSnapshot;
+    /**
+     * 缓存快照
+     *
+     * @param id - 快照ID
+     * @param snapshot - 快照数据
+     */
+    cacheSnapshot(id: string, snapshot: SceneSnapshot): void;
+    /**
+     * 获取缓存的快照
+     *
+     * @param id - 快照ID
+     * @returns 快照数据或undefined
+     */
+    getCachedSnapshot(id: string): SceneSnapshot | undefined;
+    /**
+     * 清空快照缓存
+     */
+    clearCache(): void;
+    /**
+     * 清空所有缓存
+     */
+    clearAllCaches(): void;
+    /**
+     * 获取缓存统计信息
+     */
+    getCacheStats(): {
+        snapshotCacheSize: number;
+    };
+    /**
+     * 创建实体快照
+     */
+    private createEntitySnapshot;
+    /**
+     * 创建组件快照
+     */
+    private createComponentSnapshot;
+    /**
+     * 默认组件序列化
+     */
+    private defaultSerializeComponent;
+    /**
+     * 检查值是否可序列化
+     */
+    private isSerializableValue;
+    /**
+     * 检查组件是否支持快照
+     */
+    private isComponentSnapshotable;
+    /**
+     * 获取组件快照配置
+     */
+    private getComponentSnapshotConfig;
+    /**
+     * 检查组件是否有序列化方法
+     */
+    private hasSerializeMethod;
+    /**
+     * 恢复完整快照
+     */
+    private restoreFullSnapshot;
+    /**
+     * 恢复增量快照
+     */
+    private restoreIncrementalSnapshot;
+    /**
+     * 从快照恢复实体
+     */
+    private restoreEntityFromSnapshot;
+    /**
+     * 从快照恢复组件
+     */
+    private restoreComponentFromSnapshot;
+    /**
+     * 默认组件反序列化
+     */
+    private defaultDeserializeComponent;
+    /**
+     * 检查实体结构是否发生变化（组件数量、类型等）
+     */
+    private hasEntityStructureChanged;
+    /**
+     * 获取发生变化的组件列表
+     */
+    private getChangedComponents;
+    /**
+     * 检查组件数据是否发生变化
+     */
+    private hasComponentDataChanged;
+    /**
+     * 检查组件是否有变化检测方法
+     */
+    private hasChangeDetectionMethod;
+    /**
+     * 创建增量实体快照（只包含变化的组件）
+     */
+    private createIncrementalEntitySnapshot;
+    /**
+     * 生成快照ID
+     */
+    private generateSnapshotId;
+}
+
+/**
+ * 快照扩展接口
+ *
+ * 为Component基类提供快照功能的扩展接口
+ */
+interface ISnapshotExtension {
+    /** 快照配置 */
+    snapshotConfig?: SnapshotConfig;
+    /** 序列化方法 */
+    serialize?(): any;
+    /** 反序列化方法 */
+    deserialize?(data: any): void;
+    /** 变化检测方法 */
+    hasChanged?(baseData: any): boolean;
+}
+/**
+ * 快照装饰器
+ *
+ * 用于标记组件属性为可序列化
+ */
+declare function Serializable(config?: Partial<SnapshotConfig>): (target: any, propertyKey: string) => void;
+/**
+ * 快照配置装饰器
+ *
+ * 用于配置组件的快照行为
+ */
+declare function SnapshotConfigDecorator(config: SnapshotConfig): (target: any) => void;
+/**
+ * 快照扩展工具类
+ */
+declare class SnapshotExtension {
+    /**
+     * 为组件添加快照支持
+     *
+     * @param component - 目标组件
+     * @param config - 快照配置
+     */
+    static enableSnapshot(component: Component, config?: Partial<SnapshotConfig>): void;
+    /**
+     * 禁用组件的快照功能
+     *
+     * @param component - 目标组件
+     */
+    static disableSnapshot(component: Component): void;
+    /**
+     * 检查组件是否支持快照
+     *
+     * @param component - 目标组件
+     * @returns 是否支持快照
+     */
+    static isSnapshotable(component: Component): boolean;
+    /**
+     * 获取组件的可序列化属性
+     *
+     * @param component - 目标组件
+     * @returns 可序列化属性列表
+     */
+    static getSerializableProperties(component: Component): string[];
+    /**
+     * 创建组件的默认序列化方法
+     *
+     * @param component - 目标组件
+     * @returns 序列化数据
+     */
+    static createDefaultSerializer(component: Component): () => any;
+    /**
+     * 创建组件的默认反序列化方法
+     *
+     * @param component - 目标组件
+     * @returns 反序列化函数
+     */
+    static createDefaultDeserializer(component: Component): (data: any) => void;
+    /**
+     * 创建简单的变化检测方法
+     *
+     * @param component - 目标组件
+     * @returns 变化检测函数
+     */
+    static createSimpleChangeDetector(component: Component): (baseData: any) => boolean;
+    /**
+     * 创建深度变化检测方法
+     *
+     * @param component - 目标组件
+     * @returns 变化检测函数
+     */
+    static createDeepChangeDetector(component: Component): (baseData: any) => boolean;
+    /**
+     * 深度比较两个值
+     */
+    private static deepCompare;
+}
+
+export { ArchetypeSystem, AsyncEventHandler$1 as AsyncEventHandler, BitMaskOptimizer, BitmapComponentIndex, Bits, Component, ComponentDataCollector, ComponentIndexManager, ComponentPool, ComponentPoolManager, ComponentStorage, ComponentTypeManager, Core, DebugManager, DirtyFlag, DirtyTrackingSystem, ECSEventType, ECSFluentAPI, EVENT_TYPES, Emitter, Entity, EntityDataCollector, EntityList, EntityManager, EntityProcessorList, EntityQueryBuilder, EntitySystem, EventBus, EventHandler$1 as EventHandler, EventPriority, EventTypeValidator, FuncPack, GlobalEventBus, GlobalManager, HashComponentIndex, IdentifierPool, IndexType, IndexUpdateBatcher, IntervalSystem, Matcher, NumberExtension, PassiveSystem, PerformanceDataCollector, PerformanceMonitor, PerformanceWarningType, Pool, PoolManager, ProcessingSystem, QuerySystem, Scene, SceneDataCollector, Serializable, SnapshotConfigDecorator, SnapshotExtension, SnapshotManager, SystemDataCollector, TieredObjectPool, Time, Timer, TimerManager, TypeSafeEventSystem, TypeUtils, WebSocketManager, createECSAPI };
+export type { Archetype, ArchetypeQueryResult, ComponentSnapshot, ComponentType$1 as ComponentType, DirtyData, DirtyListener, EntitySnapshot, EventListenerConfig, EventStats, IComponent, IComponentDebugData, IComponentEventData, ICoreConfig, IECSDebugConfig, IECSDebugData, IEntityDebugData, IEntityEventData, IEventBus, IEventData, IEventListenerConfig, IEventStats, IPerformanceDebugData, IPerformanceEventData, IPoolable, ISceneDebugData, ISceneEventData, ISnapshotExtension, ISnapshotable, ISystemBase, ISystemDebugData, ISystemEventData, ITimer, PerformanceData, PerformanceStats, PerformanceThresholds, PerformanceWarning, PoolStats, SceneSnapshot, SnapshotConfig };