Reference API Roblox

Engine API

Website

Related

Reference API Roblox

DataStore

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
462GetVersionAsync(key: string, version: string): Tuple
652GetVersionAtTimeAsync(key: string, timestamp: int64): Tuple
564ListKeysAsync(prefix: string = , pageSize: int = 0, cursor: string = , excludeDeleted: bool = false): DataStoreKeyPages
483ListVersionsAsync(key: string, sortDirection: SortDirection = Ascending, minDate: int64 = 0, maxDate: int64 = 0, pageSize: int = 0): DataStoreVersionPages
573RemoveVersionAsync(key: string, version: string): null
inherited from GlobalDataStore
592GetAsync(key: string, options: DataStoreGetOptions = DataStoreGetOptions): Tuple
483IncrementAsync(key: string, delta: int = 1, userIds: Array = {}, options: DataStoreIncrementOptions = DataStoreIncrementOptions): Variant
462OnUpdate(key: string, callback: Function): RBXScriptConnection
462RemoveAsync(key: string): Tuple
483SetAsync(key: string, value: Variant, userIds: Array = {}, options: DataStoreSetOptions = DataStoreSetOptions): Variant
462UpdateAsync(key: string, transformFunction: Function): Tuple
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

History 12

Members 5

GetVersionAsync

Parameters (2)
keystring
versionstring
Returns (1)
Tuple

This function retrieves the specified key version as well as a DataStoreKeyInfo instance. A version identifier can be found through DataStore:ListVersionsAsync() or alternatively be the identifier returned by GlobalDataStore:SetAsync().

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

History 1

Tags: [Yields]

GetVersionAtTimeAsync

Parameters (2)
keystring
timestampint64
Returns (1)
Tuple

This function retrieves the key version that was current at a given time as well as a DataStoreKeyInfo instance.

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

History 1

Tags: [Yields]

ListKeysAsync

Parameters (4)Default
prefixstring
pageSizeint0
cursorstring
excludeDeletedboolfalse
Returns (1)
DataStoreKeyPages

This function returns a DataStoreKeyPages object for enumerating through keys of a data store. It accepts an optional prefix parameter to only locate keys whose names start with the provided prefix.

If DataStoreOptions.AllScopes was set to true when accessing the data store through DataStoreService:GetDataStore(), keys will be returned with all scopes as prefixes.

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

History 5

Tags: [Yields]

ListVersionsAsync

Parameters (5)Default
keystring
sortDirectionSortDirectionAscending
minDateint640
maxDateint640
pageSizeint0
Returns (1)
DataStoreVersionPages

This function enumerates versions of the specified key in either ascending or descending order specified by a SortDirection parameter. It can optionally filter the returned versions by minimum and maximum timestamp.

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

History 2

Tags: [Yields]

RemoveVersionAsync

Parameters (2)
keystring
versionstring
Returns (1)
null

This function permanently deletes the specified version of a key. Version identifiers can be found through DataStore:ListVersionsAsync().

Unlike GlobalDataStore:RemoveAsync(), this function does not create a new "tombstone" version and the removed value cannot be retrieved later.

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

History 2

Tags: [Yields]

Settings