GlobalDataStore

GlobalDataStore
Not creatableThis class cannot be instantiated. Not replicatedThis class is not replicated.
Added in	128 (November 2013)
Memory category	Instances
Subclasses
Inheritance
Object Instance GlobalDataStore

Exposes functions for saving and loading data for the DataStoreService. This class was added in version 0.128.

Methods

GetAsync(key: string, options: DataStoreGetOptions = nil): Tuple

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type	Default
key	string
options	DataStoreGetOptions	nil

• Thread safety: unsafe

IncrementAsync(key: string, delta: int = 1, userIds: Array = {}, options: DataStoreIncrementOptions = nil): Variant

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type	Default
key	string
delta	int	1
userIds	Array	{}
options	DataStoreIncrementOptions	nil

• Thread safety: unsafe

OnUpdate(key: string, callback: Function): RBXScriptConnection

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
key	string
callback	Function

• Thread safety: unsafe

RemoveAsync(key: string): Tuple

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
key	string

• Thread safety: unsafe

SetAsync(key: string, value: Variant, userIds: Array = {}, options: DataStoreSetOptions = nil): Variant

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type	Default
key	string
value	Variant
userIds	Array	{}
options	DataStoreSetOptions	nil

• Thread safety: unsafe

UpdateAsync(key: string, transformFunction: Function): Tuple

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
key	string
transformFunction	Function

• Thread safety: unsafe

Removed members

Methods

• GetVersionAsync
• ListKeysAsync
• ListVersionsAsync
• RemoveVersionAsync

External links

• GlobalDataStore in the Roblox Creator Documentation
• GlobalDataStore in the Roblox API Reference