Skip to content

ECS Framework API v2.2.13


ECS Framework API / EntitySerializer

Class: EntitySerializer

Defined in: packages/core/src/ECS/Serialization/EntitySerializer.ts:65

实体序列化器类

Constructors

Constructor

new EntitySerializer(): EntitySerializer

Returns

EntitySerializer

Methods

serialize()

static serialize(entity, includeChildren): SerializedEntity

Defined in: packages/core/src/ECS/Serialization/EntitySerializer.ts:73

序列化单个实体

Parameters

entity

Entity

要序列化的实体

includeChildren

boolean = true

是否包含子实体(默认true)

Returns

SerializedEntity

序列化后的实体数据


deserialize()

static deserialize(serializedEntity, componentRegistry, idGenerator, preserveIds, scene?): Entity

Defined in: packages/core/src/ECS/Serialization/EntitySerializer.ts:114

反序列化实体

Parameters

serializedEntity

SerializedEntity

序列化的实体数据

componentRegistry

Map<string, ComponentType>

组件类型注册表

idGenerator

() => number

实体ID生成器(用于生成新ID或保持原ID)

preserveIds

boolean = false

是否保持原始ID(默认false)

scene?

IScene

目标场景(可选,用于设置entity.scene以支持添加组件)

Returns

Entity

反序列化后的实体


serializeEntities()

static serializeEntities(entities, includeChildren): SerializedEntity[]

Defined in: packages/core/src/ECS/Serialization/EntitySerializer.ts:168

批量序列化实体

Parameters

entities

Entity[]

实体数组

includeChildren

boolean = true

是否包含子实体

Returns

SerializedEntity[]

序列化后的实体数据数组


deserializeEntities()

static deserializeEntities(serializedEntities, componentRegistry, idGenerator, preserveIds, scene?): Entity[]

Defined in: packages/core/src/ECS/Serialization/EntitySerializer.ts:195

批量反序列化实体

Parameters

serializedEntities

SerializedEntity[]

序列化的实体数据数组

componentRegistry

Map<string, ComponentType>

组件类型注册表

idGenerator

() => number

实体ID生成器

preserveIds

boolean = false

是否保持原始ID

scene?

IScene

目标场景(可选,用于设置entity.scene以支持添加组件)

Returns

Entity[]

反序列化后的实体数组


clone()

static clone(entity, componentRegistry, idGenerator): Entity

Defined in: packages/core/src/ECS/Serialization/EntitySerializer.ts:226

创建实体的深拷贝

Parameters

entity

Entity

要拷贝的实体

componentRegistry

Map<string, ComponentType>

组件类型注册表

idGenerator

() => number

ID生成器

Returns

Entity

拷贝后的新实体

Released under the MIT License.