Update 3.1.1

- /defaults.lua
- /CHANGELOG

CHANGELOG

@@ -1,3 +1,20 @@
+Update 3.1.1
+- Fix all initial settings values and completely deprecate defaults.lua
+
+Version 3.1:
+- Initial l18n translations support
+- Replace stereo sounds with mono
+- Fix behaviour with initial settings
+- Clean reduntant variables and deprecate defaults.lua
+
+Version 3.0:
+- First attempt to detect collisionboxes
+- Implemented settings through settingtypes.txt, deprecating "spears.conf"
+
+Version 2.4:
+- Functions rewrite, fixed many vector/variable declarations and unknown node handling
+- Added pigiron support
+
 Version 2.3:
 - Updated to Minetest 5.6.0 API
 - Changed receipts to avoid being confused with arrows

README.md

@@ -3,12 +3,14 @@
 This mod adds spears to Minetest.
 
 How to download:
-If you have this file, you already know
+If you have this file, you probably know.
+If you're reading from gitlab.com, you already know.
 
 Forum topic:
 https://forum.minetest.net/viewtopic.php?f=11&t=13367
 
 How to install:
+Minetest content DB is the way!
 http://wiki.minetest.com/wiki/Installing_Mods
 
 How to use the mod:

defaults.lua

@@ -1,7 +1,30 @@
-DISABLE_STONE_SPEAR = false
-DISABLE_STEEL_SPEAR = false
-DISABLE_COPPER_SPEAR = false
-DISABLE_BRONZE_SPEAR = false
-DISABLE_DIAMOND_SPEAR = false
-DISABLE_OBSIDIAN_SPEAR = false
-DISABLE_GOLD_SPEAR = false
+-- Seems like defaults in settingtypes.txt are not taken by default
+--if minetest.settings:get("spears_throw_speed") == nil then
+--	minetest.settings:set("spears_throw_speed", 13)
+--end
+
+--[[ if minetest.settings:get("spears_drag_coeff") == nil then
+	minetest.settings:set("spears_drag_coeff", 0.1)
+end ]]
+
+-- if minetest.settings:get("spears_node_cracky_limit") == nil then
+--	minetest.settings:set("spears_node_cracky_limit", 3)
+-- end
+
+
+-- DISABLE_STONE_SPEAR = false
+-- DISABLE_STEEL_SPEAR = false
+-- DISABLE_COPPER_SPEAR = false
+-- DISABLE_BRONZE_SPEAR = false
+-- DISABLE_DIAMOND_SPEAR = false
+-- DISABLE_OBSIDIAN_SPEAR = false
+-- DISABLE_GOLD_SPEAR = false
+-- DISABLE_IRON_SPEAR = false
+-- SPEARS_THROW_SPEED = 13
+-- SPEARS_V_ZERO = {x = 0, y = 0, z = 0}
+-- SPEARS_DRAG_COEFF = 0.1
+-- SPEARS_NODE_UNKNOWN = nil
+-- SPEARS_NODE_THROUGH = 0
+-- SPEARS_NODE_STICKY = 1
+-- SPEARS_NODE_CRACKY = 2
+-- SPEARS_NODE_CRACKY_LIMIT = 3

functions.lua

@@ -7,30 +7,40 @@ function spears_throw (itemstack, player, pointed_thing)
 	local pitch = player:get_look_vertical()
 	local yaw = player:get_look_horizontal()
 	local rotation = vector.new(0, yaw + math.pi/2, pitch + math.pi/6)
-	-- Stick into node
-	if pointed_thing.type == "node" then
-		local node = minetest.get_node(pointed_thing.under)
-		if minetest.registered_nodes[node.name].walkable and vector.distance(pointed_thing.above, throw_pos) < 1 then
-			local spear_object = minetest.add_entity(vector.divide(vector.add(vector.multiply(pointed_thing.above, 2), pointed_thing.under), 3), spear)
+	local wear = itemstack:get_wear()
+	local pointed_a = pointed_thing.above
+	local pointed_b = pointed_thing.under	
+	if pointed_thing.type == "node" and vector.distance(pointed_a, throw_pos) < 1 then -- Stick into node
+		local node = minetest.get_node(pointed_b)
+		local check_node = spears_check_node(node.name)
+		if check_node == nil then
+			return false
+		elseif check_node == 'cracky' then
+			minetest.sound_play("default_metal_footstep", {pos = pointed_a}, true)
+			return false
+		elseif check_node == 'sticky' then
+			local spear_object = minetest.add_entity(vector.divide(vector.add(vector.multiply(pointed_a, 2), pointed_b), 3), spear)
 			spear_object:set_rotation(rotation)
