@esengine/ecs-framework 2.1.27 → 2.1.28

package/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * @esengine/ecs-framework v2.1.27
+ * @esengine/ecs-framework v2.1.28
  * TypeScript definitions
  */
 /**
@@ -1119,6 +1119,106 @@ declare abstract class Component implements IComponent {
     update(): void;
 }
 
+/**
+ * BigInt兼容性抽象层
+ *
+ * 为不支持BigInt的环境提供兼容实现，确保ECS框架在所有平台上都能正常运行。
+ * 自动检测运行时环境的BigInt支持情况，并提供统一的接口。
+ *
+ * @example
+ * ```typescript
+ * // 创建兼容的BigInt值
+ * const value = BigIntFactory.create(123);
+ *
+ * // 位运算
+ * const result = value.or(BigIntFactory.create(456));
+ *
+ * // 检查兼容性
+ * console.log(BigIntFactory.isNativeSupported()); // true/false
+ * ```
+ */
+/**
+ * BigInt兼容接口
+ *
+ * 定义了BigInt的基本操作接口，支持原生BigInt和兼容实现的统一调用。
+ */
+interface IBigIntLike {
+    /**
+     * 获取数值表示
+     * @returns 数值
+     */
+    valueOf(): number;
+    /**
+     * 转换为字符串
+     * @param radix 进制，支持2、10、16
+     * @returns 字符串表示
+     */
+    toString(radix?: number): string;
+    /**
+     * 位运算：与
+     * @param other 另一个BigInt值
+     * @returns 运算结果
+     */
+    and(other: IBigIntLike): IBigIntLike;
+    /**
+     * 位运算：或
+     * @param other 另一个BigInt值
+     * @returns 运算结果
+     */
+    or(other: IBigIntLike): IBigIntLike;
+    /**
+     * 位运算：异或
+     * @param other 另一个BigInt值
+     * @returns 运算结果
+     */
+    xor(other: IBigIntLike): IBigIntLike;
+    /**
+     * 位运算：非
+     * @param maxBits 最大位数限制
+     * @returns 运算结果
+     */
+    not(maxBits?: number): IBigIntLike;
+    /**
+     * 左移位运算
+     * @param bits 移位数
+     * @returns 运算结果
+     */
+    shiftLeft(bits: number): IBigIntLike;
+    /**
+     * 右移位运算
+     * @param bits 移位数
+     * @returns 运算结果
+     */
+    shiftRight(bits: number): IBigIntLike;
+    /**
+     * 相等比较
+     * @param other 另一个BigInt值
+     * @returns 是否相等
+     */
+    equals(other: IBigIntLike): boolean;
+    /**
+     * 检查是否为零
+     * @returns 是否为零
+     */
+    isZero(): boolean;
+    /**
+     * 创建副本
+     * @returns 新的实例
+     */
+    clone(): IBigIntLike;
+}
+/**
+ * 环境信息接口
+ */
+interface EnvironmentInfo {
+    /** 是否支持BigInt */
+    supportsBigInt: boolean;
+    /** 运行环境 */
+    environment: string;
+    /** JavaScript引擎 */
+    jsEngine: string;
+}
+
 /**
  * 组件类型定义
  */
