Reference API Roblox

Engine API

Website

Related

Reference API Roblox

MemoryStoreSortedMap

Provides access to a sorted map within MemoryStoreService.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
Tags: [NotCreatable, NotReplicated]

Member index 5

HistoryMember
600GetAsync(key: string): Tuple
600GetRangeAsync(direction: SortDirection, count: int, exclusiveLowerBound: Variant, exclusiveUpperBound: Variant): Array
573RemoveAsync(key: string): null
600SetAsync(key: string, value: Variant, expiration: int64, sortKey: Variant): bool
600UpdateAsync(key: string, transformFunction: Function, expiration: int64): Tuple
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Description

Provides access to a sorted map within MemoryStoreService. A sorted map is a collection of items where string keys are associated with arbitrary values (up to the maximum allowed size -- see Memory Stores). Each item can also have an optional sort key, which can be a number or a string. In the ordering of items, the sort key, if provided, takes precedence over the key. Items with numeric sort keys are sorted before items with string sort keys, which are sorted before items with no sort key. Items with the same sort key and items with no sort key are arranged in alphabetical order by key.

History 16

Members 5

GetAsync

Parameters (1)
keystring
Returns (1)
Tuple

Retrieves the value and sort key of a key in the sorted map.

This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

GetRangeAsync

Parameters (4)
directionSortDirection
countint
exclusiveLowerBoundVariant
exclusiveUpperBoundVariant
Returns (1)
Array

Gets items within a sorted range of keys and sort keys.

This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

RemoveAsync

Parameters (1)
keystring
Returns (1)
null

Removes the provided key from the sorted map.

This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

SetAsync

Parameters (4)
keystring
valueVariant
expirationint64
sortKeyVariant
Returns (1)
bool

Sets the value and sort key of the key overwriting any existing key value and sort key.

This function yields. It will block the calling thread until completion.

History 4

Tags: [Yields]

UpdateAsync

Parameters (3)
keystring
transformFunctionFunction
expirationint64
Returns (1)
Tuple

Retrieves the value and sort key of a key from a sorted map and lets you update it to a new value and sort key via a callback function.

This method accepts a callback function that transforms the old value and old sort key into the updated value and updated sort key as required. The method retrieves the existing key value and sort key and passes it to the transform function which returns the new value and sort key for the item, with these exceptions:

  • If the key does not exist, the old value and old sort key passed to the function will be nil.
  • If the function returns nil, the update is canceled.

The new value and new sort key is saved only if the key was not updated (e.g. by a different game server) since the moment it was read. If the value or sort key did change, the transform function is invoked again with the most recent item value and sort key. This cycle repeats until the value and sort key are saved successfully or the transform function returns nil to abort the operation.

This function yields. It will block the calling thread until completion.

History 5

Tags: [Yields]

Settings