Merge pull request 'Correct bucket behavior' (#2007) from NO11/MineClone2:buckets+ into master

Reviewed-on: MineClone2/MineClone2#2007
Reviewed-by: cora <cora@noreply.git.minetest.land>

mods/CORE/mcl_util/init.lua

@@ -571,3 +571,16 @@ function mcl_util.replace_mob(obj, mob)
 	obj:set_yaw(rot)
 	return obj
 end
+
+function mcl_util.get_pointed_thing(player, liquid)
+	local pos = vector.offset(player:get_pos(), 0, player:get_properties().eye_height, 0)
+	local look_dir = vector.multiply(player:get_look_dir(), 5)
+	local pos2 = vector.add(pos, look_dir)
+	local ray = minetest.raycast(pos, pos2, false, liquid)
+	
+	if ray then
+		for pointed_thing in ray do
+			return pointed_thing
+		end
+	end
+end

mods/ITEMS/mcl_buckets/init.lua

@@ -33,8 +33,10 @@ if mod_mcl_core then
 	})
 end
 
-mcl_buckets = {}
+mcl_buckets = {
-mcl_buckets.liquids = {}
+	liquids = {},
+	buckets = {},
+}
 
 -- Sound helper functions for placing and taking liquids
 local function sound_place(itemname, pos)
@@ -147,6 +149,172 @@ local function get_bucket_drop(itemstack, user, take_bucket)
 	end
 end
 
