MemoryStoreHashMap

Afficher les obsolètes

*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

Création impossible
Non répliqué

fournit un accès à une carte de hachage dans MemoryStoreService. Une carte de hachage est une collection d'objets où les clés de chaîne sont associées à des valeurs arbitraires (jusqu'à la taille maximale autorisée -- voir stores de mémoire). Les clés n'ont pas de garanties d'ordre.

Résumé

Méthodes

Propriétés

Méthodes

GetAsync

Variant
Rendement

Récupère la valeur d'une clé dans la carte de hachage.

Paramètres

key: string

La clé dont la valeur vous souhaitez récupérer.


Retours

Variant

La valeur, ou zéro si la clé n'existe pas.

Échantillons de code

Getting data from a MemoryStore Hash Map

local MemoryStoreService = game:GetService("MemoryStoreService")
local hashMap = MemoryStoreService:GetHashMap("HashMap1")
local key = "User_1234"
local value = 1000
local expiration = 30
local setSuccess, _ = pcall(function()
return hashMap:SetAsync(key, value, expiration)
end)
if setSuccess then
print("Set succeeded!")
end
local item
local getSuccess, getError = pcall(function()
item = hashMap:GetAsync(key)
end)
if getSuccess then
print(item)
else
warn(getError)
end
Rendement

Retourne un objet MemoryStoreHashMapPages pour l'itération à travers les éléments dans la carte de hachage. La portée valide est 1 à 200 inclus.

Paramètres

count: number

Nombre maximum d'éléments qui peuvent être retournés.


Retours

Une instance MemoryStoreHashMapPages qui numérote les éléments en tant que MemoryStoreHashMapPages instances.

Échantillons de code

Listing items in a MemoryStore Hash Map

local MemoryStoreService = game:GetService("MemoryStoreService")
local testHashMap = MemoryStoreService:GetHashMap("HashMap1")
local EXPIRATION = 600
local NUM_TEST_ITEMS = 32
local function populateHashMap(hashMap: MemoryStoreHashMap, numItems: number): { [string]: any }
print("Setting HashMap data...")
local createdItems = {}
for index = 1, numItems do
local key = tostring(index) -- HashMap keys must be strings
local value = `{key}_test_value`
local success, result = pcall(hashMap.SetAsync, hashMap, key, value, EXPIRATION)
if success then
createdItems[key] = value
else
warn(`Error setting key {key}: {result}`)
end
end
print("Done setting HashMap data.")
return createdItems
end
local function getItemsFromAllPages(pages: MemoryStoreHashMapPages): { [string]: any }
-- Purely for logging purposes, we track what page number we're on
local currentPageNumber = 1
local retrievedItems = {}
while not pages.IsFinished do
print(`Getting items on page {currentPageNumber}...`)
local items = pages:GetCurrentPage()
for _, entry in pairs(items) do
print(`\t{entry.key}: {entry.value}`)
retrievedItems[entry.key] = entry.value
end
-- Advance pages if there are more pages to read
if not pages.IsFinished then
pages:AdvanceToNextPageAsync()
currentPageNumber += 1
end
end
print("Finished reading all pages")
return retrievedItems
end
local function compareAllItems(retrievedItems: { [string]: any }, expectedItems: { [string]: any }): number
print("Comparing retrieved items to expected items...")
local numMatchingItems = 0
for key, expectedValue in pairs(expectedItems) do
if retrievedItems[key] == expectedValue then
numMatchingItems += 1
else
warn(`Mismatched retrieved value for key {key}: expected {expectedValue}, retrieved {retrievedItems[key]}`)
end
end
print("Comparison complete!")
return numMatchingItems
end
-- Keys added to the hashmap are also added to this expectedItems table.
-- Later, the retrieved hashmap items will be compared against this table of expected items.
local expectedItems = populateHashMap(testHashMap, NUM_TEST_ITEMS)
-- Getting pages can error. In this case, we will let it error and stop program execution,
-- but you may want to pcall it and handle it differently.
print(`Getting HashMap pages with ListItemsAsync...`)
local pages = testHashMap:ListItemsAsync(NUM_TEST_ITEMS)
local retrievedItems = getItemsFromAllPages(pages)
local numMatchingItems = compareAllItems(retrievedItems, expectedItems)
-- If there were no errors setting or getting items, all items should match.
print(`Program complete. {numMatchingItems}/{NUM_TEST_ITEMS} retrieved items matched the expected values.`)

