Item: Add VisualEnum to item definition. Create Settings & Callbacks classes for ItemDefinition

This commit is contained in:
Van
2025-09-03 19:08:31 +00:00
parent b798ee0b76
commit e40438ce2a
5 changed files with 30 additions and 14 deletions

View File

@@ -1,3 +1,8 @@
local modInfo = Mod.getInfo()
local require = modInfo.require
local VisualEnum = require('Item.VisualEnum')
---@class Item ---@class Item
---@field itemDef Item.ItemDefinition ---@field itemDef Item.ItemDefinition
---@field luantiDef table ---@field luantiDef table
@@ -43,10 +48,10 @@ function Item:new(itemDef)
local visual = itemDef.settings.visual local visual = itemDef.settings.visual
itemDef.settings.visual = nil itemDef.settings.visual = nil
if visual == '3d' then if visual == VisualEnum.ITEM_3D then
register3dItem(luantiDef) register3dItem(luantiDef)
else else
visual = 'flat' visual = VisualEnum.ITEM_2D
registerFlatItem(luantiDef) registerFlatItem(luantiDef)
end end

View File

@@ -1,16 +1,6 @@
---@class Item.ItemDefinition ---@class Item.ItemDefinition
---@field settings table ---@field settings Item.ItemDefinition.Settings
---@field callbacks table ---@field callbacks table
local ItemDefinition = { local ItemDefinition = {}
settings = {
name = '',
title = '', -- 1st line of item description
description = '', -- the rest of item description
visual = '', -- '3d' | 'flat'
...
},
callbacks = {
},
}
return ItemDefinition return ItemDefinition

View File

@@ -0,0 +1,4 @@
---@class Item.ItemDefinition.Callbacks
local Callbacks = {}
return Callbacks

View File

@@ -0,0 +1,8 @@
---@class Item.ItemDefinition.Settings
---@field name string
---@field title string 1st line of item description
---@field description string the rest of item description
---@field visual Enum.EnumKey from ENUM `Item.ItemDefinition.Settings.VisualEnum`
local Settings = {}
return Settings

View File

@@ -0,0 +1,9 @@
---@class Item.VisualEnum : Enum
---@field ITEM_2D Enum.EnumKey
---@field ITEM_3D Enum.EnumKey
local VisualEnum = Core.Enum:getModClassInstance({
'ITEM_2D',
'ITEM_3D',
})
return VisualEnum