ComponentStoreLike
Defined in: src/component-store.ts:83
The storage-agnostic access surface shared by the object-backed
ComponentStore and the columnar ColumnStore. world,
Query, the spatial index, and save all consume this interface, so
a component’s storage layout (object vs Structure-of-Arrays) is invisible
to them. Static ComponentStore.fromSerialized and the columnar-only fast
path (column / slotOf) are deliberately excluded — callers that need
those reach for the concrete type.
Extends
Section titled “Extends”Iterable<[EntityId,T]>
Type Parameters
Section titled “Type Parameters”T
Properties
Section titled “Properties”addedTick
Section titled “addedTick”addedTick: (
id) =>number
Defined in: src/component-store.ts:93
Clock tick at which the entity gained this component, or 0 when absent.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”number
changedTick
Section titled “changedTick”changedTick: (
id) =>number
Defined in: src/component-store.ts:95
Clock tick of the entity’s last recorded change (insert included), or 0 when absent.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”number
clear: () =>
void
Defined in: src/component-store.ts:96
Returns
Section titled “Returns”void
readonlyclock:ChangeClock
Defined in: src/component-store.ts:85
The clock this store stamps added / changed ticks from; shared by every store in a world.
delete
Section titled “delete”delete: (
id) =>boolean
Defined in: src/component-store.ts:97
Parameters
Section titled “Parameters”Returns
Section titled “Returns”boolean
entries
Section titled “entries”entries: () =>
IterableIterator<[EntityId,T]>
Defined in: src/component-store.ts:98
Returns
Section titled “Returns”IterableIterator<[EntityId, T]>
get: (
id) =>T|undefined
Defined in: src/component-store.ts:100
Read a value. Not recorded as a change — mutate through getMut for that.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”T | undefined
getMut
Section titled “getMut”getMut: (
id) =>T|undefined
Defined in: src/component-store.ts:102
Read a value for in-place mutation, recording the entity as changed.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”T | undefined
has: (
id) =>boolean
Defined in: src/component-store.ts:103
Parameters
Section titled “Parameters”Returns
Section titled “Returns”boolean
keys: () =>
IterableIterator<EntityId>
Defined in: src/component-store.ts:104
Returns
Section titled “Returns”IterableIterator<EntityId>
markChanged
Section titled “markChanged”markChanged: (
id) =>void
Defined in: src/component-store.ts:106
Record a present entity as changed after a write the store cannot see.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
set: (
id,value) =>this
Defined in: src/component-store.ts:107
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”this
readonlysize:number
Defined in: src/component-store.ts:86
subscribe
Section titled “subscribe”subscribe: {(
event,fn): () =>void; (event,fn): () =>void; (event,fn): () =>void; }
Defined in: src/component-store.ts:87
Call Signature
Section titled “Call Signature”(
event,fn): () =>void
Parameters
Section titled “Parameters”"set"
Returns
Section titled “Returns”() => void
Call Signature
Section titled “Call Signature”(
event,fn): () =>void
Parameters
Section titled “Parameters”"delete"
Returns
Section titled “Returns”() => void
Call Signature
Section titled “Call Signature”(
event,fn): () =>void
Parameters
Section titled “Parameters”"validate"
Returns
Section titled “Returns”() => void
toSerialized
Section titled “toSerialized”toSerialized: (
def) =>unknown
Defined in: src/component-store.ts:108
Parameters
Section titled “Parameters”ComponentDef<T>
Returns
Section titled “Returns”unknown
validate
Section titled “validate”validate: (
id) =>void
Defined in: src/component-store.ts:109
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
Iterator<[EntityId,T],any,any>
Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:49
Returns
Section titled “Returns”Iterator<[EntityId, T], any, any>
Inherited from
Section titled “Inherited from”Iterable.[iterator]