Module: dataStore

Methods


<static> autosaveEntity(entity)

Store entities as autosave

Parameters:
Name Type Description
entity module:entity/Entity~Entity
Source:

<static> autosaveEntity(entity)

Store entities as autosave

Parameters:
Name Type Description
entity module:entity/Entity~Entity
Source:

<static> getLoadedState(key) → {Promise}

Get the previously loaded state as a Promise

Parameters:
Name Type Description
key any
Source:
Returns:
  • Promise with previously loaded data
Type
Promise

<static> getLoadedState(key) → {Promise}

Get the previously loaded state as a Promise

Parameters:
Name Type Description
key any
Source:
Returns:
  • Promise with previously loaded data
Type
Promise

<static> getSaveStates() → {Promise}

Get a list of save states

Source:
Returns:
  • Promise with list of save states
Type
Promise

<static> getSaveStates() → {Promise}

Get a list of save states

Source:
Returns:
  • Promise with list of save states
Type
Promise

<static> loadState(key) → {Promise}

Load a state given a save state key

Parameters:
Name Type Description
key string

Save State Key

Source:
Returns:
  • Promise with saved data
Type
Promise

<static> loadState(key) → {Promise}

Load a state given a save state key

Parameters:
Name Type Description
key string

Save State Key

Source:
Returns:
  • Promise with saved data
Type
Promise

<static> manualSaveState(entity)

Parameters:
Name Type Description
entity any
Deprecated:
  • Yes
Source:

<static> manualSaveState(entity)

Parameters:
Name Type Description
entity any
Deprecated:
  • Yes
Source:

<static> resetLoadState()

Invalidate the previously loaded state

Source:

<static> resetLoadState()

Invalidate the previously loaded state

Source:

<inner> storeEntity(entity, channel)

Update entity by sending information to backend

Parameters:
Name Type Description
entity any
channel string
Source:

<inner> storeEntity(entity, channel)

Update entity by sending information to backend

Parameters:
Name Type Description
entity any
channel string
Source:

Module: dataStore

Methods


<static> autosaveEntity(entity)

Store entities as autosave

Parameters:
Name Type Description
entity module:entity/Entity~Entity
Source:

<static> autosaveEntity(entity)

Store entities as autosave

Parameters:
Name Type Description
entity module:entity/Entity~Entity
Source:

<static> getLoadedState(key) → {Promise}

Get the previously loaded state as a Promise

Parameters:
Name Type Description
key any
Source:
Returns:
  • Promise with previously loaded data
Type
Promise

<static> getLoadedState(key) → {Promise}

Get the previously loaded state as a Promise

Parameters:
Name Type Description
key any
Source:
Returns:
  • Promise with previously loaded data
Type
Promise

<static> getSaveStates() → {Promise}

Get a list of save states

Source:
Returns:
  • Promise with list of save states
Type
Promise

<static> getSaveStates() → {Promise}

Get a list of save states

Source:
Returns:
  • Promise with list of save states
Type
Promise

<static> loadState(key) → {Promise}

Load a state given a save state key

Parameters:
Name Type Description
key string

Save State Key

Source:
Returns:
  • Promise with saved data
Type
Promise

<static> loadState(key) → {Promise}

Load a state given a save state key

Parameters:
Name Type Description
key string

Save State Key

Source:
Returns:
  • Promise with saved data
Type
Promise

<static> manualSaveState(entity)

Parameters:
Name Type Description
entity any
Deprecated:
  • Yes
Source:

<static> manualSaveState(entity)

Parameters:
Name Type Description
entity any
Deprecated:
  • Yes
Source:

<static> resetLoadState()

Invalidate the previously loaded state

Source:

<static> resetLoadState()

Invalidate the previously loaded state

Source:

<inner> storeEntity(entity, channel)

Update entity by sending information to backend

Parameters:
Name Type Description
entity any
channel string
Source:

<inner> storeEntity(entity, channel)

Update entity by sending information to backend

Parameters:
Name Type Description
entity any
channel string
Source: