@codehz/ecs 0.0.1 → 0.0.2

package/README.md

@@ -4,10 +4,11 @@
 
 ## 特性
 
-- 🚀 高性能：基于原型的组件存储和高效的查询系统
+- 🚀 高性能：基于 Archetype 的组件存储和高效的查询系统
 - 🔧 类型安全：完整的 TypeScript 支持
 - 🏗️ 模块化：清晰的架构，支持自定义系统和组件
 - 📦 轻量级：零依赖，易于集成
+- ⚡ 内存高效：连续内存布局，优化的迭代性能
 
 ## 安装
 
@@ -44,6 +45,7 @@ world.flushCommands();
 
 // 创建查询并更新
 const query = world.createQuery([PositionId, VelocityId]);
+const deltaTime = 1.0 / 60.0; // 假设60FPS
 query.forEach([PositionId, VelocityId], (entity, position, velocity) => {
   position.x += velocity.x * deltaTime;
   position.y += velocity.y * deltaTime;
@@ -79,6 +81,12 @@ world.flushCommands(); // 钩子在这里被调用
 
 ### 运行示例
 
+```bash
+bun run demo
+```
+
+或者直接运行：
+
 ```bash
 bun run examples/simple/demo.ts
 ```
@@ -104,6 +112,8 @@ bun run examples/simple/demo.ts
 ### Query
 
 - `forEach(componentIds, callback)`: 遍历匹配的实体
+- `getEntities()`: 获取所有匹配实体的ID列表
+- `getEntitiesWithComponents(componentIds)`: 获取实体及其组件数据
 
 ### System
 
@@ -117,6 +127,13 @@ class MySystem implements System {
 }
 ```
 
+## 性能特点
+
+- **Archetype 系统**：实体按组件组合分组，实现连续内存访问
+- **缓存查询**：查询结果自动缓存，减少重复计算
+- **命令缓冲区**：延迟执行组件添加/移除，提高批处理效率
+- **类型安全**：编译时类型检查，无运行时开销
+
 ## 开发
 
 ### 运行测试
@@ -135,20 +152,28 @@ bunx tsc --noEmit
 
 ```
 src/
-├── index.ts          # 入口文件
-├── entity.ts         # 实体和组件管理
-├── world.ts          # 世界管理
-├── archetype.ts      # 原型系统
-├── query.ts          # 查询系统
-├── system.ts         # 系统接口
-├── command-buffer.ts # 命令缓冲区
-├── types.ts          # 类型定义
-└── utils.ts          # 工具函数
+├── index.ts              # 入口文件
+├── entity.ts             # 实体和组件管理
+├── world.ts              # 世界管理
+├── archetype.ts          # Archetype 系统（高效组件存储）
+├── query.ts              # 查询系统
+├── query-filter.ts       # 查询过滤器
+├── system.ts             # 系统接口
+├── command-buffer.ts     # 命令缓冲区
+├── types.ts              # 类型定义
+├── utils.ts              # 工具函数
+├── *.test.ts             # 单元测试
+├── query.example.ts      # 查询示例
+└── *.perf.test.ts        # 性能测试
 
 examples/
 └── simple/
-    ├── demo.ts       # 基本示例
-    └── README.md     # 示例说明
+    ├── demo.ts           # 基本示例
+    └── README.md         # 示例说明
+
+scripts/
+├── build.ts             # 构建脚本
+└── release.ts           # 发布脚本
 ```
 
 ## 许可证

package/archetype.d.ts

@@ -1,4 +1,4 @@
-import type { EntityId } from "./entity";
+import type { EntityId, WildcardRelationId } from "./entity";
 import type { ComponentTuple } from "./types";
 /**
  * Archetype class for ECS architecture
@@ -60,6 +60,13 @@ export declare class Archetype {
      * @param entityId The entity to check
      */
     hasEntity(entityId: EntityId): boolean;
+    /**
+     * Get component data for a specific entity and wildcard relation type
+     * Returns an array of all matching relation instances
+     * @param entityId The entity
+     * @param componentType The wildcard relation type
+     */
+    getComponent<T>(entityId: EntityId, componentType: WildcardRelationId<T>): [EntityId<unknown>, any][] | undefined;
     /**
      * Get component data for a specific entity and component type
      * @param entityId The entity

package/index.d.ts

@@ -3,3 +3,4 @@ export * from "./world";
 export * from "./archetype";
 export * from "./query";
 export * from "./system";
+export * from "./types";

package/index.js

@@ -275,9 +275,29 @@ class Archetype {
   getComponent(entityId, componentType) {
     const index = this.entityToIndex.get(entityId);
     if (index === undefined) {
-      return;
+      if (getIdType(componentType) === "wildcard-relation") {
+        return [];
+      } else {
+        return;
+      }
+    }
+    if (getIdType(componentType) === "wildcard-relation") {
+      const decoded = decodeRelationId(componentType);
+      const componentId = decoded.componentId;
+      const relations = [];
+      for (const relType of this.componentTypes) {
+        const relDecoded = decodeRelationId(relType);
+        if (relDecoded.componentId === componentId && (getIdType(relType) === "entity-relation" || getIdType(relType) === "component-relation")) {
+          const dataArray = this.componentData.get(relType);
+          if (dataArray && dataArray[index] !== undefined) {
+            relations.push([relDecoded.targetId, dataArray[index]]);
+          }
+        }
+      }
+      return relations;
+    } else {
+      return this.componentData.get(componentType)?.[index];
     }
-    return this.componentData.get(componentType)?.[index];
   }
   setComponent(entityId, componentType, data) {
     const index = this.entityToIndex.get(entityId);
@@ -582,12 +602,23 @@ class World {
     if (!this.hasEntity(entityId)) {
       throw new Error(`Entity ${entityId} does not exist`);
     }
+    const detailedType = getDetailedIdType(componentType);
+    if (detailedType.type === "invalid") {
+      throw new Error(`Invalid component type: ${componentType}`);
+    }
+    if (detailedType.type === "wildcard-relation") {
+      throw new Error(`Cannot directly add wildcard relation components: ${componentType}`);
+    }
     this.commandBuffer.addComponent(entityId, componentType, component);
   }
   removeComponent(entityId, componentType) {
     if (!this.hasEntity(entityId)) {
       throw new Error(`Entity ${entityId} does not exist`);
     }
+    const detailedType = getDetailedIdType(componentType);
+    if (detailedType.type === "invalid") {
+      throw new Error(`Invalid component type: ${componentType}`);
+    }
     this.commandBuffer.removeComponent(entityId, componentType);
   }
   destroyEntity(entityId) {
@@ -599,7 +630,14 @@ class World {
   }
   getComponent(entityId, componentType) {
     const archetype = this.entityToArchetype.get(entityId);
-    return archetype ? archetype.getComponent(entityId, componentType) : undefined;
+    if (!archetype) {
+      if (getIdType(componentType) === "wildcard-relation") {
+        return [];
+      } else {
+        return;
+      }
+    }
+    return archetype.getComponent(entityId, componentType);
   }
   registerSystem(system) {
     this.systems.push(system);
@@ -758,8 +796,22 @@ class World {
           break;
         case "removeComponent":
           if (cmd.componentType) {
-            removes.add(cmd.componentType);
-            adds.delete(cmd.componentType);
+            const detailedType = getDetailedIdType(cmd.componentType);
+            if (detailedType.type === "wildcard-relation") {
+              const baseComponentId = detailedType.componentId;
+              for (const componentType of currentArchetype.componentTypes) {
+                const componentDetailedType = getDetailedIdType(componentType);
+                if (componentDetailedType.type === "entity-relation" || componentDetailedType.type === "component-relation") {
+                  if (componentDetailedType.componentId === baseComponentId) {
+                    removes.add(componentType);
+                    adds.delete(componentType);
+                  }
+                }
+              }
+            } else {
+              removes.add(cmd.componentType);
+              adds.delete(cmd.componentType);
+            }
           }
           break;
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codehz/ecs",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "type": "module",
   "main": "./index.js",
   "types": "./index.d.ts",

package/types.d.ts

@@ -1,4 +1,17 @@
 import type { EntityId, WildcardRelationId } from "./entity";
+/**
+ * Hook types for component lifecycle events
+ */
+export interface LifecycleHook<T = unknown> {
+    /**
+     * Called when a component is added to an entity
+     */
+    onAdded?: (entityId: EntityId, componentType: EntityId<T>, component: T) => void;
+    /**
+     * Called when a component is removed from an entity
+     */
+    onRemoved?: (entityId: EntityId, componentType: EntityId<T>) => void;
+}
 /**
  * Type helper for component tuples extracted from EntityId array
  */

package/world.d.ts

@@ -1,37 +1,10 @@
 import { Archetype } from "./archetype";
 import { type Command } from "./command-buffer";
-import type { EntityId } from "./entity";
+import type { EntityId, WildcardRelationId } from "./entity";
 import { Query } from "./query";
 import type { QueryFilter } from "./query-filter";
-import type { ComponentTuple } from "./types";
+import type { ComponentTuple, LifecycleHook } from "./types";
 import type { System } from "./system";
-/**
- * Hook types for component lifecycle events
- */
-export interface ComponentLifecycleHook<T> {
-    /**
-     * Called when a component is added to an entity
-     */
-    onAdded?: (entityId: EntityId, componentType: EntityId<T>, component: T) => void;
-    /**
-     * Called when a component is removed from an entity
-     */
-    onRemoved?: (entityId: EntityId, componentType: EntityId<T>) => void;
-}
-/**
- * Hook types for wildcard relation lifecycle events
- * These hooks are triggered for any component that matches a wildcard relation pattern
- */
-export interface WildcardRelationLifecycleHook<T = unknown> {
-    /**
-     * Called when any component matching the wildcard relation pattern is added to an entity
-     */
-    onAdded?: (entityId: EntityId, componentType: EntityId<T>, component: T) => void;
-    /**
-     * Called when any component matching the wildcard relation pattern is removed from an entity
-     */
-    onRemoved?: (entityId: EntityId, componentType: EntityId<T>) => void;
-}
 /**
  * World class for ECS architecture
  * Manages entities, components, and systems
@@ -93,6 +66,10 @@ export declare class World<ExtraParams extends any[] = [deltaTime: number]> {
      * Check if an entity has a specific component
      */
     hasComponent<T>(entityId: EntityId, componentType: EntityId<T>): boolean;
+    /**
+     * Get wildcard relations from an entity
+     */
+    getComponent<T>(entityId: EntityId, componentType: WildcardRelationId<T>): [EntityId<unknown>, any][] | undefined;
     /**
      * Get a component from an entity
      */
@@ -108,20 +85,20 @@ export declare class World<ExtraParams extends any[] = [deltaTime: number]> {
     /**
      * Register a lifecycle hook for component events
      */
-    registerComponentLifecycleHook<T>(componentType: EntityId<T>, hook: ComponentLifecycleHook<T>): void;
+    registerComponentLifecycleHook<T>(componentType: EntityId<T>, hook: LifecycleHook<T>): void;
     /**
      * Unregister a lifecycle hook for component events
      */
-    unregisterComponentLifecycleHook<T>(componentType: EntityId<T>, hook: ComponentLifecycleHook<T>): void;
+    unregisterComponentLifecycleHook<T>(componentType: EntityId<T>, hook: LifecycleHook<T>): void;
     /**
      * Register a lifecycle hook for wildcard relation events
      * The hook will be triggered for any component that matches the wildcard relation pattern
      */
-    registerWildcardRelationLifecycleHook<T>(baseComponentType: EntityId<T>, hook: WildcardRelationLifecycleHook<T>): void;
+    registerWildcardRelationLifecycleHook<T>(baseComponentType: EntityId<T>, hook: LifecycleHook<T>): void;
     /**
      * Unregister a lifecycle hook for wildcard relation events
      */
-    unregisterWildcardRelationLifecycleHook<T>(baseComponentType: EntityId<T>, hook: WildcardRelationLifecycleHook<T>): void;
+    unregisterWildcardRelationLifecycleHook<T>(baseComponentType: EntityId<T>, hook: LifecycleHook<T>): void;
     /**
      * Update the world (run all systems)
      */