allow stack per-chest/per-furnace stack splitting

defaults to disabled, whether the node has a new formspec or not
note that furnace fuel stacks can't be split.

compat-chests.lua

@@ -0,0 +1,185 @@
+-- this bit of code modifies the default chests and furnaces to be compatible
+-- with pipeworks.
+--
+-- the formspecs found here are basically copies of the ones from minetest_game
+-- plus bits from pipeworks' sorting tubes
+
+local fs_helpers = pipeworks.fs_helpers
+
+local base_chest_formspec = "size[8,9]" ..
+	default.gui_bg ..
+	default.gui_bg_img ..
+	default.gui_slots ..
+	"list[current_player;main;0,4.85;8,1;]" ..
+	"list[current_player;main;0,6.08;8,3;8]" ..
+	"listring[current_player;main]" ..
+	default.get_hotbar_bg(0,4.85)
+
+local function update_chest_formspec(pos)
+	local meta = minetest.get_meta(pos)
+	local formspec = base_chest_formspec ..
+		"list[current_name;main;0,0.3;8,4;]" ..
+		"listring[current_name;main]" ..
+		fs_helpers.cycling_button(
+			meta,
+			"image_button[0,4.3;1,0.6",
+			"splitstacks",
+			{
+				{text="", texture="pipeworks_button_off.png", addopts="false;false;pipeworks_button_interm.png"},
+				{text="", texture="pipeworks_button_on.png",  addopts="false;false;pipeworks_button_interm.png"}
+			}
+		).."label[0.9,4.31;Allow splitting incoming stacks from tubes]"
+	meta:set_string("formspec", formspec)
+end
+
+minetest.override_item("default:chest", {
+	tiles = {
+		"default_chest_top.png^pipeworks_tube_connection_wooden.png",
+		"default_chest_top.png^pipeworks_tube_connection_wooden.png",
+		"default_chest_side.png^pipeworks_tube_connection_wooden.png",
+		"default_chest_side.png^pipeworks_tube_connection_wooden.png",
+		"default_chest_side.png^pipeworks_tube_connection_wooden.png",
+		"default_chest_front.png"
+	},
+	groups = {choppy = 2, oddly_breakable_by_hand = 2, tubedevice = 1, tubedevice_receiver = 1},
+	tube = {
+		insert_object = function(pos, node, stack, direction)
+			local meta = minetest.get_meta(pos)
+			local inv = meta:get_inventory()
+			return inv:add_item("main", stack)
+		end,
+		can_insert = function(pos, node, stack, direction)
+			local meta = minetest.get_meta(pos)
+			local inv = meta:get_inventory()
+			if meta:get_int("splitstacks") == 1 then
+				stack = stack:peek_item(1)
+			end
+			return inv:room_for_item("main", stack)
+		end,
+		input_inventory = "main",
+		connect_sides = {left = 1, right = 1, back = 1, front = 1, bottom = 1, top = 1}
+	},
+	after_place_node = pipeworks.after_place,
+	after_dig_node = pipeworks.after_dig,
+	on_construct = function(pos)
+		local meta = minetest.get_meta(pos)
+		local inv = meta:get_inventory()
+		inv:set_size("main", 8*4)
+		update_chest_formspec(pos)
+	end,
+	on_receive_fields = function(pos, formname, fields, sender)
+		if not pipeworks.may_configure(pos, sender) then return end
+		fs_helpers.on_receive_fields(pos, fields)
+		update_chest_formspec(pos)
+	end,
+})
+
+-- =====================
+
+local function get_locked_chest_formspec(pos)
+	local spos = pos.x .. "," .. pos.y .. "," .. pos.z
+	local formspec = base_chest_formspec ..
+		"list[nodemeta:" .. spos .. ";main;0,0.3;8,4;]" ..
+		"listring[nodemeta:" .. spos .. ";main]"
+	return formspec
+end
+
+local function setup_locked_formspec(pos, meta)
+	meta:set_string("formspec",
+		get_locked_chest_formspec(pos) ..
+		fs_helpers.cycling_button(
+			meta,
+			"image_button[0,4.3;1,0.6",
+			"splitstacks",
+			{
+				{text="", texture="pipeworks_button_off.png", addopts="false;false;pipeworks_button_interm.png"},
+				{text="", texture="pipeworks_button_on.png",  addopts="false;false;pipeworks_button_interm.png"}
+			}
+		).."label[0.9,4.31;Allow splitting incoming stacks from tubes]"
+	)
+end
+
+minetest.override_item("default:chest_locked", {
+	tiles = {
+		"default_chest_top.png^pipeworks_tube_connection_wooden.png",
+		"default_chest_top.png^pipeworks_tube_connection_wooden.png",
+		"default_chest_side.png^pipeworks_tube_connection_wooden.png",
+		"default_chest_side.png^pipeworks_tube_connection_wooden.png",
+		"default_chest_side.png^pipeworks_tube_connection_wooden.png",
+		"default_chest_lock.png"
+	},
+	groups = {choppy = 2, oddly_breakable_by_hand = 2, tubedevice = 1, tubedevice_receiver = 1},
+	tube = {
+		insert_object = function(pos, node, stack, direction)
+			local meta = minetest.get_meta(pos)
+			local inv = meta:get_inventory()
+			return inv:add_item("main", stack)
+		end,
+		can_insert = function(pos, node, stack, direction)
+			local meta = minetest.get_meta(pos)
+			local inv = meta:get_inventory()
+			if meta:get_int("splitstacks") == 1 then
+				stack = stack:peek_item(1)
+			end
+			return inv:room_for_item("main", stack)
+		end,
+		connect_sides = {left = 1, right = 1, back = 1, front = 1, bottom = 1, top = 1}
+	},
+	after_place_node = function (pos, placer)
+		local meta = minetest.get_meta(pos)
+		meta:set_string("owner", placer:get_player_name() or "")
+		meta:set_string("infotext", "Locked Chest (owned by "..
+		meta:get_string("owner")..")")
+		pipeworks.after_place(pos)
+	end,
+	on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
+		if default.can_interact_with_node(clicker, pos) then
+			local meta = minetest.get_meta(pos)
+			local formspec = meta:get_string("formspec")
+			print("on_rightclick")
+			print(dump(formspec))
+			setup_locked_formspec(pos, meta, clicker)
+			minetest.show_formspec(
+				clicker:get_player_name(),
+				"default:chest_locked",
+				get_locked_chest_formspec(pos)
+			)
+		end
+		return itemstack
+	end,
+	on_key_use = function(pos, player)
+		local secret = minetest.get_meta(pos):get_string("key_lock_secret")
+		local itemstack = player:get_wielded_item()
+		local key_meta = itemstack:get_meta()
+
+		if key_meta:get_string("secret") == "" then
+			key_meta:set_string("secret", minetest.parse_json(itemstack:get_metadata()).secret)
+			itemstack:set_metadata("")
+		end
+
+		if secret ~= key_meta:get_string("secret") then
+			return
+		end
+		setup_locked_formspec(pos, minetest.get_meta(pos))
+	end,
+	on_construct = function(pos)
+		local meta = minetest.get_meta(pos)
+		local inv = meta:get_inventory()
+		inv:set_size("main", 8*4)
+		setup_locked_formspec(pos, meta)
+	end,
+	on_receive_fields = function(pos, formname, fields, sender)
+		if not pipeworks.may_configure(pos, sender) then return end
+		fs_helpers.on_receive_fields(pos, fields)
+		local formspec = get_locked_chest_formspec(pos)
+		print("on_receive_fields")
+		print(dump(formspec))
+
+		if formspec == "" then
+			meta:set_string("formspec", formspec)
+		else
+			setup_locked_formspec(pos, minetest.get_meta(pos))
+		end
+	end,
+	after_dig_node = pipeworks.after_dig
+})

