DataStore

方法

GetVersionAsync(key : string,version : string):Tuple
暂停
Recupera a versão de chave especificada.
GetVersionAtTimeAsync(key : string,timestamp : number):Tuple
暂停
Recupera a versão da chave que estava atual em um determinado momento.
ListKeysAsync(prefix : string,pageSize : number,cursor : string,excludeDeleted : bool):DataStoreKeyPages
暂停
Retorna um objeto DataStoreKeyPages para listar através das chaves de um armazenamento de dados.
ListVersionsAsync(key : string,sortDirection : Enum.SortDirection,minDate : number,maxDate : number,pageSize : number):DataStoreVersionPages
暂停
Contém todas as versões de uma chave.
RemoveVersionAsync(key : string,version : string):void
暂停
Exclui permanentemente a versão especificada de uma chave.

继承自GlobalDataStore的方法

GetAsync(key : string,options : DataStoreGetOptions):Tuple
暂停
返回指定的数据存储中的钥匙的值，以及一个 DataStoreKeyInfo 实例。
IncrementAsync(key : string,delta : number,userIds : Array,options : DataStoreIncrementOptions):Variant
暂停
将键的值提高一个指定的数量（两者都必须为整数）。
RemoveAsync(key : string):Tuple
暂停
保留可访问版本，同时移除指定的钥匙。
SetAsync(key : string,value : Variant,userIds : Array,options : DataStoreSetOptions):Variant
暂停
设置数据存储为指定钥键的值。
UpdateAsync(key : string,transformFunction : function):Tuple
暂停
更新键的值，从指定的回调函数中获取一个新值。

活动

属性

方法

GetVersionAsync

暂停

Essa função recupera a versão da chave especificada, bem como uma instância DataStoreKeyInfo. Um identificador de versão pode ser encontrado através de DataStore:ListVersionsAsync() ou alternativamente ser o identificador retornado por GlobalDataStore:SetAsync().

参数

key: string

Nome da chave para a qual a informação da versão é solicitada. Se DataStoreOptions.AllScopes estiver definido como verdadeiro ao acessar o armazenamento de dados através de DataStoreService:GetDataStore(), este nome de chave deve ser anexado ao escopo original como em "escopo/chave".

version: string

Número da versão da chave para a qual as informações de versão são solicitadas.

O valor da chave na versão especificada e uma instância DataStoreKeyInfo que inclui o número de versão, data e hora que a versão foi criada e funções para recuperar UserIds e metadados.

GetVersionAtTimeAsync

暂停

Essa função recupera a versão da chave que estava atual em um determinado momento, bem como uma instância DataStoreKeyInfo.

参数

key: string

timestamp: number

O tempo de marca de Unix em milisegundos para a qual a versão solicitada estava atual. Deve ser maior que zero. Não deve ser maior que dez minutos no futuro.

O valor da chave que estava atual na hora especificada e uma instância DataStoreKeyInfo que inclui o número de versão, data e hora que a versão foi criada e funções para recuperar UserIds e metadados. nil se nenhuma versão estava atual na hora solicitada.

代码示例

The following code sample retrieves data store key versions using timestamps.

Retrieving DataStore Versions by Time

local DataStoreService = game:GetService("DataStoreService")
local dataStore = DataStoreService:GetDataStore("DataStore")
local key = "key-123"

function setData(data)
  local success, result = pcall(function()
    dataStore:SetAsync(key, data)
  end)
  if not success then
    warn(result)
  end
end

function getVersionAtTime(timestamp)
  local success, result, keyInfo = pcall(function()
    return dataStore:GetVersionAtTimeAsync(key, timestamp.UnixTimestampMillis)
  end)
  if success then
    if result == nil then
      print("No version found at time")
    else
      print(result, keyInfo.Version)
    end
  else
    warn(result)
  end
end

-- Previously ran at 2024/12/02 6:00 UTC
setData("version 1")

-- Previously ran at 2024/12/02 9:00 UTC
setData("version 2")

-- Prints "No version found at time"
local time1 = DateTime.fromUniversalTime(2024, 12, 02, 05, 00)
getVersionAtTime(time1)

