GlobalDataStore On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.

This item is not replicated. Its interface does not cross the network boundary.

Memory Category	Instances
ExplorerOrder	-1

Tags: [NotCreatable, NotReplicated]

Inherits (1)

Instance

Inherited by (2)

Member index (6)

Type	Member	History
Tuple	GetAsync (string key, DataStoreGetOptions options = nil)	453 452 459 458 459 592
Variant	IncrementAsync (string key, int delta = 1, Array userIds = {}, DataStoreIncrementOptions options = nil)	453 452 460 462 483
RBXScriptConnection	OnUpdate (string key, Function callback)	404
Tuple	RemoveAsync (string key)	313 453 452 459 458 459
Variant	SetAsync (string key, Variant value, Array userIds = {}, DataStoreSetOptions options = nil)	453 453 452 452 459 459 458 458 459 459 460 462 483
Tuple	UpdateAsync (string key, Function transformFunction)
57 members inherited from Instance

Removed member index (4)

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

592 Change Parameters of GlobalDataStore.GetAsync from (string key) to (string key, DataStoreGetOptions options = nil)
483 Change Parameters of GlobalDataStore.IncrementAsync from (string key, int delta = 1, Array userIds = {}, Instance options = nil) to (string key, int delta = 1, Array userIds = {}, DataStoreIncrementOptions options = nil)
483 Change Parameters of GlobalDataStore.SetAsync from (string key, Variant value, Array userIds = {}, Instance options = nil) to (string key, Variant value, Array userIds = {}, DataStoreSetOptions options = nil)
462 Change Parameters of GlobalDataStore.IncrementAsync from (string key, int delta = 1, Array userids = {}, Instance options = nil) to (string key, int delta = 1, Array userIds = {}, Instance options = nil)
462 Change Parameters of GlobalDataStore.SetAsync from (string key, Variant value, Array userids = {}, Instance options = nil) to (string key, Variant value, Array userIds = {}, Instance options = nil)
460 Change Parameters of GlobalDataStore.IncrementAsync from (string key, int delta = 1) to (string key, int delta = 1, Array userids = {}, Instance options = nil)
460 Change Parameters of GlobalDataStore.SetAsync from (string key, Variant value, Variant userids, Instance options = nil) to (string key, Variant value, Array userids = {}, Instance options = nil)
459 Change ReturnType of GlobalDataStore.GetAsync from Variant to Tuple
459 Change ReturnType of GlobalDataStore.RemoveAsync from Variant to Tuple
459 Change Parameters of GlobalDataStore.SetAsync from (string key, Variant value) to (string key, Variant value, Variant userids, Instance options = nil)
459 Change ReturnType of GlobalDataStore.SetAsync from void to Variant
458 Change ReturnType of GlobalDataStore.GetAsync from Tuple to Variant
458 Change ReturnType of GlobalDataStore.RemoveAsync from Tuple to Variant
458 Change Parameters of GlobalDataStore.SetAsync from (string key, Variant value, Variant userids, Instance options = nil) to (string key, Variant value)
458 Change ReturnType of GlobalDataStore.SetAsync from Variant to void
459 Change ReturnType of GlobalDataStore.GetAsync from Variant to Tuple
459 Change ReturnType of GlobalDataStore.RemoveAsync from Variant to Tuple
459 Change Parameters of GlobalDataStore.SetAsync from (string key, Variant value) to (string key, Variant value, Variant userids, Instance options = nil)
459 Change ReturnType of GlobalDataStore.SetAsync from void to Variant
452 Change ReturnType of GlobalDataStore.GetAsync from Tuple to Variant
452 Remove GlobalDataStore.GetVersionAsync
452 Change ReturnType of GlobalDataStore.IncrementAsync from Tuple to Variant
452 Remove GlobalDataStore.ListKeysAsync
452 Remove GlobalDataStore.ListVersionsAsync
452 Change ReturnType of GlobalDataStore.RemoveAsync from Tuple to Variant
452 Remove GlobalDataStore.RemoveVersionAsync
452 Change Parameters of GlobalDataStore.SetAsync from (string key, Variant value, Variant userid, Instance options = nil) to (string key, Variant value)
452 Change ReturnType of GlobalDataStore.SetAsync from string to void
453 Change ReturnType of GlobalDataStore.GetAsync from Variant to Tuple
453 Add GlobalDataStore.GetVersionAsync
453 Change ReturnType of GlobalDataStore.IncrementAsync from Variant to Tuple
453 Add GlobalDataStore.ListKeysAsync
453 Add GlobalDataStore.ListVersionsAsync
453 Change ReturnType of GlobalDataStore.RemoveAsync from Variant to Tuple
453 Add GlobalDataStore.RemoveVersionAsync
453 Change Parameters of GlobalDataStore.SetAsync from (string key, Variant value) to (string key, Variant value, Variant userid, Instance options = nil)
453 Change ReturnType of GlobalDataStore.SetAsync from void to string
404 Change Tags of GlobalDataStore.OnUpdate from [] to [Deprecated]
313 Add GlobalDataStore.RemoveAsync
128 Add GlobalDataStore

