Roblox UtilitiesDevlHub Roblox Documentation

Class

DataStoreKeyPages

NotCreatableNotReplicated
Inherits
Pages › Instance › Object
Memory category
Instances

A special type of Pages object whose pages contain DataStoreKey instances.

A special type of Pages object whose pages contain DataStoreKey instances. Pages:GetCurrentPage() can be used to retrieve an array of the DataStoreKey instances.

See also:

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

Properties 1#

CursorstringMarks the position from which the next page of keys is retrieved.ReadSafeReadOnlyNotReplicated

Cursor: string#

ReadOnlyNotReplicatedReadSafe

A read-only pagination cursor that marks the position from which the next page of keys is retrieved. It defaults to an empty string.

The cursor advances as each page is retrieved. When you call Pages:AdvanceToNextPageAsync(), a non-empty cursor is sent as the exclusive start key so the request returns the keys that follow the current page; while it remains empty, the request fetches the first page. The cursor is cleared once there are no more keys to return, at which point Pages.IsFinished becomes true.

Inherited members#

Inherited from Pages 3
Properties (1)

IsFinished

Inherited from Instance 58
Inherited from Object 6
Properties (2)

ClassName, className

Events (1)

Changed