Cleanup, make and use util.lua, port command block and delayer to nodedef

5 files changed, 145 insertions, 113 deletions

diff --git a/mesecons/init.lua b/mesecons/init.lua
index d980419..aa3f001 100644
--- a/mesecons/init.lua
+++ b/mesecons/init.lua
@@ -3,41 +3,105 @@
 -- |  \/  | |___ ____  |___ |      |    | | \  | |____
 -- |      | |        | |    |      |    | |  \ |     |
 -- |      | |___ ____| |___ |____  |____| |   \| ____|
--- by Jeija, Uberi (Temperest), sfan5, VanessaE, 
+-- by Jeija, Uberi (Temperest), sfan5, VanessaE
 --
 --
 --
 -- This mod adds mesecons[=minecraft redstone] and different receptors/effectors to minetest.
---
 -- See the documentation on the forum for additional information, especially about crafting
 --
--- For developer documentation see the Developers' section on mesecons.tk 
+--
+-- For developer documentation see the Developers' section on mesecons.TK
+--
+--
+--
+--Quick draft for the mesecons array in the node's definition
+--mesecons =
+--{
+--	receptor =
+--	{
+--		state = mesecon.state.on/off
+--		rules = rules/get_rules
+--	}
+--	effector =
+--	{
+--		action_on = function
+--		action_off = function
+--		action_change = function
+--		rules = rules/get_rules
+--	}
+--	conductor = 
+--	{
+--		state = mesecon.state.on/off
+--		offstate = opposite state (for state = on only)
+--		onstate = opposite state (for state = off only)
+--		rules = rules/get_rules
+--	}
+--}
 
 
 -- PUBLIC VARIABLES
 mesecon={} -- contains all functions and all global variables
-mesecon.actions_on={} -- Saves registered function callbacks for mesecon on
-mesecon.actions_off={} -- Saves registered function callbacks for mesecon off
-mesecon.actions_change={} -- Saves registered function callbacks for mesecon change
-mesecon.receptors={}
-mesecon.effectors={}
-mesecon.conductors={}
-
--- INCLUDE SETTINGS
+mesecon.actions_on={} -- Saves registered function callbacks for mesecon on | DEPRECATED
+mesecon.actions_off={} -- Saves registered function callbacks for mesecon off | DEPRECATED
+mesecon.actions_change={} -- Saves registered function callbacks for mesecon change | DEPRECATED
+mesecon.receptors={} --  saves all information about receptors  | DEPRECATED
+mesecon.effectors={} --  saves all information about effectors  | DEPRECATED
+mesecon.conductors={} -- saves all information about conductors | DEPRECATED
+
+-- Settings
 dofile(minetest.get_modpath("mesecons").."/settings.lua")
 
---Presets (eg default rules)
+-- Presets (eg default rules)
 dofile(minetest.get_modpath("mesecons").."/presets.lua");
 
---Internal API
+
+-- Utilities like comparing positions,
+-- adding positions and rules,
+-- mostly things that make the source look cleaner
+dofile(minetest.get_modpath("mesecons").."/util.lua");
+
+-- Internal stuff
+-- This is the most important file
+-- it handles signal transmission and basically everything else
+-- It is also responsible for managing the nodedef things,
+-- like calling action_on/off/change
 dofile(minetest.get_modpath("mesecons").."/internal.lua");
 
---Deprecated stuff
+-- Deprecated stuff
+-- To be removed in future releases
 dofile(minetest.get_modpath("mesecons").."/legacy.lua");
 
--- API API API API API API API API API API API API API API API API API API
+-- API
+-- these are the only functions you need to remember
+
+function mesecon:receptor_on(pos, rules)
+	rules = rules or mesecon.rules.default
+
+	for _, rule in ipairs(rules) do
+		local np = {
+		x = pos.x + rule.x,
+		y = pos.y + rule.y,
+		z = pos.z + rule.z}
+		if mesecon:rules_link(pos, np, rules) then
+			mesecon:turnon(np, pos)
+		end
+	end
+end
 
+function mesecon:receptor_off(pos, rules)
+	rules = rules or mesecon.rules.default
 
+	for _, rule in ipairs(rules) do
+		local np = {
+		x = pos.x + rule.x,
+		y = pos.y + rule.y,
+		z = pos.z + rule.z}
+		if mesecon:rules_link(pos, np, rules) and not mesecon:connected_to_pw_src(np) then
+			mesecon:turnoff(np, pos)
+		end
+	end
+end
 
 
 print("[OK] mesecons")