Members

GetAsync On DevHub

This function yields. It will block the calling thread until completion.

Parameters	2

Name	Type	Default
key	string	none
options	DataStoreGetOptions	nil

Return Type	Tuple

History

592 Change Parameters of GlobalDataStore.GetAsync from (string key) to (string key, DataStoreGetOptions options = nil)
459 Change ReturnType of GlobalDataStore.GetAsync from Variant to Tuple
458 Change ReturnType of GlobalDataStore.GetAsync from Tuple to Variant
459 Change ReturnType of GlobalDataStore.GetAsync from Variant to Tuple
452 Change ReturnType of GlobalDataStore.GetAsync from Tuple to Variant
453 Change ReturnType of GlobalDataStore.GetAsync from Variant to Tuple

Tags: [Yields]

IncrementAsync On DevHub

This function yields. It will block the calling thread until completion.

Parameters	4

Name	Type	Default
key	string	none
delta	int	1
userIds	Array	{}
options	DataStoreIncrementOptions	nil

Return Type	Variant

History

483 Change Parameters of GlobalDataStore.IncrementAsync from (string key, int delta = 1, Array userIds = {}, Instance options = nil) to (string key, int delta = 1, Array userIds = {}, DataStoreIncrementOptions options = nil)
462 Change Parameters of GlobalDataStore.IncrementAsync from (string key, int delta = 1, Array userids = {}, Instance options = nil) to (string key, int delta = 1, Array userIds = {}, Instance options = nil)
460 Change Parameters of GlobalDataStore.IncrementAsync from (string key, int delta = 1) to (string key, int delta = 1, Array userids = {}, Instance options = nil)
452 Change ReturnType of GlobalDataStore.IncrementAsync from Tuple to Variant
453 Change ReturnType of GlobalDataStore.IncrementAsync from Variant to Tuple

Tags: [Yields]

OnUpdate On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	2

Name	Type	Default
key	string	none
callback	Function	none

Return Type	RBXScriptConnection

History

404 Change Tags of GlobalDataStore.OnUpdate from [] to [Deprecated]

Tags: [Deprecated]

RemoveAsync On DevHub

This function yields. It will block the calling thread until completion.

Parameters	1

Name	Type	Default
key	string	none

Return Type	Tuple

History

459 Change ReturnType of GlobalDataStore.RemoveAsync from Variant to Tuple
458 Change ReturnType of GlobalDataStore.RemoveAsync from Tuple to Variant
459 Change ReturnType of GlobalDataStore.RemoveAsync from Variant to Tuple
452 Change ReturnType of GlobalDataStore.RemoveAsync from Tuple to Variant
453 Change ReturnType of GlobalDataStore.RemoveAsync from Variant to Tuple
313 Add GlobalDataStore.RemoveAsync

Tags: [Yields]

