@esengine/ecs-framework 2.7.1 → 2.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.cjs +1 -1
- package/index.cjs.map +1 -1
- package/index.d.ts +135 -109
- package/index.es5.js +1 -1
- package/index.es5.js.map +1 -1
- package/index.mjs +1 -1
- package/index.mjs.map +1 -1
- package/index.umd.js +1 -1
- package/index.umd.js.map +1 -1
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @esengine/ecs-framework v2.
|
|
2
|
+
* @esengine/ecs-framework v2.11.1
|
|
3
3
|
* TypeScript definitions
|
|
4
4
|
*/
|
|
5
5
|
/**
|
|
@@ -5355,6 +5355,114 @@ declare class IncrementalSerializer {
|
|
|
5355
5355
|
static resetVersion(): void;
|
|
5356
5356
|
}
|
|
5357
5357
|
|
|
5358
|
+
/**
|
|
5359
|
+
* 轻量级实体句柄
|
|
5360
|
+
*
|
|
5361
|
+
* 使用数值表示实体,包含索引和代数信息。
|
|
5362
|
+
* 28位索引 + 20位代数 = 48位,在 JavaScript 安全整数范围内。
|
|
5363
|
+
*
|
|
5364
|
+
* Lightweight entity handle.
|
|
5365
|
+
* Uses numeric value to represent entity with index and generation.
|
|
5366
|
+
* 28-bit index + 20-bit generation = 48-bit, within JavaScript safe integer range.
|
|
5367
|
+
*
|
|
5368
|
+
* @example
|
|
5369
|
+
* ```typescript
|
|
5370
|
+
* const handle = makeHandle(42, 1);
|
|
5371
|
+
* console.log(indexOf(handle)); // 42
|
|
5372
|
+
* console.log(genOf(handle)); // 1
|
|
5373
|
+
* console.log(isValidHandle(handle)); // true
|
|
5374
|
+
* ```
|
|
5375
|
+
*/
|
|
5376
|
+
/**
|
|
5377
|
+
* 实体句柄类型
|
|
5378
|
+
*
|
|
5379
|
+
* 使用 branded type 提供类型安全。
|
|
5380
|
+
*
|
|
5381
|
+
* Entity handle type.
|
|
5382
|
+
* Uses branded type for type safety.
|
|
5383
|
+
*/
|
|
5384
|
+
type EntityHandle = number & {
|
|
5385
|
+
readonly __brand: 'EntityHandle';
|
|
5386
|
+
};
|
|
5387
|
+
/**
|
|
5388
|
+
* 索引位数 | Index bits
|
|
5389
|
+
*/
|
|
5390
|
+
declare const INDEX_BITS = 28;
|
|
5391
|
+
/**
|
|
5392
|
+
* 代数位数 | Generation bits
|
|
5393
|
+
*/
|
|
5394
|
+
declare const GEN_BITS = 20;
|
|
5395
|
+
/**
|
|
5396
|
+
* 索引掩码 | Index mask
|
|
5397
|
+
*/
|
|
5398
|
+
declare const INDEX_MASK: number;
|
|
5399
|
+
/**
|
|
5400
|
+
* 代数掩码 | Generation mask
|
|
5401
|
+
*/
|
|
5402
|
+
declare const GEN_MASK: number;
|
|
5403
|
+
/**
|
|
5404
|
+
* 最大实体数量 | Maximum entity count
|
|
5405
|
+
*/
|
|
5406
|
+
declare const MAX_ENTITIES: number;
|
|
5407
|
+
/**
|
|
5408
|
+
* 最大代数值 | Maximum generation value
|
|
5409
|
+
*/
|
|
5410
|
+
declare const MAX_GENERATION: number;
|
|
5411
|
+
/**
|
|
5412
|
+
* 空句柄常量 | Null handle constant
|
|
5413
|
+
*/
|
|
5414
|
+
declare const NULL_HANDLE: EntityHandle;
|
|
5415
|
+
/**
|
|
5416
|
+
* 创建实体句柄
|
|
5417
|
+
* Create entity handle
|
|
5418
|
+
*
|
|
5419
|
+
* @param index 实体索引 | Entity index
|
|
5420
|
+
* @param generation 实体代数 | Entity generation
|
|
5421
|
+
* @returns 实体句柄 | Entity handle
|
|
5422
|
+
*/
|
|
5423
|
+
declare function makeHandle(index: number, generation: number): EntityHandle;
|
|
5424
|
+
/**
|
|
5425
|
+
* 从句柄提取索引
|
|
5426
|
+
* Extract index from handle
|
|
5427
|
+
*
|
|
5428
|
+
* @param handle 实体句柄 | Entity handle
|
|
5429
|
+
* @returns 实体索引 | Entity index
|
|
5430
|
+
*/
|
|
5431
|
+
declare function indexOf(handle: EntityHandle): number;
|
|
5432
|
+
/**
|
|
5433
|
+
* 从句柄提取代数
|
|
5434
|
+
* Extract generation from handle
|
|
5435
|
+
*
|
|
5436
|
+
* @param handle 实体句柄 | Entity handle
|
|
5437
|
+
* @returns 实体代数 | Entity generation
|
|
5438
|
+
*/
|
|
5439
|
+
declare function genOf(handle: EntityHandle): number;
|
|
5440
|
+
/**
|
|
5441
|
+
* 检查句柄是否有效(非空)
|
|
5442
|
+
* Check if handle is valid (non-null)
|
|
5443
|
+
*
|
|
5444
|
+
* @param handle 实体句柄 | Entity handle
|
|
5445
|
+
* @returns 是否有效 | Whether valid
|
|
5446
|
+
*/
|
|
5447
|
+
declare function isValidHandle(handle: EntityHandle): boolean;
|
|
5448
|
+
/**
|
|
5449
|
+
* 比较两个句柄是否相等
|
|
5450
|
+
* Compare two handles for equality
|
|
5451
|
+
*
|
|
5452
|
+
* @param a 第一个句柄 | First handle
|
|
5453
|
+
* @param b 第二个句柄 | Second handle
|
|
5454
|
+
* @returns 是否相等 | Whether equal
|
|
5455
|
+
*/
|
|
5456
|
+
declare function handleEquals(a: EntityHandle, b: EntityHandle): boolean;
|
|
5457
|
+
/**
|
|
5458
|
+
* 将句柄转换为字符串(用于调试)
|
|
5459
|
+
* Convert handle to string (for debugging)
|
|
5460
|
+
*
|
|
5461
|
+
* @param handle 实体句柄 | Entity handle
|
|
5462
|
+
* @returns 字符串表示 | String representation
|
|
5463
|
+
*/
|
|
5464
|
+
declare function handleToString(handle: EntityHandle): string;
|
|
5465
|
+
|
|
5358
5466
|
/**
|
|
5359
5467
|
* 场景接口定义
|
|
5360
5468
|
*
|
|
@@ -5557,6 +5665,19 @@ type IScene = {
|
|
|
5557
5665
|
* 根据ID查找实体
|
|
5558
5666
|
*/
|
|
5559
5667
|
findEntityById(id: number): Entity | null;
|
|
5668
|
+
/**
|
|
5669
|
+
* 释放实体句柄
|
|
5670
|
+
*
|
|
5671
|
+
* 从句柄管理器中销毁句柄并清理映射关系。
|
|
5672
|
+
* 当实体被销毁时调用此方法。
|
|
5673
|
+
*
|
|
5674
|
+
* Release entity handle.
|
|
5675
|
+
* Destroys the handle in the handle manager and cleans up the mapping.
|
|
5676
|
+
* Called when an entity is destroyed.
|
|
5677
|
+
*
|
|
5678
|
+
* @param handle 实体句柄 | Entity handle
|
|
5679
|
+
*/
|
|
5680
|
+
releaseEntityHandle(handle: EntityHandle): void;
|
|
5560
5681
|
/**
|
|
5561
5682
|
* 根据名称查找实体
|
|
5562
5683
|
*/
|
|
@@ -5824,114 +5945,6 @@ declare class ReferenceTracker {
|
|
|
5824
5945
|
private _findRecord;
|
|
5825
5946
|
}
|
|
5826
5947
|
|
|
5827
|
-
/**
|
|
5828
|
-
* 轻量级实体句柄
|
|
5829
|
-
*
|
|
5830
|
-
* 使用数值表示实体,包含索引和代数信息。
|
|
5831
|
-
* 28位索引 + 20位代数 = 48位,在 JavaScript 安全整数范围内。
|
|
5832
|
-
*
|
|
5833
|
-
* Lightweight entity handle.
|
|
5834
|
-
* Uses numeric value to represent entity with index and generation.
|
|
5835
|
-
* 28-bit index + 20-bit generation = 48-bit, within JavaScript safe integer range.
|
|
5836
|
-
*
|
|
5837
|
-
* @example
|
|
5838
|
-
* ```typescript
|
|
5839
|
-
* const handle = makeHandle(42, 1);
|
|
5840
|
-
* console.log(indexOf(handle)); // 42
|
|
5841
|
-
* console.log(genOf(handle)); // 1
|
|
5842
|
-
* console.log(isValidHandle(handle)); // true
|
|
5843
|
-
* ```
|
|
5844
|
-
*/
|
|
5845
|
-
/**
|
|
5846
|
-
* 实体句柄类型
|
|
5847
|
-
*
|
|
5848
|
-
* 使用 branded type 提供类型安全。
|
|
5849
|
-
*
|
|
5850
|
-
* Entity handle type.
|
|
5851
|
-
* Uses branded type for type safety.
|
|
5852
|
-
*/
|
|
5853
|
-
type EntityHandle = number & {
|
|
5854
|
-
readonly __brand: 'EntityHandle';
|
|
5855
|
-
};
|
|
5856
|
-
/**
|
|
5857
|
-
* 索引位数 | Index bits
|
|
5858
|
-
*/
|
|
5859
|
-
declare const INDEX_BITS = 28;
|
|
5860
|
-
/**
|
|
5861
|
-
* 代数位数 | Generation bits
|
|
5862
|
-
*/
|
|
5863
|
-
declare const GEN_BITS = 20;
|
|
5864
|
-
/**
|
|
5865
|
-
* 索引掩码 | Index mask
|
|
5866
|
-
*/
|
|
5867
|
-
declare const INDEX_MASK: number;
|
|
5868
|
-
/**
|
|
5869
|
-
* 代数掩码 | Generation mask
|
|
5870
|
-
*/
|
|
5871
|
-
declare const GEN_MASK: number;
|
|
5872
|
-
/**
|
|
5873
|
-
* 最大实体数量 | Maximum entity count
|
|
5874
|
-
*/
|
|
5875
|
-
declare const MAX_ENTITIES: number;
|
|
5876
|
-
/**
|
|
5877
|
-
* 最大代数值 | Maximum generation value
|
|
5878
|
-
*/
|
|
5879
|
-
declare const MAX_GENERATION: number;
|
|
5880
|
-
/**
|
|
5881
|
-
* 空句柄常量 | Null handle constant
|
|
5882
|
-
*/
|
|
5883
|
-
declare const NULL_HANDLE: EntityHandle;
|
|
5884
|
-
/**
|
|
5885
|
-
* 创建实体句柄
|
|
5886
|
-
* Create entity handle
|
|
5887
|
-
*
|
|
5888
|
-
* @param index 实体索引 | Entity index
|
|
5889
|
-
* @param generation 实体代数 | Entity generation
|
|
5890
|
-
* @returns 实体句柄 | Entity handle
|
|
5891
|
-
*/
|
|
5892
|
-
declare function makeHandle(index: number, generation: number): EntityHandle;
|
|
5893
|
-
/**
|
|
5894
|
-
* 从句柄提取索引
|
|
5895
|
-
* Extract index from handle
|
|
5896
|
-
*
|
|
5897
|
-
* @param handle 实体句柄 | Entity handle
|
|
5898
|
-
* @returns 实体索引 | Entity index
|
|
5899
|
-
*/
|
|
5900
|
-
declare function indexOf(handle: EntityHandle): number;
|
|
5901
|
-
/**
|
|
5902
|
-
* 从句柄提取代数
|
|
5903
|
-
* Extract generation from handle
|
|
5904
|
-
*
|
|
5905
|
-
* @param handle 实体句柄 | Entity handle
|
|
5906
|
-
* @returns 实体代数 | Entity generation
|
|
5907
|
-
*/
|
|
5908
|
-
declare function genOf(handle: EntityHandle): number;
|
|
5909
|
-
/**
|
|
5910
|
-
* 检查句柄是否有效(非空)
|
|
5911
|
-
* Check if handle is valid (non-null)
|
|
5912
|
-
*
|
|
5913
|
-
* @param handle 实体句柄 | Entity handle
|
|
5914
|
-
* @returns 是否有效 | Whether valid
|
|
5915
|
-
*/
|
|
5916
|
-
declare function isValidHandle(handle: EntityHandle): boolean;
|
|
5917
|
-
/**
|
|
5918
|
-
* 比较两个句柄是否相等
|
|
5919
|
-
* Compare two handles for equality
|
|
5920
|
-
*
|
|
5921
|
-
* @param a 第一个句柄 | First handle
|
|
5922
|
-
* @param b 第二个句柄 | Second handle
|
|
5923
|
-
* @returns 是否相等 | Whether equal
|
|
5924
|
-
*/
|
|
5925
|
-
declare function handleEquals(a: EntityHandle, b: EntityHandle): boolean;
|
|
5926
|
-
/**
|
|
5927
|
-
* 将句柄转换为字符串(用于调试)
|
|
5928
|
-
* Convert handle to string (for debugging)
|
|
5929
|
-
*
|
|
5930
|
-
* @param handle 实体句柄 | Entity handle
|
|
5931
|
-
* @returns 字符串表示 | String representation
|
|
5932
|
-
*/
|
|
5933
|
-
declare function handleToString(handle: EntityHandle): string;
|
|
5934
|
-
|
|
5935
5948
|
/**
|
|
5936
5949
|
* 实体句柄管理器
|
|
5937
5950
|
*
|
|
@@ -6571,6 +6584,19 @@ declare class Scene implements IScene {
|
|
|
6571
6584
|
* @returns 实体实例或 null | Entity instance or null
|
|
6572
6585
|
*/
|
|
6573
6586
|
findEntityByHandle(handle: EntityHandle): Entity | null;
|
|
6587
|
+
/**
|
|
6588
|
+
* 释放实体句柄
|
|
6589
|
+
*
|
|
6590
|
+
* 从句柄管理器中销毁句柄并清理映射关系。
|
|
6591
|
+
* 当实体被销毁时调用此方法。
|
|
6592
|
+
*
|
|
6593
|
+
* Release entity handle.
|
|
6594
|
+
* Destroys the handle in the handle manager and cleans up the mapping.
|
|
6595
|
+
* Called when an entity is destroyed.
|
|
6596
|
+
*
|
|
6597
|
+
* @param handle 实体句柄 | Entity handle
|
|
6598
|
+
*/
|
|
6599
|
+
releaseEntityHandle(handle: EntityHandle): void;
|
|
6574
6600
|
/**
|
|
6575
6601
|
* 根据标签查找实体
|
|
6576
6602
|
* @param tag 实体标签
|