-- Prints "version 1 <version>"
local time2 = DateTime.fromUniversalTime(2024, 12, 02, 07, 00)
getVersionAtTime(time2)

-- Prints "version 2 <version>"
local time3 = DateTime.fromUniversalTime(2024, 12, 02, 10, 00)
getVersionAtTime(time3)

ListKeysAsync

DataStoreKeyPages

暂停

Essa função retorna um objeto DataStoreKeyPages para listar através das chaves de um armazenamento de dados. Ela aceita um parâmetro opcional prefix para localizar apenas chaves cujos nomes começam com o prefixo fornecido.

Se DataStoreOptions.AllScopes estiver definido como verdadeiro ao acessar o armazenamento de dados através de DataStoreService:GetDataStore(), as chaves serão retornadas com todos os scopes como prefixos.

参数

prefix: string

(Opcional) Prefixo para usar para localizar chaves.

默认值：""

pageSize: number

(Opcional) Número de itens a serem retornados em cada página. Se nenhum valor for dado, o motor envia um valor padrão de 0 para o serviço de armazenamento de dados, que por sua vez padrão para 50 itens por página.

默认值：0

cursor: string

(Opcional) Cursor para continuar a iteração.

默认值：""

excludeDeleted: bool

(Opcional) Excluir chaves excluídas de serem retornadas.

Quando ativado, ListKeys verificará até 512 chaves. Se todas as chaves verificadas forem excluídas, ele retornará uma lista vazia com um cursor para continuar a iteração.

默认值：false

DataStoreKeyPages

Uma instância DataStoreKeyPages que lista as chaves como DataStoreKey instâncias.

ListVersionsAsync

DataStoreVersionPages

暂停

Essa função lista as versões da chave especificada em ordem crescente ou decrescente, especificadas por um parâmetro Enum.SortDirection. Ele pode filtrar opcionalmente as versões retornadas por tempo mínimo e máximo.

参数

key: string

Nome da chave para as versões listadas. Se DataStoreOptions.AllScopes estiver definido como verdadeiro ao acessar o armazenamento de dados através de DataStoreService:GetDataStore(), este nome de chave deve ser anexado ao escopo original como em "escopo/chave".

sortDirection: Enum.SortDirection

(Opcional) Lista de itens que especificam a ordem de classificação ascendente ou descendente.

默认值："Ascending"

minDate: number

(Opcional) Data de sincronização de Unix em milisegundos após a qual as versões devem ser listadas.

默认值：0

maxDate: number

(Opcional) Data de sincronização do tempo em milisegundos até o qual as versões devem ser listadas.

默认值：0

pageSize: number

默认值：0

DataStoreVersionPages

Uma instância DataStoreVersionPages que lista todas as versões da chave como instâncias DataStoreObjectVersionInfo .

代码示例

The following code sample retrieves all versions after a specified starting time, sorted in ascending order.

Retrieving DataStore Versions With A Date Filter

local DataStoreService = game:GetService("DataStoreService")

local experienceStore = DataStoreService:GetDataStore("PlayerExperience")

local time = DateTime.fromUniversalTime(2020, 10, 09, 01, 42)

local listSuccess, pages = pcall(function()
	return experienceStore:ListVersionsAsync("User_1234", nil, time.UnixTimestampMillis)
end)

if listSuccess then
	local items = pages:GetCurrentPage()

	for key, info in pairs(items) do
		print("Key:", key, "; Version:", info.Version, "; Created:", info.CreatedTime, "; Deleted:", info.IsDeleted)
	end
end

RemoveVersionAsync

void

暂停

Essa função exclui permanentemente a versão especificada de uma chave. Os identificadores de versão podem ser encontrados através de DataStore:ListVersionsAsync() .

Ao contrário de GlobalDataStore:RemoveAsync(), esta função não cria uma nova versão "tombstone" e o valor removido não pode ser recuperado mais tarde.

参数

key: string

Nome da chave para a qual uma versão será removida. Se DataStoreOptions.AllScopes for definido como verdadeiro ao acessar o armazenamento de dados através de DataStoreService:GetDataStore(), este nome de chave deve ser precedido com o escopo original como em "escopo/chave".

version: string

Número da versão da chave para remover.

void

属性继承自GlobalDataStore

活动