`ProcessingStation: delegation of functionality to senior classes
This commit is contained in:
@@ -1,8 +1,5 @@
|
||||
local FUEL_ENERGY_FACTOR = 0.1
|
||||
|
||||
local getInstance = Class.getInstance
|
||||
|
||||
local CraftSystem = Smc.requireCraftSystem()
|
||||
local BaseProcessingStation = Smc.requireBaseProcessingStation()
|
||||
local ProcessingContainerStation, ProcessingFuelStation = Smc.requireProcessingContainerStation(), Smc.requireProcessingFuelStation()
|
||||
|
||||
local PlayerInventoryUI = Smc.requirePlayerInventoryUI()
|
||||
|
||||
@@ -17,57 +14,25 @@ local ProcessingStationNode = Node:getExtended({
|
||||
},
|
||||
})
|
||||
|
||||
---@class ProcessingStation
|
||||
---@field name string
|
||||
---@field timeout number
|
||||
---@field enableRegression boolean?
|
||||
---@field enableIdling boolean?
|
||||
---@field craftType CraftSystem.ProcessingCraftType
|
||||
---@field fuelGroup string
|
||||
---@field inputSlots integer
|
||||
---@field outputSlots integer
|
||||
---@field fuelSlots integer
|
||||
---@field handler CraftSystem.ProcessingCraftHandler
|
||||
---@field tab PlayerInventoryUI.getTabFunc
|
||||
---@field nodeName string
|
||||
---@field activeNodeName string?
|
||||
local ProcessingStation = {}
|
||||
---@class ProcessingStation : BaseProcessingStation
|
||||
---@field containerStation ProcessingContainerStation
|
||||
---@field fuelStation ProcessingFuelStation
|
||||
local ProcessingStation = BaseProcessingStation:extend({})
|
||||
|
||||
---Definition table for the `ProcessingStation`.
|
||||
---
|
||||
---**Only for EmmyLua.**
|
||||
---@class ProcessingStationDef
|
||||
---@field timeout number?
|
||||
---@field enableRegression boolean?
|
||||
---@field enableIdling boolean?
|
||||
---@field craftType CraftSystem.ProcessingCraftType
|
||||
---@field fuelGroup string?
|
||||
---@field inputSlots integer?
|
||||
---@field outputSlots integer?
|
||||
---@field fuelSlots integer?
|
||||
---@field tab PlayerInventoryUI.getTabFunc
|
||||
|
||||
---@alias ProcessingStation.NodesDef {settings:Node.Settings, activeSettings?:Node.Settings, callbacks:Node.Callbacks?}
|
||||
---@class ProcessingStationDef : ProcessingContainerStationDef, ProcessingFuelStationDef
|
||||
|
||||
---@param name string
|
||||
---@param def ProcessingStationDef
|
||||
---@param nodesDef ProcessingStation.NodesDef
|
||||
---@param nodesDef BaseProcessingStation.NodesDef
|
||||
function ProcessingStation:new(name, def, nodesDef)
|
||||
local handler = CraftSystem:getProcessingCraftHandler(def.craftType)
|
||||
|
||||
---@type ProcessingStation
|
||||
local instance = getInstance(self, {})
|
||||
instance.name = name
|
||||
instance.timeout = def.timeout or 1
|
||||
instance.enableRegression = def.enableRegression
|
||||
instance.enableIdling = def.enableIdling
|
||||
instance.craftType = def.craftType
|
||||
instance.fuelGroup = def.fuelGroup or 'fuel'
|
||||
instance.inputSlots = def.inputSlots or 1
|
||||
instance.outputSlots = def.outputSlots or 1
|
||||
instance.fuelSlots = def.outputSlots or 1
|
||||
instance.handler = handler
|
||||
instance.tab = def.tab
|
||||
local instance = self:getInstance(BaseProcessingStation:new(name, def, nodesDef))
|
||||
instance.containerStation = ProcessingContainerStation:new(name, def, nodesDef)
|
||||
instance.fuelStation = ProcessingFuelStation:new(name, def, nodesDef)
|
||||
|
||||
local settings = nodesDef.settings
|
||||
local activeSettings = nodesDef.activeSettings
|
||||
@@ -79,7 +44,8 @@ function ProcessingStation:new(name, def, nodesDef)
|
||||
callbacks.on_construct = function(pos)
|
||||
oldCallback(pos)
|
||||
|
||||
instance:init(pos)
|
||||
instance.containerStation:init(pos)
|
||||
instance.fuelStation:init(pos)
|
||||
end
|
||||
|
||||
oldCallback = callbacks.on_rightclick or function(...) end
|
||||
@@ -134,183 +100,26 @@ function ProcessingStation:new(name, def, nodesDef)
|
||||
return instance
|
||||
end
|
||||
|
||||
---Opens the player's inventory, adding the tab described in `self.tab`.
|
||||
---@param pos MapPosition
|
||||
---@param player Player
|
||||
function ProcessingStation:showForm(pos, player)
|
||||
local playerName = player:get_player_name()
|
||||
|
||||
PlayerInventoryUI:addActiveNodeForm(pos, playerName)
|
||||
PlayerInventoryUI:setContex(playerName, 'left_tab_name', 'node_tab')
|
||||
PlayerInventoryUI:setContex(playerName, 'node_tab_pos', pos)
|
||||
PlayerInventoryUI:setContex(playerName, 'node_tab', self.tab)
|
||||
|
||||
PlayerInventoryUI:showForm(playerName)
|
||||
end
|
||||
|
||||
---@param pos MapPosition
|
||||
function ProcessingStation:init(pos)
|
||||
---@type ProcessingStation.MetaData
|
||||
local meta = core.get_meta(pos)
|
||||
meta:set_float('remaining_fuel', 0.0)
|
||||
meta:set_float('processing_time', 0.0)
|
||||
|
||||
local inventory = meta:get_inventory()
|
||||
inventory:set_size('input', self.inputSlots)
|
||||
inventory:set_size('output', self.outputSlots)
|
||||
inventory:set_size('fuel', self.fuelSlots)
|
||||
|
||||
self:startTimer(pos)
|
||||
end
|
||||
|
||||
---Starts the station timer only if it is not running.
|
||||
---
|
||||
---The timer timeout is set to the timeout specified `self.timeout`.
|
||||
---
|
||||
---Returns `true` if the timer has been started.
|
||||
---@param pos MapPosition
|
||||
---@return boolean
|
||||
function ProcessingStation:startTimer(pos)
|
||||
local timer = core.get_node_timer(pos)
|
||||
if not timer:is_started() then
|
||||
timer:start(self.timeout)
|
||||
return true
|
||||
end
|
||||
|
||||
return false
|
||||
end
|
||||
|
||||
---@param pos MapPosition
|
||||
---@param elapsed number
|
||||
---@param node NodeTable
|
||||
---@param timeout number
|
||||
---@return boolean
|
||||
---@return boolean?
|
||||
function ProcessingStation:onTimer(pos, elapsed, node, timeout)
|
||||
---An indicator of whether the station
|
||||
---is processing resources in this iteration.
|
||||
local isProcessing = true
|
||||
|
||||
---@type ProcessingStation.MetaData
|
||||
local meta = core.get_meta(pos)
|
||||
local inventory = meta:get_inventory()
|
||||
|
||||
---An indicator of how many units of fuel are currently remaining.
|
||||
local remainingFuel = meta:get_float('remaining_fuel')
|
||||
---An indicator of how long the station has been processing the materials.
|
||||
local processingTime = meta:get_float('processing_time')
|
||||
local isProcessing, craft = self.containerStation:getCraft(true, meta, timeout)
|
||||
core.log(tostring(isProcessing))
|
||||
isProcessing = self.fuelStation:burnFuel(isProcessing, meta, timeout)
|
||||
core.log(tostring(isProcessing))
|
||||
isProcessing = self.containerStation:processing(isProcessing, meta, timeout, craft)
|
||||
core.log(tostring(isProcessing))
|
||||
|
||||
local craft = self.handler:getCraftByRecipe(inventory:get_list('input'))
|
||||
|
||||
-- If the materials in the input slot are not a recipe for any crafting,
|
||||
-- then we will not process them.
|
||||
if craft == nil then
|
||||
isProcessing = false
|
||||
end
|
||||
|
||||
-- If there is no space in the output slots for the crafting result, then we stop processing.
|
||||
if isProcessing and craft ~= nil and not inventory:room_for_item('output', craft.output) then
|
||||
isProcessing = false
|
||||
end
|
||||
|
||||
-- If we are in the process of processing and we run out of fuel,
|
||||
-- but there are still items in the fuel slot...
|
||||
if isProcessing and remainingFuel <= 0 and not inventory:is_empty('fuel') then
|
||||
-- ... then we will convert the first itemstack into station fuel
|
||||
-- if it has the required fuel group.
|
||||
local fuelList = inventory:get_list('fuel')
|
||||
for index, fuelStack in ipairs(fuelList) do
|
||||
if not fuelStack:is_empty() then
|
||||
---Fuel units contained in the itemstack.
|
||||
---
|
||||
-- Note: since item groups can only contain integers,
|
||||
-- we divide the fuel units by a constant to convert seconds to smaller units.
|
||||
local fuelEnergy = core.get_item_group(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 < timeout then
|
||||
itemCount = math.min(math.ceil(timeout/fuelEnergy), itemCount)
|
||||
else
|
||||
itemCount = 1
|
||||
end
|
||||
|
||||
remainingFuel = remainingFuel + (fuelEnergy * itemCount)
|
||||
|
||||
fuelStack:set_count(itemCount)
|
||||
inventory:remove_item('fuel', fuelStack)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
if self.enableIdling and isProcessing then
|
||||
remainingFuel = remainingFuel - timeout
|
||||
else
|
||||
remainingFuel = remainingFuel - timeout
|
||||
end
|
||||
|
||||
-- If we don't have fuel remaining,
|
||||
-- we don't process the materials.
|
||||
if remainingFuel < 0 then
|
||||
remainingFuel = 0
|
||||
isProcessing = false
|
||||
end
|
||||
|
||||
-- If we process materials...
|
||||
if isProcessing == true then
|
||||
-- ...then we add the processing progress for this iteration.
|
||||
processingTime = processingTime + timeout
|
||||
else
|
||||
-- ...else we take away progress
|
||||
-- (if there was progress, but the fuel ran out,
|
||||
-- the crafting progress will gradually decrease).
|
||||
if self.enableRegression then
|
||||
processingTime = processingTime - timeout
|
||||
end
|
||||
end
|
||||
|
||||
-- If the station is working and the progress time is longer than required for crafting, we produce the craft
|
||||
-- (we take the item stacks needed for crafting and put the result of the crafting into the output)
|
||||
if isProcessing and craft ~= nil and processingTime >= craft.time then
|
||||
for _, item in ipairs(craft.recipe) do
|
||||
inventory:remove_item('input', item)
|
||||
end
|
||||
|
||||
inventory:add_item('output', craft.output)
|
||||
processingTime = 0
|
||||
end
|
||||
|
||||
if processingTime < 0 then
|
||||
processingTime = 0
|
||||
end
|
||||
|
||||
-- If the processing is in progress and the station has an active node type, then we use it.
|
||||
if self.activeNodeName ~= nil then
|
||||
if isProcessing then
|
||||
core.swap_node(pos, {name = self.activeNodeName})
|
||||
else
|
||||
core.swap_node(pos, {name = self.nodeName})
|
||||
end
|
||||
end
|
||||
|
||||
meta:set_float('processing_time', processingTime)
|
||||
meta:set_float('remaining_fuel', remainingFuel)
|
||||
self:swapNode(isProcessing, pos)
|
||||
|
||||
PlayerInventoryUI:updateNodeForm(pos)
|
||||
|
||||
-- If we not processing we stop the timer so as not to overload the server.
|
||||
--
|
||||
-- The timer will have to start again
|
||||
-- if the player interacts with any items in the station's inventory.
|
||||
if not isProcessing and (not self.enableRegression or processingTime == 0) and (not self.enableIdling or remainingFuel == 0) then
|
||||
core.log('timer stop')
|
||||
return false
|
||||
else
|
||||
core.log('timer work')
|
||||
return true
|
||||
end
|
||||
return isProcessing
|
||||
end
|
||||
|
||||
--- DEBUG ---
|
||||
@@ -318,6 +127,7 @@ end
|
||||
local Formspec = Smc.requireFormspec()
|
||||
local TileSheet = Smc.requireTileSheet()
|
||||
local tileSheet = TileSheet:new('debug_processing_station_sheet.png', 16, 16)
|
||||
local CraftSystem = Smc.requireCraftSystem()
|
||||
local handler = CraftSystem:getProcessingCraftHandler('test')
|
||||
|
||||
handler:registerCraft('test_pro_craft', {
|
||||
@@ -355,7 +165,7 @@ ProcessingStation:new('test_processing_node', {
|
||||
inputSlots = 2,
|
||||
fuelGroup = 'wood',
|
||||
enableIdling = true,
|
||||
enableRegression = false,
|
||||
enableRegression = true,
|
||||
},
|
||||
{
|
||||
settings = {
|
||||
|
||||
Reference in New Issue
Block a user