ECS Framework API v2.1.50

---

ECS Framework API / ECSFluentAPI

Class: ECSFluentAPI

Defined in: ECS/Core/FluentAPI/ECSFluentAPI.ts:16

ECS流式API主入口 提供统一的流式接口

Constructors

Constructor

new ECSFluentAPI(scene, querySystem, eventSystem): ECSFluentAPI

Defined in: ECS/Core/FluentAPI/ECSFluentAPI.ts:21

Parameters

scene

IScene

querySystem

QuerySystem

eventSystem

TypeSafeEventSystem

Returns

ECSFluentAPI

Methods

createEntity()

createEntity(): EntityBuilder

Defined in: ECS/Core/FluentAPI/ECSFluentAPI.ts:31

创建实体构建器

Returns

EntityBuilder

实体构建器

---

createScene()

createScene(): SceneBuilder

Defined in: ECS/Core/FluentAPI/ECSFluentAPI.ts:39

创建场景构建器

Returns

SceneBuilder

场景构建器

---

createComponent()

createComponent<T>(componentClass, ...args): ComponentBuilder<T>

Defined in: ECS/Core/FluentAPI/ECSFluentAPI.ts:49

创建组件构建器

Type Parameters

T

T extends Component

Parameters

componentClass

(...args) => T

组件类

args

...unknown[]

构造参数

Returns

ComponentBuilder<T>

组件构建器

---

query()

query(): QueryBuilder

Defined in: ECS/Core/FluentAPI/ECSFluentAPI.ts:60

创建查询构建器

Returns

QueryBuilder

查询构建器

---

find()

find(...componentTypes): readonly Entity[]

Defined in: ECS/Core/FluentAPI/ECSFluentAPI.ts:69

查找实体

Parameters

componentTypes

...ComponentType[]

组件类型

Returns

readonly Entity[]

实体数组

---

findFirst()

findFirst(...componentTypes): null | Entity

Defined in: ECS/Core/FluentAPI/ECSFluentAPI.ts:78

查找第一个匹配的实体

Parameters

componentTypes

...ComponentType[]

组件类型

Returns

null | Entity

实体或null

---

findByName()

findByName(name): null | Entity

Defined in: ECS/Core/FluentAPI/ECSFluentAPI.ts:88

按名称查找实体

Parameters

name

string

实体名称

Returns

null | Entity

实体或null

---

findByTag()

findByTag(tag): Entity[]

Defined in: ECS/Core/FluentAPI/ECSFluentAPI.ts:97

按标签查找实体

Parameters

tag

number

标签

Returns

Entity[]

实体数组

---

emit()

emit<T>(eventType, event): void

Defined in: ECS/Core/FluentAPI/ECSFluentAPI.ts:106

触发事件

Type Parameters

T

T

Parameters

eventType

string

事件类型

event

T

事件数据

Returns

void

---

emitAsync()

emitAsync<T>(eventType, event): Promise<void>

Defined in: ECS/Core/FluentAPI/ECSFluentAPI.ts:115

异步触发事件

Type Parameters

T

T

Parameters

eventType

string

事件类型

event

T

事件数据

Returns

Promise<void>

---

on()

on<T>(eventType, handler): string

Defined in: ECS/Core/FluentAPI/ECSFluentAPI.ts:125

监听事件

Type Parameters

T

T

Parameters

eventType

string

事件类型

handler

(event) => void

事件处理器

Returns

string

监听器ID

---

once()

once<T>(eventType, handler): string

Defined in: ECS/Core/FluentAPI/ECSFluentAPI.ts:135

一次性监听事件

Type Parameters

T

T

Parameters

eventType

string

事件类型

handler

(event) => void

事件处理器

Returns

string

监听器ID

---

off()

off(eventType, listenerId): void

Defined in: ECS/Core/FluentAPI/ECSFluentAPI.ts:144

移除事件监听器

Parameters

eventType

string

事件类型

listenerId

string

监听器ID

Returns

void

---

batch()

batch(entities): EntityBatchOperator

Defined in: ECS/Core/FluentAPI/ECSFluentAPI.ts:153

批量操作实体

Parameters

entities

Entity[]

实体数组

Returns

EntityBatchOperator

批量操作器

---

getStats()

getStats(): object

Defined in: ECS/Core/FluentAPI/ECSFluentAPI.ts:161

获取场景统计信息

Returns

object

统计信息

entityCount

entityCount: number

systemCount

systemCount: number

componentStats

componentStats: Map<string, unknown>

queryStats

queryStats: unknown

eventStats

eventStats: Map<string, unknown>