ECS Framework API v2.1.50

---

ECS Framework API / IScene

Interface: IScene

Defined in: ECS/IScene.ts:15

场景接口定义

定义场景应该实现的核心功能和属性，使用接口而非继承提供更灵活的实现方式。

Properties

name

name: string

Defined in: ECS/IScene.ts:19

场景名称

---

entities

readonly entities: EntityList

Defined in: ECS/IScene.ts:24

场景中的实体集合

---

entityProcessors

readonly entityProcessors: EntityProcessorList

Defined in: ECS/IScene.ts:29

实体系统处理器集合

---

identifierPool

readonly identifierPool: IdentifierPool

Defined in: ECS/IScene.ts:34

标识符池

---

componentStorageManager

readonly componentStorageManager: ComponentStorageManager

Defined in: ECS/IScene.ts:39

组件存储管理器

---

querySystem

readonly querySystem: QuerySystem

Defined in: ECS/IScene.ts:44

查询系统

---

eventSystem

readonly eventSystem: TypeSafeEventSystem

Defined in: ECS/IScene.ts:49

事件系统

---

systems

readonly systems: EntitySystem[]

Defined in: ECS/IScene.ts:54

获取系统列表

Methods

initialize()

initialize(): void

Defined in: ECS/IScene.ts:59

初始化场景

Returns

void

---

onStart()

onStart(): void

Defined in: ECS/IScene.ts:64

场景开始运行时的回调

Returns

void

---

unload()

unload(): void

Defined in: ECS/IScene.ts:69

场景卸载时的回调

Returns

void

---

begin()

begin(): void

Defined in: ECS/IScene.ts:74

开始场景

Returns

void

---

end()

end(): void

Defined in: ECS/IScene.ts:79

结束场景

Returns

void

---

update()

update(): void

Defined in: ECS/IScene.ts:84

更新场景

Returns

void

---

createEntity()

createEntity(name): Entity

Defined in: ECS/IScene.ts:89

创建实体

Parameters

name

string

Returns

Entity

---

clearSystemEntityCaches()

clearSystemEntityCaches(): void

Defined in: ECS/IScene.ts:94

清除所有EntitySystem的实体缓存

Returns

void

---

addEntity()

addEntity(entity, deferCacheClear?): Entity

Defined in: ECS/IScene.ts:99

添加实体

Parameters

entity

Entity

deferCacheClear?

boolean

Returns

Entity

---

createEntities()

createEntities(count, namePrefix?): Entity[]

Defined in: ECS/IScene.ts:104

批量创建实体

Parameters

count

number

namePrefix?

string

Returns

Entity[]

---

destroyAllEntities()

destroyAllEntities(): void

Defined in: ECS/IScene.ts:109

销毁所有实体

Returns

void

---

findEntity()

findEntity(name): null | Entity

Defined in: ECS/IScene.ts:114

查找实体

Parameters

name

string

Returns

null | Entity

---

findEntitiesByTag()

findEntitiesByTag(tag): Entity[]

Defined in: ECS/IScene.ts:119

根据标签查找实体

Parameters

tag

number

Returns

Entity[]

---

addEntityProcessor()

addEntityProcessor(processor): EntitySystem

Defined in: ECS/IScene.ts:124

添加实体处理器

Parameters

processor

EntitySystem

Returns

EntitySystem

---

removeEntityProcessor()

removeEntityProcessor(processor): void

Defined in: ECS/IScene.ts:129

移除实体处理器

Parameters

processor

EntitySystem

Returns

void

---

getEntityProcessor()

getEntityProcessor<T>(type): null | T

Defined in: ECS/IScene.ts:134

获取实体处理器

Type Parameters

T

T extends EntitySystem

Parameters

type

(...args) => T

Returns

null | T