MemoryStoreService

Show Deprecated
Service

A top-level singleton class which exposes methods to access specific primitives within the MemoryStoreService. Use it for any data that rapidly changes that other servers can restore, such as global leaderboards, matchmaking queues, and auction houses.

For a more in-depth look, see Memory Stores.

Summary

Properties

Events

Methods

GetQueue(name: string, invisibilityTimeout: number): MemoryStoreQueue  

Returns a MemoryStoreQueue instance for the provided name.


Returns a MemoryStoreSortedMap instance for the provided name.

Properties

Events

Methods

Returns a MemoryStoreQueue instance for the provided name. The name is global within the game, thus any place that uses the same name will access the same queue.

Parameters

name: string

Name of the queue.

invisibilityTimeout: number

(Optional) Invisibility timeout, in seconds, for read operations through this queue instance. If not provided, defaults to 30 seconds.

Default Value: "30"

Returns

A MemoryStoreQueue instance for the provided name.

Returns a MemoryStoreSortedMap instance for the provided name. The name is global within the game, so any place that uses the same name will access the same sorted map.

Parameters

name: string

Name of the sorted map.


Returns

A MemoryStoreSortedMap instance for the provided name.