-			spear_object:get_luaentity()._wear = itemstack:get_wear()
-			spear_object:get_luaentity()._stickpos = pointed_thing.under
-			return
+			spear_object:get_luaentity()._wear = wear
+			spear_object:get_luaentity()._stickpos = pointed_b
+			minetest.sound_play("default_place_node", {pos = pointed_a}, true)
+			return false
 		end
+	else -- Throw
+		local throw_speed = tonumber(minetest.settings:get("spears_throw_speed") or 13)
+		--while vector.distance(player_pos, throw_pos) < 1.2 do
+		--	throw_pos = vector.add(throw_pos, vector.multiply(direction, 0.1))
+		--end
+		local player_vel = player:get_velocity()
+		local spear_object = minetest.add_entity(throw_pos, spear)
+		spear_object:set_velocity(vector.add(player_vel, vector.multiply(direction, throw_speed)))
+		spear_object:set_rotation(rotation)
+		minetest.sound_play("spears_throw", {pos = player_pos}, true)
+		spear_object:get_luaentity()._wear = wear
+		spear_object:get_luaentity()._stickpos = nil
+		spear_object:get_luaentity()._owner = player:get_luaentity()
+		return true
 	end
-	-- Avoid hitting yourself and throw
-	local throw_speed = 12
-	while vector.distance(player_pos, throw_pos) < 1.2 do
-		throw_pos = vector.add(throw_pos, vector.multiply(direction, 0.1))
-	end
-	local player_vel = player:get_velocity()
-	local spear_object = minetest.add_entity(throw_pos, spear)
-	spear_object:set_velocity(vector.add(player_vel, vector.multiply(direction, throw_speed)))
-	spear_object:set_rotation(rotation)
-	minetest.sound_play("spears_throw", {pos = player_pos}, true)
-	spear_object:get_luaentity()._wear = itemstack:get_wear()
-	spear_object:get_luaentity()._stickpos = nil
-	return true
 end
 
 function spears_set_entity(spear_type, base_damage, toughness)
@@ -59,65 +69,70 @@ function spears_set_entity(spear_type, base_damage, toughness)
 		end,
 
 		on_step = function(self, dtime)
-			if not self._wear then
+			local wear = self._wear
+			if wear == nil then
 				self.object:remove()
-				return
+				return false
 			end
 			local pos = self.object:get_pos()
 			local velocity = self.object:get_velocity()
 			local speed = vector.length(velocity)
-			-- Spear is stuck ?
-			if self._stickpos then
+			if self._stickpos ~= nil then -- Spear is stuck
 				local node = minetest.get_node(self._stickpos)
-				local node_cracky = minetest.registered_nodes[node.name].groups.cracky
-				if node_cracky and node_cracky < 3 then
-					minetest.sound_play("default_metal_footstep", {pos = pos}, true)
+				local check_node = spears_check_node(node.name)
+				if check_node ~= 'sticky' then -- Fall when node is removed
 					self.object:remove()
-					minetest.add_item(pos, {name='spears:spear_' .. spear_type, wear = self._wear})
-				elseif not self._node_walkable then
-					minetest.sound_play("default_place_node", {pos = pos}, true)
-				end
-				self._node_walkable = minetest.registered_nodes[node.name].walkable			
-				if not node or not self._node_walkable then -- Fall when node is removed
-					self.object:remove()
-					minetest.add_item(pos, {name='spears:spear_' .. spear_type, wear = self._wear})
-					return
+					minetest.add_item(pos, {name='spears:spear_' .. spear_type, wear = wear})
+					return false
 				end
 			else -- Spear is flying
 				local direction = vector.normalize(velocity)
 				local yaw = minetest.dir_to_yaw(direction)
 				local pitch = math.acos(velocity.y/speed) - math.pi/3
 				local spearhead_pos = vector.add(pos, vector.multiply(direction, 0.5))
-				local node = minetest.get_node(spearhead_pos)
 				self.object:set_rotation({x = 0, y = yaw + math.pi/2, z = pitch})
-				-- Hit someone?
-				local objects_in_radius = minetest.get_objects_inside_radius(spearhead_pos, 0.6)
+				-- Hit a target?
+				local objects_in_radius = minetest.get_objects_inside_radius(spearhead_pos, 1)
 				for _,object in ipairs(objects_in_radius) do
-					if object:get_luaentity() ~= self and object:get_armor_groups().fleshy then
+					if spears_check_target(self, object, spearhead_pos) and object:get_armor_groups().fleshy then
 						local damage = (speed + base_damage)^1.15 - 20
 						object:punch(self.object, 1.0, {full_punch_interval = 1.0, damage_groups = {fleshy=damage},}, direction)
 						self.object:remove()
 						minetest.sound_play("spears_hit", {pos = pos}, true)
