Skip to main content

Function: useEasyState()

useEasyState<TStateShape>(options?): object

Defined in: online/state/useEasyState.ts:23

Type Parameters​

TStateShape​

TStateShape extends StateBase

Parameters​

options?​

Partial<UseEasyStateOptions<TStateShape>>

Returns​

object

getMyState()​

getMyState: (copy) => null | PartialDeep<TStateShape["@players"][string]>

Parameters​

copy​

boolean = false

Returns​

null | PartialDeep<TStateShape["@players"][string]>

getPlayerState()​

getPlayerState: (clientId, copy) => null | PartialDeep<TStateShape["@players"][string]>

Parameters​

clientId​

string

copy​

boolean = false

Returns​

null | PartialDeep<TStateShape["@players"][string]>

getPlayerStates()​

getPlayerStates: (copy) => PartialDeep<TStateShape[PlayerEntityCollectionKey]>

Parameters​

copy​

boolean = false

Returns​

PartialDeep<TStateShape[PlayerEntityCollectionKey]>

getState()​

getState: (copy) => PartialDeep<TStateShape>

Parameters​

copy​

boolean = false

Returns​

PartialDeep<TStateShape>

updateMyState()​

updateMyState: (delta) => void

Parameters​

delta​

PartialStructWithNullPropsDeep<TStateShape[PlayerEntityCollectionKey][string]>

Returns​

void

updatePlayerState()​

updatePlayerState: (clientId, delta) => void

Parameters​

clientId​

string

delta​

null | PartialStructWithNullPropsDeep<TStateShape["@players"][string]>

Returns​

void

updateState()​

updateState: (delta, send) => void

Parameters​

delta​

PartialStructWithNullPropsDeep<TStateShape>

send​

boolean = true

Returns​

void