techpack/tubelib_addons2/sequencer.lua

--[[

	Tubelib Addons 2
	================

	Copyright (C) 2017-2020 Joachim Stolberg

	AGPL v3
	See LICENSE.txt for more information

	sequencer.lua:

]]--

-- Load support for I18n
local S = tubelib_addons2.S

local RUNNING_STATE = 1
local STOP_STATE = 0
local NUM_SLOTS = 8

local sAction = ",on,off"
local kvAction = {[""]=1, ["on"]=2, ["off"]=3}
local tAction = {nil, "on", "off"}

local function formspec(state, rules, endless)
	endless = endless == 1 and "true" or "false"
	local tbl = {"size[8,9.2]"..
		default.gui_bg..
		default.gui_bg_img..
		default.gui_slots..
		"label[0,0;Number(s)]label[2.1,0;"..S("Command").."]label[6.4,0;Offset/s]"}

	for idx, rule in ipairs(rules or {}) do
		tbl[#tbl+1] = "field[0.2,"..(-0.2+idx)..";2,1;num"..idx..";;"..(rule.num or "").."]"
		tbl[#tbl+1] = "dropdown[2,"..(-0.4+idx)..";3.9,1;act"..idx..";"..sAction..";"..(rule.act or "").."]"
		tbl[#tbl+1] = "field[6.2,"..(-0.2+idx)..";2,1;offs"..idx..";;"..(rule.offs or "").."]"
	end
	tbl[#tbl+1] = "checkbox[0,8.5;endless;"..S("Run endless")..";"..endless.."]"
	tbl[#tbl+1] = "image_button[5,8.5;1,1;".. tubelib.state_button(state) ..";button;]"
	tbl[#tbl+1] = "button[6.2,8.5;1.5,1;"..S("help")..";help]"

	return table.concat(tbl)
end

local function formspec_help()
	return "size[8,9.2]"..
		default.gui_bg..
		default.gui_bg_img..
		default.gui_slots..
		"label[2,0;"..S("Sequencer Help").."]"..
		"label[0,1;"..S("Define a sequence of commands\nto control other machines.").."]"..
		"label[0,2.2;"..S("Numbers(s) are the node numbers,\nthe command shall sent to.").."]"..
		"label[0,3.4;"..S("The commands 'on'/'off' are used\n for machines and other nodes.").."]"..
		"label[0,4.6;"..S("Offset is the time to the\nnext line in seconds (1..999).").."]"..
		"label[0,5.8;"..S("If endless is set, the Sequencer\nrestarts again and again.").."]"..
		"label[0,7;"..S("The command '  ' does nothing,\nonly consuming the offset time.").."]"..
		"button[3,8;2,1;"..S("exit")..";close]"
end

local function stop_the_sequencer(pos)
	local node = minetest.get_node(pos)
	local meta = minetest.get_meta(pos)
	local number = meta:get_string("number")
	meta:set_int("running", STOP_STATE)
	meta:set_string("infotext", S("Tubelib Sequencer").." "..number..": stopped")
	local rules = minetest.deserialize(meta:get_string("rules"))
	local endless = meta:get_int("endless") or 0
	meta:set_string("formspec", formspec(tubelib.STOPPED, rules, endless))
	minetest.get_node_timer(pos):stop()
	return false
end

local function get_next_slot(idx, rules, endless)
	idx = idx + 1
	if idx <= #rules and rules[idx].offs ~= "" and rules[idx].num ~= "" then
		return idx
	elseif endless == 1 then
		return 1
	end
	return nil
end

local function restart_timer(pos, time)
	local timer = minetest.get_node_timer(pos)
	if timer:is_started() then
		timer:stop()
	end
	if type(time) == "number" then
		timer:start(time)
	end
end

local function check_rules(pos, elapsed)
	if tubelib.data_not_corrupted(pos) then
		local meta = minetest.get_meta(pos)
		local rules = minetest.deserialize(meta:get_string("rules"))
		if rules then
			local running = meta:get_int("running")
			local index = meta:get_int("index") or 1
			local number = meta:get_string("number")
			local endless = meta:get_int("endless") or 0
			local placer_name = meta:get_string("placer_name")
			while true do -- process all rules as long as offs == 0
				local rule = rules[index]
				local offs = rules[index].offs
				if type(offs) == "string" then
					offs = 0
				end
				tubelib.send_message(rule.num, placer_name, nil, tAction[rule.act], number)
				index = get_next_slot(index, rules, endless)
				if index ~= nil and offs ~= nil and running == 1 then
					-- after the last rule a pause with 1 or more sec is required
					if index == 1 and offs < 1 then
						offs = 1
					end
					meta:set_string("infotext", S("Tubelib Sequencer").." "..number..": running ("..index.."/"..NUM_SLOTS..")")
					meta:set_int("index", index)
					if offs > 0 then
						minetest.after(0, restart_timer, pos, offs)
						return false
					end
				else
					return stop_the_sequencer(pos)
				end
			end
		end
		return false
	end
	return false
end

local function start_the_sequencer(pos)
	local node = minetest.get_node(pos)
	local meta = minetest.get_meta(pos)
	local number = meta:get_string("number")
	meta:set_int("running", 1)
	meta:set_int("index", 1)
	meta:set_string("infotext", S("Tubelib Sequencer").." "..number..": running (1/"..NUM_SLOTS..")")
	local rules = minetest.deserialize(meta:get_string("rules"))
	local endless = meta:get_int("endless") or 0
	meta:set_string("formspec", formspec(tubelib.RUNNING, rules, endless))
	minetest.get_node_timer(pos):start(0.1)
	return false
end

local function 	on_receive_fields(pos, formname, fields, player)
	if tubelib.data_not_corrupted(pos) then
		local meta = minetest.get_meta(pos)
		local running = meta:get_int("running")
		if minetest.is_protected(pos, player:get_player_name()) then
			return
		end

		if fields.help ~= nil then
			meta:set_string("formspec", formspec_help())
			return
		end

		local endless = meta:get_int("endless") or 0
		if fields.endless ~= nil then
			endless = fields.endless == "true" and 1 or 0
			meta:set_int("index", 1)
		end
		meta:set_int("endless", endless)

		local rules = minetest.deserialize(meta:get_string("rules"))
		if fields.exit ~= nil then
			meta:set_string("formspec", formspec(tubelib.state(running), rules, endless))
			return
		end

		for idx = 1,NUM_SLOTS do
			if fields["offs"..idx] ~= nil then
				rules[idx].offs = tonumber(fields["offs"..idx]) or ""
			end
			if fields["num"..idx] ~= nil and tubelib.check_numbers(fields["num"..idx]) then
				rules[idx].num = fields["num"..idx]
			end
			if fields["act"..idx] ~= nil then
				rules[idx].act = kvAction[fields["act"..idx]]
			end
		end
		meta:set_string("rules", minetest.serialize(rules))

		if fields.button ~= nil then
			if running > STOP_STATE then
				stop_the_sequencer(pos)
			else
				start_the_sequencer(pos)
			end
		elseif fields.num1 ~= nil then  -- any other change?
			stop_the_sequencer(pos)
		else
			local endless = meta:get_int("endless") or 0
			meta:set_string("formspec", formspec(tubelib.state(running), rules, endless))
		end
	end
end

minetest.register_node("tubelib_addons2:sequencer", {
	description = S("Tubelib Sequencer"),
	tiles = {
		-- up, down, right, left, back, front
		'tubelib_front.png',
		'tubelib_front.png',
		'tubelib_front.png^tubelib_addons2_sequencer.png',
	},

	after_place_node = function(pos, placer)
		local meta = minetest.get_meta(pos)
		local number = tubelib.add_node(pos, "tubelib_addons2:sequencer")
		local rules = {}
		for idx = 1,NUM_SLOTS do
			rules[idx] = {offs = "", num = "", act = 1}
		end
		meta:set_string("placer_name", placer:get_player_name())
		meta:set_string("rules", minetest.serialize(rules))
		meta:set_string("number", number)
		meta:set_int("index", 1)
		meta:set_int("endless", 0)
		meta:get_int("running", STOP_STATE)
		meta:set_string("formspec", formspec(tubelib.STOPPED, rules, 0))
		meta:set_string("infotext", "Tubelib Sequencer "..number)
	end,

	on_receive_fields = on_receive_fields,

	on_dig = function(pos, node, puncher, pointed_thing)
		if minetest.is_protected(pos, puncher:get_player_name()) then
			return
		end
		local meta = minetest.get_meta(pos)
		local running = meta:get_int("running")
		if running ~= 1 then
			minetest.node_dig(pos, node, puncher, pointed_thing)
			tubelib.remove_node(pos)
		end
	end,

	on_timer = check_rules,

	paramtype = "light",
	sunlight_propagates = true,
	paramtype2 = "facedir",
	groups = {choppy=2, cracky=2, crumbly=2},
	is_ground_content = false,
	sounds = default.node_sound_stone_defaults(),
	on_blast = function() end,
})


minetest.register_craft({
	output = "tubelib_addons2:sequencer",
	recipe = {
		{"group:wood", "group:wood", ""},
		{"default:mese_crystal", "tubelib:wlanchip", ""},
		{"group:wood", "group:wood", ""},
	},
})

tubelib.register_node("tubelib_addons2:sequencer", {}, {
	on_recv_message = function(pos, topic, payload)
		local node = minetest.get_node(pos)
		if topic == "on" then
			start_the_sequencer(pos)
		elseif topic == "off" then
			-- do not stop immediately
			local meta = minetest.get_meta(pos)
			meta:set_int("endless", 0)
		end
	end,
	on_node_load = function(pos)
		local meta = minetest.get_meta(pos)
		if meta:get_int("running") ~= STOP_STATE then
			meta:set_int("running", RUNNING_STATE)
			minetest.get_node_timer(pos):start(1)
		end
	end,
})