techage/basic_machines/gravelrinser.lua

--[[

	TechAge
	=======

	Copyright (C) 2019 Joachim Stolberg

	GPL v3
	See LICENSE.txt for more information
	
	TA2 Gravel Rinser, washing sieved gravel to find more ores
	
]]--

-- for lazy programmers
local M = minetest.get_meta
local S = techage.S

-- Consumer Related Data
local CRD = function(pos) return (minetest.registered_nodes[minetest.get_node(pos).name] or {}).consumer end

local STANDBY_TICKS = 10
local COUNTDOWN_TICKS = 10
local CYCLE_TIME = 4

local Probability = {}

local function formspec(self, pos, mem)
	return "size[8,8]"..
	default.gui_bg..
	default.gui_bg_img..
	default.gui_slots..
	"list[context;src;0,0;3,3;]"..
	"item_image[0,0;1,1;default:gravel]"..
	"image[0,0;1,1;techage_form_mask.png]"..
	"image[3.5,0;1,1;"..techage.get_power_image(pos, mem).."]"..
	"image[3.5,1;1,1;techage_form_arrow.png]"..
	"image_button[3.5,2;1,1;".. self:get_state_button_image(mem) ..";state_button;]"..
	"list[context;dst;5,0;3,3;]"..
	"list[current_player;main;0,4;8,4;]"..
	"listring[context;dst]"..
	"listring[current_player;main]"..
	"listring[context;src]"..
	"listring[current_player;main]"..
	default.get_hotbar_bg(0, 4)
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
	if listname == "src" then
		CRD(pos).State:start_if_standby(pos)
		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 get_water_level(pos)
	local node  = minetest.get_node(pos)
	if minetest.get_item_group(node.name, "water") > 0 then
		local ndef = minetest.registered_nodes[node.name]
		if ndef and ndef.liquidtype == "flowing" then
			return node.param2
		end
	end
	return 99
end

local function determine_water_dir(pos)
	local lvl = get_water_level(pos)
	if lvl > get_water_level({x=pos.x+1, y=pos.y, z=pos.z}) then
		return 2
	end
	if lvl > get_water_level({x=pos.x-1, y=pos.y, z=pos.z}) then
		return 4
	end
	if lvl > get_water_level({x=pos.x, y=pos.y, z=pos.z+1}) then
		return 1
	end
	if lvl > get_water_level({x=pos.x, y=pos.y, z=pos.z-1}) then
		return 3
	end
	return 0
end

local function set_velocity(obj, pos, vel)
	obj:set_acceleration({x = 0, y = 0, z = 0})
	local p = obj:get_pos()
	if p then
		obj:set_pos({x=p.x, y=p.y-0.3, z=p.z})
		obj:set_velocity(vel)
	end
end

local function add_object(pos, name)
	local dir = determine_water_dir(pos)
	if dir > 0 then
		local obj = minetest.add_item(pos, ItemStack(name))
		local vel = vector.multiply(tubelib2.Dir6dToVector[dir], 0.3)
		minetest.after(0.3, set_velocity, obj, pos, vel)
	end
end

local function get_random_gravel_ore()
	for ore, probability in pairs(Probability) do
		if math.random(probability) == 1 then
			return ore
		end
	end
end

local function washing(pos, crd, mem, inv)
	-- for testing purposes
	if inv:contains_item("src", ItemStack("default:stick")) then
		add_object({x=pos.x, y=pos.y+1, z=pos.z}, "default:stick")
		inv:remove_item("src", ItemStack("default:stick"))
		crd.State:keep_running(pos, mem, COUNTDOWN_TICKS)
		return
	end
	
	local src = ItemStack("techage:sieved_gravel")
	local dst = ItemStack("default:sand")
	if inv:contains_item("src", src) then
		local ore = get_random_gravel_ore()
		if ore then
			add_object({x=pos.x, y=pos.y+1, z=pos.z}, ore)
		end
	else
		crd.State:idle(pos, mem)
		return
	end
	if not inv:room_for_item("dst", dst) then
		crd.State:idle(pos, mem)
		return
	end
	inv:add_item("dst", dst)
	inv:remove_item("src", src)
	crd.State:keep_running(pos, mem, COUNTDOWN_TICKS)