diff --git a/mesecons/internal.lua b/mesecons/internal.lua
index ce72d38..d438a53 100644
--- a/mesecons/internal.lua
+++ b/mesecons/internal.lua
@@ -1,6 +1,7 @@
 -- INTERNAL
 
---Receptors
+-- Receptors
+-- Nodes that can power mesecons
 function mesecon:is_receptor_node(nodename)
 	if  minetest.registered_nodes[nodename]
 	and minetest.registered_nodes[nodename].mesecons
@@ -35,11 +36,9 @@ function mesecon:receptor_get_rules(node)
 	if  minetest.registered_nodes[node.name].mesecons
 	and minetest.registered_nodes[node.name].mesecons.receptor then
 		local rules = minetest.registered_nodes[node.name].mesecons.receptor.rules
-		if not rules then
-			return mesecon.rules.default
-		elseif type(rules) == 'function' then
+		if type(rules) == 'function' then
 			return rules(node)
-		else
+		elseif rules then
 			return rules
 		end
 	end
@@ -54,18 +53,20 @@ function mesecon:receptor_get_rules(node)
 			end
 		end
 	end
-	return nil
+	return mesecon.rules.default
 end
 
 -- Effectors
+-- Nodes that can be powered by mesecons
 function mesecon:is_effector_on(nodename)
-	if  minetest.registered_nodes[nodename]
-	and minetest.registered_nodes[nodename].mesecons
-	and minetest.registered_nodes[nodename].mesecons.effector
-	and minetest.registered_nodes[nodename].mesecons.effector.state == mesecon.state.on then
+	if   minetest.registered_nodes[nodename]
+	and  minetest.registered_nodes[nodename].mesecons
+	and  minetest.registered_nodes[nodename].mesecons.effector
+	and (minetest.registered_nodes[nodename].mesecons.effector.action_off
+	or   minetest.registered_nodes[nodename].mesecons.effector.action_change) then
 		return true
 	end
-	for i, effector in ipairs(mesecon.effectors) do --TODO
+	for _, effector in ipairs(mesecon.effectors) do --TODO
 		if effector.onstate == nodename then
 			return true
 		end
@@ -74,13 +75,14 @@ function mesecon:is_effector_on(nodename)
 end
 
 function mesecon:is_effector_off(nodename)
-	if  minetest.registered_nodes[nodename]
-	and minetest.registered_nodes[nodename].mesecons
-	and minetest.registered_nodes[nodename].mesecons.effector
-	and minetest.registered_nodes[nodename].mesecons.effector.state == mesecon.state.off then
+	if   minetest.registered_nodes[nodename]
+	and  minetest.registered_nodes[nodename].mesecons
+	and  minetest.registered_nodes[nodename].mesecons.effector
+	and (minetest.registered_nodes[nodename].mesecons.effector.action_on
+	or   minetest.registered_nodes[nodename].mesecons.effector.action_change) then
 		return true
 	end
-	for i, effector in ipairs(mesecon.effectors) do --TODO
+	for _, effector in ipairs(mesecon.effectors) do --TODO
 		if effector.offstate == nodename then
 			return true
 		end
@@ -101,11 +103,9 @@ function mesecon:effector_get_input_rules(node)
 	if  minetest.registered_nodes[node.name].mesecons
 	and minetest.registered_nodes[node.name].mesecons.effector then
 		local rules = minetest.registered_nodes[node.name].mesecons.effector.rules
-		if not rules then
-			return mesecon.rules.default
-		elseif type(rules) == 'function' then
+		if type(rules) == 'function' then
 			return rules(node)
-		else
+		elseif rules then
 			return rules
 		end
 	end
@@ -121,6 +121,7 @@ function mesecon:effector_get_input_rules(node)
 			end
 		end
 	end
+	return mesecon.rules.default
 end
 
 --Signals
@@ -153,11 +154,11 @@ end
 
 function mesecon:changesignal(pos) --TODO
 	local node = minetest.env:get_node(pos)
-	if  minetest.registered_nodes[nodename]
-	and minetest.registered_nodes[nodename].mesecons
-	and minetest.registered_nodes[nodename].mesecons.effector
-	and minetest.registered_nodes[nodename].mesecons.effector.action_change then
-		minetest.registered_nodes[nodename].mesecons.action_change(pos, node)
+	if  minetest.registered_nodes[node.name]
+	and minetest.registered_nodes[node.name].mesecons
+	and minetest.registered_nodes[node.name].mesecons.effector
+	and minetest.registered_nodes[node.name].mesecons.effector.action_change then
+		minetest.registered_nodes[node.name].mesecons.effector.action_change(pos, node)
 	end
 	for i, action in ipairs(mesecon.actions_change) do
 		action(pos, node) 
