@latticexyz/recs / ComponentWithStream
Interface: ComponentWithStream
Type of component returned by defineComponent.
Type parameters
| Name | Type |
|---|---|
S | extends Schema |
T | undefined |
Hierarchy
Table of contents
Properties
Properties
entities
• entities: () => IterableIterator<EntityIndex>
Type declaration
▸ (): IterableIterator<EntityIndex>
Returns
IterableIterator<EntityIndex>
Inherited from
Defined in
types.ts:82 (opens in a new tab)
id
• id: string
Inherited from
Defined in
types.ts:78 (opens in a new tab)
metadata
• metadata: Metadata
Inherited from
Defined in
types.ts:81 (opens in a new tab)
schema
• schema: S
Inherited from
Defined in
types.ts:80 (opens in a new tab)
stream$
• stream$: Subject<{ entity: EntityIndex ; value: undefined | ComponentValue
Defined in
types.ts:100 (opens in a new tab)
update$
• update$: Subject<ComponentUpdate & { observers: any }
Inherited from
Defined in
types.ts:85 (opens in a new tab)
values
• values: { [key in string | number | symbol]: Map<EntityIndex, ValueType<T>[S[key]]> }
Inherited from
Defined in
types.ts:79 (opens in a new tab)
world
• world: World