Reference API Roblox

Engine API

Website

Related

Reference API Roblox

GlobalDataStore

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.
Tags: [NotCreatable, NotReplicated]

Member index 6

HistoryMember
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
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 4

HistoryMember
452GetVersionAsync(key: string, version: string): Tuple
452ListKeysAsync(prefix: string = , pageSize: int = 0): Instance
452ListVersionsAsync(key: string, sortDirection: SortDirection = Ascending, minDate: int64 = 0, maxDate: int64 = 0, pageSize: int = 0): Instance
452RemoveVersionAsync(key: string, version: string): void

History 51

Members 6

GetAsync

Parameters (2)Default
keystring
optionsDataStoreGetOptionsDataStoreGetOptions
Returns (1)
Tuple
This function yields. It will block the calling thread until completion.

History 8

Tags: [Yields]

IncrementAsync

Parameters (4)Default
keystring
deltaint1
userIdsArray{}
optionsDataStoreIncrementOptionsDataStoreIncrementOptions
Returns (1)
Variant
This function yields. It will block the calling thread until completion.

History 7

Tags: [Yields]

OnUpdate

Parameters (2)
keystring
callbackFunction
Returns (1)
RBXScriptConnection
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

RemoveAsync

Parameters (1)
keystring
Returns (1)
Tuple
This function yields. It will block the calling thread until completion.

History 7

Tags: [Yields]

SetAsync

Parameters (4)Default
keystring
valueVariant
userIdsArray{}
optionsDataStoreSetOptionsDataStoreSetOptions
Returns (1)
Variant
This function yields. It will block the calling thread until completion.

History 15

Tags: [Yields]

UpdateAsync

Parameters (2)
keystring
transformFunctionFunction
Returns (1)
Tuple
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

Removed members 4

GetVersionAsync

Parameters (2)
keystring
versionstring
Returns (1)
Tuple
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

ListKeysAsync

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

History 2

Tags: [Yields]

ListVersionsAsync

Parameters (5)Default
keystring
sortDirectionSortDirectionAscending
minDateint640
maxDateint640
pageSizeint0
Returns (1)
Instance
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

RemoveVersionAsync

Parameters (2)
keystring
versionstring
Returns (1)
void
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

Settings