Item: add getFactory & getExtended methods, add support defaultItemDef
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---@class Item.ItemDefinition
|
||||
---@field settings Item.Settings
|
||||
---@field callbacks Item.Callbacks
|
||||
---@field callbacks Item.Callbacks?
|
||||
local ItemDefinition = {}
|
||||
|
||||
return ItemDefinition
|
||||
|
||||
@@ -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 = ""
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user