GlobalDataStore

Show Deprecated
Not Creatable
Not Replicated

A GlobalDataStore exposes functions for saving and loading data for the DataStoreService.

See Data Stores for an in-depth guide on data structure, management, error handling, etc.

Ordered data stores do not support versioning and metadata, so DataStoreKeyInfo is always nil for keys in an OrderedDataStore. If you need versioning and metadata support, use a DataStore.

Summary

Methods

Properties

Methods

GetAsync

Yields

Parameters

key: string
Default Value: "nil"

Returns

IncrementAsync

Variant
Yields

Parameters

key: string
delta: number
Default Value: 1
userIds: Array
Default Value: "{}"
Default Value: "nil"

Returns

Variant
Deprecated

Parameters

key: string
callback: function

Returns

Code Samples

Print Data Store Value on Update

local DataStoreService = game:GetService("DataStoreService")
local sampleDataStore = DataStoreService:GetDataStore("MyDataStore")
local connection
local function printOut(input)
print(input)
connection:Disconnect()
end
connection = sampleDataStore:OnUpdate("myKey", printOut)
local success, result = pcall(function()
sampleDataStore:SetAsync("myKey", 11)
end)
if not success then
warn(result)
end

RemoveAsync

Yields

Parameters

key: string

Returns

SetAsync

Variant
Yields

Parameters

key: string
value: Variant
userIds: Array
Default Value: "{}"
Default Value: "nil"

Returns

Variant

UpdateAsync

Yields

Parameters

key: string
transformFunction: function

Returns

Events