Reference API Roblox

Engine API

Website

Related

Reference API Roblox

DataStoreOptions

Object used to provide additional parameters to DataStoreService:GetDataStore().

This class is not replicated. Its interface does not cross the network boundary.
Memory categoryInstances
Tags: [NotReplicated]

Member index 2

HistoryMember
731AllScopes: bool
573SetExperimentalFeatures(experimentalFeatures: Dictionary): null
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: 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
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

A configuration object passed as the third argument to DataStoreService:GetDataStore() to customize how the returned DataStore behaves. Create one with Instance.new("DataStoreOptions"), set its properties, then pass it to GetDataStore. Currently the only behavioral property is DataStoreOptions.AllScopes.

History 7

Members 2

AllScopes

TypeDefault
boolfalse

When set to true, the DataStore returned by DataStoreService:GetDataStore() operates across all scopes instead of a single scope. The scope parameter (second argument) to GetDataStore must be an empty string ("") when this property is enabled; passing a non-empty scope throws an error.

In all-scopes mode, every key is prefixed with its scope and a slash separator. For example, DataStore:ListKeysAsync() returns keys such as global/player_data_1234 or houses/house3. When you create or access a key, you must include the scope prefix in the format scope/keyname; omitting the slash throws an error.

Default value is false.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 4

SetExperimentalFeatures

Parameters (1)
experimentalFeaturesDictionary
Returns (1)
null

Accepts a dictionary of feature-name keys mapped to boolean values and stores them on this DataStoreOptions instance. Calling this method has no observable effect on runtime behavior.

Thread safetyUnsafe

History 2

Settings