@@ -178,7 +179,7 @@ function mesecon:get_rules(name)
 	end
 end
 
---Conductor system stuff
+-- Conductors
 
 function mesecon:get_conductor_on(offstate)
 	if  minetest.registered_nodes[offstate]
@@ -248,11 +249,9 @@ function mesecon:conductor_get_rules(node)
 	and minetest.registered_nodes[node.name].mesecons
 	and minetest.registered_nodes[node.name].mesecons.conductor then
 		local rules = minetest.registered_nodes[node.name].mesecons.conductor.rules
-		if not rules then
-			return mesecon.rules.default
-		elseif type(rules) == 'function' then
+		if type(rules) == 'function' then
 			return rules(node)
-		else
+		elseif rules then
 			return rules
 		end
 	end
@@ -266,6 +265,7 @@ function mesecon:conductor_get_rules(node)
 			end
 		end
 	end
+	return mesecon.rules.default
 end
 
 --
@@ -292,11 +292,8 @@ function mesecon:turnon(pos)
 		local rules = mesecon:conductor_get_rules(node)
 		minetest.env:add_node(pos, {name=mesecon:get_conductor_on(node.name), param2 = node.param2})
 
-		for i, rule in ipairs(rules) do
-			local np = {}
-			np.x = pos.x + rule.x
-			np.y = pos.y + rule.y
-			np.z = pos.z + rule.z
+		for _, rule in ipairs(rules) do
+			local np = mesecon:addPosRule(pos, rule)
 
 			if mesecon:rules_link(pos, np) then
 				mesecon:turnon(np)
@@ -319,11 +316,8 @@ function mesecon:turnoff(pos) --receptor rules used because output could have be
 		local rules = mesecon:conductor_get_rules(node)
 		minetest.env:add_node(pos, {name=mesecon:get_conductor_off(node.name), param2 = node.param2})
 
-		for i, rule in ipairs(rules) do
-			local np = {
-			x = pos.x + rule.x,
-			y = pos.y + rule.y,
-			z = pos.z + rule.z,}
+		for _, rule in ipairs(rules) do
+			local np = mesecon:addPosRule(pos, rule)
 
 			if mesecon:rules_link(pos, np) then
 				mesecon:turnoff(np)
@@ -345,7 +339,7 @@ function mesecon:connected_to_pw_src(pos, checked)
 	local c = 1
 	checked = checked or {}
 	while checked[c] ~= nil do --find out if node has already been checked (to prevent from endless loop)
-		if  compare_pos(checked[c], pos) then
+		if mesecon:cmpPos(checked[c], pos) then
 			return false, checked
 		end
 		c = c + 1
@@ -368,11 +362,8 @@ function mesecon:connected_to_pw_src(pos, checked)
 		return false, checked
 	end
 
-	for i, rule in ipairs(rules) do
-		local np = {}
-		np.x = pos.x + rule.x
-		np.y = pos.y + rule.y
-		np.z = pos.z + rule.z
+	for _, rule in ipairs(rules) do
+		local np = mesecon:addPosRule(pos, rule)
 		if mesecon:rules_link(pos, np) then
 			connected, checked = mesecon:connected_to_pw_src(np, checked)
 			if connected then 
@@ -410,13 +401,9 @@ function mesecon:rules_link(output, input, dug_outputrules) --output/input are p
 
 
 	for _, outputrule in ipairs(outputrules) do
-		if  outputrule.x + output.x == input.x
-		and outputrule.y + output.y == input.y
-		and outputrule.z + output.z == input.z then -- Check if output sends to input
+		if mesecon:cmpPos(mesecon:addPosRule(output, outputrule), input) then -- Check if output sends to input
 			for _, inputrule in ipairs(inputrules) do
-				if  inputrule.x + input.x == output.x
-				and inputrule.y + input.y == output.y
-				and inputrule.z + input.z == output.z then --Check if input accepts from output
+				if  mesecon:cmpPos(mesecon:addPosRule(input, inputrule), output) then --Check if input accepts from output
 					return true
 				end
 			end
@@ -447,11 +434,8 @@ function mesecon:is_powered_by_conductor(pos)
 		return false
 	end
 