-						minetest.add_item(pos, {name='spears:spear_' .. spear_type, wear = self._wear + 65535/toughness})
-						return
+						wear = spears_wear(wear, toughness)
+						minetest.add_item(pos, {name='spears:spear_' .. spear_type, wear = wear})
+						return true
 					end
 				end
-				-- Hit a node?	
-				if node and minetest.registered_nodes[node.name].walkable
-				and not minetest.registered_nodes[node.name].buildable_to
-				and not (minetest.registered_nodes[node.name].groups.slab and spearhead_pos.y % 1 < 0.5)
-				then -- Stick
-					self.object:set_acceleration({x = 0, y = 0, z = 0})
-					self.object:set_velocity({x = 0, y = 0, z = 0})
-					self._wear = self._wear + 65535/toughness
-					if self._wear >= 65535 then
+				-- Hit a node?
+				local node = minetest.get_node(spearhead_pos)
+				local check_node = spears_check_node(node.name)
+				if check_node == nil then
+					self.object:remove()
+					minetest.add_item(pos, {name='spears:spear_' .. spear_type, wear = wear})
+				elseif check_node ~= 'through' then
+					wear = spears_wear(wear, toughness)
+					if wear >= 65535 then
 						minetest.sound_play("default_tool_breaks", {pos = pos}, true)
 						self.object:remove()
-						return
+						minetest.add_item(pos, {name='defaut:stick'})
+						return false
+					elseif check_node == 'cracky' then
+						minetest.sound_play("default_metal_footstep", {pos = pos}, true)
+						self.object:remove()
+						minetest.add_item(pos, {name='spears:spear_' .. spear_type, wear = wear})
+						return false
+					elseif check_node == 'sticky' then
+						self.object:set_acceleration({x = 0, y = 0, z = 0})
+						self.object:set_velocity({x = 0, y = 0, z = 0})
+						minetest.sound_play("default_place_node", {pos = pos}, true)
+						self._stickpos = spearhead_pos
+						self._wear = wear
 					end
-					self._stickpos = spearhead_pos
-				else  -- Get drag
-					local drag = math.max(minetest.registered_nodes[node.name].liquid_viscosity, 0.1)
+				else -- Get drag
+					local viscosity = minetest.registered_nodes[node.name].liquid_viscosity
+					local drag_coeff = tonumber(minetest.settings:get("spears_drag_coeff") or 0.1)
+					local drag = math.max(viscosity, drag_coeff)
 					local acceleration = vector.multiply(velocity, -drag)
 					acceleration.y = acceleration.y - 10 * ((7 - drag) / 7)
 					self.object:set_acceleration(acceleration)
@@ -127,3 +142,83 @@ function spears_set_entity(spear_type, base_damage, toughness)
 	}
 	return SPEAR_ENTITY
 end
+
+function spears_check_node(node_name)
+	local node = minetest.registered_nodes[node_name]
+	local cracky_limit = tonumber(minetest.settings:get("spears_node_cracky_limit") or 3)
+	if node == nil then
+		return nil
+	elseif node.groups.cracky ~= nil and node.groups.cracky < cracky_limit then
+		return 'cracky'
+	elseif node.walkable and not node.buildable_to then
+		return 'sticky'
+	else
+		return 'through'
+	end
+end
+
+function spears_wear(initial_wear, toughness)
+	if not minetest.settings:get_bool("creative_mode") then
+		local wear = initial_wear + 65535/toughness
+		return wear
+	else
+		local wear = initial_wear
+		return wear
+	end
+end
+
+function spears_check_target(self, object, spearhead_pos)
+	if object:get_luaentity() == self then
+		return false
+	elseif isPointInsideEntity(object, spearhead_pos) then
+		-- print(self.name .. " hit " .. object:get_luaentity().name)
+		return true
+	else
+		-- print(self.name .. " missed " .. object:get_luaentity().name)
+		return false
+	end
+end
+
+-- Function to check if a point is inside an entity
+function isPointInsideEntity(object, point)
+    local pos = object:get_pos()
+    local collisionbox = object:get_properties().collisionbox
+    local yaw = object:get_yaw()
+
+    -- Adjust position for the center of the collision box
+    local center = {
+        x = pos.x + (collisionbox[1] + collisionbox[4]) / 2,
+        y = pos.y + (collisionbox[2] + collisionbox[5]) / 2,
+        z = pos.z + (collisionbox[3] + collisionbox[6]) / 2
+    }
+
+    -- Rotate the point around the entity's center
+    local rotatedPoint = rotatePoint(point, center, yaw)
+
+    -- Check if the rotated point is inside the collision box
+    return rotatedPoint.x >= pos.x + collisionbox[1] and
+           rotatedPoint.x <= pos.x + collisionbox[4] and
+           rotatedPoint.y >= pos.y + collisionbox[2] and
+           rotatedPoint.y <= pos.y + collisionbox[5] and
+           rotatedPoint.z >= pos.z + collisionbox[3] and
+           rotatedPoint.z <= pos.z + collisionbox[6]
+end
+
+-- Function to rotate a point around a center and yaw angle
+function rotatePoint(point, center, yaw)
+    local cosYaw = math.cos(yaw)
+    local sinYaw = math.sin(yaw)
+
+    local translatedX = point.x - center.x
+    local translatedZ = point.z - center.z
+
+    local rotatedX = translatedX * cosYaw - translatedZ * sinYaw
+    local rotatedZ = translatedX * sinYaw + translatedZ * cosYaw
+
+    return {
+        x = rotatedX + center.x,
+        y = point.y,
+        z = rotatedZ + center.z
+    }
+end
+