compat-furnaces.lua

@@ -0,0 +1,431 @@
+
+-- this file is basically a modified copy of
+-- minetest_game/mods/default/furnaces.lua
+
+local fs_helpers = pipeworks.fs_helpers
+
+local function active_formspec(fuel_percent, item_percent, pos, meta)
+	local formspec =
+		"size[8,8.5]"..
+		default.gui_bg..
+		default.gui_bg_img..
+		default.gui_slots..
+		"list[current_name;src;2.75,0.5;1,1;]"..
+		"list[current_name;fuel;2.75,2.5;1,1;]"..
+		"image[2.75,1.5;1,1;default_furnace_fire_bg.png^[lowpart:"..
+		(100-fuel_percent)..":default_furnace_fire_fg.png]"..
+		"image[3.75,1.5;1,1;gui_furnace_arrow_bg.png^[lowpart:"..
+		(item_percent)..":gui_furnace_arrow_fg.png^[transformR270]"..
+		"list[current_name;dst;4.75,0.96;2,2;]"..
+		"list[current_player;main;0,4.25;8,1;]"..
+		"list[current_player;main;0,5.5;8,3;8]"..
+		"listring[current_name;dst]"..
+		"listring[current_player;main]"..
+		"listring[current_name;src]"..
+		"listring[current_player;main]"..
+		"listring[current_name;fuel]"..
+		"listring[current_player;main]"..
+		default.get_hotbar_bg(0, 4.25) ..
+			fs_helpers.cycling_button(
+				meta,
+				"image_button[0,3.5;1,0.6",
+				"split_material_stacks",
+				{
+					{text="", texture="pipeworks_button_off.png", addopts="false;false;pipeworks_button_interm.png"},
+					{text="", texture="pipeworks_button_on.png",  addopts="false;false;pipeworks_button_interm.png"}
+				}
+			).."label[0.9,3.51;Allow splitting incoming material (not fuel) stacks from tubes]"
+	return formspec
+end
+
+local function inactive_formspec(pos, meta)
+	local formspec = "size[8,8.5]"..
+	default.gui_bg..
+	default.gui_bg_img..
+	default.gui_slots..
+	"list[current_name;src;2.75,0.5;1,1;]"..
+	"list[current_name;fuel;2.75,2.5;1,1;]"..
+	"image[2.75,1.5;1,1;default_furnace_fire_bg.png]"..
+	"image[3.75,1.5;1,1;gui_furnace_arrow_bg.png^[transformR270]"..
+	"list[current_name;dst;4.75,0.96;2,2;]"..
+	"list[current_player;main;0,4.25;8,1;]"..
+	"list[current_player;main;0,5.5;8,3;8]"..
+	"listring[current_name;dst]"..
+	"listring[current_player;main]"..
+	"listring[current_name;src]"..
+	"listring[current_player;main]"..
+	"listring[current_name;fuel]"..
+	"listring[current_player;main]"..
+	default.get_hotbar_bg(0, 4.25) ..
+		fs_helpers.cycling_button(
+			meta,
+			"image_button[0,3.5;1,0.6",
+			"split_material_stacks",
+			{
+				{text="", texture="pipeworks_button_off.png", addopts="false;false;pipeworks_button_interm.png"},
+				{text="", texture="pipeworks_button_on.png",  addopts="false;false;pipeworks_button_interm.png"}
+			}
+		).."label[0.9,3.51;Allow splitting incoming material (not fuel) stacks from tubes]"
+	return formspec
+end
+
+--
+-- Node callback functions that are the same for active and inactive furnace
+--
+
+local function can_dig(pos, player)
+	local meta = minetest.get_meta(pos);
+	local inv = meta:get_inventory()
+	return inv:is_empty("fuel") and inv:is_empty("dst") and inv:is_empty("src")
+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 = minetest.get_meta(pos)
+	local inv = meta:get_inventory()
+	if listname == "fuel" then
+		if minetest.get_craft_result({method="fuel", width=1, items={stack}}).time ~= 0 then
+			if inv:is_empty("src") then
+				meta:set_string("infotext", "Furnace is empty")
+			end
+			return stack:get_count()
+		else
+			return 0
+		end
+	elseif listname == "src" then
+		return stack:get_count()
+	elseif listname == "dst" then
+		return 0
+	end
+end
+
+local function allow_metadata_inventory_move(pos, from_list, from_index, to_list, to_index, count, player)
+	local meta = minetest.get_meta(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
+
+local function allow_metadata_inventory_take(pos, listname, index, stack, player)
+	if minetest.is_protected(pos, player:get_player_name()) then
+		return 0
+	end
+	return stack:get_count()
+end
+
+local function swap_node(pos, name)
+	local node = minetest.get_node(pos)
+	if node.name == name then
+		return
+	end
+	node.name = name
+	minetest.swap_node(pos, node)
+end
+
+local function furnace_node_timer(pos, elapsed)
+	--
+	-- Inizialize metadata
+	--
+	local meta = minetest.get_meta(pos)
+	local fuel_time = meta:get_float("fuel_time") or 0
+	local src_time = meta:get_float("src_time") or 0
+	local fuel_totaltime = meta:get_float("fuel_totaltime") or 0
+
+	local inv = meta:get_inventory()
+	local srclist, fuellist
+
+	local cookable, cooked
+	local fuel
+
+	local update = true
+	while update do
+		update = false
+
+		srclist = inv:get_list("src")
+		fuellist = inv:get_list("fuel")
+
+		--
+		-- Cooking
+		--
+
+		-- Check if we have cookable content
+		local aftercooked
+		cooked, aftercooked = minetest.get_craft_result({method = "cooking", width = 1, items = srclist})
+		cookable = cooked.time ~= 0
+
+		-- Check if we have enough fuel to burn
+		if fuel_time < fuel_totaltime then
+			-- The furnace is currently active and has enough fuel
+			fuel_time = fuel_time + elapsed
+			-- If there is a cookable item then check if it is ready yet
+			if cookable then
+				src_time = src_time + elapsed
+				if src_time >= cooked.time then
+					-- Place result in dst list if possible
+					if inv:room_for_item("dst", cooked.item) then
+						inv:add_item("dst", cooked.item)
+						inv:set_stack("src", 1, aftercooked.items[1])
+						src_time = src_time - cooked.time
+						update = true
+					end
+				end
+			end
+		else
+			-- Furnace ran out of fuel
+			if cookable then
+				-- We need to get new fuel
+				local afterfuel
+				fuel, afterfuel = minetest.get_craft_result({method = "fuel", width = 1, items = fuellist})
+
+				if fuel.time == 0 then
+					-- No valid fuel in fuel list
+					fuel_totaltime = 0
+					src_time = 0
+				else
+					-- Take fuel from fuel list
+					inv:set_stack("fuel", 1, afterfuel.items[1])
+					update = true
+					fuel_totaltime = fuel.time + (fuel_time - fuel_totaltime)
+					src_time = src_time + elapsed
+				end
+			else
+				-- We don't need to get new fuel since there is no cookable item
+				fuel_totaltime = 0
+				src_time = 0
+			end
+			fuel_time = 0
+		end
+
+		elapsed = 0
+	end
+
+	if fuel and fuel_totaltime > fuel.time then
+		fuel_totaltime = fuel.time
+	end
+	if srclist[1]:is_empty() then
+		src_time = 0
+	end
+
+	--
+	-- Update formspec, infotext and node
+	--
+	local formspec = inactive_formspec(pos, meta)
+	local item_state
+	local item_percent = 0
+	if cookable then
+		item_percent = math.floor(src_time / cooked.time * 100)
+		if item_percent > 100 then
+			item_state = "100% (output full)"
+		else
+			item_state = item_percent .. "%"
+		end
+	else
+		if srclist[1]:is_empty() then
+			item_state = "Empty"
+		else
+			item_state = "Not cookable"
+		end
+	end
+
+	local fuel_state = "Empty"
+	local active = "inactive "
+	local result = false
+
+	if fuel_totaltime ~= 0 then
+		active = "active "
+		local fuel_percent = math.floor(fuel_time / fuel_totaltime * 100)
+		fuel_state = fuel_percent .. "%"
+		formspec = active_formspec(fuel_percent, item_percent, pos, meta)
+		swap_node(pos, "default:furnace_active")
+		-- make sure timer restarts automatically
+		result = true
+	else
+		if not fuellist[1]:is_empty() then
+			fuel_state = "0%"
+		end
+		swap_node(pos, "default:furnace")
+		-- stop timer on the inactive furnace
+		minetest.get_node_timer(pos):stop()
+	end
+
+	local infotext = "Furnace " .. active .. "(Item: " .. item_state .. "; Fuel: " .. fuel_state .. ")"
+
+	--
+	-- Set meta values
+	--
+	meta:set_float("fuel_totaltime", fuel_totaltime)
+	meta:set_float("fuel_time", fuel_time)
+	meta:set_float("src_time", src_time)
+	meta:set_string("formspec", formspec)
+	meta:set_string("infotext", infotext)
+
+	return result
+end
+
+--
+-- Node definitions
+--
+
+minetest.register_node(":default:furnace", {
+	description = "Furnace",
+	tiles = {
+		"default_furnace_top.png^pipeworks_tube_connection_stony.png",
+		"default_furnace_bottom.png^pipeworks_tube_connection_stony.png",
+		"default_furnace_side.png^pipeworks_tube_connection_stony.png",
+		"default_furnace_side.png^pipeworks_tube_connection_stony.png",
+		"default_furnace_side.png^pipeworks_tube_connection_stony.png",
+		"default_furnace_front.png"
+	},
+	groups = {cracky = 2, tubedevice = 1, tubedevice_receiver = 1},
+	tube = {
+		insert_object = function(pos, node, stack, direction)
+			local meta = minetest.get_meta(pos)
+			local inv = meta:get_inventory()
+			local timer = minetest.get_node_timer(pos)
+			if not timer:is_started() then
+				timer:start(1.0)
+			end
+			if direction.y == 1 then
+				return inv:add_item("fuel", stack)
+			else
+				return inv:add_item("src", stack)
+			end
+		end,
+		can_insert = function(pos,node,stack,direction)
+			local meta = minetest.get_meta(pos)
+			local inv = meta:get_inventory()
+			if direction.y == 1 then
+				return inv:room_for_item("fuel", stack)
+			else
+				if meta:get_int("split_material_stacks") == 1 then
+					stack = stack:peek_item(1)
+				end
+				return inv:room_for_item("src", stack)
+			end
+		end,
+		input_inventory = "dst",
+		connect_sides = {left = 1, right = 1, back = 1, front = 1, bottom = 1, top = 1}
+	},
+	paramtype2 = "facedir",
+	legacy_facedir_simple = true,
+	is_ground_content = false,
+	sounds = default.node_sound_stone_defaults(),
+
+	can_dig = can_dig,
+
+	on_timer = furnace_node_timer,
+
+	on_construct = function(pos)
+		local meta = minetest.get_meta(pos)
+		meta:set_string("formspec", inactive_formspec(pos, meta))
+		local inv = meta:get_inventory()
+		inv:set_size('src', 1)
+		inv:set_size('fuel', 1)
+		inv:set_size('dst', 4)
+	end,
+
+	on_metadata_inventory_move = function(pos)
+		minetest.get_node_timer(pos):start(1.0)
+	end,
+	on_metadata_inventory_put = function(pos)
+		-- start timer function, it will sort out whether furnace can burn or not.
+		minetest.get_node_timer(pos):start(1.0)
+	end,
+	on_blast = function(pos)
+		local drops = {}
+		default.get_inventory_drops(pos, "src", drops)
+		default.get_inventory_drops(pos, "fuel", drops)
+		default.get_inventory_drops(pos, "dst", drops)
+		drops[#drops+1] = "default:furnace"
+		minetest.remove_node(pos)
+		return drops
+	end,
+	allow_metadata_inventory_put = allow_metadata_inventory_put,
+	allow_metadata_inventory_move = allow_metadata_inventory_move,
+	allow_metadata_inventory_take = allow_metadata_inventory_take,
+	on_receive_fields = function(pos, formname, fields, sender)
+		if not pipeworks.may_configure(pos, sender) then return end
+		fs_helpers.on_receive_fields(pos, fields)
+		local meta = minetest.get_meta(pos)
+		local formspec = inactive_formspec(pos, meta)
+		meta:set_string("formspec", formspec)
+	end,
+	after_place_node = pipeworks.after_place,
+	after_dig_node = pipeworks.after_dig
+})
+
+minetest.register_node(":default:furnace_active", {
+	description = "Furnace",
+	tiles = {
+		"default_furnace_top.png^pipeworks_tube_connection_stony.png",
+		"default_furnace_bottom.png^pipeworks_tube_connection_stony.png",
+		"default_furnace_side.png^pipeworks_tube_connection_stony.png",
+		"default_furnace_side.png^pipeworks_tube_connection_stony.png",
+		"default_furnace_side.png^pipeworks_tube_connection_stony.png",
+		{
+			image = "default_furnace_front_active.png",
+			backface_culling = false,
+			animation = {
+				type = "vertical_frames",
+				aspect_w = 16,
+				aspect_h = 16,
+				length = 1.5
+			},
+		}
+	},
+	groups = {cracky = 2, tubedevice = 1, tubedevice_receiver = 1, not_in_creative_inventory = 1},
+	tube = {
+		insert_object = function(pos,node,stack,direction)
+			local meta = minetest.get_meta(pos)
+			local inv = meta:get_inventory()
+			local timer = minetest.get_node_timer(pos)
+			if not timer:is_started() then
+				timer:start(1.0)
+			end
+			if direction.y == 1 then
+				return inv:add_item("fuel", stack)
+			else
+				return inv:add_item("src", stack)
+			end
+		end,
+		can_insert = function(pos, node, stack, direction)
+			local meta = minetest.get_meta(pos)
+			local inv = meta:get_inventory()
+			if direction.y == 1 then
+				return inv:room_for_item("fuel", stack)
+			else
+				if meta:get_int("split_material_stacks") == 1 then
+					stack = stack:peek_item(1)
+				end
+				return inv:room_for_item("src", stack)
+			end
+		end,
+		input_inventory = "dst",
+		connect_sides = {left = 1, right = 1, back = 1, front = 1, bottom = 1, top = 1}
+	},
+	paramtype2 = "facedir",
+	light_source = 8,
+	drop = "default:furnace",
+	legacy_facedir_simple = true,
+	is_ground_content = false,
+	sounds = default.node_sound_stone_defaults(),
+	on_timer = furnace_node_timer,
+
+	can_dig = can_dig,
+
+	allow_metadata_inventory_put = allow_metadata_inventory_put,
+	allow_metadata_inventory_move = allow_metadata_inventory_move,
+	allow_metadata_inventory_take = allow_metadata_inventory_take,
+	on_receive_fields = function(pos, formname, fields, sender)
+		if not pipeworks.may_configure(pos, sender) then return end
+		fs_helpers.on_receive_fields(pos, fields)
+		local meta = minetest.get_meta(pos)
+		local formspec = active_formspec(0, 0, pos, meta)
+		meta:set_string("formspec", formspec)
+	end,
+	after_place_node = pipeworks.after_place,
+	after_dig_node = pipeworks.after_dig
+})
+

init.lua

@@ -108,7 +108,10 @@ dofile(pipeworks.modpath.."/wielder.lua")
 if pipeworks.enable_pipes then dofile(pipeworks.modpath.."/pipes.lua") end
 if pipeworks.enable_teleport_tube then dofile(pipeworks.modpath.."/teleport_tube.lua") end
 if pipeworks.enable_pipe_devices then dofile(pipeworks.modpath.."/devices.lua") end
-if pipeworks.enable_redefines then dofile(pipeworks.modpath.."/compat.lua") end
+if pipeworks.enable_redefines then
+	dofile(pipeworks.modpath.."/compat-chests.lua")
+	dofile(pipeworks.modpath.."/compat-furnaces.lua")
+end
 if pipeworks.enable_autocrafter then dofile(pipeworks.modpath.."/autocrafter.lua") end
 
 minetest.register_alias("pipeworks:pipe", "pipeworks:pipe_110000_empty")