RemoveAsync

void
Rendement

Supprime un élément de la carte de hachage.

Paramètres

key: string

La clé à retirer.


Retours

void

Échantillons de code

Removing data from a MemoryStore Hash Map

local MemoryStoreService = game:GetService("MemoryStoreService")
local hashMap = MemoryStoreService:GetHashMap("HashMap1")
local key = "User_1234"
local value = 1000
local expiration = 30
local setSuccess, setError = pcall(function()
return hashMap:SetAsync(key, value, expiration)
end)
if not setSuccess then
warn(setError)
end
local removeSuccess, removeError = pcall(function()
hashMap:RemoveAsync(key)
end)
if removeSuccess then
print("Remove succeeded!")
else
warn(removeError)
end

SetAsync

Rendement

Définit la valeur d'une clé dans la carte de hachage, écrasant toute valeur existante.

Paramètres

key: string

La clé dont la valeur est configurer.

value: Variant

La valeur à configurer.

expiration: number

Expiration de l'article dans secondes, après quoi l'article est automatiquement supprimé de la carte de hachage. Le temps d'expiration maximum est de 45 jours (3 888 000 secondes).


Retours

Échantillons de code

Adding data to a MemoryStore Hash Map

local MemoryStoreService = game:GetService("MemoryStoreService")
local hashMap = MemoryStoreService:GetHashMap("HashMap1")
local key = "User_1234"
local value = 1000
local expiration = 30
local setSuccess, setError = pcall(function()
return hashMap:SetAsync(key, value, expiration)
end)
if setSuccess then
print("Set succeeded!")
else
warn(setError)
end

UpdateAsync

Variant
Rendement

Récupère la valeur d'une clé à partir d'une carte de hachage et te permet de la mettre à jour en valeur.

Cette méthode accepte une fonction de rappel qui récupère la valeur clé existante et la passe à une fonction de transformation, qui renvoie la nouvelle valeur pour l'item, avec ces exceptions :

  • Si la clé n'existe pas, la valeur vieille passée à la fonction est nul.
  • Si la fonction renvoie zéro, la mise à jour est annulée.

La nouvelle valeur est enregistrée uniquement si la clé n'a pas été mise à jour (par exemple, par un autre serveur de jeu) depuis le moment où elle a été lue. Si la valeur change à l'époque, la fonction transformer est appelée à nouveau avec la valeur de l'article la plus récente. Ce cycle se répète jusqu'à ce que la valeur soit enregistrée avec succès ou que la fonction transformer retourne zéro pour annuler l'opération.

Paramètres

key: string

La clé dont la valeur vous souhaitez mettre à mise à jour.

transformFunction: function

La fonction de transformation, que vous fournir. Cette fonction prend la valeur vieille comme entrée et renvoie la nouvelle valeur.

expiration: number

Expiration de l'article dans secondes, après quoi l'article est automatiquement supprimé de la carte de hachage. Le temps d'expiration maximum est de 45 jours (3 888 000 secondes).


Retours

Variant

La dernière valeur renvoyée par la fonction de transformation.

Échantillons de code

Updating a Memory Store Hash Map

local MemoryStoreService = game:GetService("MemoryStoreService")
local hashMap = MemoryStoreService:GetHashMap("ResourceInventory")
local function contributeResources(itemResource, addedCount)
local success, newResourceCount = pcall(function()
return hashMap:UpdateAsync(itemResource, function(resource)
resource = resource or {count = 0}
resource.count = resource.count + addedCount
-- ensure we don't exceed the maximum resource count
if resource.count > 500 then
resource.count = 500
end
return resource
end, 1200)
end)
if success then
print(newResourceCount)
end
end
contributeResources("myResource", 50)

Évènements