init.lua

@@ -1,18 +1,14 @@
-dofile(minetest.get_modpath("spears").."/defaults.lua")
+-- dofile(minetest.get_modpath("spears").."/defaults.lua")
 
-local input = io.open(minetest.get_modpath("spears").."/spears.conf", "r")
-if input then
-	dofile(minetest.get_modpath("spears").."/spears.conf")
-	input:close()
-	input = nil
-end
+-- local input = io.open(minetest.get_modpath("spears").."/spears.conf", "r")
+-- if input then
+--	dofile(minetest.get_modpath("spears").."/spears.conf")
+--	input:close()
+--	input = nil
+-- end
 
 dofile(minetest.get_modpath("spears").."/functions.lua")
 
 dofile(minetest.get_modpath("spears").."/tools.lua")
 
-local log_mods = minetest.settings:get_bool("log_mods")
-
-if minetest.settings:get_bool("log_mods") then
-	minetest.log("action", "[MOD] Spears loaded")
-end
+minetest.log("action", "[MOD] Spears loaded with throwing speed " .. minetest.settings:get("spears_throw_speed") .. " and drag coeff. " .. minetest.settings:get("spears_drag_coeff"))

locale/spears.eo.tr

@@ -0,0 +1,9 @@
+# textdomain: spears
+Stone Spear=Ŝtona Ponardego
+Iron Spear=Fera Ponardego
+Steel Spear=Ŝtala Ponardego
+Copper Spear=Kupra Ponardego
+Bronze Spear=Bronza Ponardego
+Obsidian Spear=Obsidiana Ponardego
+Diamond Spear=Diamanta Ponardego
+Golden Spear=Ora Ponardego

locale/spears.it.tr

@@ -0,0 +1,9 @@
+# textdomain: spears
+Stone Spear=Lancia di Pietra
+Iron Spear=Lancia di Ferro
+Steel Spear=Lancia di Acciaio
+Copper Spear=Lancia di Rame
+Bronze Spear=Lancia di Bronzo
+Obsidian Spear=Lancia di Ossidiana
+Diamond Spear=Lancia di Diamante
+Golden Spear=Lancia Dorata

locale/template.txt

@@ -0,0 +1,9 @@
+# textdomain: spears
+Stone Spear=
+Iron Spear=
+Steel Spear=
+Copper Spear=
+Bronze Spear=
+Obsidian Spear=
+Diamond Spear=
+Golden Spear=

mod.conf

@@ -1,7 +1,8 @@
 name = spears
 depends = default
+optional_depends = pigiron
 description = Add spears to Minetest, versatile weapons that can be thrown
-release = 2.3
 author = Echoes91
 title = Spears
+min_minetest_version = 5.4
 

settingtypes.txt

