Annotations changes: clarification of types, addition of missing annotations

This commit is contained in:
Van
2025-10-03 20:50:14 +03:00
parent ab92e372f3
commit 69b8c6469c
13 changed files with 129 additions and 84 deletions

View File

@@ -19,22 +19,27 @@ local Item = {
}
}
---The alias `table.merge` for EmmyLua
---@type fun(...):(NodeDefinition|ItemDefinition)
local defMerge = function(...)
return table.merge(...)
end
---@param itemDef Item.ItemDefinition
---@return NodeDefinition|ItemDefinition
local function itemDefToLuantiDef(itemDef)
-- TODO: удалить следующую строчку, когда подключим ide-helper от Алека
---@diagnostic disable-next-line: undefined-field
itemDef = table.copy(itemDef)
local s = itemDef.settings
local c = itemDef.callbacks
local description = s.title .. "\n" .. s.description
s.title, s.description = nil, description
local luantiDef = table.merge(s, c)
local luantiDef = defMerge(s, c)
return luantiDef
end
---@param luantiDef table
---@param luantiDef NodeDefinition|ItemDefinition
local function register3dItem(luantiDef)
local ld = luantiDef
local name = ld.name
@@ -42,7 +47,7 @@ local function register3dItem(luantiDef)
core.register_node(':'..name, luantiDef)
end
---@param luantiDef table
---@param luantiDef ItemDefinition
local function registerFlatItem(luantiDef)
local ld = luantiDef
local name = ld.name
@@ -50,14 +55,14 @@ local function registerFlatItem(luantiDef)
core.register_craftitem(':'..name, luantiDef)
end
---The aleas `table.merge` for EmmyLua
---The alias `table.merge` for EmmyLua
---@type fun(...):(Item.ItemDefinition)
local defMerge = function(...)
return table.merge(...)
end
---@param itemDef Item.ItemDefinition
---@return Item
---@param itemDef Item.ItemDefinition
---@return Item
function Item:new(itemDef)
---Adding default parameters
itemDef = defMerge(itemDef, self.defaultDef, true)
@@ -81,13 +86,13 @@ function Item:new(itemDef)
registerFlatItem(luantiDef)
end
---@return string
function instance:getVisual()
return visual
end
instance.itemDef = itemDef
instance.luantiDef = luantiDef
return instance
end
@@ -95,7 +100,7 @@ end
---default parameters that will be added to the item's parameters
---when an instance is received.
---@param defaultDef Item.ItemDefinition
---@return Item
---@return Item
function Item:getExtended(defaultDef)
---@type Item
local ChildClass = Mod:getClassExtended(self, {
@@ -107,12 +112,13 @@ end
---Returns an instance of the `ItemFactory` class that can be used to mass-register identical items.
---@param defaultDef? Item.ItemDefinition
---@return ItemFactory
---@return ItemFactory
function Item:getFactory(defaultDef)
if defaultDef == nil then
defaultDef = self.defaultDef
end
---@type ItemFactory
local instance = Core.ItemFactory():new(self, defaultDef)
return instance

View File

@@ -1,7 +1,7 @@
---@class Item.Callbacks
local Callbacks = {}
-- TODO: Вписать вместо `table` более определенные классы: ItemStack, ObjectRef и т.п.
-- TODO: Разобраться с дубликатами аннотаций полей. Приоритетно брать аннотации из util/ide-helper
---Called when the 'place' key was pressed with the item in hand
---and pointing at a node.

View File

@@ -1,6 +1,8 @@
---@class Item.Settings
local Settings = {}
-- TODO: Разобраться с дубликатами аннотаций полей. Приоритетно брать аннотации из util/ide-helper
---Technical name of the item. Must be unique and have the format `mod_name:item_name`
---@type string
Settings.name = ""
@@ -70,7 +72,6 @@ Settings.color = nil
---Maximum amount of items that can be in a single stack.
---The default can be changed by the setting `default_stack_max`.
---TODO: сделать другой стак по умолчанию?
---@type number?
Settings.stack_max = nil