Maciej 'agaran' Pijanka
2017-03-15 10307f23a78b33af50dc4a5f3d1baafb4ee4b0d9
technic/machines/switching_station.lua
@@ -1,7 +1,10 @@
-- SWITCHING STATION
-- The switching station is the center of all power distribution on an electric network.
-- The station will collect all produced power from producers (PR) and batteries (BA)
-- and distribute it to receivers (RE) and depleted batteries (BA).
--
-- The station collects power from sources (PR), distributes it to sinks (RE),
-- and uses the excess/shortfall to charge and discharge batteries (BA).
--
-- For now, all supply and demand values are expressed in kW.
--
-- It works like this:
--  All PR,BA,RE nodes are indexed and tagged with the switching station.
@@ -27,58 +30,48 @@
--
--  The reason the LV|MV|HV type is prepended toe meta data is because some machine could require several supplies to work.
--  This way the supplies are separated per network.
technic.DBG = 1
local dprint = technic.dprint
technic.networks = {}
technic.cables = {}
local S = technic.getter
minetest.register_craft({
   output = "technic:switching_station",
   recipe = {
      {"default:steel_ingot",  "technic:lv_transformer", "default:steel_ingot"},
      {"default:copper_ingot", "technic:lv_cable0",      "default:copper_ingot"},
      {"default:steel_ingot",  "technic:lv_cable0",      "default:steel_ingot"}
      {"",                     "technic:lv_transformer", ""},
      {"default:copper_ingot", "technic:machine_casing", "default:copper_ingot"},
      {"technic:lv_cable",     "technic:lv_cable",       "technic:lv_cable"}
   }
})
minetest.register_node("technic:switching_station",{
   description = "Switching Station",
   description = S("Switching Station"),
   tiles  = {"technic_water_mill_top_active.png", "technic_water_mill_top_active.png",
                  "technic_water_mill_top_active.png", "technic_water_mill_top_active.png",
             "technic_water_mill_top_active.png", "technic_water_mill_top_active.png"},
   groups = {snappy=2, choppy=2, oddly_breakable_by_hand=2},
   groups = {snappy=2, choppy=2, oddly_breakable_by_hand=2, technic_all_tiers=1},
   connect_sides = {"bottom"},
   sounds = default.node_sound_wood_defaults(),
   drawtype = "nodebox",
   paramtype = "light",
   node_box = {
      type = "fixed",
      fixed = {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
   },
   on_construct = function(pos)
      local meta = minetest.get_meta(pos)
      meta:set_string("infotext", "Switching Station")
      meta:set_string("infotext", S("Switching Station"))
      meta:set_string("active", 1)
   end,
   after_dig_node = function(pos)
      minetest.forceload_free_block(pos)
      pos.y = pos.y - 1
      minetest.forceload_free_block(pos)
   end,
})
--------------------------------------------------
-- Functions to help the machines on the electrical network
--------------------------------------------------
-- This one provides a timeout for a node in case it was disconnected from the network
-- A node must be touched by the station continuously in order to function
function technic.switching_station_timeout_count(pos, tier)
   local meta = minetest.get_meta(pos)
   timeout = meta:get_int(tier.."_EU_timeout")
   if timeout == 0 then
      meta:set_int(tier.."_EU_input", 0)
   else
      meta:set_int(tier.."_EU_timeout", timeout - 1)
   end
end
--------------------------------------------------
-- Functions to traverse the electrical network
--------------------------------------------------
-- Add a wire node to the LV/MV/HV network
local add_new_cable_node = function(nodes, pos)
local add_new_cable_node = function(nodes, pos, network_id)
   technic.cables[minetest.hash_node_position(pos)] = network_id
   -- Ignore if the node has already been added
   for i = 1, #nodes do
      if pos.x == nodes[i].x and
@@ -92,20 +85,31 @@
end
-- Generic function to add found connected nodes to the right classification array
local check_node_subp = function(PR_nodes, RE_nodes, BA_nodes, all_nodes, pos, machines, tier)
local check_node_subp = function(PR_nodes, RE_nodes, BA_nodes, SP_nodes, all_nodes, pos, machines, tier, sw_pos, from_below, network_id)
   technic.get_or_load_node(pos)
   local meta = minetest.get_meta(pos)
   local name = minetest.get_node(pos).name
   if technic.is_tier_cable(name, tier) then
      add_new_cable_node(all_nodes, pos)
      add_new_cable_node(all_nodes, pos,network_id)
   elseif machines[name] then
      --dprint(name.." is a "..machines[name])
      meta:set_string(tier.."_network",minetest.pos_to_string(sw_pos))
      if     machines[name] == technic.producer then
         add_new_cable_node(PR_nodes, pos)
         add_new_cable_node(PR_nodes, pos, network_id)
      elseif machines[name] == technic.receiver then
         add_new_cable_node(RE_nodes, pos)
         add_new_cable_node(RE_nodes, pos, network_id)
      elseif machines[name] == technic.producer_receiver then
         add_new_cable_node(PR_nodes, pos, network_id)
         add_new_cable_node(RE_nodes, pos, network_id)
      elseif machines[name] == "SPECIAL" and
            (pos.x ~= sw_pos.x or pos.y ~= sw_pos.y or pos.z ~= sw_pos.z) and
            from_below then
         -- Another switching station -> disable it
         add_new_cable_node(SP_nodes, pos, network_id)
         meta:set_int("active", 0)
      elseif machines[name] == technic.battery then
         add_new_cable_node(BA_nodes, pos)
         add_new_cable_node(BA_nodes, pos, network_id)
      end
      meta:set_int(tier.."_EU_timeout", 2) -- Touch node
@@ -113,7 +117,7 @@
end
-- Traverse a network given a list of machines and a cable type name
local traverse_network = function(PR_nodes, RE_nodes, BA_nodes, all_nodes, i, machines, tier)
local traverse_network = function(PR_nodes, RE_nodes, BA_nodes, SP_nodes, all_nodes, i, machines, tier, sw_pos, network_id)
   local pos = all_nodes[i]
   local positions = {
      {x=pos.x+1, y=pos.y,   z=pos.z},
@@ -124,7 +128,7 @@
      {x=pos.x,   y=pos.y,   z=pos.z-1}}
   --print("ON")
   for i, cur_pos in pairs(positions) do
      check_node_subp(PR_nodes, RE_nodes, BA_nodes, all_nodes, cur_pos, machines, tier)
      check_node_subp(PR_nodes, RE_nodes, BA_nodes, SP_nodes, all_nodes, cur_pos, machines, tier, sw_pos, i == 3, network_id)
   end
end
@@ -135,25 +139,32 @@
   end
end
local get_network = function(pos1, tier)
local get_network = function(sw_pos, pos1, tier)
   local cached = technic.networks[minetest.hash_node_position(pos1)]
   if cached and cached.tier == tier then
      touch_nodes(cached.PR_nodes, tier)
      touch_nodes(cached.BA_nodes, tier)
      touch_nodes(cached.RE_nodes, tier)
      for _, pos in ipairs(cached.SP_nodes) do
         local meta = minetest.get_meta(pos)
         meta:set_int("active", 0)
         meta:set_string("active_pos", minetest.serialize(sw_pos))
      end
      return cached.PR_nodes, cached.BA_nodes, cached.RE_nodes
   end
   local i = 1
   local PR_nodes = {}
   local BA_nodes = {}
   local RE_nodes = {}
   local SP_nodes = {}
   local all_nodes = {pos1}
   repeat
      traverse_network(PR_nodes, RE_nodes, BA_nodes, all_nodes,
            i, technic.machines[tier], tier)
      traverse_network(PR_nodes, RE_nodes, BA_nodes, SP_nodes, all_nodes,
            i, technic.machines[tier], tier, sw_pos, minetest.hash_node_position(pos1))
      i = i + 1
   until all_nodes[i] == nil
   technic.networks[minetest.hash_node_position(pos1)] = {tier = tier, PR_nodes = PR_nodes, RE_nodes = RE_nodes, BA_nodes = BA_nodes}
   technic.networks[minetest.hash_node_position(pos1)] = {tier = tier, PR_nodes = PR_nodes,
         RE_nodes = RE_nodes, BA_nodes = BA_nodes, SP_nodes = SP_nodes, all_nodes = all_nodes}
   return PR_nodes, BA_nodes, RE_nodes
end
@@ -162,6 +173,7 @@
-----------------------------------------------
minetest.register_abm({
   nodenames = {"technic:switching_station"},
   label = "Switching Station", -- allows the mtt profiler to profile this abm individually
   interval   = 1,
   chance     = 1,
   action = function(pos, node, active_object_count, active_object_count_wider)
@@ -177,28 +189,81 @@
      local PR_nodes
      local BA_nodes
      local RE_nodes
      local machine_name = S("Switching Station")
      -- Which kind of network are we on:
      pos1 = {x=pos.x, y=pos.y-1, z=pos.z}
      --Disable if necessary
      if meta:get_int("active") ~= 1 then
         minetest.forceload_free_block(pos)
         minetest.forceload_free_block(pos1)
         meta:set_string("infotext",S("%s Already Present"):format(machine_name))
         return
      end
      local name = minetest.get_node(pos1).name
      local tier = technic.get_cable_tier(name)
      if tier then
         PR_nodes, RE_nodes, BA_nodes = get_network(pos1, tier)
         -- Forceload switching station
         minetest.forceload_block(pos)
         minetest.forceload_block(pos1)
         PR_nodes, BA_nodes, RE_nodes = get_network(pos, pos1, tier)
      else
         --dprint("Not connected to a network")
         meta:set_string("infotext", "Switching Station - no network")
         meta:set_string("infotext", S("%s Has No Network"):format(machine_name))
         minetest.forceload_free_block(pos)
         minetest.forceload_free_block(pos1)
         return
      end
      --dprint("nodes="..table.getn(all_nodes)
      --      .." PR="..table.getn(PR_nodes)
      --      .." BA="..table.getn(BA_nodes)
      --      .." RE="..table.getn(RE_nodes))
      -- Run all the nodes
      local function run_nodes(list, run_stage)
         for _, pos2 in ipairs(list) do
            technic.get_or_load_node(pos2)
            local node2 = minetest.get_node(pos2)
            local nodedef
            if node2 and node2.name then
               nodedef = minetest.registered_nodes[node2.name]
            end
            if nodedef and nodedef.technic_run then
               nodedef.technic_run(pos2, node2, run_stage)
            end
         end
      end
      run_nodes(PR_nodes, technic.producer)
      run_nodes(RE_nodes, technic.receiver)
      run_nodes(BA_nodes, technic.battery)
      -- Strings for the meta data
      local eu_demand_str    = tier.."_EU_demand"
      local eu_input_str     = tier.."_EU_input"
      local eu_supply_str    = tier.."_EU_supply"
      -- Distribute charge equally across multiple batteries.
      local charge_total = 0
      local battery_count = 0
      for n, pos1 in pairs(BA_nodes) do
         meta1 = minetest.get_meta(pos1)
         local charge = meta1:get_int("internal_EU_charge")
         if (meta1:get_int(eu_demand_str) ~= 0) then
            charge_total = charge_total + charge
            battery_count = battery_count + 1
         end
      end
      local charge_distributed = math.floor(charge_total / battery_count)
      for n, pos1 in pairs(BA_nodes) do
         meta1 = minetest.get_meta(pos1)
         if (meta1:get_int(eu_demand_str) ~= 0) then
            meta1:set_int("internal_EU_charge", charge_distributed)
         end
      end
      -- Get all the power from the PR nodes
      local PR_eu_supply = 0 -- Total power
@@ -233,8 +298,12 @@
      --dprint("Total BA demand:"..BA_eu_demand)
      meta:set_string("infotext",
            "Switching Station. Supply: "..PR_eu_supply
            .." Demand: "..RE_eu_demand)
            S("@1. Supply: @2 Demand: @3",
            machine_name, technic.pretty_num(PR_eu_supply), technic.pretty_num(RE_eu_demand)))
      -- Data that will be used by the power monitor
      meta:set_int("supply",PR_eu_supply)
      meta:set_int("demand",RE_eu_demand)
      -- If the PR supply is enough for the RE demand supply them all
      if PR_eu_supply >= RE_eu_demand then
@@ -297,6 +366,62 @@
         meta1 = minetest.get_meta(pos1)
         meta1:set_int(eu_input_str, 0)
      end
   end,
})
-- Timeout ABM
-- Timeout for a node in case it was disconnected from the network
-- A node must be touched by the station continuously in order to function
local function switching_station_timeout_count(pos, tier)
   local meta = minetest.get_meta(pos)
   local timeout = meta:get_int(tier.."_EU_timeout")
   if timeout <= 0 then
      meta:set_int(tier.."_EU_input", 0) -- Not needed anymore <-- actually, it is for supply converter
      return true
   else
      meta:set_int(tier.."_EU_timeout", timeout - 1)
      return false
   end
