OrderedDataStore¶
A GlobalDataStore that also allows for ordered data store entries.
Note: GetSortedAsync is implemented through the persistence backend.
Description¶
A OrderedDataStore is essentially a GlobalDataStore with the exception that stored values must be integers. It exposes a method GetSortedAsync() which allows inspection of the entries in sorted order using a DataStorePages object.
Ordered data stores do not support versioning and metadata, so
DataStoreKeyInfo is always nil for keys in an
OrderedDataStore. If you need versioning and metadata support, use a
DataStore.
Ordered data stores do not support the optional userIds parameter for
SetAsync() or
IncrementAsync().
See Data stores for an overview on how to use ordered data stores.
Inheritance¶
Object → Instance → GlobalDataStore → OrderedDataStore
Nova inheritance: Instance → GlobalDataStore → OrderedDataStore
Methods¶
GetSortedAsync Supported Function Returns a DataStorePages object.
OrderedDataStore:GetSortedAsync(bool ascending, int pagesize, Variant minValue, Variant maxValue): Instance
Returns a DataStorePages object. The sort order is determined by ascending, the length of each page by pageSize, and minValue/maxValue are optional parameters which filter the results.
See Error codes and limits for request limits and descriptions of the error codes.
Roblox reference signature
Inherited members¶
Inherited from GlobalDataStore: 8 properties, 41 methods, 7 events. They are documented on the base class page.
Roblox reference: OrderedDataStore
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.