Class
MemoryStoreService
Service
Exposes methods to access specific primitives within MemoryStore.
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. For the limits and quotas of the service, see Limits and Quotas.
Methods 3#
| GetHashMap | Returns a MemoryStoreHashMap instance for the provided name. |
| GetQueue | Returns a MemoryStoreQueue instance for the provided name. |
| GetSortedMap | Returns a MemoryStoreSortedMap instance for the provided name. |
GetHashMap(name: string): MemoryStoreHashMap#
Returns a MemoryStoreHashMap instance for the provided name. The
name is global within the game, so any place that uses the same name
accesses the same hash map.
| Name | Type | Default | Description |
|---|---|---|---|
name | string | The name of the hash map. |
Returns
MemoryStoreHashMap— AMemoryStoreHashMapinstance for the provided name.
GetQueue(name: string, invisibilityTimeout: int = 30): MemoryStoreQueue#
Returns a MemoryStoreQueue instance for the provided name. The
name is global within the game, thus any place that uses the same name
accesses the same queue.
| Name | Type | Default | Description |
|---|---|---|---|
name | string | Name of the queue. | |
invisibilityTimeout | int | 30 | (Optional) Invisibility timeout, in seconds, for read operations through this queue instance. If not provided, defaults to 30 seconds. |
Returns
MemoryStoreQueue— AMemoryStoreQueueinstance for the provided name.
GetSortedMap(name: string): MemoryStoreSortedMap#
Returns a MemoryStoreSortedMap instance for the provided name. The
name is global within the game, so any place that uses the same name
accesses the same sorted map.
| Name | Type | Default | Description |
|---|---|---|---|
name | string | Name of the sorted map. |
Returns
MemoryStoreSortedMap— AMemoryStoreSortedMapinstance for the provided name.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild