ComponentDef

Defined in: ecs/component.ts:204

A component type, as defineComponent returns it. Pass it to queries, world.get/world.insert and Commands; the reflection members below are what the editor and the asset cook read, derived from the metadata given at definition. The underscored members are engine plumbing.

Type Parameters

T

T

Properties

animatableFields

readonly animatableFields: readonly string[]

Defined in: ecs/component.ts:217

---

assetFields

readonly assetFields: readonly AssetFieldMeta[]

Defined in: ecs/component.ts:213

---

colorKeys

readonly colorKeys: readonly string[]

Defined in: ecs/component.ts:216

---

discoverAssets?

readonly optional discoverAssets?: (data) => AssetRef[]

Defined in: ecs/component.ts:223

Parameters

data

Record<string, unknown>

Returns

AssetRef[]

---

entityFields

readonly entityFields: readonly string[]

Defined in: ecs/component.ts:215

---

fieldMeta

readonly fieldMeta: Readonly<Record<string, FieldMeta>>

Defined in: ecs/component.ts:222

---

readonlyFields

readonly readonlyFields: readonly string[]

Defined in: ecs/component.ts:221

Engine-computed output fields the editor must never write back. See ComponentMetadata.readonlyFields.

---

renderableField

readonly renderableField: string | null

Defined in: ecs/component.ts:228

Bool field gating this component’s visibility, or null if it draws nothing. See ComponentMetadata.renderableField.

---

replicatedFields

readonly replicatedFields: readonly string[]

Defined in: ecs/component.ts:219

Fields the replication layer syncs; empty = never replicates. See ComponentMetadata.replicatedFields.

---

skeletalFields?

readonly optional skeletalFields?: SkeletalFieldMeta

Defined in: ecs/component.ts:214

---

transient

readonly transient: boolean

Defined in: ecs/component.ts:225

Runtime-only: omitted from scene serialization. See ComponentMetadata.transient.

Methods

create()

create(data?): T

Defined in: ecs/component.ts:229

Parameters

data?

Partial<T>

Returns

T