techpack/tubelib/distributor.lua

567 lines
16 KiB
Lua
Raw Normal View History

2018-03-10 22:14:57 +01:00
--[[
Tube Library
============
Copyright (C) 2017-2020 Joachim Stolberg
2018-03-10 22:14:57 +01:00
AGPL v3
2018-03-10 22:14:57 +01:00
See LICENSE.txt for more information
distributor.lua:
A more complex node acting as server and client.
This node claims a position number and registers its message and items interface.
2018-12-22 16:58:11 +01:00
The Distributor is based on the class NodeStates and supports the following messages:
2018-03-10 22:14:57 +01:00
- topic = "on", payload = nil
- topic = "off" , payload = nil
- topic = "state", payload = nil,
response is "running", "stopped", "standby", "defect", or "not supported"
2018-03-10 22:14:57 +01:00
]]--
-- Load support for I18n
local S = tubelib.S
2018-12-22 16:58:11 +01:00
-- for lazy programmers
local P = minetest.string_to_pos
local M = minetest.get_meta
local MAX_NUM_PER_CYC = 20 -- maximum number of items, which can be pushed per slot
2018-03-10 22:14:57 +01:00
local NUM_FILTER_ELEM = 6
local NUM_FILTER_SLOTS = 4
2018-12-22 16:58:11 +01:00
2019-01-13 12:37:44 +01:00
local COUNTDOWN_TICKS = 8
2018-12-22 16:58:11 +01:00
local STANDBY_TICKS = 4
2018-03-10 22:14:57 +01:00
local CYCLE_TIME = 2
2018-12-22 16:58:11 +01:00
local function formspec(self, pos, meta)
2018-12-28 22:16:55 +01:00
local filter = minetest.deserialize(meta:get_string("filter")) or {false,false,false,false}
2018-12-22 16:58:11 +01:00
return "size[10.5,8.5]"..
default.gui_bg..
default.gui_bg_img..
default.gui_slots..
"list[context;src;0,0;2,4;]"..
"image[2,1.5;1,1;tubelib_gui_arrow.png]"..
"image_button[2,3;1,1;"..self:get_state_button_image(meta)..";state_button;]"..
2018-12-22 16:58:11 +01:00
"checkbox[3,0;filter1;On;"..dump(filter[1]).."]"..
"checkbox[3,1;filter2;On;"..dump(filter[2]).."]"..
"checkbox[3,2;filter3;On;"..dump(filter[3]).."]"..
"checkbox[3,3;filter4;On;"..dump(filter[4]).."]"..
"image[4,0;0.3,1;tubelib_red.png]"..
"image[4,1;0.3,1;tubelib_green.png]"..
"image[4,2;0.3,1;tubelib_blue.png]"..
"image[4,3;0.3,1;tubelib_yellow.png]"..
"list[context;red;4.5,0;6,1;]"..
"list[context;green;4.5,1;6,1;]"..
"list[context;blue;4.5,2;6,1;]"..
"list[context;yellow;4.5,3;6,1;]"..
"list[current_player;main;1.25,4.5;8,4;]"..
"listring[context;src]"..
"listring[current_player;main]"
end
local State = tubelib.NodeStates:new({
node_name_passive = "tubelib:distributor",
node_name_active = "tubelib:distributor_active",
node_name_defect = "tubelib:distributor_defect",
infotext_name = S("Tubelib Distributor"),
cycle_time = CYCLE_TIME,
standby_ticks = STANDBY_TICKS,
aging_factor = 10,
formspec_func = formspec,
})
2018-03-10 22:14:57 +01:00
-- Return a key/value table with all items and the corresponding stack numbers
local function invlist_content_as_kvlist(list)
local res = {}
2020-04-07 20:05:11 +02:00
for idx,items in ipairs(list or {}) do
2018-03-10 22:14:57 +01:00
local name = items:get_name()
if name ~= "" then
res[name] = idx
end
end
return res
end
-- Return the total number of list entries
local function invlist_num_entries(list)
local res = 0
for _,items in ipairs(list) do
local name = items:get_name()
if name ~= "" then
res = res + items:get_count()
end
end
return res
end
-- Return a gapless table with all items
2018-03-10 22:14:57 +01:00
local function invlist_entries_as_list(list)
local res = {}
for _,items in ipairs(list) do
if items:get_count() > 0 then
res[#res+1] = {items:get_name(), items:get_count()}
2018-03-10 22:14:57 +01:00
end
end
return res
end
local function AddToTbl(kvTbl, new_items)
for _, l in ipairs(new_items) do
kvTbl[l[1]] = true
2018-03-10 22:14:57 +01:00
end
return kvTbl
end
local function countItemOccurrenceInFilters(kvTbl, new_items)
for _, l in ipairs(new_items) do
local name = l[1]
if kvTbl[name] == nil then
kvTbl[name] = 1
else
kvTbl[name] = kvTbl[name] + 1
end
end
return kvTbl
end
-- return the number of items to be pushed to an unconfigured slot
local function num_items(moved_items, name, filter_item_names, rejected_item_names)
if filter_item_names[name] == nil then -- not configured in one filter?
if moved_items < MAX_NUM_PER_CYC then
return math.min(4, MAX_NUM_PER_CYC - moved_items)
end
end
if rejected_item_names[name] then -- rejected item from another slot?
if moved_items < MAX_NUM_PER_CYC then
return math.min(rejected_item_names[name], MAX_NUM_PER_CYC - moved_items)
end
end
end
2018-03-10 22:14:57 +01:00
local SlotColors = {"red", "green", "blue", "yellow"}
local Num2Ascii = {"B", "L", "F", "R"} -- color to side translation
local FilterCache = {} -- local cache for filter settings
local function filter_settings(pos)
local hash = minetest.hash_node_position(pos)
2018-12-22 16:58:11 +01:00
local meta = M(pos)
2018-03-10 22:14:57 +01:00
local inv = meta:get_inventory()
local filter = minetest.deserialize(meta:get_string("filter")) or {false,false,false,false}
local kvFilterItemNames = {} -- {<item:name> = true,...}
local kvSide2ItemNames = {} -- {"F" = {<item:name>,...},...}
local kvNumOccur = {}
2018-03-10 22:14:57 +01:00
-- collect all filter settings
for idx,slot in ipairs(SlotColors) do
local side = Num2Ascii[idx]
if filter[idx] == true then
local list = inv:get_list(slot)
local filter = invlist_entries_as_list(list)
AddToTbl(kvFilterItemNames, filter)
kvSide2ItemNames[side] = filter
countItemOccurrenceInFilters(kvNumOccur, filter)
2018-03-10 22:14:57 +01:00
end
end
FilterCache[hash] = {
kvFilterItemNames = kvFilterItemNames,
kvSide2ItemNames = kvSide2ItemNames,
kvRejectedItemNames = {},
kvNumOccur = kvNumOccur,
2018-03-10 22:14:57 +01:00
}
end
local function allow_metadata_inventory_put(pos, listname, index, stack, player)
if minetest.is_protected(pos, player:get_player_name()) then
return 0
end
local meta = M(pos)
local inv = meta:get_inventory()
local list = inv:get_list(listname)
local stack_count = stack:get_count()
if listname == "src" then
if State:get_state(M(pos)) == tubelib.STANDBY then
State:start(pos, meta)
end
return stack_count
end
local space_left = MAX_NUM_PER_CYC - invlist_num_entries(list)
if space_left <= 0 then -- < 0 case is possible if distributor is already misconfigured
return 0
end
filter_settings(pos)
return math.min(stack_count, space_left)
end
local function allow_metadata_inventory_take(pos, listname, index, stack, player)
if minetest.is_protected(pos, player:get_player_name()) then
return 0
end
if listname ~= "src" then
filter_settings(pos)
end
return stack:get_count()
end
local function allow_metadata_inventory_move(pos, from_list, from_index, to_list, to_index, count, player)
local meta = M(pos)
local inv = meta:get_inventory()
local stack = inv:get_stack(from_list, from_index)
return allow_metadata_inventory_put(pos, to_list, to_index, stack, player)
end
2018-12-22 16:58:11 +01:00
-- move items from configured filters to the output
local function distributing(pos, meta)
2018-03-10 22:14:57 +01:00
local player_name = meta:get_string("player_name")
local slot_idx = meta:get_int("slot_idx") or 1
meta:set_int("slot_idx", (slot_idx + 1) % NUM_FILTER_SLOTS)
local side = Num2Ascii[slot_idx+1]
local listname = SlotColors[slot_idx+1]
local inv = meta:get_inventory()
local list = inv:get_list("src")
local kvSrc = invlist_content_as_kvlist(list)
local counter = minetest.deserialize(meta:get_string("item_counter")) or
{red=0, green=0, blue=0, yellow=0}
2018-03-10 22:14:57 +01:00
-- calculate the filter settings only once
local hash = minetest.hash_node_position(pos)
if FilterCache[hash] == nil then
filter_settings(pos)
end
-- read data from Cache
-- all filter items as key/value {<item:name> = true,...}
local kvFilterItemNames = FilterCache[hash].kvFilterItemNames
-- filter items of one slot as list {{<item:name>, <num-items>},...}
local items = FilterCache[hash].kvSide2ItemNames[side]
local kvNumOccur = FilterCache[hash].kvNumOccur
-- rejected items from other filter slots
local rejected = FilterCache[hash].kvRejectedItemNames
2018-03-10 22:14:57 +01:00
if items == nil then return end
2018-03-10 22:14:57 +01:00
local moved_items_total = 0
if next(items) then
for _,item in ipairs(items) do
local name, num = item[1], item[2]
2018-03-10 22:14:57 +01:00
if kvSrc[name] then
local item = tubelib.get_this_item(meta, "src", kvSrc[name], num) -- <<=== tubelib
2018-03-10 22:14:57 +01:00
if item then
if not tubelib.push_items(pos, side, item, player_name) then -- <<=== tubelib
tubelib.put_item(meta, "src", item)
rejected[name] = num
2018-03-10 22:14:57 +01:00
else
counter[listname] = counter[listname] + num
moved_items_total = moved_items_total + num
2018-03-10 22:14:57 +01:00
end
end
end
end
end
-- move additional items from unconfigured filters to the output
if next(items) == nil then
local moved_items = 0
2018-03-10 22:14:57 +01:00
for name,_ in pairs(kvSrc) do
local num = num_items(moved_items, name, kvFilterItemNames, rejected)
if num then
local item = tubelib.get_this_item(meta, "src", kvSrc[name], num) -- <<=== tubelib
if item then
if not kvNumOccur[item:get_name()] or kvNumOccur[item:get_name()] < 2 then
if not tubelib.push_items(pos, side, item, player_name) then -- <<=== tubelib
tubelib.put_item(meta, "src", item)
else
counter[listname] = counter[listname] + num
moved_items = moved_items + num
moved_items_total = moved_items_total + num
end
2018-03-10 22:14:57 +01:00
else
tubelib.put_item(meta, "src", item)
2018-03-10 22:14:57 +01:00
end
end
end
end
-- delete list for next slot round
if moved_items > 0 then
FilterCache[hash].kvRejectedItemNames = {}
end
2018-03-10 22:14:57 +01:00
end
2018-12-22 16:58:11 +01:00
meta:set_string("item_counter", minetest.serialize(counter))
if moved_items_total > 0 then
State:keep_running(pos, meta, COUNTDOWN_TICKS, moved_items_total)
else
State:idle(pos, meta)
end
2018-12-22 16:58:11 +01:00
end
-- move items to the output slots
local function keep_running(pos, elapsed)
if tubelib.data_not_corrupted(pos) then
local meta = M(pos)
distributing(pos, meta)
return State:is_active(meta)
end
return false
2018-03-10 22:14:57 +01:00
end
local function on_receive_fields(pos, formname, fields, player)
if minetest.is_protected(pos, player:get_player_name()) then
return
end
2018-12-22 16:58:11 +01:00
local meta = M(pos)
local filter = minetest.deserialize(meta:get_string("filter")) or {false,false,false,false}
2018-03-10 22:14:57 +01:00
if fields.filter1 ~= nil then
filter[1] = fields.filter1 == "true"
elseif fields.filter2 ~= nil then
filter[2] = fields.filter2 == "true"
elseif fields.filter3 ~= nil then
filter[3] = fields.filter3 == "true"
elseif fields.filter4 ~= nil then
filter[4] = fields.filter4 == "true"
end
meta:set_string("filter", minetest.serialize(filter))
filter_settings(pos)
2019-01-15 21:01:24 +01:00
if fields.state_button ~= nil then
State:state_button_event(pos, fields)
else
meta:set_string("formspec", formspec(State, pos, meta))
end
2018-03-10 22:14:57 +01:00
end
2018-07-01 21:56:39 +02:00
-- tubelib command to turn on/off filter channels
local function change_filter_settings(pos, slot, val)
local slots = {["red"] = 1, ["green"] = 2, ["blue"] = 3, ["yellow"] = 4}
2018-12-22 16:58:11 +01:00
local meta = M(pos)
local filter = minetest.deserialize(meta:get_string("filter")) or {false,false,false,false}
2018-07-01 21:56:39 +02:00
local num = slots[slot] or 1
if num >= 1 and num <= 4 then
filter[num] = val == "on"
end
meta:set_string("filter", minetest.serialize(filter))
filter_settings(pos)
2019-01-15 21:01:24 +01:00
meta:set_string("formspec", formspec(State, pos, meta))
2018-07-01 21:56:39 +02:00
return true
end
2018-03-10 22:14:57 +01:00
minetest.register_node("tubelib:distributor", {
description = S("Tubelib Distributor"),
2018-03-10 22:14:57 +01:00
tiles = {
-- up, down, right, left, back, front
'tubelib_distributor.png',
2019-01-01 20:14:43 +01:00
'tubelib_front.png',
2018-03-10 22:14:57 +01:00
'tubelib_distributor_yellow.png',
'tubelib_distributor_green.png',
"tubelib_distributor_red.png",
"tubelib_distributor_blue.png",
},
after_place_node = function(pos, placer)
2018-12-22 16:58:11 +01:00
local meta = M(pos)
2018-03-10 22:14:57 +01:00
local number = tubelib.add_node(pos, "tubelib:distributor") -- <<=== tubelib
local filter = {false,false,false,false}
meta:set_string("filter", minetest.serialize(filter))
2018-12-22 16:58:11 +01:00
State:node_init(pos, number)
meta:set_string("player_name", placer:get_player_name())
2018-03-10 22:14:57 +01:00
local inv = meta:get_inventory()
inv:set_size('src', 8)
inv:set_size('yellow', 6)
inv:set_size('green', 6)
inv:set_size('red', 6)
inv:set_size('blue', 6)
meta:set_string("item_counter", minetest.serialize({red=0, green=0, blue=0, yellow=0}))
2018-03-10 22:14:57 +01:00
end,
on_receive_fields = on_receive_fields,
can_dig = function(pos, player)
if minetest.is_protected(pos, player:get_player_name()) then
return false
2018-03-10 22:14:57 +01:00
end
local inv = M(pos):get_inventory()
return inv:is_empty("src")
2018-03-10 22:14:57 +01:00
end,
2020-08-12 20:15:26 +02:00
on_dig = function(pos, node, player)
State:on_dig_node(pos, node, player)
tubelib.remove_node(pos)
2018-12-22 16:58:11 +01:00
end,
2018-03-10 22:14:57 +01:00
allow_metadata_inventory_put = allow_metadata_inventory_put,
allow_metadata_inventory_take = allow_metadata_inventory_take,
allow_metadata_inventory_move = allow_metadata_inventory_move,
on_timer = keep_running,
on_rotate = screwdriver.disallow,
2018-03-10 22:14:57 +01:00
paramtype = "light",
sunlight_propagates = true,
paramtype2 = "facedir",
groups = {choppy=2, cracky=2, crumbly=2},
is_ground_content = false,
sounds = default.node_sound_wood_defaults(),
})
minetest.register_node("tubelib:distributor_active", {
description = S("Tubelib Distributor"),
2018-03-10 22:14:57 +01:00
tiles = {
-- up, down, right, left, back, front
{
image = "tubelib_distributor_active.png",
backface_culling = false,
animation = {
type = "vertical_frames",
aspect_w = 32,
aspect_h = 32,
length = 2.0,
},
},
2019-01-01 20:14:43 +01:00
'tubelib_front.png',
2018-03-10 22:14:57 +01:00
'tubelib_distributor_yellow.png',
'tubelib_distributor_green.png',
"tubelib_distributor_red.png",
"tubelib_distributor_blue.png",
},
on_receive_fields = on_receive_fields,
allow_metadata_inventory_put = allow_metadata_inventory_put,
allow_metadata_inventory_take = allow_metadata_inventory_take,
allow_metadata_inventory_move = allow_metadata_inventory_move,
on_timer = keep_running,
on_rotate = screwdriver.disallow,
2018-03-10 22:14:57 +01:00
diggable = false,
can_dig = function() return false end,
2018-03-10 22:14:57 +01:00
paramtype = "light",
sunlight_propagates = true,
paramtype2 = "facedir",
groups = {crumbly=0, not_in_creative_inventory=1},
is_ground_content = false,
sounds = default.node_sound_wood_defaults(),
})
2018-12-22 16:58:11 +01:00
minetest.register_node("tubelib:distributor_defect", {
description = S("Tubelib Distributor"),
2018-12-22 16:58:11 +01:00
tiles = {
-- up, down, right, left, back, front
'tubelib_distributor.png',
2019-01-01 20:14:43 +01:00
'tubelib_front.png',
2018-12-22 16:58:11 +01:00
'tubelib_distributor_yellow.png^tubelib_defect.png',
'tubelib_distributor_green.png^tubelib_defect.png',
"tubelib_distributor_red.png^tubelib_defect.png",
"tubelib_distributor_blue.png^tubelib_defect.png",
},
after_place_node = function(pos, placer)
local meta = M(pos)
local number = tubelib.add_node(pos, "tubelib:distributor") -- <<=== tubelib
State:node_init(pos, number)
meta:set_string("player_name", placer:get_player_name())
local filter = {false,false,false,false}
meta:set_string("filter", minetest.serialize(filter))
local inv = meta:get_inventory()
inv:set_size('src', 8)
inv:set_size('yellow', 6)
inv:set_size('green', 6)
inv:set_size('red', 6)
inv:set_size('blue', 6)
meta:set_string("item_counter", minetest.serialize({red=0, green=0, blue=0, yellow=0}))
State:defect(pos, meta)
end,
2018-12-22 16:58:11 +01:00
on_receive_fields = on_receive_fields,
can_dig = function(pos, player)
if minetest.is_protected(pos, player:get_player_name()) then
return false
end
local inv = M(pos):get_inventory()
return inv:is_empty("src")
end,
after_dig_node = function(pos, oldnode, oldmetadata, digger)
tubelib.remove_node(pos) -- <<=== tubelib
end,
2018-12-22 16:58:11 +01:00
allow_metadata_inventory_put = allow_metadata_inventory_put,
allow_metadata_inventory_take = allow_metadata_inventory_take,
allow_metadata_inventory_move = allow_metadata_inventory_move,
on_rotate = screwdriver.disallow,
paramtype = "light",
sunlight_propagates = true,
paramtype2 = "facedir",
groups = {choppy=2, cracky=2, crumbly=2, not_in_creative_inventory=1},
2018-12-22 16:58:11 +01:00
is_ground_content = false,
sounds = default.node_sound_wood_defaults(),
})
2018-03-10 22:14:57 +01:00
minetest.register_craft({
output = "tubelib:distributor 2",
recipe = {
{"group:wood", "default:steel_ingot", "group:wood"},
2018-12-31 14:59:02 +01:00
{"tubelib:tubeS", "default:mese_crystal", "tubelib:tubeS"},
2018-03-10 22:14:57 +01:00
{"group:wood", "default:steel_ingot", "group:wood"},
},
})
--------------------------------------------------------------- tubelib
2018-12-22 16:58:11 +01:00
tubelib.register_node("tubelib:distributor",
{"tubelib:distributor_active", "tubelib:distributor_defect"}, {
2018-03-10 22:14:57 +01:00
on_pull_item = function(pos, side)
2018-12-22 16:58:11 +01:00
return tubelib.get_item(M(pos), "src")
2018-03-10 22:14:57 +01:00
end,
on_push_item = function(pos, side, item)
2018-12-22 16:58:11 +01:00
return tubelib.put_item(M(pos), "src", item)
2018-03-10 22:14:57 +01:00
end,
on_unpull_item = function(pos, side, item)
2018-12-22 16:58:11 +01:00
return tubelib.put_item(M(pos), "src", item)
2018-03-10 22:14:57 +01:00
end,
on_recv_message = function(pos, topic, payload)
2018-12-22 16:58:11 +01:00
if topic == "filter" then
2018-07-01 21:56:39 +02:00
return change_filter_settings(pos, payload.slot, payload.val)
elseif topic == "counter" then
local meta = minetest.get_meta(pos)
return minetest.deserialize(meta:get_string("item_counter")) or
{red=0, green=0, blue=0, yellow=0}
elseif topic == "clear_counter" then
local meta = minetest.get_meta(pos)
meta:set_string("item_counter", minetest.serialize({red=0, green=0, blue=0, yellow=0}))
2018-12-22 16:58:11 +01:00
else
local resp = State:on_receive_message(pos, topic, payload)
if resp then
return resp
else
return "unsupported"
end
2018-03-10 22:14:57 +01:00
end
end,
2018-12-22 16:58:11 +01:00
on_node_load = function(pos)
State:on_node_load(pos)
end,
on_node_repair = function(pos)
return State:on_node_repair(pos)
end,
2018-03-10 22:14:57 +01:00
})
--------------------------------------------------------------- tubelib