SceneComponentCodec
Defined in: scene.ts:175
Hook for a component whose full state does not fit the plain field record — e.g. TilemapLayer’s tile chunks live in a C++ blob. Registered by the owning plugin (see tilemapPlugin) so the generic (de)serializer carries no component-specific knowledge.
Properties
Section titled “Properties”outOfBandFields?
Section titled “outOfBandFields?”
optionaloutOfBandFields?: readonlystring[]
Defined in: scene.ts:183
Out-of-band field keys. Stripped from data before validation/insert
(so the component insert doesn’t choke on them) and passed to
importData after insert.
Methods
Section titled “Methods”exportData()?
Section titled “exportData()?”
optionalexportData(entity,data):void
Defined in: scene.ts:177
Serialize: write out-of-band state into the plain record.
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Record<string, unknown>
Returns
Section titled “Returns”void
importData()?
Section titled “importData()?”
optionalimportData(entity,outOfBand):void
Defined in: scene.ts:185
Deserialize: reapply out-of-band state after the component is inserted.
Parameters
Section titled “Parameters”entity
Section titled “entity”number
outOfBand
Section titled “outOfBand”Record<string, unknown>
Returns
Section titled “Returns”void