CloudDataStore

Up and coming: shot check knows this class and its members today, and programs run it once the native runtime lands.

ShotInstancenot creatablecomingRoblox

Up and coming

Read, write and copy a live game's data store keys from a desktop program.

Get one from RobloxUniverse:GetDataStore(name, scope). It talks to Open Cloud: get, set, increment and remove keys, list keys and versions, and copy a whole store in one CopyToAsync. A live game's data stores hold its players' data, so treat every write as a change to production.

Properties

NameTypeDefaultDescription
Scopestring

Methods

NameArgumentsReturnsDescription
GetAsync
yields
(key: string)(DataStoreEntry?, string?)Reads a key's value with its version, update time, user ids and attributes; nil with no reason when the key has no value.
SetAsync
yields
(key: string, value: any, options: { UserIds: { number }?, Attributes: { [string]: any }?, MatchVersion: string?, ExclusiveCreate: boolean? }?)(string?, string?)Writes a key's value, with optional user ids and attributes, and returns the new version.
IncrementAsync
yields
(key: string, delta: number)(number?, string?)
RemoveAsync
yields
(key: string)(boolean, string?)
ListKeysAsync
yields
(prefix: string?, limit: number?)({ string }?, string?)
ListVersionsAsync
yields
(key: string)({ DataStoreVersion }?, string?)Lists a key's versions, each with its creation time and whether it was deleted.
CopyToAsync
yields
(target: CloudDataStore, options: { Prefix: string?, DryRun: boolean? }?)(CopyReport?, string?)Copies every key into another data store; a listed key whose value is nil is skipped and named in the report.
From ShotInstance 33