Item: add param addModName

This commit is contained in:
Van
2026-01-05 15:44:53 +03:00
parent 6236a12ca9
commit a08934c6e4
6 changed files with 26 additions and 27 deletions

View File

@@ -15,7 +15,8 @@ local Item = {
title = '', title = '',
description = '', description = '',
titleColor = '#FFFFFF', titleColor = '#FFFFFF',
descriptionColor = '#C0C0C0' descriptionColor = '#C0C0C0',
addModName = true,
}, },
callbacks = {} callbacks = {}
} }
@@ -28,21 +29,16 @@ local defMerge = function(...)
end end
---@param itemDef Item.ItemDefinition ---@param itemDef Item.ItemDefinition
---@param addModName boolean? Whether to add the mod name to the settings.name. Default: `true`
---@return NodeDefinition|ItemDefinition ---@return NodeDefinition|ItemDefinition
local function itemDefToLuantiDef(itemDef, addModName) local function itemDefToLuantiDef(itemDef)
local modName = Mod.getInfo().shortName local modName = Mod.getInfo().shortName
local S = core.get_translator(modName) local S = core.get_translator(modName)
if addModName == nil then
addModName = true
end
itemDef = table.copy(itemDef) itemDef = table.copy(itemDef)
local s = itemDef.settings local s = itemDef.settings
local c = itemDef.callbacks local c = itemDef.callbacks
if addModName then if s.addModName then
s.name = modName .. ':' .. s.name s.name = modName .. ':' .. s.name
end end
@@ -57,8 +53,12 @@ local function itemDefToLuantiDef(itemDef, addModName)
description = string.match(s.name, '%S:(%S+)')..'-desc' description = string.match(s.name, '%S:(%S+)')..'-desc'
end end
---@diagnostic disable-next-line: param-type-not-match if s.titleColor ~= nil and s.descriptionColor ~= nil then
local description = core.colorize(s.titleColor ,S(title))..'\n'..core.colorize(s.descriptionColor, S(description)) description = core.colorize(s.titleColor ,S(title))..'\n'..
core.colorize(s.descriptionColor, S(description))
else
error('Item description color parameters cannot be empty.')
end
s.title, s.description = nil, description s.title, s.description = nil, description
@@ -90,16 +90,15 @@ local defMerge = function(...)
end end
---@param itemDef Item.ItemDefinition|Node.NodeDefinition ---@param itemDef Item.ItemDefinition|Node.NodeDefinition
---@param addModName boolean? Whether to add the mod name to the settings.name. Default: `true`
---@return Item ---@return Item
function Item:new(itemDef, addModName) function Item:new(itemDef)
---Adding default parameters ---Adding default parameters
itemDef = defMerge(itemDef, self.defaultDef, true) itemDef = defMerge(itemDef, self.defaultDef, true)
---@type Item ---@type Item
local instance = setmetatable({}, {__index = self}) local instance = setmetatable({}, {__index = self})
local luantiDef = itemDefToLuantiDef(itemDef, addModName) local luantiDef = itemDefToLuantiDef(itemDef)
local visual = itemDef.settings.visual local visual = itemDef.settings.visual
if visual == nil then if visual == nil then

View File

@@ -3,7 +3,11 @@ local Settings = {}
---Technical name of the item. Must be unique and have the format `mod_name:item_name` ---Technical name of the item. Must be unique and have the format `mod_name:item_name`
---@type string ---@type string
Settings.name = "" Settings.name = ''
---Whether to add the mod name to the settings.name. Default: `true`
---@type boolean?
Settings.addModName = nil
---Item description. 1st line of item description. ---Item description. 1st line of item description.
---@type string? ---@type string?

View File

@@ -23,13 +23,12 @@ local defMerge = function(...)
end end
---@param itemDefs Item.ItemDefinition[]|Node.NodeDefinition[] List of nodes with parameters unique to them. ---@param itemDefs Item.ItemDefinition[]|Node.NodeDefinition[] List of nodes with parameters unique to them.
---@param addModName boolean? Whether to add the mod name to the settings.name. Default: `true` function ItemFactory:registerItems(itemDefs)
function ItemFactory:registerItems(itemDefs, addModName)
---@param nodeDef Item.ItemDefinition | Node.NodeDefinition ---@param nodeDef Item.ItemDefinition | Node.NodeDefinition
for _, itemDef in ipairs(itemDefs) do for _, itemDef in ipairs(itemDefs) do
itemDef = defMerge(itemDef, self.defaultDef, true) itemDef = defMerge(itemDef, self.defaultDef, true)
self.itemClass:new(itemDef, addModName) self.itemClass:new(itemDef)
end end
end end
@@ -41,8 +40,7 @@ local defMerge = function(...)
end end
---@param shortNodeDefs table Table of the form `{ {name, title, description, tiles}, {name, title, description, tiles}, ...}` ---@param shortNodeDefs table Table of the form `{ {name, title, description, tiles}, {name, title, description, tiles}, ...}`
---@param addModName boolean? Whether to add the mod name to the settings.name. Default: `true` function ItemFactory:registerNodesByShortDef(shortNodeDefs)
function ItemFactory:registerNodesByShortDef(shortNodeDefs, addModName)
for _, shortNodeDef in ipairs(shortNodeDefs) do for _, shortNodeDef in ipairs(shortNodeDefs) do
---@type Node.NodeDefinition ---@type Node.NodeDefinition
local nodeDef = { local nodeDef = {
@@ -56,8 +54,7 @@ function ItemFactory:registerNodesByShortDef(shortNodeDefs, addModName)
nodeDef = defMerge(nodeDef, self.defaultDef, true) nodeDef = defMerge(nodeDef, self.defaultDef, true)
self.itemClass:new(nodeDef, addModName) self.itemClass:new(nodeDef)
end end
end end

View File

@@ -17,17 +17,15 @@ local defMerge = function(...)
end end
---@param nodeDef Node.NodeDefinition ---@param nodeDef Node.NodeDefinition
---@param addModName boolean? Whether to add the mod name to the settings.name. Default: `true`
---@return Node ---@return Node
function Node:new(nodeDef, addModName) function Node:new(nodeDef)
---Adding default parameters ---Adding default parameters
nodeDef = defMerge(nodeDef, self.defaultDef, true) nodeDef = defMerge(nodeDef, self.defaultDef, true)
nodeDef.settings.visual = 'item_3d' nodeDef.settings.visual = 'item_3d'
---@type Node ---@type Node
local instance = Item:new(nodeDef, addModName) local instance = Item:new(nodeDef)
return instance return instance
end end

View File

@@ -5,6 +5,7 @@ local Node = Mod.getInfo('smc__core__node').require('Node')
local defaultLiquidDef = { local defaultLiquidDef = {
settings = { settings = {
name = '', name = '',
addModName = false,
tiles = {}, tiles = {},
waving = 3, waving = 3,
use_texture_alpha = "blend", use_texture_alpha = "blend",
@@ -94,4 +95,4 @@ liquidFactory:registerItems({
paramtype2 = "flowingliquid", paramtype2 = "flowingliquid",
} }
} }
}, false) })

View File

@@ -236,7 +236,7 @@ soilFactory:registerItems({
}, },
}, },
}, true) })
---@type TileSheet ---@type TileSheet
local tsT = TileSheet:new("soils_turfs_sheet.png", 16, 16) local tsT = TileSheet:new("soils_turfs_sheet.png", 16, 16)