BuiltinComponentDef
Defined in: ecs/component.ts:503
A component the engine ships, whose storage lives in C++. Carries the same
reflection a ComponentDef does, authored at the ES_PROPERTY site
instead of in a metadata argument, so tooling reads both the same way.
Type Parameters
Section titled “Type Parameters”T
Properties
Section titled “Properties”animatableFields
Section titled “animatableFields”
readonlyanimatableFields: readonlystring[]
Defined in: ecs/component.ts:518
assetFields
Section titled “assetFields”
readonlyassetFields: readonlyAssetFieldMeta[]
Defined in: ecs/component.ts:514
colorKeys
Section titled “colorKeys”
readonlycolorKeys: readonlystring[]
Defined in: ecs/component.ts:517
discoverAssets?
Section titled “discoverAssets?”
readonlyoptionaldiscoverAssets?: (data) =>AssetRef[]
Defined in: ecs/component.ts:524
Parameters
Section titled “Parameters”Record<string, unknown>
Returns
Section titled “Returns”AssetRef[]
entityFields
Section titled “entityFields”
readonlyentityFields: readonlystring[]
Defined in: ecs/component.ts:516
fieldMeta
Section titled “fieldMeta”
readonlyfieldMeta:Readonly<Record<string,FieldMeta>>
Defined in: ecs/component.ts:523
readonlyFields
Section titled “readonlyFields”
readonlyreadonlyFields: readonlystring[]
Defined in: ecs/component.ts:522
Fields authored readonly (engine-computed outputs); the editor never writes them back.
renderableField
Section titled “renderableField”
readonlyrenderableField:string|null
Defined in: ecs/component.ts:529
Bool field gating this component’s visibility, or null if it draws nothing.
Authored ES_COMPONENT(renderable=<field>).
replicatedFields
Section titled “replicatedFields”
readonlyreplicatedFields: readonlystring[]
Defined in: ecs/component.ts:520
Fields authored replicated at the C++ ES_PROPERTY site (via COMPONENT_META).
skeletalFields?
Section titled “skeletalFields?”
readonlyoptionalskeletalFields?:SkeletalFieldMeta
Defined in: ecs/component.ts:515
transient
Section titled “transient”
readonlytransient:boolean
Defined in: ecs/component.ts:526
Runtime-only: omitted from scene serialization. Authored ES_COMPONENT(transient).