end

local function keep_running(pos, elapsed)
	local mem = tubelib2.get_mem(pos)
	local crd = CRD(pos)
	local inv = M(pos):get_inventory()
	washing(pos, crd, mem, inv)
	return crd.State:is_active(mem)
end

local function on_receive_fields(pos, formname, fields, player)
	if minetest.is_protected(pos, player:get_player_name()) then
		return
	end
	local mem = tubelib2.get_mem(pos)
	CRD(pos).State:state_button_event(pos, mem, fields)
end

local function can_dig(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("dst") and inv:is_empty("src")
end


local tiles = {}
-- '#' will be replaced by the stage number
-- '{power}' will be replaced by the power PNG
tiles.pas = {
	-- up, down, right, left, back, front
	"techage_appl_rinser_top.png^techage_frame_ta#_top.png",
	"techage_filling_ta#.png^techage_frame_ta#.png",
	"techage_filling_ta#.png^techage_frame_ta#.png^techage_appl_outp.png",
	"techage_filling_ta#.png^techage_frame_ta#.png^techage_appl_inp.png",
	"techage_filling_ta#.png^techage_appl_rinser.png^techage_frame_ta#.png",
	"techage_filling_ta#.png^techage_appl_rinser.png^techage_frame_ta#.png",
}
tiles.act = {
	-- up, down, right, left, back, front
	{
		image = "techage_appl_rinser4_top.png^techage_frame4_ta#_top.png",
		backface_culling = false,
		animation = {
			type = "vertical_frames",
			aspect_w = 32,
			aspect_h = 32,
			length = 2.0,
		},
	},
	"techage_filling_ta#.png^techage_frame_ta#.png",
	"techage_filling_ta#.png^techage_frame_ta#.png^techage_appl_outp.png",
	"techage_filling_ta#.png^techage_frame_ta#.png^techage_appl_inp.png",
	"techage_filling_ta#.png^techage_appl_rinser.png^techage_frame_ta#.png",
	"techage_filling_ta#.png^techage_appl_rinser.png^techage_frame_ta#.png",
}

local tubing = {
	on_pull_item = function(pos, in_dir, num)
		local meta = minetest.get_meta(pos)
		if meta:get_int("pull_dir") == in_dir then
			local inv = M(pos):get_inventory()
			return techage.get_items(inv, "dst", num)
		end
	end,
	on_push_item = function(pos, in_dir, stack)
		local meta = minetest.get_meta(pos)
		if meta:get_int("push_dir") == in_dir  or in_dir == 5 then
			local inv = M(pos):get_inventory()
			CRD(pos).State:start_if_standby(pos)
			return techage.put_items(inv, "src", stack)
		end
	end,
	on_unpull_item = function(pos, in_dir, stack)
		local meta = minetest.get_meta(pos)
		if meta:get_int("pull_dir") == in_dir then
			local inv = M(pos):get_inventory()
			return techage.put_items(inv, "dst", stack)
		end
	end,
	on_recv_message = function(pos, topic, payload)
		local resp = CRD(pos).State:on_receive_message(pos, topic, payload)
		if resp then
			return resp
		else
			return "unsupported"
		end
	end,
	on_node_load = function(pos)
		CRD(pos).State:on_node_load(pos)
	end,
}

local node_name_ta2, node_name_ta3, node_name_ta4 = 
	techage.register_consumer("rinser", S("Gravel Rinser"), tiles, {
		drawtype = "nodebox",
		node_box = {
			type = "fixed",
			fixed = {
				{-8/16, -8/16, -8/16,  8/16, 8/16, -6/16},
				{-8/16, -8/16,  6/16,  8/16, 8/16,  8/16},
				{-8/16, -8/16, -8/16, -6/16, 8/16,  8/16},
				{ 6/16, -8/16, -8/16,  8/16, 8/16,  8/16},
				{-6/16, -8/16, -6/16,  6/16, 6/16,  6/16},
				{-6/16,  6/16, -1/16,  6/16, 8/16,  1/16},
				{-1/16,  6/16, -6/16,  1/16, 8/16,  6/16},
			},
		},
		selection_box = {
			type = "fixed",
			fixed = {-8/16, -8/16, -8/16,   8/16, 8/16, 8/16},
		},
		cycle_time = CYCLE_TIME,
		standby_ticks = STANDBY_TICKS,
		formspec = formspec,
		tubing = tubing,
		after_place_node = function(pos, placer)
			local inv = M(pos):get_inventory()
			inv:set_size('src', 9)
			inv:set_size('dst', 9)
		end,
		can_dig = can_dig,
		node_timer = keep_running,
		on_receive_fields = on_receive_fields,
		allow_metadata_inventory_put = allow_metadata_inventory_put,
		allow_metadata_inventory_move = allow_metadata_inventory_move,
		allow_metadata_inventory_take = allow_metadata_inventory_take,
		groups = {choppy=2, cracky=2, crumbly=2},
		sounds = default.node_sound_wood_defaults(),
		num_items = {0,1,2,4},
		power_consumption = {0,3,4,5},
	},
	{false, true, false, false})  -- TA2 only

minetest.register_craft({
	output = node_name_ta2,
	recipe = {
		{"group:wood", "default:mese_crystal", "group:wood"},
		{"techage:tubeS", "techage:sieve", "techage:tubeS"},
		{"group:wood", "default:tin_ingot", "group:wood"},
	},
})


if minetest.global_exists("unified_inventory") then
	unified_inventory.register_craft_type("rinsing", {
		description = S("Rinsing"),
		icon = "techage_appl_rinser_top.png^techage_frame_ta2_top.png",
		width = 2,
		height = 2,
	})
end

function techage.add_rinser_recipe(recipe)
	Probability[recipe.output] = recipe.probability
	if minetest.global_exists("unified_inventory") then
		recipe.items = {recipe.input}
		recipe.type = "rinsing"
		unified_inventory.register_craft(recipe)
	end
end	

local function remove_objects(pos)
	for _, object in pairs(minetest.get_objects_inside_radius(pos, 1)) do
		local lua_entity = object:get_luaentity()
		if not object:is_player() and lua_entity and lua_entity.name == "__builtin:item" then
			object:remove()
		end
	end
end

minetest.register_lbm({
	label = "[techage] Rinser update",
	name = "techage:update",
	nodenames = {"techage:ta2_rinser_act"},
	run_at_every_load = true,
	action = function(pos, node)
		remove_objects({x=pos.x, y=pos.y+1, z=pos.z})
	end
})


techage.add_rinser_recipe({input="techage:sieved_gravel", output="techage:usmium_nuggets", probability=40})
techage.add_rinser_recipe({input="techage:sieved_gravel", output="default:copper_lump", probability=20})

local Tube = "techage_tube_knee.png"
local Tube2 = "techage_tube_knee.png^[transformR270"
local Rinser = "techage_filling_ta2.png^techage_appl_rinser.png^techage_frame_ta2.png"
local Hopper = "techage_hopper.png"
local Glass = "default_glass.png"
local Water = "default_water.png"
local Chest = "default_chest_lock.png"
local Dirt = "default_dirt.png"

local Images = {
	{false, false, false, false, false, false, false, false},
	{false, Glass, false, false, false, false, Water, Glass},
	{false, Chest, Hopper, Tube, Rinser, Tube2, Glass, Glass},
}

techage.register_entry_page("ta2", "rinser",
	S("TA2 Gravel Rinser"), 
	S("Used to wash Sieved Gravel to get Usmium Nuggets. The block has to be placed under flowing water. "..
		"The washed-out nuggets must be sucked in with a Hopper.@nFor the plant you need a chest, "..
		"the Hopper, the Rinser with tube support and a frame around the flowing water (see plan).@n"..
		"Hint: You can test the Rinser with some sticks that are washed out immediately.@n"..
		"It needs 3 units axle power"), 
	nil, Images)