Complete pickup particle feature

Rewrite

.github/workflows/build.yml

@@ -1,11 +0,0 @@
-on: [push, pull_request]
-name: build
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@master
-      - name: lint
-        uses: Roang-zero1/factorio-mod-luacheck@master
-        with:
-          luacheckrc_url: https://raw.githubusercontent.com/minetest-mods/item_drop/master/.luacheckrc

.luacheckrc

@@ -1,19 +0,0 @@
-unused_args = false
-allow_defined_top = true
-max_line_length = 999
-
-ignore = {
-    "name", "drops", "i",
-}
-
-globals = {
-    "minetest",
-}
-
-read_globals = {
-    string = {fields = {"split", "trim"}},
-    table = {fields = {"copy", "getn"}},
-
-    "vector", "ItemStack",
-    "dump",
-}

README.md

@@ -1,14 +1,15 @@
-# Item Drop [![](https://github.com/minetest-mods/item_drop/workflows/build/badge.svg)](https://github.com/minetest-mods/item_drop/actions) [![License](https://img.shields.io/badge/license-LGPLv2.1%2B-blue.svg)](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html)
-
-A highly configurable mod providing item magnet and in-world node drops\
+# item_drop
 By [PilzAdam](https://github.com/PilzAdam),
 [texmex](https://github.com/tacotexmex/), [hybriddog](https://github.com/hybriddog/).
 
+## Description
+This mod adds Minecraft like drop/pick up of items to Minetest.
+
 ## Licensing
-LGPLv2.1/CC BY-SA 3.0. Particle code from WCILA mod by Aurailus, originally licensed MIT.
+LGPLv2.1/CC BY-SA 3.0.
 
 ## Notes
-`item_drop` can be played with Minetest 0.4.16 or above. It was originally
+item_drop can be played with Minetest 0.4.16 or above. It was originally
 developed by [PilzAdam](https://github.com/PilzAdam/item_drop).
 
 ## List of features
@@ -18,8 +19,6 @@ developed by [PilzAdam](https://github.com/PilzAdam/item_drop).
   `true` (true by default) It does nothing in creative mode.
 * Puts dropped items to the player's inventory if `item_drop.enable_item_pickup`
   is `true` (true by default)
-  * Multiple items are picked in a quick succession instead of all at once which
-    is indicated by the pickup sound.
   * It uses a node radius set in `item_drop.pickup_radius` (default 0.75),
     if items are within this radius around the player's belt, they're picked.
   * If `item_drop.pickup_age` is something positive, items dropped by players
@@ -30,8 +29,6 @@ developed by [PilzAdam](https://github.com/PilzAdam/item_drop).
     items between these radii are flying to the player for
     `item_drop.magnet_time` seconds, after this time, they're picked or stop
     flying.
-  * Enable manual item pickups by mouse only if `item_drop.mouse_pickup` is
-    `true` (true by default)
 * Plays a sound when the items are picked up with the gain level set to
   `item_drop.pickup_sound_gain` (default 0.2)
 * Requires a key to be pressed in order to pick items if
@@ -42,11 +39,8 @@ developed by [PilzAdam](https://github.com/PilzAdam/item_drop).
     * Left and Right keys combined (`LeftAndRight`)
     * Right mouse button (`RMB`)
     * Sneak key and right mouse button combined (`SneakAndRMB`)
-  * If `item_drop.pickup_keyinvert` is `true`, items are
+  * If `item_drop.pickup_keyinvert` is `true` (false by default), items are
     collected when the key is not pressed instead of when it's pressed.
-* Displays a particle of the picked item above the player if
-  `item_drop.pickup_particle` is `true` (true by default)
-
 
 ## Known issues
 

description.txt

@@ -1 +1 @@
-A highly configurable mod providing item magnet and in-world node drops
+This mod adds Minecraft like drop/pick up of items to Minetest.

init.lua

@@ -1,63 +1,26 @@
 local load_time_start = minetest.get_us_time()
+pickup_radius = tonumber(minetest.settings:get("item_pickup_radius"))
 
--- Functions which can be overridden by mods
-item_drop = {
-	-- This function is executed before picking up an item or making it fly to
-	-- the player. If it does not return true, the item is ignored.
-	-- It is also executed before collecting the item after it flew to
-	-- the player and did not reach him/her for magnet_time seconds.
-	can_pickup = function(entity, player)
-		if entity.item_drop_picked then
-			-- Ignore items where picking has already failed
-			return false
-		end
-		return true
-	end,
-
-	-- before_collect and after_collect are executed before and after an item
-	-- is collected by a player
-	before_collect = function(entity, pos, player)
-	end,
-	after_collect = function(entity, pos, player)
-		entity.item_drop_picked = true
-	end,
-}
-
-local function legacy_setting_getbool(name_new, name_old, default)
-	local v = minetest.settings:get_bool(name_new)
-	if v == nil then
-		v = minetest.settings:get_bool(name_new)
-	end
-	if default then
-		return v ~= false
-	end
-	return v
-end
-
-local function legacy_setting_getnumber(name_new, name_old, default)
-	return tonumber(minetest.settings:get(name_new))
-		or tonumber(minetest.settings:get(name_old))
-		or default
-end
-
-if legacy_setting_getbool("item_drop.enable_item_pickup",
-		"enable_item_pickup", true) then
-	local pickup_gain = legacy_setting_getnumber("item_drop.pickup_sound_gain",
-		"item_pickup_gain", 0.2)
+if minetest.settings:get_bool("item_drop.enable_item_pickup") ~= false or
+minetest.settings:get_bool("enable_item_pickup") ~= false then
+	local pickup_gain = tonumber(
+		minetest.settings:get("item_drop.pickup_sound_gain")) or
+		tonumber(minetest.settings:get("item_pickup_gain")) or 0.2
 	local pickup_particle =
-		minetest.settings:get_bool("item_drop.pickup_particle", true)
-	local pickup_radius = legacy_setting_getnumber("item_drop.pickup_radius",
-		"item_pickup_radius", 0.75)
+		minetest.settings:get_bool("item_drop.pickup_particle") ~= false
+	local pickup_radius = tonumber(
+		minetest.settings:get("item_drop.pickup_radius")) or 0.75
 	local magnet_radius = tonumber(
 		minetest.settings:get("item_drop.magnet_radius")) or -1
 	local magnet_time = tonumber(
 		minetest.settings:get("item_drop.magnet_time")) or 5.0
 	local pickup_age = tonumber(
 		minetest.settings:get("item_drop.pickup_age")) or 0.5
-	local key_triggered = legacy_setting_getbool("item_drop.enable_pickup_key",
-		"enable_item_pickup_key", true)
+	local key_triggered = minetest.settings:get_bool(
+		"item_drop.enable_pickup_key") or
+		minetest.settings:get_bool("enable_item_pickup_key") ~= false
 	local key_invert = minetest.settings:get_bool(
-		"item_drop.pickup_keyinvert") ~= false
+		"item_drop.pickup_keyinvert") or false
 	local keytype
 	if key_triggered then
 		keytype = minetest.settings:get("item_drop.pickup_keytype") or
@@ -67,11 +30,6 @@ if legacy_setting_getbool("item_drop.enable_item_pickup",
 			pickup_age = math.min(pickup_age, 0)
 		end
 	end
-	local mouse_pickup = minetest.settings:get_bool(
-		"item_drop.mouse_pickup") ~= false
-	if not mouse_pickup then
-		minetest.registered_entities["__builtin:item"].pointable = false
-	end
 
 	local magnet_mode = magnet_radius > pickup_radius
 	local zero_velocity_mode = pickup_age == -1
@@ -80,62 +38,43 @@ if legacy_setting_getbool("item_drop.enable_item_pickup",
 		error"zero velocity mode can't be used together with magnet mode"
 	end
 
-	-- tells whether an inventorycube should be shown as pickup_particle or not
-	-- for known drawtypes
-	local inventorycube_drawtypes = {
-		normal = true,
-		allfaces = true,
-		allfaces_optional = true,
-		glasslike = true,
-		glasslike_framed = true,
-		glasslike_framed_optional = true,
-		liquid = true,
-		flowingliquid = true,
-	}
-
-	-- Get an image string from a tile definition
-	local function tile_to_image(tile, fallback_image)
-		if not tile then
-			return fallback_image
-		end
-		local tile_type = type(tile)
-		if tile_type == "string" then
-			return tile
-		end
-		assert(tile_type == "table", "Tile definition is not a string or table")
-		local image = tile.name or tile.image
-		assert(image, "Tile definition has no image file specified")
-		if tile.color then
-			local colorstr = minetest.colorspec_to_colorstring(tile.color)
-			if colorstr then
-				return image .. "^[multiply:" .. colorstr
-			end
-		end
-		return image
-	end
-
 	-- adds the item to the inventory and removes the object
 	local function collect_item(ent, pos, player)
-		item_drop.before_collect(ent, pos, player)
 		minetest.sound_play("item_drop_pickup", {
 			pos = pos,
 			gain = pickup_gain,
-		}, true)
+		})
 		if pickup_particle then
-			local item = minetest.registered_nodes[
-				ent.itemstring:gsub("(.*)%s.*$", "%1")]
-			local image
-			if item and item.tiles and item.tiles[1] then
-				if inventorycube_drawtypes[item.drawtype] then
-					local tiles = item.tiles
-					-- color in the tile definition is handled by tile_to_image.
-					-- color in the node definition is not yet supported here.
-					local top = tile_to_image(tiles[1])
-					local left = tile_to_image(tiles[3], top)
-					local right = tile_to_image(tiles[5], left)
-					image = minetest.inventorycube(top, left, right)
-				else
-					image = item.inventory_image or item.tiles[1]
+			local item = minetest.registered_nodes[ent.itemstring:gsub("(.*)%s.*$","%1")]
+			local image = ""
+			if minetest.registered_items[item.name] and minetest.registered_items[item.name].tiles then
+				if minetest.registered_items[item.name].tiles[1] then
+						local dt = minetest.registered_items[item.name].drawtype
+						if dt == "normal" or dt == "allfaces" or dt == "allfaces_optional"
+						or dt == "glasslike" or dt =="glasslike_framed" or dt == "glasslike_framed_optional"
+						or dt == "liquid" or dt == "flowingliquid" then
+							local tiles = minetest.registered_items[item.name].tiles
+
+							local top = tiles[1]
+							if (type(top) == "table") then top = top.item end
+							local left = tiles[3]
+							if not left then left = top end
+							if (type(left) == "table") then left = left.item end
+							local right = tiles[5]
+							if not right then right = left end
+							if (type(right) == "table") then right = right.item end
+
+							image = "[inventorycube{"..top.."{"..left.."{"..right
+						else
+							image = minetest.registered_items[item.name].inventory_image
+							if not image then image = minetest.registered_items[item.name].tiles[1] end
+						end
+				end
+			end
+			if item then
+				local texture = item.tiles[1] or item.inventory_image or ""
+				if item.drawtype == "normal" then
+					texture = item.tiles
 				end
 				minetest.add_particle({
 					pos = {x = pos.x, y = pos.y + 1.5, z = pos.z},
@@ -149,7 +88,6 @@ if legacy_setting_getbool("item_drop.enable_item_pickup",
 			end
 		end
 		ent:on_punch(player)
-		item_drop.after_collect(ent, pos, player)
 	end
 
 	-- opt_get_ent gets the object's luaentity if it can be collected
@@ -157,7 +95,7 @@ if legacy_setting_getbool("item_drop.enable_item_pickup",
 	if zero_velocity_mode then
 		function opt_get_ent(object)
 			if object:is_player()
-			or not vector.equals(object:get_velocity(), {x=0, y=0, z=0}) then
+			or not vector.equals(object:getvelocity(), {x=0, y=0, z=0}) then
 				return
 			end
 			local ent = object:get_luaentity()
@@ -195,42 +133,16 @@ if legacy_setting_getbool("item_drop.enable_item_pickup",
 			end
 			local item = ItemStack(ent.itemstring)
 			if inv
-			and inv:room_for_item("main", item)
-			and item_drop.can_pickup(ent, player) then
+			and inv:room_for_item("main", item) then
 				collect_item(ent, object:get_pos(), player)
 			else
-				-- the acceleration will be reset by the object's on_step
-				object:set_velocity({x=0,y=0,z=0})
-				ent.is_magnet_item = false
+				object:setvelocity({x=0,y=0,z=0})
+				ent.physical_state = true
+				ent.object:set_properties({
+					physical = true
+				})
 			end
 		end
-
-		-- disable velocity and acceleration changes of items flying to players
-		minetest.after(0, function()
-			local ObjectRef
-			local blocked_methods = {"set_acceleration", "set_velocity",
-				"setacceleration", "setvelocity"}
-			local itemdef = minetest.registered_entities["__builtin:item"]
-			local old_on_step = itemdef.on_step
-			local function do_nothing() end
-			function itemdef.on_step(self, ...)
-				if not self.is_magnet_item then
-					return old_on_step(self, ...)
-				end
-				ObjectRef = ObjectRef or getmetatable(self.object)
-				local old_funcs = {}
-				for i = 1, #blocked_methods do
-					local method = blocked_methods[i]
-					old_funcs[method] = ObjectRef[method]
-					ObjectRef[method] = do_nothing
-				end
-				old_on_step(self, ...)
-				for i = 1, #blocked_methods do
-					local method = blocked_methods[i]
-					ObjectRef[method] = old_funcs[method]
-				end
-			end
-		end)
 	end
 
 	-- set keytype to the key name if possible
@@ -264,13 +176,6 @@ if legacy_setting_getbool("item_drop.enable_item_pickup",
 		return keys_pressed ~= key_invert
 	end
 
-	local function is_inside_map(pos)
-		local bound = 31000
-		return -bound < pos.x and pos.x < bound
-			and -bound < pos.y and pos.y < bound
-			and -bound < pos.z and pos.z < bound
-	end
-
 	-- called for each player to possibly collect an item, returns true if so
 	local function pickupfunc(player)
 		if not has_keys_pressed(player)
@@ -279,43 +184,46 @@ if legacy_setting_getbool("item_drop.enable_item_pickup",
 			return
 		end
 
-		local pos = player:get_pos()
-		if not is_inside_map(pos) then
-			-- get_objects_inside_radius crashes for too far positions
-			return
-		end
+		local pos = player:getpos()
 		pos.y = pos.y+0.5
-		local inv = player:get_inventory()
+		local inv
 
 		local objectlist = minetest.get_objects_inside_radius(pos,
 			magnet_mode and magnet_radius or pickup_radius)
 		for i = 1,#objectlist do
 			local object = objectlist[i]
 			local ent = opt_get_ent(object)
-			if ent
-			and item_drop.can_pickup(ent, player) then
+			if ent then
+				if not inv then
+					inv = player:get_inventory()
+					if not inv then
+						minetest.log("error", "[item_drop] Couldn't " ..
+							"get inventory")
+						return
+					end
+				end
 				local item = ItemStack(ent.itemstring)
 				if inv:room_for_item("main", item) then
 					local flying_item
 					local pos2
 					if magnet_mode then
-						pos2 = object:get_pos()
+						pos2 = object:getpos()
 						flying_item = vector.distance(pos, pos2) > pickup_radius
 					end
 					if not flying_item then
-						-- The item is near enough to pick it
+						-- collect one item at a time to avoid the loud pop
 						collect_item(ent, pos, player)
-						-- Collect one item at a time to avoid the loud pop
 						return true
 					end
-					-- The item is not too far a way but near enough to be
-					-- magnetised, make it fly to the player
-					local vel = vector.multiply(vector.subtract(pos, pos2), 3)
+					local vel = vector.multiply(
+						vector.subtract(pos, pos2), 3)
 					vel.y = vel.y + 0.6
-					object:set_velocity(vel)
-					if not ent.is_magnet_item then
-						ent.object:set_acceleration({x=0, y=0, z=0})
-						ent.is_magnet_item = true
+					object:setvelocity(vel)
+					if ent.physical_state then
+						ent.physical_state = false
+						ent.object:set_properties({
+							physical = false
+						})
 
 						minetest.after(magnet_time, afterflight,
 							object, inv, player)
@@ -343,84 +251,39 @@ if legacy_setting_getbool("item_drop.enable_item_pickup",
 	minetest.after(3.0, pickup_step)
 end
 
-if legacy_setting_getbool("item_drop.enable_item_drop", "enable_item_drop", true)
+if minetest.settings:get_bool("item_drop.enable_item_drop") ~= false or
+minetest.settings:get_bool("enable_item_drop") ~= false
 and not minetest.settings:get_bool("creative_mode") then
-	-- Workaround to test if an item metadata (ItemStackMetaRef) is empty
-	local function itemmeta_is_empty(meta)
-		local t = meta:to_table()
-		for k, v in pairs(t) do
-			if k ~= "fields" then
-				return false
-			end
-			assert(type(v) == "table")
-			if next(v) ~= nil then
-				return false
-			end
-		end
-		return true
-	end
-
-	-- Tests if the item has special information such as metadata
-	local function can_split_item(item)
-		return item:get_wear() == 0 and itemmeta_is_empty(item:get_meta())
-	end
-
-	local function spawn_items(pos, items_to_spawn)
-		for i = 1,#items_to_spawn do
-			local obj = minetest.add_item(pos, items_to_spawn[i])
-			if not obj then
-				error("Couldn't spawn item " .. name .. ", drops: "
-					.. dump(drops))
-			end
-
-			local vel = obj:get_velocity()
-			local x = math.random(-5, 4)
-			if x >= 0 then
-				x = x+1
-			end
-			vel.x = 1 / x
-			local z = math.random(-5, 4)
-			if z >= 0 then
-				z = z+1
-			end
-			vel.z = 1 / z
-			obj:set_velocity(vel)
-		end
-	end
-
-	local old_handle_node_drops = minetest.handle_node_drops
-	function minetest.handle_node_drops(pos, drops, player)
-		if not player or player.is_fake_player then
-			-- Node Breaker or similar machines should receive items in the
-			-- inventory
-			return old_handle_node_drops(pos, drops, player)
-		end
+	function minetest.handle_node_drops(pos, drops)
 		for i = 1,#drops do
 			local item = drops[i]
+			local count, name
 			if type(item) == "string" then
-				-- The string is not necessarily only the item name,
-				-- so always convert it to ItemStack
-				item = ItemStack(item)
-			end
-			local count = item:get_count()
-			local name = item:get_name()
-
-			-- Sometimes nothing should be dropped
-			if name == ""
-			or not minetest.registered_items[name] then
-				count = 0
+				count = 1
+				name = item
+			else
+				count = item:get_count()
+				name = item:get_name()
 			end
 
-			if count > 0 then
-				-- Split items if possible
-				local items_to_spawn = {item}
-				if can_split_item(item) then
-					for i = 1,count do
-						items_to_spawn[i] = name
-					end
+			for _ = 1,count do
+				local obj = minetest.add_item(pos, name)
+				if not obj then
+					error("Couldn't spawn item")
 				end
 
-				spawn_items(pos, items_to_spawn)
+				local vel = obj:getvelocity()
+				local x = math.random(-5, 4)
+				if x >= 0 then
+					x = x+1
+				end
+				vel.x = 1 / x
+				local z = math.random(-5, 4)
+				if z >= 0 then
+					z = z+1
+				end
+				vel.z = 1 / z
+				obj:setvelocity(vel)
 			end
 		end
 	end

mod.conf

@@ -1,2 +1 @@
 name = item_drop
-description = A highly configurable mod providing item magnet and in-world node drops

settingtypes.txt

@@ -8,7 +8,7 @@ item_drop.enable_item_drop (Enable item drops) bool true
 item_drop.enable_pickup_key (Use pickup key) bool true
 
 #Collect items when the key is not pressed instead of when it is pressed
-item_drop.pickup_keyinvert (Invert pickup key) bool true
+item_drop.pickup_keyinvert (Invert pickup key) bool false
 
 #What keytype to use as pickup key
 item_drop.pickup_keytype (Pickup keytype) enum Use Use,Sneak,LeftAndRight,RMB,SneakAndRMB
@@ -33,6 +33,3 @@ item_drop.magnet_time (Magnet time) float 5.0
 
 #Time delay in seconds after autopicking an item if it's dropped by a player
 item_drop.pickup_age (Pickup age) float 0.5
-
-#Enable manual item pickups by mouse
-item_drop.mouse_pickup (Mouse pickup) bool true