From d3f583272d2dd0aa249c2ccd5ac835f09ef6715f Mon Sep 17 00:00:00 2001 From: varttist Date: Wed, 10 Jun 2026 16:50:38 +0300 Subject: [PATCH] `ImmersiveWorkStation`: refactoring (assignment to `NodeSuperClass`) --- .../src/ImmersiveWorkStation.lua | 136 ++++++++++++------ 1 file changed, 93 insertions(+), 43 deletions(-) diff --git a/mods/CORE/ImmersiveWorkStation/src/ImmersiveWorkStation.lua b/mods/CORE/ImmersiveWorkStation/src/ImmersiveWorkStation.lua index bbe1cbe..e5d0704 100644 --- a/mods/CORE/ImmersiveWorkStation/src/ImmersiveWorkStation.lua +++ b/mods/CORE/ImmersiveWorkStation/src/ImmersiveWorkStation.lua @@ -1,29 +1,29 @@ -local getInstance = Class.getInstance +local assert = assert +local coreNodePunch, coreNodeDig, coreChatSendPlayer, coreGetMeta, coreSwapNode = core.node_punch, core.node_dig, core.chat_send_player, core.get_meta, core.swap_node local CraftSystem = Smc.requireCraftSystem() - local PlayerInventoryUI = Smc.requirePlayerInventoryUI() - local Node = Smc.requireNode() --- Default settings that a work station node should have. local ImmersiveWorkStationNode = Node:getExtended({ settings = { name = '', drawtype = 'normal', paramtype = 'light', - groups = { immersive_station = 1, dig_immediate = 2 } + groups = { immersive_work_station = 1, dig_immediate = 2 } } }) ---A work station (node) that enables player interaction ---with the immersive crafting mechanics. ----@class ImmersiveWorkStation ----@field name string ----@field craftType CraftSystem.ImmersiveCraftType ----@field handler CraftSystem.ImmersiveCraftHandler ----@field tab PlayerInventoryUI.getTabFunc -local ImmersiveWorkStation = {} +---@class ImmersiveWorkStation : Class, NodeSuperClass +---@field name string +---@field craftType CraftSystem.ImmersiveCraftType +---@field handler CraftSystem.ImmersiveCraftHandler +---@field tab PlayerInventoryUI.getTabFunc +---@field nodeName string? +---@field activeNodeName string? +local ImmersiveWorkStation = Class:extend({}) ---Definition table for the `ImmersiveWorkStation`. --- @@ -32,67 +32,86 @@ local ImmersiveWorkStation = {} ---@field craftType CraftSystem.ImmersiveCraftType ---@field tab PlayerInventoryUI.getTabFunc ----@param name string ----@param def ImmersiveWorkStationDef ----@param nodeDef Node.NodeDefinition -function ImmersiveWorkStation:new(name, def, nodeDef) +---@alias ImmersiveWorkStation.NodesDefinition {settings:Node.Settings, activeSettings:Node.Settings?, callbacks:Node.Callbacks?} + +---@param def ImmersiveWorkStationDef +---@param nodesDef ImmersiveWorkStation.NodesDefinition +function ImmersiveWorkStation:new(def, nodesDef) local handler = CraftSystem:getImmersiveCraftHandler(def.craftType) ---@type ImmersiveWorkStation - local instance = getInstance(self, {}) - instance.name = name + local instance = self:getInstance({}) instance.craftType = def.craftType instance.handler = handler instance.tab = def.tab - if nodeDef.callbacks == nil then - ---@type Node.Callbacks - nodeDef.callbacks = {} - end - local settings = nodeDef.settings - local callbacks = nodeDef.callbacks + local settings = nodesDef.settings + local activeSettings = nodesDef.activeSettings + local callbacks = nodesDef.callbacks or {} - -- Callback when the work station block is installed in the world - -- Ensures initialization of necessary parameters + local oldCallback = callbacks.on_construct or function(...) end callbacks.on_construct = function(pos) + oldCallback(pos) + instance:init(pos) end + oldCallback = callbacks.on_rightclick or function(...) end -- Callback for interaction with a work station (start of crafting) callbacks.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing) + oldCallback(pos, node, clicker, itemstack, pointed_thing) + instance:showForm(pos, clicker) end + oldCallback = callbacks.on_punch or function(...) end + -- Callback for interaction with a work station (abort of crafting) callbacks.on_punch = function(pos, node, puncher, pointed_thing) + oldCallback(pos, node, puncher, pointed_thing) + instance:abortCraft(pos) + coreNodePunch(pos, node, puncher, pointed_thing) end + oldCallback = callbacks.on_dig or function(...) end callbacks.on_dig = function(pos, node, digger) - ---@type ImmersiveWorkStation.MetaData - local meta = core.get_meta(pos) + oldCallback(pos, node, digger) - local craftName = meta:get_string('craft_name') - if craftName == '' then - return core.node_dig(pos, node, digger) - else - return false - end + return instance:onDig(pos, node, digger) end - -- Registering a node for Luanti. - ImmersiveWorkStationNode:new(nodeDef) + -- Registering a nodes for Luanti. + local node = ImmersiveWorkStationNode:new({ settings = settings, callbacks = callbacks }) + instance.nodeName = node.itemDef.settings.name + + if activeSettings ~= nil then + local activeNode = ImmersiveWorkStationNode:new({ settings = activeSettings, callbacks = callbacks }) + instance.activeNodeName = activeNode.itemDef.settings.name + + Smc.addNodeSuperclass(instance.activeNodeName, instance) + end + + Smc.addNodeSuperclass(instance.nodeName, instance) return instance end +---A wrapper around `core.get_meta()` for convenience +---and returning the correct `MetaDataRef` type. +---@static +---@param pos MapVector +---@return ImmersiveWorkStation.MetaData +function ImmersiveWorkStation:getMeta(pos) + return coreGetMeta(pos) +end + function ImmersiveWorkStation:showForm(pos, player) local playerName = player:get_player_name() - ---@type ImmersiveWorkStation.MetaData - local meta = core.get_meta(pos) + local meta = self:getMeta(pos) local craftName = meta:get_string('craft_name') if craftName ~= '' then - core.chat_send_player(playerName, 'The workbench is occupied by another craft.') + coreChatSendPlayer(playerName, 'The workbench is occupied by another craft.') return end @@ -106,14 +125,45 @@ end ---@param pos MapVector function ImmersiveWorkStation:init(pos) - ---@type ImmersiveWorkStation.MetaData - local meta = core.get_meta(pos) + local meta = self:getMeta(pos) +end + +---Replaces the node with active or inactive depending on the status of the craft. +--- +---If an active node is not specified for a station, +---then no replacement will occur regardless of the status of the process. +---@param isCrafting boolean The stations process status. If `true`, the process is running. +---@param pos MapVector +function ImmersiveWorkStation:swapNode(isCrafting, pos) + assert(self.nodeName ~= nil) + + if self.activeNodeName ~= nil then + if isCrafting then + coreSwapNode(pos, {name = self.activeNodeName}) + else + coreSwapNode(pos, {name = self.nodeName}) + end + end +end + +---@param pos MapVector +---@param node NodeTable +---@param digger Player +---@return boolean +function ImmersiveWorkStation:onDig(pos, node, digger) + local meta = self:getMeta(pos) + + local craftName = meta:get_string('craft_name') + if craftName == '' then + return coreNodeDig(pos, node, digger) + else + return false + end end ---@param pos MapVector function ImmersiveWorkStation:abortCraft(pos) - ---@type ImmersiveWorkStation.MetaData - local meta = core.get_meta(pos) + local meta = self:getMeta(pos) local craftName = meta:get_string('craft_name') if craftName == '' then @@ -139,7 +189,7 @@ local function tab(self, playerName, tabType) return baseGetCraftTab(self, playerName, tabType, 'node_tab', handler) end -ImmersiveWorkStation:new('test_station', { +ImmersiveWorkStation:new({ craftType = 'workbench', tab = tab, },