MemoryStoreHashMap
*このコンテンツは、ベータ版のAI(人工知能)を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、 こちら をクリックしてください。
Class.MemoryStoreService 内のハッシュマップにアクセスできます。ハッシュマップは、単語のキーが任意の値(最大サイズを参照してください - 「メモリストア」)に関連付けられたコレクションのアイテムです。キーには並べ替えの保証はありません。
概要
方法
ハッシュマップのキーの値を取り戻します。
ハッシュマップのアイテムを枚数で表示するための MemoryStoreHashMapPages オブジェクトを返します。
ハッシュマップからアイテムを削除します。
ハッシュマップのキーの値を設定します。
ハッシュマップからキーの値を取得し、新しい値に更新できます。
プロパティ
方法
GetAsync
ハッシュマップのキーの値を取り戻します。
パラメータ
取り戻したい値のキー。
戻り値
キーが存在しない場合は、値、またはなしです。
コードサンプル
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
ListItemsAsync
ハッシュマップのアイテムを枚数で表示するための MemoryStoreHashMapPages オブジェクトを返します。有効な範囲は 1 から 200 までです。
パラメータ
返すことのできるアイテムの最大可能数。
戻り値
Class.MemoryStoreOperations インスタンス、MemoryStoreHashMapPages インスタンスを列挙します。
コードサンプル
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
ハッシュマップからアイテムを削除します。
パラメータ
削除するキー。
戻り値
コードサンプル
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
ハッシュマップのキーの値を設定し、既存の値を上書きします。
パラメータ
設定する値のあるキー。
設定する値。
アイテムの有効期限は、後で自動的にハッシュマップから削除されます。最大有効期限は 45 日 (3,888,000 秒) です。
戻り値
コードサンプル
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
ハッシュマップからキーの値を取得し、新しい値に更新できます。
このメソッドは、既存のキー値を取り戻し、変換関数にパスし、アイテムの新しい値を返す、これらの例外を除きます:
- キーが存在しない場合、古い値は関数に渡されます。
- 関数が nil を返すと、更新はキャンセルされます。
新しい値は、キーが更新されていない場合(例えば、別のゲームサーバーによって)にのみ保存されます。この時点で、キーが変更されていない場合は、変換機能は最新のアイテム値を使用して再び呼び出されます。このサイクルは、キーが正常に保存されるか、変換機能が零を返して操作を中止するまで繰り返されます。
パラメータ
アップデート新したい値のキー。
あなたが提供する変換機能は、入力として古い値を取り、新しい値を返します。
アイテムの有効期限は、後で自動的にハッシュマップから削除されます。最大有効期限は 45 日 (3,888,000 秒) です。
戻り値
変換関数によって返される最後の値。
コードサンプル
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)