DataStore
*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.
Voir magasins de données.
Résumé
Méthodes
Récupère la version clé spécifiée.
- ListKeysAsync(prefix : string,pageSize : number,cursor : string,excludeDeleted : bool):DataStoreKeyPages
Renvoie un objet DataStoreKeyPages pour l'itération à travers les clés d'un boutiquede données.
- ListVersionsAsync(key : string,sortDirection : Enum.SortDirection,minDate : number,maxDate : number,pageSize : number):DataStoreVersionPages
En numérote toutes les versions d'une clé.
Supprime en permanence la version spécifiée d'une clé.
Renvoie la valeur d'une clé dans un stock de données spécifié et une instance DataStoreKeyInfo.
- IncrementAsync(key : string,delta : number,userIds : Array,options : DataStoreIncrementOptions):Variant
Augmente la valeur d'une clé de la valeur fournie (les deux doivent être des nombres).
Supprime la clé spécifiée tout en conservant une version accessible.
Définit la valeur du stock de données pour la clé donnée.
Mise à jour la valeur d'une clé avec une nouvelle valeur de la fonction d'appel spécifiée.
Propriétés
Méthodes
GetVersionAsync
Cette fonction récupère la version de clé spécifiée ainsi que l'instance DataStoreKeyInfo. Un identifiant de version peut être trouvé via DataStore:ListVersionsAsync() ou alternativement être l'identifiant renvoyé par GlobalDataStore:SetAsync().
Paramètres
Nom de la clé pour lequel les informations de version sont demandées. Si DataStoreOptions.AllScopes est défini comme vrai lors de l'accès au magasin de données via DataStoreService:GetDataStore(), ce nom de la clé doit être prépendu avec le champ de vision/clé comme dans « scope/key».
Numéro de version de la clé pour laquelle les informations de version sont demandées.
Retours
La valeur de la clé à la version spécifiée et une instance DataStoreKeyInfo qui inclut le numéro de version, la date et l'heure de la création de la version et les fonctions pour récupérer UserIds et les métadonnées.
ListKeysAsync
Cette fonction renvoie un objet DataStoreKeyPages pour l'indexer par clé dans un boutiquede données. Elle accepte un paramètre facultatif prefix pour ne localiser que les clés dont les noms commencent par le préfixe fourni.
Si DataStoreOptions.AllScopes était réglé sur vrai lors de l'accès au stockage de données via DataStoreService:GetDataStore(), les clés seront renvoyées avec tous les scopes en tant que préfixes.
Paramètres
(Facultatif) Préfixe à utiliser pour localiser les clés.
(Facultatif) Nombre maximum d'éléments qui peuvent être retournés.
(Facultatif) Cursor pour continuer l'itération.
(Facultatif) Exclure les clés supprimées d'être renvoyées.
Lorsqu'il est activé, ListKeys vérifiera jusqu'à 512 clés. Si toutes les clés vérifiées sont supprimées, il renverra une liste vide avec un curseur pour continuer l'itération.
Retours
Une instance DataStoreKeyPages qui numérote les clés en tant que DataStoreKey instances.
ListVersionsAsync
Cette fonction numérote les versions de la clé spécifiée dans l'ordre ascendant ou descendant défini par un Enum.SortDirection paramètre. Il peut filtrer facultativement les versions retournées par leur date de génération minimum et maximum.
Paramètres
Nom de la clé pour les versions à liste. Si DataStoreOptions.AllScopes a été défini comme vrai lors de l'accès au magasin de données via DataStoreService:GetDataStore(), ce nom de la clé doit être prépendu avec le champ d'œil d'origine comme dans « scope/key ».
Liste de types d' éléments.
Date detimestamp de l'UNIX dans millisecondes après laquelle les versions devraient être listées.
Date detimestamp en millis secondes jusqu'à laquelle les versions doivent être répertoriées.
Nombre d'éléments à retourner sur chaque page.
Retours
Une instance DataStoreVersionPages qui numérote toutes les versions de la clé en tant que DataStoreObjectVersionInfo instances.
Échantillons de code
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
endRemoveVersionAsync
Cette fonction supprime en permanence la version spécifiée d'une clé. Les identifiants de version peuvent être trouvés via DataStore:ListVersionsAsync() .
Contrairement à GlobalDataStore:RemoveAsync(), cette fonction ne crée pas de nouvelle version "tombstone" et la valeur supprimée ne peut pas être récupérée plus tard.
Paramètres
Nom de la clé pour laquelle une version doit être supprimée. Si DataStoreOptions.AllScopes a été défini comme vrai lors de l'accès au magasin de données via DataStoreService:GetDataStore(), ce nom de la clé doit être prépendu avec le champ de vision/clé comme dans « scope/key».
Numéro de version de la clé à retirer.