Class UseLiveState

Hierarchy (View Summary)

LeaHooks<{ value: any; live: LiveState<any> }>
- UseLiveState

Index

Constructors

Properties

slots keyedSlots cursor entity classUsed

Methods

reset nextNumberSlot getKeyedSlot isNotNull isNull atSlot atCursor setSlot slotSize onBeginTick? onEndTick? onCallNonKeyed onCallKeyed

Constructors

constructor

new UseLiveState(entity: LeaEntityII): UseLiveState
Parameters
- entity: LeaEntityII
Returns UseLiveState
Inherited from LeaHooks.constructor
- Defined in src/lea.ts:1346

Properties

slots

slots: { value: any; live: LiveState<any> }[] = []

keyedSlots

keyedSlots: Map<string, { value: any; live: LiveState<any> }> = null

cursor

cursor: number = 0

entity

entity: LeaEntityII

`Readonly`classUsed

classUsed: ValidHookClass

Methods

reset

reset(): void
Returns void
Inherited from LeaHooks.reset
- Defined in src/lea.ts:1354

nextNumberSlot

nextNumberSlot(value?: { value: any; live: LiveState<any> }): number
Parameters
- Optionalvalue: { value: any; live: LiveState<any> }
Returns number
Inherited from LeaHooks.nextNumberSlot
- Defined in src/lea.ts:1358

getKeyedSlot

getKeyedSlot(
key: string,
initVal?: { value: any; live: LiveState<any> },
): { value: any; live: LiveState<any> }
Parameters
- key: string
- OptionalinitVal: { value: any; live: LiveState<any> }
Returns { value: any; live: LiveState<any> }
Inherited from LeaHooks.getKeyedSlot
- Defined in src/lea.ts:1366

isNotNull

isNotNull(slot: number): boolean
Parameters
- slot: number
Returns boolean
Inherited from LeaHooks.isNotNull
- Defined in src/lea.ts:1376

isNull

isNull(slot: number): boolean
Parameters
- slot: number
Returns boolean
Inherited from LeaHooks.isNull
- Defined in src/lea.ts:1380

atSlot

atSlot(slot: string | number): { value: any; live: LiveState<any> }
Parameters
- slot: string | number
Returns { value: any; live: LiveState<any> }
Inherited from LeaHooks.atSlot
- Defined in src/lea.ts:1384

atCursor

atCursor(): { value: any; live: LiveState<any> }
Returns { value: any; live: LiveState<any> }
Inherited from LeaHooks.atCursor
- Defined in src/lea.ts:1394

setSlot

setSlot(
slot: string | number,
value: { value: any; live: LiveState<any> },
): void
Parameters
- slot: string | number
- value: { value: any; live: LiveState<any> }
Returns void
Inherited from LeaHooks.setSlot
- Defined in src/lea.ts:1398

slotSize

slotSize(): number
Returns number
Inherited from LeaHooks.slotSize
- Defined in src/lea.ts:1409

`Optional`onBeginTick

onBeginTick?(delta: number): void
Parameters
- delta: number
Returns void
Inherited from LeaHooks.onBeginTick
- Defined in src/lea.ts:1413

`Optional`onEndTick

onEndTick?(delta: number): void
Parameters
- delta: number
Returns void
Inherited from LeaHooks.onEndTick
- Defined in src/lea.ts:1414

onCallNonKeyed

onCallNonKeyed<T>(initial: T): LiveState<T>
Type Parameters
- T
Parameters
- initial: T
Returns LiveState<T>
Overrides LeaHooks.onCallNonKeyed
- Defined in src/lea.ts:1806

onCallKeyed

onCallKeyed<T>(key: string, initial: T): LiveState<T>
Type Parameters
- T
Parameters
- key: string
- initial: T
Returns LiveState<T>
Overrides LeaHooks.onCallKeyed
- Defined in src/lea.ts:1835