SetAsync On DevHub

This function yields. It will block the calling thread until completion.

Parameters	4

Name	Type	Default
key	string	none
value	Variant	none
userIds	Array	{}
options	DataStoreSetOptions	nil

Return Type	Variant

History

483 Change Parameters of GlobalDataStore.SetAsync from (string key, Variant value, Array userIds = {}, Instance options = nil) to (string key, Variant value, Array userIds = {}, DataStoreSetOptions options = nil)
462 Change Parameters of GlobalDataStore.SetAsync from (string key, Variant value, Array userids = {}, Instance options = nil) to (string key, Variant value, Array userIds = {}, Instance options = nil)
460 Change Parameters of GlobalDataStore.SetAsync from (string key, Variant value, Variant userids, Instance options = nil) to (string key, Variant value, Array userids = {}, Instance options = nil)
459 Change Parameters of GlobalDataStore.SetAsync from (string key, Variant value) to (string key, Variant value, Variant userids, Instance options = nil)
459 Change ReturnType of GlobalDataStore.SetAsync from void to Variant
458 Change Parameters of GlobalDataStore.SetAsync from (string key, Variant value, Variant userids, Instance options = nil) to (string key, Variant value)
458 Change ReturnType of GlobalDataStore.SetAsync from Variant to void
459 Change Parameters of GlobalDataStore.SetAsync from (string key, Variant value) to (string key, Variant value, Variant userids, Instance options = nil)
459 Change ReturnType of GlobalDataStore.SetAsync from void to Variant
452 Change Parameters of GlobalDataStore.SetAsync from (string key, Variant value, Variant userid, Instance options = nil) to (string key, Variant value)
452 Change ReturnType of GlobalDataStore.SetAsync from string to void
453 Change Parameters of GlobalDataStore.SetAsync from (string key, Variant value) to (string key, Variant value, Variant userid, Instance options = nil)
453 Change ReturnType of GlobalDataStore.SetAsync from void to string

Tags: [Yields]

UpdateAsync On DevHub

This function yields. It will block the calling thread until completion.

Parameters	2

Name	Type	Default
key	string	none
transformFunction	Function	none

Return Type	Tuple

Tags: [Yields]

Removed members

GetVersionAsync

This function yields. It will block the calling thread until completion.

Parameters	2

Name	Type	Default
key	string	none
version	string	none

Return Type	Tuple

History

452 Remove GlobalDataStore.GetVersionAsync
453 Add GlobalDataStore.GetVersionAsync

Tags: [Yields]

ListKeysAsync

This function yields. It will block the calling thread until completion.

Parameters	2

Name	Type	Default
prefix	string
pageSize	int	0

Return Type	Instance

History

452 Remove GlobalDataStore.ListKeysAsync
453 Add GlobalDataStore.ListKeysAsync

Tags: [Yields]

ListVersionsAsync

This function yields. It will block the calling thread until completion.

Parameters	5

Name	Type	Default
key	string	none
sortDirection	SortDirection	Ascending
minDate	int64	0
maxDate	int64	0
pageSize	int	0

Return Type	Instance

History

452 Remove GlobalDataStore.ListVersionsAsync
453 Add GlobalDataStore.ListVersionsAsync

Tags: [Yields]

RemoveVersionAsync

This function yields. It will block the calling thread until completion.

Parameters	2

Name	Type	Default
key	string	none
version	string	none

Return Type	void

Roblox API Reference

GlobalDataStore On DevHub

Summary

Inherits (1)

Inherited by (2)

Member index (6)

Removed member index (4)

History

Members

GetAsync On DevHub

History

IncrementAsync On DevHub

History

OnUpdate On DevHub

History

RemoveAsync On DevHub

History

SetAsync On DevHub

History

UpdateAsync On DevHub

Removed members

GetVersionAsync

History

ListKeysAsync

History

ListVersionsAsync

History

RemoveVersionAsync

History

Relevant classes (3)

Relevant members (2)