From c7cfe26335412de4c4ae56f4a976ef0502678be2 Mon Sep 17 00:00:00 2001 From: Vanic Date: Fri, 27 Feb 2026 20:57:54 +0300 Subject: [PATCH] `Tool`: create tool class --- mods/CORE/Item/src/Item.lua | 37 ++++++++---- mods/CORE/Item/src/Item/Settings.lua | 4 +- mods/CORE/Item/src/Item/Type.lua | 1 + mods/CORE/Item/src/Item/Visual.lua | 1 - mods/CORE/Node/src/Node.lua | 2 +- mods/CORE/Tool/init.lua | 4 ++ mods/CORE/Tool/mod.conf | 2 + mods/CORE/Tool/src/Tool.lua | 70 ++++++++++++++++++++++ mods/CORE/adminCommands/init.lua | 5 +- mods/SYSTEM/HelperLib/src/Lib/requires.lua | 8 +++ 10 files changed, 116 insertions(+), 18 deletions(-) create mode 100644 mods/CORE/Item/src/Item/Type.lua delete mode 100644 mods/CORE/Item/src/Item/Visual.lua create mode 100644 mods/CORE/Tool/init.lua create mode 100644 mods/CORE/Tool/mod.conf create mode 100644 mods/CORE/Tool/src/Tool.lua diff --git a/mods/CORE/Item/src/Item.lua b/mods/CORE/Item/src/Item.lua index b1afa66..ff420e3 100644 --- a/mods/CORE/Item/src/Item.lua +++ b/mods/CORE/Item/src/Item.lua @@ -34,7 +34,7 @@ local RARITY_INDEX = { ---@class Item ---@field itemDef Item.ItemDefinition ---@field luantiDef ItemDefinition ----@field getVisual fun(): string +---@field getType fun():string ---@field defaultDef Item.ItemDefinition local Item = { defaultDef = { @@ -121,7 +121,7 @@ local function itemDefToLuantiDef(itemDef) end ---@param luantiDef NodeDefinition -local function register3dItem(luantiDef) +local function registerNode(luantiDef) local name = luantiDef.name luantiDef.name = nil @@ -129,13 +129,21 @@ local function register3dItem(luantiDef) end ---@param luantiDef ItemDefinition -local function registerFlatItem(luantiDef) +local function registerCraftitem(luantiDef) local name = luantiDef.name luantiDef.name = nil core.register_craftitem(':'..name, luantiDef) end +---@param luantiDef ItemDefinition +local function registerTool(luantiDef) + local name = luantiDef.name + luantiDef.name = nil + + core.register_tool(':'..name, luantiDef) +end + ---The alias `table.merge` for EmmyLua ---@type fun(...):(Item.ItemDefinition) local defMerge = function(...) @@ -162,23 +170,26 @@ function Item:new(itemDef) local instance = getInstance(self, {}) local luantiDef = itemDefToLuantiDef(itemDef) - local visual = itemDef.settings._visual + local type = itemDef.settings._type - if visual == nil then - visual = 'item_2d' + if type == nil then + type = 'craftitem' end - itemDef.settings._visual = nil + itemDef.settings._type = nil - if visual == 'item_3d' then - register3dItem(luantiDef) + if type == 'node' then + registerNode(luantiDef) + elseif type == 'craftitem' then + registerCraftitem(luantiDef) + elseif type == 'tool' then + registerTool(luantiDef) else - visual = 'item_2d' - registerFlatItem(luantiDef) + error(('Unknown item type: `%s`.'):format(type)) end - function instance:getVisual() - return visual + function instance:getType() + return type end instance.itemDef = itemDef diff --git a/mods/CORE/Item/src/Item/Settings.lua b/mods/CORE/Item/src/Item/Settings.lua index 3942219..b8edd78 100644 --- a/mods/CORE/Item/src/Item/Settings.lua +++ b/mods/CORE/Item/src/Item/Settings.lua @@ -33,8 +33,8 @@ Settings._title_color = nil Settings._description_color = nil ---Visual node type. ----@type Item.Visual? -Settings._visual = nil +---@type Item.Type? +Settings._type = nil ---Formal (lore) rarity of an item. Default `common`. ---@type Item.Rarity? diff --git a/mods/CORE/Item/src/Item/Type.lua b/mods/CORE/Item/src/Item/Type.lua new file mode 100644 index 0000000..9e144d0 --- /dev/null +++ b/mods/CORE/Item/src/Item/Type.lua @@ -0,0 +1 @@ +---@alias Item.Type 'craftitem'|'node'|'tool' \ No newline at end of file diff --git a/mods/CORE/Item/src/Item/Visual.lua b/mods/CORE/Item/src/Item/Visual.lua deleted file mode 100644 index 5715984..0000000 --- a/mods/CORE/Item/src/Item/Visual.lua +++ /dev/null @@ -1 +0,0 @@ ----@alias Item.Visual 'item_2d'|'item_3d' \ No newline at end of file diff --git a/mods/CORE/Node/src/Node.lua b/mods/CORE/Node/src/Node.lua index 22ca625..05661f9 100644 --- a/mods/CORE/Node/src/Node.lua +++ b/mods/CORE/Node/src/Node.lua @@ -16,7 +16,7 @@ function Node:new(nodeDef) ---Adding default parameters nodeDef = defMerge(nodeDef, self.defaultDef, true) - nodeDef.settings._visual = 'item_3d' + nodeDef.settings._type = 'node' ---@type Node local instance = Item:new(nodeDef) diff --git a/mods/CORE/Tool/init.lua b/mods/CORE/Tool/init.lua new file mode 100644 index 0000000..312f5a4 --- /dev/null +++ b/mods/CORE/Tool/init.lua @@ -0,0 +1,4 @@ +local modInfo = Mod.getInfo('smc__core__tool') +local require = modInfo.require + +return require('Tool') diff --git a/mods/CORE/Tool/mod.conf b/mods/CORE/Tool/mod.conf new file mode 100644 index 0000000..0ab0b0e --- /dev/null +++ b/mods/CORE/Tool/mod.conf @@ -0,0 +1,2 @@ +name = smc__core__tool +depends = smc__core__item diff --git a/mods/CORE/Tool/src/Tool.lua b/mods/CORE/Tool/src/Tool.lua new file mode 100644 index 0000000..fae22f2 --- /dev/null +++ b/mods/CORE/Tool/src/Tool.lua @@ -0,0 +1,70 @@ +local Item, ItemFactory = Smc.requireItem(), Smc.requireItemFactory() + +---@class Tool : Item +---@field defaultDef Item.ItemDefinition +local Tool = Class.extend(Item, {}) + +---The alias `table.merge` for EmmyLua +---@type fun(...):(Item.ItemDefinition) +local defMerge = function(...) + return table.merge(...) +end + +---@param ToolDef Item.ItemDefinition +---@return Tool +function Tool:new(ToolDef) + ---Adding default parameters + ToolDef = defMerge(ToolDef, self.defaultDef, true) + + ToolDef.settings._type = 'tool' + + ---@type Tool + local instance = Item:new(ToolDef) + return instance +end + +---Allows you to create a child class of an tool by specifying +---default parameters that will be added to the tool's parameters +---when an instance is received. +---@param defaultDef Item.ItemDefinition +---@return Tool +function Tool:getExtended(defaultDef) + defaultDef = defMerge(defaultDef, self.defaultDef) + + ---@type Tool + local ChildClass = Class.extend(self, { + defaultDef = defaultDef, + }) + + return ChildClass +end + +---Returns an instance of the `ItemFactory` class that can be used to mass-register identical items. +---@param defaultDef? Item.ItemDefinition +---@return ItemFactory +function Tool:getFactory(defaultDef) + if defaultDef == nil then + defaultDef = self.defaultDef + else + defaultDef = defMerge(self.defaultDef, defaultDef) + end + + ---@type ItemFactory + local instance = ItemFactory:new(self, defaultDef) + + return instance +end +--[[ + Tool:new({ + settings = { + name = 'tool', + inventory_image = 'anoba.png', + tool_capabilities = { + groupcaps={ + crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}} + }, + } + } + })--]] + +return Tool diff --git a/mods/CORE/adminCommands/init.lua b/mods/CORE/adminCommands/init.lua index c6136bf..598d24f 100644 --- a/mods/CORE/adminCommands/init.lua +++ b/mods/CORE/adminCommands/init.lua @@ -64,7 +64,10 @@ core.register_on_player_receive_fields(function(player, formname, fields) return end - core.log(tostring(stack)) + ---@type ItemStack + stack = ItemStack(stack) + + core.log(dump(stack:get_definition())) ---@type InvRef local inv = player:get_inventory() diff --git a/mods/SYSTEM/HelperLib/src/Lib/requires.lua b/mods/SYSTEM/HelperLib/src/Lib/requires.lua index 9d8ab94..ce35b53 100644 --- a/mods/SYSTEM/HelperLib/src/Lib/requires.lua +++ b/mods/SYSTEM/HelperLib/src/Lib/requires.lua @@ -16,6 +16,14 @@ function Smc.requireNode() return class end +---@return Tool +function Smc.requireTool() + ---@type Tool + local class = Mod.getInfo('smc__core__tool').require('Tool') + + return class +end + ---@return Plant function Smc.requirePlant() ---@type Plant