end
minetest.register_abm({
   nodenames = {"group:technic_machine"},
   interval   = 1,
   chance     = 1,
   action = function(pos, node, active_object_count, active_object_count_wider)
      local meta = minetest.get_meta(pos)
      for tier, machines in pairs(technic.machines) do
         if machines[node.name] and switching_station_timeout_count(pos, tier) then
            local nodedef = minetest.registered_nodes[node.name]
            if nodedef and nodedef.technic_disabled_machine_name then
               node.name = nodedef.technic_disabled_machine_name
               minetest.swap_node(pos, node)
            elseif nodedef and nodedef.technic_on_disable then
               nodedef.technic_on_disable(pos, node)
            end
            if nodedef then
               local meta = minetest.get_meta(pos)
               meta:set_string("infotext", S("%s Has No Network"):format(nodedef.description))
            end
         end
      end
   end,
})
--Re-enable disabled switching station if necessary, similar to the timeout above
minetest.register_abm({
   nodenames = {"technic:switching_station"},
   interval   = 1,
   chance     = 1,
   action = function(pos, node, active_object_count, active_object_count_wider)
      local meta = minetest.get_meta(pos)
      local pos1 = {x=pos.x,y=pos.y-1,z=pos.z}
      local tier = technic.get_cable_tier(minetest.get_node(pos1).name)
      if not tier then return end
      if switching_station_timeout_count(pos, tier) then
         local meta = minetest.get_meta(pos)
         meta:set_int("active",1)
      end
   end,
})