From d7c9a49b4b030734c1fea57069f47cb38f7fa512 Mon Sep 17 00:00:00 2001 From: Vanic Date: Mon, 22 Sep 2025 17:45:39 +0000 Subject: [PATCH] Item: add getFactory & getExtended methods, add support defaultItemDef --- mods/CORE/Item/src/Item.lua | 56 ++++++++++++++++++++-- mods/CORE/Item/src/Item/ItemDefinition.lua | 2 +- mods/CORE/Item/src/Item/Settings.lua | 2 +- 3 files changed, 54 insertions(+), 6 deletions(-) diff --git a/mods/CORE/Item/src/Item.lua b/mods/CORE/Item/src/Item.lua index 0ccaa85..71b2843 100644 --- a/mods/CORE/Item/src/Item.lua +++ b/mods/CORE/Item/src/Item.lua @@ -4,10 +4,17 @@ local require = modInfo.require local VisualEnum = require('Item.VisualEnum') ---@class Item ----@field itemDef Item.ItemDefinition ----@field luantiDef table ----@field getVisual fun(): string -local Item = {} +---@field itemDef Item.ItemDefinition +---@field luantiDef table +---@field getVisual fun(): string +---@field defaultItemDef Item.ItemDefinition +local Item = { + defaultItemDef = { + settings = { + name = "" + } + } +} ---@param itemDef Item.ItemDefinition local function itemDefToLuantiDef(itemDef) @@ -38,14 +45,28 @@ local function registerFlatItem(luantiDef) core.register_craftitem(':'..name, luantiDef) end +---The aleas `table.merge` for EmmyLua +---@type fun(...):(Item.ItemDefinition) +local defMerge = function(...) + return table.merge(..., true) +end + ---@param itemDef Item.ItemDefinition ---@return Item function Item:new(itemDef) + ---Adding default parameters + itemDef = defMerge(itemDef, self.defaultItemDef) + ---@type Item local instance = setmetatable({}, {__index = self}) local luantiDef = itemDefToLuantiDef(itemDef) local visual = itemDef.settings.visual + + if visual == nil then + visual = VisualEnum.ITEM_2D + end + itemDef.settings.visual = nil if visual == VisualEnum.ITEM_3D then @@ -65,4 +86,31 @@ function Item:new(itemDef) return instance end +---Allows you to create a child class of an item by specifying +---default parameters that will be added to the item's parameters +---when an instance is received. +---@param defaultItemDef Item.ItemDefinition +---@return Item +function Item:getExtended(defaultItemDef) + ---@type Item + ChildClass = Mod:getClassExtended(self, { + defaultItemDef = defaultItemDef, + }) + + return ChildClass +end + +---Returns an instance of the `Factory` class that can be used to mass-register identical items. +---@param defaultItemDef Item.ItemDefinition +---@return Factory +function Item:getFactory(defaultItemDef) + if defaultItemDef == nil then + defaultItemDef = self.defaultItemDef + end + + local instance = Core.Factory():new(self, defaultItemDef) + + return instance +end + return Item diff --git a/mods/CORE/Item/src/Item/ItemDefinition.lua b/mods/CORE/Item/src/Item/ItemDefinition.lua index e7834b9..72afc5e 100644 --- a/mods/CORE/Item/src/Item/ItemDefinition.lua +++ b/mods/CORE/Item/src/Item/ItemDefinition.lua @@ -1,6 +1,6 @@ ---@class Item.ItemDefinition ---@field settings Item.Settings ----@field callbacks Item.Callbacks +---@field callbacks Item.Callbacks? local ItemDefinition = {} return ItemDefinition diff --git a/mods/CORE/Item/src/Item/Settings.lua b/mods/CORE/Item/src/Item/Settings.lua index 75403f8..1ea5f3e 100644 --- a/mods/CORE/Item/src/Item/Settings.lua +++ b/mods/CORE/Item/src/Item/Settings.lua @@ -15,7 +15,7 @@ Settings.description = nil ---Visual node type. ---Values ​​are specified via an enumeration `Item.VisualEnum`. ----@type Enum.EnumKey +---@type Enum.EnumKey? Settings.visual = ""