Interface IComponentStore<T>

Interface for component storage implementations with change tracking 支持变更追踪的组件存储实现接口

interface IComponentStore<T> {
    add(entity: number, value: T): void;
    forEach(callback: (entity: number, value: T) => void): void;
    get(entity: number): undefined | T;
    getVersion(entity: number): number;
    has(entity: number): boolean;
    markChanged(entity: number, frame: number): void;
    remove(entity: number): void;
    size(): number;
}

Type Parameters

T

Implemented by

SparseSetStore

Index

Methods

add forEach get getVersion has markChanged remove size

Methods

add

add(entity: number, value: T): void
Add component to entity 向实体添加组件
Parameters
- entity: number
- value: T
Returns void
- Defined in core/SparseSetStore.ts:29

forEach

forEach(callback: (entity: number, value: T) => void): void
Iterate over all components 遍历所有组件
Parameters
- callback: (entity: number, value: T) => void
Returns void
- Defined in core/SparseSetStore.ts:47

get

get(entity: number): undefined | T
Get component for entity 获取实体的组件
Parameters
- entity: number
Returns undefined | T
- Defined in core/SparseSetStore.ts:23

getVersion

getVersion(entity: number): number
Get the frame version when component was last written 获取组件最近一次写入的帧版本
Parameters
- entity: number
Returns number
- Defined in core/SparseSetStore.ts:59

has

has(entity: number): boolean
Check if entity has component 检查实体是否拥有组件
Parameters
- entity: number
Returns boolean
- Defined in core/SparseSetStore.ts:17

markChanged

markChanged(entity: number, frame: number): void
Mark component as changed for this frame 标记组件在此帧发生变更
Parameters
- entity: number
- frame: number
Returns void
- Defined in core/SparseSetStore.ts:53

remove

remove(entity: number): void
Remove component from entity 从实体移除组件
Parameters
- entity: number
Returns void
- Defined in core/SparseSetStore.ts:35

size

size(): number
Get number of stored components 获取存储的组件数量

Returns number
- Defined in core/SparseSetStore.ts:41