Reference API Roblox

Engine API

Website

Related

Reference API Roblox

MemoryStoreHashMap

Provides access to a hash 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.
Memory categoryInstances
Tags: [NotCreatable, NotReplicated]

Member index 5

HistoryMember
591GetAsync(key: string): Variant
605ListItemsAsync(count: int): MemoryStoreHashMapPages
591RemoveAsync(key: string): null
591SetAsync(key: string, value: Variant, expiration: int64): bool
591UpdateAsync(key: string, transformFunction: Function, expiration: int64): Variant
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
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
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: 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
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

Provides access to a hash map within MemoryStoreService. A hash map is a collection of items where string keys are associated with arbitrary values (up to the maximum allowed size -- see Memory Stores). The keys have no ordering guarantees.

History 6

Members 5

GetAsync

Parameters (1)
keystring
Returns (1)
Variant

Retrieves the value of a key in the hash map.

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

History 1

Tags: [Yields]

ListItemsAsync

Parameters (1)
countint
Returns (1)
MemoryStoreHashMapPages

Returns a MemoryStoreHashMapPages object for enumerating through items in the hash map. The valid range is 1 to 200 inclusive.

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

History 1

Tags: [Yields]

RemoveAsync

Parameters (1)
keystring
Returns (1)
null

Removes an item from the hash map.

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

History 1

Tags: [Yields]

SetAsync

Parameters (3)
keystring
valueVariant
expirationint64
Returns (1)
bool

Sets the value of a key in the hash map, overwriting any existing value.

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

History 1

Tags: [Yields]

UpdateAsync

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

Retrieves the value of a key from a hash map and lets you update it to a new value.

This method accepts a callback function that retrieves the existing key value and passes it to a transform function, which returns the new value for the item, with these exceptions:

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

The new value is saved only if the key was not updated (for example, by a different game server) since the moment it was read. If the value changed in that time, the transform function is called again with the most recent item value. This cycle repeats until the value is saved successfully or the transform function returns nil to abort the operation.

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

History 1

Tags: [Yields]

Settings