From 7c241af96a7f04e31f76fa08f046f597d00f2429 Mon Sep 17 00:00:00 2001 From: Vanic Date: Mon, 27 Apr 2026 19:34:04 +0300 Subject: [PATCH] `HelperLib`: Added methods for handler inventory items --- mods/SYSTEM/HelperLib/src/Lib.lua | 1 + .../HelperLib/src/Lib/itemStackInventory.lua | 53 +++++++++++++++++++ .../HelperLib/src/Lib/registeredItems.lua | 16 +++++- 3 files changed, 69 insertions(+), 1 deletion(-) create mode 100644 mods/SYSTEM/HelperLib/src/Lib/itemStackInventory.lua diff --git a/mods/SYSTEM/HelperLib/src/Lib.lua b/mods/SYSTEM/HelperLib/src/Lib.lua index 8d02882..68f8cd4 100644 --- a/mods/SYSTEM/HelperLib/src/Lib.lua +++ b/mods/SYSTEM/HelperLib/src/Lib.lua @@ -7,6 +7,7 @@ require('Lib.activeFormspecs') require('Lib.globalStep') require('Lib.color') require('Lib.immersiveCraftData') +require('Lib.itemStackInventory') require('Lib.getObjectByGUID') require('Lib.receiveFields') require('Lib.registeredItems') diff --git a/mods/SYSTEM/HelperLib/src/Lib/itemStackInventory.lua b/mods/SYSTEM/HelperLib/src/Lib/itemStackInventory.lua new file mode 100644 index 0000000..d32323f --- /dev/null +++ b/mods/SYSTEM/HelperLib/src/Lib/itemStackInventory.lua @@ -0,0 +1,53 @@ +local ITEMSTACK_INVENTORY_LIST_META_KEY = 'itemstack_inventory_list' + +---Adds an inventory list to the ItemStack's metadata. +---@param item ItemStack +---@param list ItemStack[] +function Smc.setItemInventoryList(item, list) + if #list ~= Smc.getItemInventoryListSize(item) then + error('The passed inventory list does not match the item\'s inventory list size.') + end + + local meta = item:get_meta() + + local items = {} + for i, stack in ipairs(list) do + items[i] = stack:to_string() + end + + meta:set_string(ITEMSTACK_INVENTORY_LIST_META_KEY, core.serialize(items)) + print('LIST: ', dump(core.deserialize(meta:get_string(ITEMSTACK_INVENTORY_LIST_META_KEY)))) +end + +---Return an inventory list to the ItemStack's metadata. +--- +---If the item has no inventory, it will return the `nil`. +---@param item ItemStack +---@return ItemStack[]? +function Smc.getItemInventoryList(item) + local meta = item:get_meta() + + ---@type ItemStack[]? + local list = core.deserialize(meta:get_string(ITEMSTACK_INVENTORY_LIST_META_KEY)) + print('LIST2: ', dump(core.deserialize(meta:get_string(ITEMSTACK_INVENTORY_LIST_META_KEY)))) + + return list +end + +---Returns the size of an item's inventory list, as determined by `_itemstack_inventory_size`. +--- +---If the item has no inventory, it will return `0`. +---@param item ItemStack +---@return integer +function Smc.getItemInventoryListSize(item) + return Smc.getItemDefinition(item).settings._itemstack_inventory_size or 0 +end + +---Returns the name of the bag background texture, as determined by `_itemstack_inventory_background`. +--- +---If the item has no texture, it will return empty string. +---@param item ItemStack +---@return string +function Smc.getItemInventoryListBackground(item) + return Smc.getItemDefinition(item).settings._itemstack_inventory_background or '' +end diff --git a/mods/SYSTEM/HelperLib/src/Lib/registeredItems.lua b/mods/SYSTEM/HelperLib/src/Lib/registeredItems.lua index e110e86..61a206c 100644 --- a/mods/SYSTEM/HelperLib/src/Lib/registeredItems.lua +++ b/mods/SYSTEM/HelperLib/src/Lib/registeredItems.lua @@ -27,7 +27,7 @@ function Smc.getRegisteredItemsByMod(shortModName) return table.copy_with_metatables(registeredItemsByMod[shortModName]) end ----@param itemName string +---@param itemName ItemStackString ---@return Item|Node function Smc.getRegisteredItemByName(itemName) return table.copy_with_metatables(registeredItems[itemName]) @@ -37,3 +37,17 @@ end function Smc.getRegisteredItems() return table.copy_with_metatables(registeredItems) end + +---@param itemName ItemStack|ItemStackString +---@return Item.ItemDefinition|Node.NodeDefinition +function Smc.getItemDefinition(itemName) + if type(itemName) == 'table' or type(itemName) == 'userdata' then + itemName = itemName:get_name() + end + print('ItemName:', itemName) + + local item = Smc.getRegisteredItemByName(itemName) + assert(item ~= nil) + + return item.itemDef +end