diff --git a/mods/CORE/ProcessingFuelStation/src/ProcessingFuelStation.lua b/mods/CORE/ProcessingFuelStation/src/ProcessingFuelStation.lua index 6b9d854..16d1343 100644 --- a/mods/CORE/ProcessingFuelStation/src/ProcessingFuelStation.lua +++ b/mods/CORE/ProcessingFuelStation/src/ProcessingFuelStation.lua @@ -1,11 +1,12 @@ local FUEL_ENERGY_FACTOR = 0.1 +local v = vector.new +local assert, ipairs = assert, ipairs +local mathMin, mathCeil = math.min, math.ceil +local coreNodePunch, coreGetNode, coreGetItemGroup = core.node_punch, core.get_node, core.get_item_group + local BaseProcessingStation = Smc.requireBaseProcessingStation() ----@type Events.ProcessingStationEvents -local ProcessingStationEvents = Smc.requireEvents('ProcessingStationEvents') - local PlayerInventoryUI = Smc.requirePlayerInventoryUI() - local Node = Smc.requireNode() local ProcessingFuelStationNode = Node:getExtended({ @@ -18,29 +19,49 @@ local ProcessingFuelStationNode = Node:getExtended({ }) ---@class ProcessingFuelStation : BaseProcessingStation +---@field alwaysEnable boolean? +---@field enablerItemGroup string? +---@field disablerItemGroup string? ---@field enableIdling boolean? ----@field enableContainerProcessing boolean? ----@field fuelGroup string ----@field fuelSlots integer +--- +---@field fuelGroup string +---@field fuelSlots integer +--- +---@field getMeta fun(self:ProcessingFuelStation, pos:MapVector):ProcessingFuelStation.MetaData local ProcessingFuelStation = BaseProcessingStation:extend({}) ---Definition table for the `ProcessingFuelStation`. --- ---**Only for EmmyLua.** ---@class ProcessingFuelStationDef : BaseProcessingStationDef +---If `true`, the station will always be enable +---(that is, if there is fuel, it will always try to burn it). +--- +---**Note**: This does not mean the station timer will run always: +---`enable` and `active` are different states. +---@field alwaysEnable boolean? +--- +---The item group that will turn on the station when item hits it. +---If is `nil`, punch with any item will enable the station. +---@field enablerItemGroup string? +--- +---Same as `enablerItemGroup` field, only it turns off the station. +---@field disablerItemGroup string? +--- +---If `true`, it will burn the remaining fuel even if the station is disable. ---@field enableIdling boolean? ----@field enableContainerProcessing boolean? +--- ---@field fuelGroup string? ---@field fuelSlots integer? ----@param name string ---@param def ProcessingFuelStationDef ----@param nodesDef BaseProcessingStation.NodesDef? -function ProcessingFuelStation:new(name, def, nodesDef) +---@param nodesDef BaseProcessingStation.NodesDefinition? +function ProcessingFuelStation:new(def, nodesDef) ---@type ProcessingFuelStation - local instance = self:getInstance(BaseProcessingStation:new(name, def)) + local instance = self:getInstance(BaseProcessingStation:new(def)) + instance.alwaysEnable = def.alwaysEnable + instance.enablerItemGroup = def.enablerItemGroup instance.enableIdling = def.enableIdling - instance.enableContainerProcessing = def.enableContainerProcessing instance.fuelGroup = def.fuelGroup or 'fuel' instance.fuelSlots = def.fuelSlots or 1 @@ -61,6 +82,14 @@ function ProcessingFuelStation:new(name, def, nodesDef) instance:init(pos) end + oldCallback = callbacks.on_punch or function(...) end + callbacks.on_punch = function(pos, node, puncher, pointed_thing) + oldCallback(pos, node, puncher, pointed_thing) + + instance:onPunch(pos, node, puncher, pointed_thing) + coreNodePunch(pos, node, puncher, pointed_thing) + end + oldCallback = callbacks.on_rightclick or function(...) end -- Right-clicking on a station opens the player's inventory, adding context to the station tab. -- Note: we do not use formspec via node metadata. @@ -108,17 +137,19 @@ function ProcessingFuelStation:new(name, def, nodesDef) if activeSettings ~= nil then local activeNode = ProcessingFuelStationNode: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 ---@param pos MapVector function ProcessingFuelStation:init(pos) - ---@type ProcessingFuelStation.MetaData - local meta = core.get_meta(pos) + local meta = self:getMeta(pos) meta:set_float('remaining_fuel', 0.0) - meta:set_string('fuel_group', self.fuelGroup) local inventory = meta:get_inventory() inventory:set_size('fuel', self.fuelSlots) @@ -126,52 +157,70 @@ function ProcessingFuelStation:init(pos) self:startTimer(pos) end ----@param isProcessing boolean ----@param meta ProcessingFuelStation.MetaData ----@param elapsed number ----@return boolean isProcessing -function ProcessingFuelStation:takeFuel(isProcessing, meta, elapsed) - local inventory = meta:get_inventory() - local remainingFuel = meta:get_float('remaining_fuel') - - if remainingFuel > 0 or inventory:is_empty('fuel') then - return isProcessing +---@param pos MapVector +---@param node NodeTable +---@param puncher ObjectRef|Player +---@param pointedThing pointed_thing +function ProcessingFuelStation:onPunch(pos, node, puncher, pointedThing) + if self.alwaysEnable then + return end - local fuelList = inventory:get_list('fuel') + local meta = self:getMeta(pos) + local isEnable = self:getMetaIsEnable(meta) - for _, fuelStack in ipairs(fuelList) do - if not fuelStack:is_empty() then - -- Note: since item groups can only contain integers, - -- we divide the fuel units by a constant `FUEL_ENERGY_FACTOR` to convert seconds to smaller units. - local fuelEnergy = core.get_item_group(fuelStack:get_name(), self.fuelGroup or 'fuel') / FUEL_ENERGY_FACTOR + if not isEnable then + if self.enablerItemGroup == nil then + self:setMetaIsEnable(meta, true) + self:startTimer(pos) - if fuelEnergy > 0 then - local itemCount = fuelStack:get_count() + return + end - -- If the energy of one item is not enough for one iteration, - -- we calculate how many items we need to take - if fuelEnergy < elapsed then - itemCount = math.min(math.ceil(elapsed/fuelEnergy), itemCount) - else - itemCount = 1 - end + local itemName = puncher:get_wielded_item():get_name() + if coreGetItemGroup(itemName, self.enablerItemGroup) > 0 then + self:setMetaIsEnable(meta, true) + self:startTimer(pos) + end + else + if self.disablerItemGroup == nil then + self:setMetaIsEnable(meta, false) + self:startTimer(pos) - remainingFuel = remainingFuel + (fuelEnergy * itemCount) + return + end - fuelStack:set_count(itemCount) - inventory:remove_item('fuel', fuelStack) - end + local itemName = puncher:get_wielded_item():get_name() + if coreGetItemGroup(itemName, self.disablerItemGroup) > 0 then + self:setMetaIsEnable(meta, false) + self:startTimer(pos) end end - - isProcessing = true - - meta:set_float('remaining_fuel', remainingFuel) - - return isProcessing end +---@param meta ProcessingFuelStation.MetaData +---@param isEnable boolean +function ProcessingFuelStation:setMetaIsEnable(meta, isEnable) + if isEnable then + meta:set_string('is_enable', 'true') + else + meta:set_string('is_enable', 'false') + end +end + +---@param meta ProcessingFuelStation.MetaData +---@return boolean +function ProcessingFuelStation:getMetaIsEnable(meta) + local isEnableString = meta:get_string('is_enable') + + if isEnableString == 'true' then + return true + else + return false + end +end + +---Subtracts the elapsed time from the remaining fuel value. ---@param isProcessing boolean ---@param meta ProcessingFuelStation.MetaData ---@param elapsed number @@ -195,26 +244,83 @@ function ProcessingFuelStation:burnFuel(isProcessing, meta, elapsed) return isProcessing or (self.enableIdling == true and remainingFuel ~= 0) end ----@param pos MapVector -function ProcessingFuelStation:pushContainer(pos) - if not self.enableContainerProcessing then +---If required, takes an item from the fuel slot +---and converts it into the remaining fuel in the station. +---@param isProcessing boolean +---@param meta ProcessingFuelStation.MetaData +---@param elapsed number +---@return boolean isProcessing +function ProcessingFuelStation:takeFuel(isProcessing, meta, elapsed) + local inventory = meta:get_inventory() + local remainingFuel = meta:get_float('remaining_fuel') + local isEnable = self:getMetaIsEnable(meta) + + if not (self.alwaysEnable or isEnable) then + return isProcessing + end + + if remainingFuel > 0 then + return isProcessing + end + + if inventory:is_empty('fuel') then + self:setMetaIsEnable(meta, false) + return isProcessing + end + + local fuelList = inventory:get_list('fuel') + + for _, fuelStack in ipairs(fuelList) do + if not fuelStack:is_empty() then + -- Note: since item groups can only contain integers, + -- we divide the fuel units by a constant `FUEL_ENERGY_FACTOR` to convert seconds to smaller units. + local fuelEnergy = coreGetItemGroup(fuelStack:get_name(), self.fuelGroup or 'fuel') / FUEL_ENERGY_FACTOR + + if fuelEnergy > 0 then + local itemCount = fuelStack:get_count() + + -- If the energy of one item is not enough for one iteration, + -- we calculate how many items we need to take + if fuelEnergy < elapsed then + itemCount = mathMin(mathCeil(elapsed / fuelEnergy), itemCount) + else + itemCount = 1 + end + + remainingFuel = remainingFuel + (fuelEnergy * itemCount) + + fuelStack:set_count(itemCount) + inventory:remove_item('fuel', fuelStack) + end + end + end + + isProcessing = true + + meta:set_float('remaining_fuel', remainingFuel) + + return isProcessing +end + +---@param meta ProcessingFuelStation.MetaData +---@param pos MapVector +function ProcessingFuelStation:pushContainerStation(meta, pos) + local containerPos = pos + v(0, 1, 0) + local containerName = coreGetNode(containerPos).name + + if coreGetItemGroup(containerName, 'processing_container_station') == 0 then return end - local containerPos = pos + vector.new(0, 1, 0) - ---@type ProcessingContainerStation.MetaData - local containerMeta = core.get_meta(containerPos) + ---@type ProcessingContainerStation? + local containerStation = Smc.getNodeSuperclassByPos(containerPos) + assert(containerStation ~= nil) - local fuelGroup = containerMeta:get_string('fuel_group') - - if fuelGroup ~= self.fuelGroup then + if containerStation.fuelGroup ~= self.fuelGroup then return end - ---@type ProcessingFuelStation.MetaData - local fuelMeta = core.get_meta(pos) - - ProcessingStationEvents:callOnPushContainer(containerPos, fuelMeta:get_float('remaining_fuel')) + containerStation:onPush(containerPos, meta:get_float('remaining_fuel')) end ---@param pos MapVector @@ -223,11 +329,12 @@ end ---@param elapsed number ---@return boolean? function ProcessingFuelStation:onTimer(pos, elapsed, node, timeout) - local meta = core.get_meta(pos) + local meta = self:getMeta(pos) + local isEnable = self:getMetaIsEnable(meta) - local isProcessing = self:burnFuel(true, meta, elapsed) - isProcessing = self:takeFuel(isProcessing, meta, elapsed) -- TODO: if-else - self:pushContainer(pos) + local isProcessing = self:burnFuel(self.alwaysEnable or isEnable, meta, elapsed) + isProcessing = self:takeFuel(isProcessing, meta, elapsed) + self:pushContainerStation(meta, pos) self:swapNode(isProcessing, pos) @@ -236,6 +343,18 @@ function ProcessingFuelStation:onTimer(pos, elapsed, node, timeout) return isProcessing end +---@param pos MapVector +---@param enable boolean +function ProcessingFuelStation:onPush(pos, enable) + local meta = self:getMeta(pos) + + self:setMetaIsEnable(meta, enable) + + if enable then + self:startTimer(pos) + end +end + --- DEBUG --- local Formspec = Smc.requireFormspec() @@ -262,13 +381,13 @@ local tab = function(self, playerName, tabType) return form end -ProcessingFuelStation:new('test_processing_node', { +ProcessingFuelStation:new({ craftType = 'test', tab = tab, inputSlots = 2, fuelGroup = 'wood', - enableIdling = false, - enableContainerProcessing = true, + alwaysEnable = false, + enableIdling = true, }, { settings = { diff --git a/mods/CORE/ProcessingFuelStation/src/ProcessingFuelStation/MetaData.lua b/mods/CORE/ProcessingFuelStation/src/ProcessingFuelStation/MetaData.lua index 4af92f1..fcb7483 100644 --- a/mods/CORE/ProcessingFuelStation/src/ProcessingFuelStation/MetaData.lua +++ b/mods/CORE/ProcessingFuelStation/src/ProcessingFuelStation/MetaData.lua @@ -1,5 +1,5 @@ ---@alias ProcessingFuelStation.MetaData.FloatKey 'remaining_fuel' ----@alias ProcessingFuelStation.MetaData.StringKey 'fuel_group' +---@alias ProcessingFuelStation.MetaData.StringKey 'is_enable' ---**Only for EmmyLua.** ---@class ProcessingFuelStation.MetaData : NodeMetaRef