Reference API Roblox

Engine API

Website

Related

Reference API Roblox

DataStoreService

Summary

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.
This class is a service. It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service, NotReplicated]

Member index 7

HistoryMember
553AutomaticRetry: bool
483GetDataStore(name: string, scope: string = global, options: Instance = Instance): GlobalDataStore
483GetGlobalDataStore(): GlobalDataStore
483GetOrderedDataStore(name: string, scope: string = global): OrderedDataStore
462GetRequestBudgetForRequestType(requestType: DataStoreRequestType): int
548ListDataStoresAsync(prefix: string = , pageSize: int = 0, cursor: string = ): DataStoreListingPages
inherited from Instance
553Archivable: bool
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
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
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: 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
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 1

HistoryMember
478GetDataFromEmptyScopeDataStoreAsyncTemporary(name: string, key: string): Variant

History 36

Members 7

AutomaticRetry

TypeDefault
booltrue
This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated]

GetDataStore

Parameters (3)Default
namestring
scopestringglobal
optionsInstanceInstance
Returns (1)
GlobalDataStore

History 8

GetGlobalDataStore

Parameters (0)
No parameters.
Returns (1)
GlobalDataStore

History 3

GetOrderedDataStore

Parameters (2)Default
namestring
scopestringglobal
Returns (1)
OrderedDataStore

History 3

GetRequestBudgetForRequestType

Parameters (1)
requestTypeDataStoreRequestType
Returns (1)
int

History 2

ListDataStoresAsync

Parameters (3)Default
prefixstring
pageSizeint0
cursorstring
Returns (1)
DataStoreListingPages
This function yields. It will block the calling thread until completion.

History 6

Tags: [Yields]

Removed members 1

GetDataFromEmptyScopeDataStoreAsyncTemporary

Parameters (2)
namestring
keystring
Returns (1)
Variant
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields, Deprecated]

Settings