@@ -0,0 +1,17 @@
+# Initial speed
+spears_throw_speed (Spear's speed when throwing) float 13
+
+# Drag and fluid viscosity slows down the spear
+spears_drag_coeff (Drag coefficient for spears in air) float 0.1
+
+# Crackyness limit to stick a spear into a node instead of bouncing
+spears_node_cracky_limit (Cracky node level limit to stick a spear) int 3
+
+spears_enable_stone_spear (Stone spear enabled) bool true
+spears_enable_iron_spear (Iron spear enabled, requires pigiron mod) bool false
+spears_enable_steel_spear (Steel spear enabled) bool true
+spears_enable_copper_spear (Copper spear enabled) bool true
+spears_enable_bronze_spear (Bronze spear enabled) bool true
+spears_enable_obsidian_spear (Obsidian spear enabled) bool true
+spears_enable_diamond_spear (Diamond spear enabled) bool true
+spears_enable_gold_spear (Gold spear enabled) bool true

spears.conf.example

@@ -1,7 +0,0 @@
-DISABLE_STONE_SPEAR = true
-DISABLE_STEEL_SPEAR = true
-DISABLE_COPPER_SPEAR = true
-DISABLE_BRONZE_SPEAR = true
-DISABLE_DIAMOND_SPEAR = true
-DISABLE_OBSIDIAN_SPEAR = true
-DISABLE_GOLD_SPEAR = true

tools.lua

@@ -1,7 +1,9 @@
+local S = minetest.get_translator("spears")
+
 function spears_register_spear(spear_type, desc, base_damage, toughness, material)
 
 	minetest.register_tool("spears:spear_" .. spear_type, {
-		description = desc .. " spear",
+		description = desc,
                 wield_image = "spears_spear_" .. spear_type .. ".png^[transform4",
 		inventory_image = "spears_spear_" .. spear_type .. ".png",
 		wield_scale= {x = 1.5, y = 1.5, z = 1.5},
@@ -54,30 +56,43 @@ function spears_register_spear(spear_type, desc, base_damage, toughness, materia
 	})
 end
 
-if not DISABLE_STONE_SPEAR then
-	spears_register_spear('stone', 'Stone', 4, 20, 'group:stone')
+if minetest.settings:get_bool('spears_enable_stone_spear') then
+	spears_register_spear('stone', S('Stone Spear'), 4, 20, 'group:stone')
 end
 
-if not DISABLE_STEEL_SPEAR then
-	spears_register_spear('steel', 'Steel', 6, 30, 'default:steel_ingot')
+if minetest.get_modpath("pigiron") then
+	if minetest.settings:get_bool('spears_enable_iron_spear') then
+		spears_register_spear('iron', S('Iron Spear'), 5.5, 30, 'pigiron:iron_ingot')
+	end
+	if minetest.settings:get_bool('spears_enable_steel_spear') then
+		spears_register_spear('steel', S('Steel Spear'), 6, 35, 'default:steel_ingot')
+	end
+	if minetest.settings:get_bool('spears_enable_copper_spear') then
+		spears_register_spear('copper', S('Copper Spear'), 4.8, 30, 'default:copper_ingot')
+	end
+	if minetest.settings:get_bool('spears_enable_bronze_spear') then
+		spears_register_spear('bronze', S('Bronze Spear'), 5.5, 35, 'default:bronze_ingot')
+	end
+else
+	if minetest.settings:get_bool('spears_enable_steel_spear') then
+		spears_register_spear('steel', S('Steel Spear'), 6, 30, 'default:steel_ingot')
+	end
+	if minetest.settings:get_bool('spears_enable_copper_spear') then
+		spears_register_spear('copper', S('Copper Spear'), 5, 30, 'default:copper_ingot')
+	end
+	if minetest.settings:get_bool('spears_enable_bronze_spear') then
+		spears_register_spear('bronze', S('Bronze Spear'), 6, 35, 'default:bronze_ingot')
+	end
 end
 
-if not DISABLE_COPPER_SPEAR then
-	spears_register_spear('copper', 'Copper', 5, 35, 'default:copper_ingot')
+if minetest.settings:get_bool('spears_enable_obsidian_spear') then
+	spears_register_spear('obsidian', S('Obsidian Spear'), 8, 30, 'default:obsidian')
 end
 
-if not DISABLE_BRONZE_SPEAR then
-	spears_register_spear('bronze', 'Bronze', 6, 35, 'default:bronze_ingot')
+if minetest.settings:get_bool('spears_enable_diamond_spear') then
+	spears_register_spear('diamond', S('Diamond Spear'), 8, 40, 'default:diamond')
 end
 
-if not DISABLE_OBSIDIAN_SPEAR then
-	spears_register_spear('obsidian', 'Obsidian', 8, 30, 'default:obsidian')
-end
-
-if not DISABLE_DIAMOND_SPEAR then
-	spears_register_spear('diamond', 'Diamond', 8, 40, 'default:diamond')
-end
-
-if not DISABLE_GOLD_SPEAR then
-	spears_register_spear('gold', 'Golden', 5, 40, 'default:gold_ingot')
+if minetest.settings:get_bool('spears_enable_gold_spear') then
+	spears_register_spear('gold', S('Golden Spear'), 5, 40, 'default:gold_ingot')
 end