-	for i, rule in ipairs(rules) do
-		local con_pos = {
-		x = pos.x + rule.x,
-		y = pos.y + rule.y,
-		z = pos.z + rule.z}
+	for _, rule in ipairs(rules) do
+		local con_pos = mesecon:addPosRule(pos, rule)
 
 		con_node = minetest.env:get_node(con_pos)
 
@@ -482,10 +466,7 @@ function mesecon:is_powered_by_receptor(pos)
 	end
 
 	for i, rule in ipairs(rules) do
-		local rcpt_pos = {
-		x = pos.x + rule.x,
-		y = pos.y + rule.y,
-		z = pos.z + rule.z}
+		local rcpt_pos = mesecon:addPosRule(pos, rule)
 
 		rcpt_node = minetest.env:get_node(rcpt_pos)
 
@@ -509,10 +490,6 @@ function mesecon:updatenode(pos)
     end
 end
 
-function compare_pos(pos1, pos2)
-	return pos1.x == pos2.x and pos1.y == pos2.y and pos1.z == pos2.z
-end
-
 --Rules rotation Functions:
 function mesecon:rotate_rules_right(rules)
 	local nr={};
diff --git a/mesecons/legacy.lua b/mesecons/legacy.lua
index 3f87b1b..947c100 100644
--- a/mesecons/legacy.lua
+++ b/mesecons/legacy.lua
@@ -38,38 +38,6 @@ function mesecon:register_effector(onstate, offstate, input_rules, get_input_rul
 		 get_input_rules = get_input_rules})
 end
 
-function mesecon:receptor_on(pos, rules)
-	if rules == nil then
-		rules = mesecon:get_rules("default")
-	end
-
-	for i, rule in ipairs(rules) do
-		local np = {
-		x = pos.x + rule.x,
-		y = pos.y + rule.y,
-		z = pos.z + rule.z}
-		if mesecon:rules_link(pos, np, rules) then
-			mesecon:turnon(np, pos)
-		end
-	end
-end
-
-function mesecon:receptor_off(pos, rules)
-	if rules == nil then
-		rules = mesecon:get_rules("default")
-	end
-
-	for i, rule in ipairs(rules) do
-		local np = {
-		x = pos.x + rule.x,
-		y = pos.y + rule.y,
-		z = pos.z + rule.z}
-		if mesecon:rules_link(pos, np, rules) and not mesecon:connected_to_pw_src(np) then
-			mesecon:turnoff(np, pos)
-		end
-	end
-end
-
 function mesecon:register_on_signal_on(action)
 	table.insert(mesecon.actions_on, action)
 end
diff --git a/mesecons/presets.lua b/mesecons/presets.lua
index 450f039..463a0f8 100644
--- a/mesecons/presets.lua
+++ b/mesecons/presets.lua
@@ -1,7 +1,7 @@
 mesecon.rules={}
 mesecon.state = {}
 
-mesecon.rules.default = 
+mesecon.rules.default =
 {{x=0,  y=0,  z=-1},
 {x=1,  y=0,  z=0},
 {x=-1, y=0,  z=0},
@@ -15,5 +15,13 @@ mesecon.rules.default =
 {x=0,  y=1,  z=-1},
 {x=0,  y=-1, z=-1}}
 
+mesecon.rules.buttonlike =
+{{x = 1,  y = 0, z = 0},
+{x = 1,  y = 1, z = 0},
+{x = 1,  y =-1, z = 0},
+{x = 1,  y =-1, z = 1},
+{x = 1,  y =-1, z =-1},
+{x = 2,  y = 0, z = 0}}
+
 mesecon.state.on = "on"
 mesecon.state.off = "off"
diff --git a/mesecons/util.lua b/mesecons/util.lua
new file mode 100644
index 0000000..b95cf6e
--- /dev/null
+++ b/mesecons/util.lua
@@ -0,0 +1,15 @@
+function mesecon:swap_node(pos, name)
+	local node = minetest.env:get_node(pos)
+	local data = minetest.env:get_meta(pos):to_table()
+	node.name = name
+	minetest.env:add_node(pos, node)
+	minetest.env:get_meta(pos):from_table(data)
+end
+
+function mesecon:addPosRule(p, r)
+	return {x = p.x + r.x, y = p.y + r.y, z = p.z + r.z}
+end
+
+function mesecon:cmpPos(p1, p2)
+	return (p1.x == p2.x and p1.y == p2.y and p1.z == p2.z)
+end