A game service that gives access to persistent data storage across places in a
game.
Its interface does not cross the network boundary.
Instances of this class cannot be created with Instance.new.
It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service, NotReplicated]
History Member 553 AutomaticRetry : bool 553 LegacyNamingScheme : bool 638 GetDataStore ( name: string , scope: string = global , options: Instance = ) : DataStore 638 GetGlobalDataStore ( ) : DataStore 483 GetOrderedDataStore ( name: string , scope: string = global ) : OrderedDataStore 462 GetRequestBudgetForRequestType ( requestType: DataStoreRequestType ) : int 548 ListDataStoresAsync ( prefix: string = , pageSize: int = 0 , cursor: string = ) : DataStoreListingPages 63 members553 Archivable : bool 553 Attributes : string 553 AttributesReplicate : string 553 AttributesSerialize : BinaryString 635 Capabilities : SecurityCapabilities 553 DataCost : int 619 DefinesCapabilities : bool 553 HistoryId : UniqueId 553 Name : string 553 Parent : Instance 553 PropertyStatusStudio : PropertyStatus 553 RobloxLocked : bool 635 Sandboxed : bool 616 SourceAssetId : int64 553 Tags : BinaryString 616 UniqueId : UniqueId 553 archivable : bool 553 numExpectedDirectChildren : int 576 AddTag ( tag: string ) : null 573 ClearAllChildren ( ) : null 462 Clone ( ) : Instance 573 Destroy ( ) : null 486 FindFirstAncestor ( name: string ) : Instance 486 FindFirstAncestorOfClass ( className: string ) : Instance 486 FindFirstAncestorWhichIsA ( className: string ) : Instance 486 FindFirstChild ( name: string , recursive: bool = false ) : Instance 486 FindFirstChildOfClass ( className: string ) : Instance 486 FindFirstChildWhichIsA ( className: string , recursive: bool = false ) : Instance 486 FindFirstDescendant ( name: string ) : Instance 563 GetActor ( ) : Actor 486 GetAttribute ( attribute: string ) : Variant 462 GetAttributeChangedSignal ( attribute: string ) : RBXScriptSignal 631 GetAttributes ( ) : Dictionary 648 GetChildren ( ) : Instances 462 GetDebugId ( scopeLength: int = 4 ) : string 486 GetDescendants ( ) : Array 486 GetFullName ( ) : string 641 GetStyled ( name: string ) : Variant 576 GetTags ( ) : Array 576 HasTag ( tag: string ) : bool 486 IsAncestorOf ( descendant: Instance ) : bool 486 IsDescendantOf ( ancestor: Instance ) : bool 580 IsPropertyModified ( name: string ) : bool 573 Remove ( ) : null 576 RemoveTag ( tag: string ) : null 580 ResetPropertyToDefault ( name: string ) : null 573 SetAttribute ( attribute: string , value: Variant ) : null 462 WaitForChild ( childName: string , timeOut: double ) : Instance 648 children ( ) : Instances 553 clone ( ) : Instance 573 destroy ( ) : null 553 findFirstChild ( name: string , recursive: bool = false ) : Instance 648 getChildren ( ) : Instances 553 isDescendantOf ( ancestor: Instance ) : bool 573 remove ( ) : null 462 AncestryChanged ( child: Instance , parent: Instance ) 462 AttributeChanged ( attribute: string ) 462 ChildAdded ( child: Instance ) 462 ChildRemoved ( child: Instance ) 462 DescendantAdded ( descendant: Instance ) 462 DescendantRemoving ( descendant: Instance ) 500 Destroying ( ) 553 childAdded ( child: Instance ) 6 members647 ClassName : string 647 className : string 647 GetPropertyChangedSignal ( property: string ) : RBXScriptSignal 647 IsA ( className: string ) : bool 650 isA ( className: string ) : bool 647 Changed ( property: string )
638
Change ReturnType of from
GlobalDataStore to
DataStore 638
Change ReturnType of from
GlobalDataStore to
DataStore 553
Change Default of from
to
false 553
Change Default of from
to
true 548
Change Parameters of from
( prefix: string = , pageSize: int = 0 ) to
( prefix: string = , pageSize: int = 0 , cursor: string = ) 489
Change ReturnType of from
DataStoreEnumerationPages to
DataStoreListingPages 486
Change ThreadSafety of from
ReadOnly
to
ReadSafe 486
Change ThreadSafety of from
ReadOnly
to
ReadSafe 483
Change ReturnType of from
Instance to
DataStoreEnumerationPages 483
Change ReturnType of from
Instance to
OrderedDataStore 483
Change ReturnType of from
Instance to
GlobalDataStore 483
Change ReturnType of from
Instance to
GlobalDataStore 478
Remove 469
Change Tags of from
[Deprecated]
to
[Hidden, Deprecated] 463
Add 463
Change Parameters of from
( name: string , scope: string = global ) to
( name: string , scope: string = global , options: Instance = ) 462
Change ThreadSafety of from
to
Unsafe 462
Change ThreadSafety of from
to
Unsafe 462
Change ThreadSafety of from
to
Unsafe 462
Change ThreadSafety of from
to
Unsafe 462
Change ThreadSafety of from
to
Unsafe 462
Change ThreadSafety of from
to
ReadOnly 462
Change ThreadSafety of from
to
ReadOnly 452
Remove 452
Change Tags of from
[Yields]
to
[] 452
Change Parameters of from
( name: string , scope: Variant , options: Instance = ) to
( name: string , scope: string = global ) 452
Add 453
Add 453
Change Tags of from
[]
to
[Yields] 453
Change Parameters of from
( name: string , scope: string = global ) to
( name: string , scope: Variant , options: Instance = ) 306
Add 292
Change Tags of from
[]
to
[Deprecated] 288
Add 155
Add 138
Add 137
Add 132
Add 132
Add Sets whether data store functions should automatically retry or not.
DataStoreService does not respect this property because automatic retry
has been disabled due to technical reasons. Therefore, you must implement
systems for retrying operations yourself. It is possible that automatic
retry will be enabled again in the future.
Its interface does not cross the network boundary.
History 4 Tags: [NotReplicated]
This function creates a DataStore instance with the provided name
and scope. Subsequent calls to this method with the same name/scope will
return the same object.
Using the scope parameter will restrict operations to that scope by
automatically prepending the scope to keys in all operations done on the
data store. This function also accepts an optional
DataStoreOptions instance which includes options for enabling
AllScopes . See
Data Stores for details on scope.
History 9 Parameters (0 ) No parameters. Returns (1 )
This function returns the default GlobalDataStore . If you want to
access a specific named data store instead, you should use the
GetDataStore() function.
History 4 This function returns the number of data store requests that the current
place can make based on the given DataStoreRequestType . Any
requests made that exceed this budget are subject to throttling.
Monitoring and adjusting the frequency of data store requests using this
function is recommended.
History 2
It exists only for backward compatibility, and should not be used for new work.
It is not meant to be used, and may have unresolved issues.
History 6 Tags: [Hidden, Deprecated]
Returns a DataStoreListingPages object for enumerating through all
of the experience's data stores. It accepts an optional prefix parameter
to only locate data stores whose names start with the provided prefix.
Only data stores containing at least one object will be listed via this
function.
It will block the calling thread until completion.
History 6 Tags: [Yields]
It exists only for backward compatibility, and should not be used for new work.
It will block the calling thread until completion.
History 3 Tags: [Yields, Deprecated]