+local function on_place_bucket(itemstack, user, pointed_thing, def)
+	-- Must be pointing to node
+	if pointed_thing.type ~= "node" then
+		return
+	end
+	-- Call on_rightclick if the pointed node defines it
+	local new_stack = mcl_util.call_on_rightclick(itemstack, user, pointed_thing)
+	if new_stack then
+		return new_stack
+	end
+
+	local undernode = get_node(pointed_thing.under)
+	local abovenode = get_node(pointed_thing.above)
+	local buildable1 = minetest.registered_nodes[undernode.name] and minetest.registered_nodes[undernode.name].buildable_to
+	local buildable2 = minetest.registered_nodes[abovenode.name] and minetest.registered_nodes[abovenode.name].buildable_to
+	if not buildable1 and not buildable2 then return itemstack end --if both nodes aren't buildable_to, skip
+
+	if buildable1 then
+		local result, take_bucket = get_extra_check(def.extra_check, pointed_thing.under, user)
+		if result then
+			local node_place = get_node_place(def.source_place, pointed_thing.under)
+			local pns = user:get_player_name()
+
+			-- Check protection
+			if minetest.is_protected(pointed_thing.under, pns) then
+				minetest.record_protection_violation(pointed_thing.under, pns)
+				return itemstack
+			end
+
+			-- Place liquid
+			place_liquid(pointed_thing.under, node_place)
+
+			-- Update doc mod
+			if mod_doc and doc.entry_exists("nodes", node_place) then
+				doc.mark_entry_as_revealed(user:get_player_name(), "nodes", node_place)
+			end
+		end
+		return get_bucket_drop(itemstack, user, take_bucket)
+	elseif buildable2 then
+		local result, take_bucket = get_extra_check(def.extra_check, pointed_thing.above, user)
+		if result then
+			local node_place = get_node_place(def.source_place, pointed_thing.above)
+			local pns = user:get_player_name()
+
+			-- Check protection
+			if minetest.is_protected(pointed_thing.above, pns) then
+				minetest.record_protection_violation(pointed_thing.above, pns)
+				return itemstack
+			end
+
+			-- Place liquid
+			place_liquid(pointed_thing.above, node_place)
+
+			-- Update doc mod
+			if mod_doc and doc.entry_exists("nodes", node_place) then
+				doc.mark_entry_as_revealed(user:get_player_name(), "nodes", node_place)
+			end
+		end
+		return get_bucket_drop(itemstack, user, take_bucket)
+	else
+		return itemstack
+	end
+end
+
+
+local function on_place_bucket_empty(itemstack, user, pointed_thing)
+	-- Must be pointing to node
+	if pointed_thing.type ~= "node" then
+		return itemstack
+	end
+
+	-- Call on_rightclick if the pointed node defines it
+	local new_stack = mcl_util.call_on_rightclick(itemstack, user, pointed_thing)
+	if new_stack then
+		return new_stack
+	end
+
+	local node = minetest.get_node(pointed_thing.under)
+	local nn = node.name
+
+	local new_bucket
+	local liquid_node = bucket_raycast(user)
+	if liquid_node then
+		if minetest.is_protected(liquid_node.above, user:get_player_name()) then
+			minetest.record_protection_violation(liquid_node.above, user:get_player_name())
+		end
+		local liquid_name = get_node(liquid_node.above).name
+		if liquid_name then
+			local liquid_def = mcl_buckets.liquids[liquid_name]
+			if liquid_def then
+				--minetest.chat_send_all("test")
+				-- Fill bucket, but not in Creative Mode
+				-- FIXME: remove this line
+				--if not minetest.is_creative_enabled(user:get_player_name()) then
+				if not false then
+					new_bucket = ItemStack({name = liquid_def.bucketname})
+					if liquid_def.on_take then
+						liquid_def.on_take(user)
+					end
+				end
+				add_node(liquid_node.above, {name="air"})
+				sound_take(nn, liquid_node.above)
+
+				if mod_doc and doc.entry_exists("nodes", liquid_name) then
+					doc.mark_entry_as_revealed(user:get_player_name(), "nodes", liquid_name)
+				end
+				if new_bucket then
+					return give_bucket(new_bucket, itemstack, user)
+				end
+			else
+				minetest.log("error", string.format("[mcl_buckets] Node [%s] has invalid group [_mcl_bucket_pointable]!", liquid_name))
+			end
+		end
+		return itemstack
+	else
+		-- FIXME: replace this ugly code by cauldrons API
+		if nn == "mcl_cauldrons:cauldron_3" then
+			-- Take water out of full cauldron
+			minetest.set_node(pointed_thing.under, {name="mcl_cauldrons:cauldron"})
+			if not minetest.is_creative_enabled(user:get_player_name()) then
+				new_bucket = ItemStack("mcl_buckets:bucket_water")
+			end
+			sound_take("mcl_core:water_source", pointed_thing.under)
+		elseif nn == "mcl_cauldrons:cauldron_3r" then
+			-- Take river water out of full cauldron
+			minetest.set_node(pointed_thing.under, {name="mcl_cauldrons:cauldron"})
+			if not minetest.is_creative_enabled(user:get_player_name()) then
+				new_bucket = ItemStack("mcl_buckets:bucket_river_water")
+			end
+			sound_take("mclx_core:river_water_source", pointed_thing.under)
+		end
+		if new_bucket then
+			return give_bucket(new_bucket, itemstack, user)
+		end
+	end
+	return itemstack
+end
+
+controls.register_on_press(function(player, key)
+	if key ~= "RMB" then
+		return
+	end
+
+	local wielded_item = player:get_wielded_item()
+	local itemname = wielded_item:get_name()
+	local def = mcl_buckets.buckets[itemname]
+
+	if itemname == "mcl_buckets:bucket_empty" then
+		local pointed_thing = mcl_util.get_pointed_thing(player, true)
+
+		if not pointed_thing then
+			return
+		end
+		wielded_item = on_place_bucket_empty(wielded_item, player, pointed_thing)
+	elseif def then
+		local pointed_thing = mcl_util.get_pointed_thing(player, false)
+
+		if not pointed_thing then
+			return
+		end
+		wielded_item = on_place_bucket(wielded_item, player, pointed_thing, def)
+	end
+	
+	player:set_wielded_item(wielded_item)
+end)
+
 function mcl_buckets.register_liquid(def)
 	for _,source in ipairs(def.source_take) do
 		mcl_buckets.liquids[source] = {
@@ -161,6 +329,8 @@ function mcl_buckets.register_liquid(def)
 		end
 	end
 
+	mcl_buckets.buckets[def.bucketname] = def
+
 	if def.bucketname == nil or def.bucketname == "" then
 		error(string.format("[mcl_bucket] Invalid itemname then registering [%s]!", def.name))
 	end
@@ -173,69 +343,6 @@ function mcl_buckets.register_liquid(def)
 		inventory_image = def.inventory_image,
 		stack_max = 1,
 		groups = def.groups,
-		on_place = function(itemstack, user, pointed_thing)
-			-- Must be pointing to node
-			if pointed_thing.type ~= "node" then
-				return
-			end
-			-- Call on_rightclick if the pointed node defines it
-			local new_stack = mcl_util.call_on_rightclick(itemstack, user, pointed_thing)
-			if new_stack then
-				return new_stack
-			end
-
-			local undernode = get_node(pointed_thing.under)
-			local abovenode = get_node(pointed_thing.above)
-			local buildable1 = minetest.registered_nodes[undernode.name] and minetest.registered_nodes[undernode.name].buildable_to
-			local buildable2 = minetest.registered_nodes[abovenode.name] and minetest.registered_nodes[abovenode.name].buildable_to
-			if not buildable1 and not buildable2 then return itemstack end --if both nodes aren't buildable_to, skip
-
-			if buildable1 then
-				local result, take_bucket = get_extra_check(def.extra_check, pointed_thing.under, user)
-				if result then
-					local node_place = get_node_place(def.source_place, pointed_thing.under)
-					local pns = user:get_player_name()
-
-					-- Check protection
-					if minetest.is_protected(pointed_thing.under, pns) then
-						minetest.record_protection_violation(pointed_thing.under, pns)
-						return itemstack
-					end
-
-					-- Place liquid
-					place_liquid(pointed_thing.under, node_place)
-
-					-- Update doc mod
-					if mod_doc and doc.entry_exists("nodes", node_place) then
-						doc.mark_entry_as_revealed(user:get_player_name(), "nodes", node_place)
-					end
-				end
-				return get_bucket_drop(itemstack, user, take_bucket)
-			elseif buildable2 then
-				local result, take_bucket = get_extra_check(def.extra_check, pointed_thing.above, user)
-				if result then
-					local node_place = get_node_place(def.source_place, pointed_thing.above)
-					local pns = user:get_player_name()
-
-					-- Check protection
-					if minetest.is_protected(pointed_thing.above, pns) then
-						minetest.record_protection_violation(pointed_thing.above, pns)
-						return itemstack
-					end
-
-					-- Place liquid
-					place_liquid(pointed_thing.above, node_place)
-
-					-- Update doc mod
-					if mod_doc and doc.entry_exists("nodes", node_place) then
-						doc.mark_entry_as_revealed(user:get_player_name(), "nodes", node_place)
-					end
-				end
-				return get_bucket_drop(itemstack, user, take_bucket)
-			else
-				return itemstack
-			end
-		end,
 		_on_dispense = function(stack, pos, droppos, dropnode, dropdir)
 			local buildable = minetest.registered_nodes[dropnode.name].buildable_to or dropnode.name == "mcl_portals:portal"
 			if not buildable then return stack end
@@ -259,78 +366,6 @@ minetest.register_craftitem("mcl_buckets:bucket_empty", {
 	--liquids_pointable = true,
 	inventory_image = "bucket.png",
 	stack_max = 16,
-	on_place = function(itemstack, user, pointed_thing)
-		-- Must be pointing to node
-		if pointed_thing.type ~= "node" then
-			return itemstack
-		end
-
-		-- Call on_rightclick if the pointed node defines it
-		local new_stack = mcl_util.call_on_rightclick(itemstack, user, pointed_thing)
-		if new_stack then
-			return new_stack
-		end
-
-		local node = minetest.get_node(pointed_thing.under)
-		local nn = node.name
-
-		local new_bucket
-		local liquid_node = bucket_raycast(user)
-		if liquid_node then
-			if minetest.is_protected(liquid_node.above, user:get_player_name()) then
-				minetest.record_protection_violation(liquid_node.above, user:get_player_name())
-			end
-			local liquid_name = get_node(liquid_node.above).name
-			if liquid_name then
-				local liquid_def = mcl_buckets.liquids[liquid_name]
-				if liquid_def then
-					--minetest.chat_send_all("test")
-					-- Fill bucket, but not in Creative Mode
-					-- FIXME: remove this line
-					--if not minetest.is_creative_enabled(user:get_player_name()) then
-					if not false then
-						new_bucket = ItemStack({name = liquid_def.bucketname})
-						if liquid_def.on_take then
-							liquid_def.on_take(user)
-						end
-					end
-					add_node(liquid_node.above, {name="air"})
-					sound_take(nn, liquid_node.above)
-
-					if mod_doc and doc.entry_exists("nodes", liquid_name) then
-						doc.mark_entry_as_revealed(user:get_player_name(), "nodes", liquid_name)
-					end
-					if new_bucket then
-						return give_bucket(new_bucket, itemstack, user)
-					end
-				else
-					minetest.log("error", string.format("[mcl_buckets] Node [%s] has invalid group [_mcl_bucket_pointable]!", liquid_name))
-				end
-			end
-			return itemstack
-		else
-			-- FIXME: replace this ugly code by cauldrons API
-			if nn == "mcl_cauldrons:cauldron_3" then
-				-- Take water out of full cauldron
-				minetest.set_node(pointed_thing.under, {name="mcl_cauldrons:cauldron"})
-				if not minetest.is_creative_enabled(user:get_player_name()) then
-					new_bucket = ItemStack("mcl_buckets:bucket_water")
-				end
-				sound_take("mcl_core:water_source", pointed_thing.under)
-			elseif nn == "mcl_cauldrons:cauldron_3r" then
-				-- Take river water out of full cauldron
-				minetest.set_node(pointed_thing.under, {name="mcl_cauldrons:cauldron"})
-				if not minetest.is_creative_enabled(user:get_player_name()) then
-					new_bucket = ItemStack("mcl_buckets:bucket_river_water")
-				end
-				sound_take("mclx_core:river_water_source", pointed_thing.under)
-			end
-			if new_bucket then
-				return give_bucket(new_bucket, itemstack, user)
-			end
-        end
-        return itemstack
-	end,
 	_on_dispense = function(stack, pos, droppos, dropnode, dropdir)
 		-- Fill empty bucket with liquid or drop bucket if no liquid
 		local collect_liquid = false

mods/ITEMS/mcl_buckets/mod.conf

@@ -1,6 +1,6 @@
 name = mcl_buckets
 author = Kahrl
 description =
-depends = mcl_worlds, mcl_util
+depends = mcl_worlds, mcl_util, controls
 optional_depends = mcl_core, mclx_core, doc