@@ -1247,7 +1347,7 @@ declare class ComponentStorageManager {
      * @param entityId 实体ID
      * @returns 组件位掩码
      */
-    getComponentMask(entityId: number): bigint;
+    getComponentMask(entityId: number): IBigIntLike;
     /**
      * 压缩所有存储器
      */
@@ -1707,7 +1807,7 @@ declare class Entity {
      *
      * @returns 实体的组件位掩码
      */
-    get componentMask(): bigint;
+    get componentMask(): IBigIntLike;
     /**
      * 创建并添加组件
      *
@@ -2022,33 +2122,60 @@ declare class EntityList {
 
 /**
  * 高性能位操作类
- * 基于BigInt实现，支持任意数量的位操作
+ *
+ * 基于BigInt实现，支持任意数量的位操作。
+ * 自动适配运行环境，在不支持BigInt的环境中使用兼容实现。
+ *
+ * @example
+ * ```typescript
+ * const bits = new Bits();
+ * bits.set(0);
+ * bits.set(5);
+ * console.log(bits.get(0)); // true
+ * console.log(bits.get(1)); // false
+ * ```
  */
 declare class Bits {
     private _value;
-    constructor(initialValue?: bigint);
+    /**
+     * 构造函数
+     * @param initialValue 初始值，可以是IBigIntLike或数值
+     */
+    constructor(initialValue?: IBigIntLike | number | string);
     /**
      * 设置指定位置的位为1
+     * @param index 位索引（从0开始）
+     * @throws {Error} 当索引为负数时抛出错误
      */
     set(index: number): void;
     /**
      * 清除指定位置的位（设为0）
+     * @param index 位索引（从0开始）
+     * @throws {Error} 当索引为负数时抛出错误
      */
     clear(index: number): void;
     /**
      * 获取指定位置的位值
+     * @param index 位索引（从0开始）
+     * @returns 位值（true表示1，false表示0）
      */
     get(index: number): boolean;
     /**
      * 检查是否包含所有指定的位
+     * @param other 另一个Bits对象
+     * @returns 是否包含所有指定的位
      */
     containsAll(other: Bits): boolean;
     /**
      * 检查是否包含任意一个指定的位
+     * @param other 另一个Bits对象
+     * @returns 是否包含任意一个指定的位
      */
     intersects(other: Bits): boolean;
     /**
      * 检查是否不包含任何指定的位
+     * @param other 另一个Bits对象
+     * @returns 是否不包含任何指定的位
      */
     excludes(other: Bits): boolean;
     /**
@@ -2057,74 +2184,100 @@ declare class Bits {
     clearAll(): void;
     /**
      * 检查是否为空（没有设置任何位）
+     * @returns 是否为空
      */
     isEmpty(): boolean;
     /**
      * 获取设置的位数量
+     * @returns 设置为1的位数量
      */
     cardinality(): number;
     /**
      * 位运算：与
+     * @param other 另一个Bits对象
+     * @returns 新的Bits对象，包含与运算结果
      */
     and(other: Bits): Bits;
     /**
      * 位运算：或
+     * @param other 另一个Bits对象
+     * @returns 新的Bits对象，包含或运算结果
      */
     or(other: Bits): Bits;
     /**
      * 位运算：异或
+     * @param other 另一个Bits对象
+     * @returns 新的Bits对象，包含异或运算结果
      */
     xor(other: Bits): Bits;
     /**
      * 位运算：非
+     * @param maxBits 最大位数限制，默认64位
+     * @returns 新的Bits对象，包含非运算结果
      */
     not(maxBits?: number): Bits;
     /**
      * 复制另一个Bits对象
+     * @param other 要复制的Bits对象
      */
     copyFrom(other: Bits): void;
     /**
      * 创建当前Bits的副本
+     * @returns 新的Bits对象副本
      */
     clone(): Bits;
     /**
-     * 获取原始BigInt值
+     * 获取原始值
+     * @returns 原始的IBigIntLike值
      */
-    getValue(): bigint;
+    getValue(): IBigIntLike;
     /**
-     * 设置原始BigInt值
+     * 设置原始值
+     * @param value 新的值，可以是IBigIntLike或数值
      */
-    setValue(value: bigint): void;
+    setValue(value: IBigIntLike | number | string): void;
     /**
      * 获取调试信息
+     * @returns 返回显示设置位索引的字符串
      */
     toString(): string;
     /**
      * 获取二进制表示
+     * @param maxBits 最大位数，默认64位
+     * @returns 二进制字符串表示
      */
     toBinaryString(maxBits?: number): string;
     /**
      * 获取十六进制表示
+     * @returns 十六进制字符串表示
      */
     toHexString(): string;
     /**
      * 从二进制字符串创建Bits
+     * @param binaryString 二进制字符串
+     * @returns 新的Bits对象
      */
     static fromBinaryString(binaryString: string): Bits;
     /**
      * 从十六进制字符串创建Bits
+     * @param hexString 十六进制字符串
+     * @returns 新的Bits对象
      */
     static fromHexString(hexString: string): Bits;
     /**
      * 比较两个Bits对象是否相等
+     * @param other 另一个Bits对象
+     * @returns 是否相等
      */
     equals(other: Bits): boolean;
     /**
      * 获取最高位的索引
+     * @returns 最高位的索引，如果为空则返回-1
      */
     getHighestBitIndex(): number;
     /**
      * 获取最低位的索引
+     * @returns 最低位的索引，如果为空则返回-1
      */
     getLowestBitIndex(): number;
 }
@@ -4510,6 +4663,10 @@ declare class Core {
      * Core配置
      */
     private _config;
+    /**
+     * 兼容性信息
+     */
+    private _environmentInfo;
     /**
      * 创建核心实例
      *
@@ -4633,6 +4790,18 @@ declare class Core {
      * @returns 调试状态
      */
     static get isDebugEnabled(): boolean;
+    /**
+     * 获取环境兼容性信息
+     *
+     * @returns 环境兼容性信息
+     */
+    static getEnvironmentInfo(): EnvironmentInfo | null;
+    /**
+     * 检查BigInt是否支持
+     *
+     * @returns 是否支持BigInt
+     */
+    static get supportsBigInt(): boolean;
     /**
      * 场景切换回调
      *
@@ -4645,6 +4814,12 @@ declare class Core {
      * 执行核心系统的初始化逻辑。
      */
     protected initialize(): void;
+    /**
+     * 记录兼容性信息
+     *
+     * 在控制台输出当前环境的兼容性信息和建议。
+     */
+    private logCompatibilityInfo;
     /**
      * 内部更新方法
      *
@@ -5600,6 +5775,8 @@ declare class IndexUpdateBatcher {
 
 /**
  * 位掩码优化器，用于预计算和缓存常用的组件掩码
+ *
+ * 使用BigInt兼容层确保在所有平台上的正常运行。
  */
 declare class BitMaskOptimizer {
     private static instance;
@@ -5618,32 +5795,51 @@ declare class BitMaskOptimizer {
     getComponentTypeId(componentName: string): number | undefined;
     /**
      * 创建单个组件的掩码
+     * @param componentName 组件名称
+     * @returns 组件掩码
      */
-    createSingleComponentMask(componentName: string): bigint;
+    createSingleComponentMask(componentName: string): IBigIntLike;
     /**
      * 创建多个组件的组合掩码
+     * @param componentNames 组件名称数组
+     * @returns 组合掩码
      */
-    createCombinedMask(componentNames: string[]): bigint;
+    createCombinedMask(componentNames: string[]): IBigIntLike;
     /**
      * 检查掩码是否包含指定组件
+     * @param mask 要检查的掩码
+     * @param componentName 组件名称
+     * @returns 是否包含指定组件
      */
-    maskContainsComponent(mask: bigint, componentName: string): boolean;
+    maskContainsComponent(mask: IBigIntLike, componentName: string): boolean;
     /**
      * 检查掩码是否包含所有指定组件
+     * @param mask 要检查的掩码
+     * @param componentNames 组件名称数组
+     * @returns 是否包含所有指定组件
      */
-    maskContainsAllComponents(mask: bigint, componentNames: string[]): boolean;
+    maskContainsAllComponents(mask: IBigIntLike, componentNames: string[]): boolean;
     /**
      * 检查掩码是否包含任一指定组件
+     * @param mask 要检查的掩码
+     * @param componentNames 组件名称数组
+     * @returns 是否包含任一指定组件
      */
-    maskContainsAnyComponent(mask: bigint, componentNames: string[]): boolean;
+    maskContainsAnyComponent(mask: IBigIntLike, componentNames: string[]): boolean;
     /**
      * 添加组件到掩码
+     * @param mask 原始掩码
+     * @param componentName 要添加的组件名称
+     * @returns 新的掩码
      */
-    addComponentToMask(mask: bigint, componentName: string): bigint;
+    addComponentToMask(mask: IBigIntLike, componentName: string): IBigIntLike;
     /**
      * 从掩码中移除组件
+     * @param mask 原始掩码
+     * @param componentName 要移除的组件名称
+     * @returns 新的掩码
      */
-    removeComponentFromMask(mask: bigint, componentName: string): bigint;
+    removeComponentFromMask(mask: IBigIntLike, componentName: string): IBigIntLike;
     /**
      * 预计算常用掩码组合
      */
@@ -5666,11 +5862,11 @@ declare class BitMaskOptimizer {
     /**
      * 将掩码转换为组件名称数组
      */
-    maskToComponentNames(mask: bigint): string[];
+    maskToComponentNames(mask: IBigIntLike): string[];
     /**
      * 获取掩码中组件的数量
      */
-    getComponentCount(mask: bigint): number;
+    getComponentCount(mask: IBigIntLike): number;
 }
 
 /**