Skip to content

ECS Framework API v2.1.50


ECS Framework API / IComponent

Interface: IComponent

Defined in: Types/index.ts:10

组件接口

定义组件的基本契约,所有组件都应该实现此接口

Properties

id

readonly id: number

Defined in: Types/index.ts:12

组件唯一标识符


entityId?

optional entityId: string | number

Defined in: Types/index.ts:14

组件所属的实体ID


enabled

enabled: boolean

Defined in: Types/index.ts:16

组件启用状态


updateOrder

updateOrder: number

Defined in: Types/index.ts:18

更新顺序

Methods

onAddedToEntity()

onAddedToEntity(): void

Defined in: Types/index.ts:21

组件添加到实体时的回调

Returns

void


onRemovedFromEntity()

onRemovedFromEntity(): void

Defined in: Types/index.ts:23

组件从实体移除时的回调

Returns

void


onEnabled()

onEnabled(): void

Defined in: Types/index.ts:25

组件启用时的回调

Returns

void


onDisabled()

onDisabled(): void

Defined in: Types/index.ts:27

组件禁用时的回调

Returns

void


update()

update(): void

Defined in: Types/index.ts:32

更新组件

Returns

void

Deprecated

不符合ECS架构规范,建议使用EntitySystem来处理更新逻辑

Released under the MIT License.