Reference API Roblox

Engine API

Website

Related

Reference API Roblox

DataStoreSetOptions

Specifies additional parameters for a GlobalDataStore:SetAsync() call.

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

Member index 2

HistoryMember
462GetMetadata(): Dictionary
573SetMetadata(attributes: Dictionary): null
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

An object that specifies additional parameters for a GlobalDataStore:SetAsync() call.

See also:

  • Data Stores, an in-depth guide on data structure, management, error handling, etc.

History 9

Members 2

GetMetadata

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

This function gets custom metadata associated with this DataStoreSetOptions instance.

Thread safetyUnsafe

History 3

SetMetadata

Parameters (1)
attributesDictionary
Returns (1)
null

This function sets custom metadata used by GlobalDataStore:SetAsync() to associate metadata with a key. Metadata should be in key-value pair form.

Thread safetyUnsafe

History 4

Settings