DataStore

DataStore : GlobalDataStore

Overview

An object that can be created or retrieved via the DataStoreService:GetDataStore() method, used to continuously store and retrieve in-game data such as player level, currency balance, equipment list, etc.

Properties

Methods

ListKeysAsync

Currently not supported.

Parameters

string InPrefix

A prefix string used to filter the keys to enumerate. If empty, all keys are targeted; if specified, only keys starting with the given prefix are included in the result.

number InPageSize

The maximum number of keys to return per page. The default value is 50.

string InCursor

A cursor returned from a previous request, used to query subsequent pages. If empty, the query starts from the first page.

boolean InExcludeDeleted

Whether to exclude deleted keys from the result. The default value is true; if set to false, keys marked as deleted will also be enumerated.

Return

DataStoreKeyPages

Returns a DataStoreKeyPages object that allows iterating through the keys of the data store on a per-page basis.

Code Samples

Events

See also

Saving & Loading Data

Last updated