Update documentation.

LICENSE.txt

@@ -26,4 +26,5 @@ Textures:
 	Default wood and wool textures from minetest-game.
 
 Models and sounds: 
-	CC BY-SA (4.0) by Piezo_.
+	CC BY-SA (4.0) by Piezo_.
+	hangglider_flying.ogg: Derived from "Flag Flapping in Wind" by Felix Blume, CC0 1.0 Universal License.

README.md

@@ -5,19 +5,22 @@ This is a fork of the minetest-hangglider mod by Piezo_ (orderofthefourthwall@gm
 Which is located at:
     <https://notabug.org/Piezo_/minetest-hangglider>
 
-**This version is an experimental version that is not intended for general use.**
+This was last synched up with Piezo_'s updates from Nov 25.
 
-This was synched up with Piezo_'s updates from Nov 25
-
-- hud overlay and debug can be enabled/disabled
+- hud overlay and debug can be enabled/disabled.
 - Added blender-rendered overlay for struts using the actual model.
 - Reduced airbreak penalty severity
 - gave glider limited durability.
 
-The only changes I've made are:
+I've made the following changes to the code:
 
 - Slightly blurred Piezo_'s excellent strut overlay.
-- Created new blank.png with same size as Piezo_'s overlay.
-- Piezo_ also increased flight speed to 1.75.  This was OK, but the transition seemed too abrupt.
-    - I changed flight speed to also increase smoothly. It starts at 1 and maxes out at 1.75.
-- Use minetest.get_version() to automatically choose which set_attach offset to use.
+- Changed flight speed to increase smoothly. It starts at 1 and maxes out at 1.75.
+- Use minetest.get_version() to automatically choose which set_attach offset to use depending on whether minetest version is 0.4.x or 5.x.
+- Removed use of blank.png overlay.
+- Detect when hangglider is no longer wielded_item and unequip if appropriate. *Don't hit 'Q' key during flight.*
+- Added AUX key as hangglider equip alternative, in addition to left-click. This allows hangglider flight on Android clients.
+- Wear is back and better than ever. Breaks on unequip rather than equip, so doesn't leave you falling from a cliff.
+- Number of uses is configurable, currently defaults to 50, but expect this will need tuning.
+- Updated pos offset for launching, so don't have unintended wear when standing.
+- Added sound while flying.

init.lua

@@ -21,7 +21,6 @@
 -- Temporarily add hud debug display to show descent velocity, gravity override, and airbreak flag.
 --     Still in process of tuning all the parameters.
 
--- Modifications by David G
 -- 2018-11-24
 -- For Minetest 5.x, glider's set_attach needs to be offset by 1 node
 --     Switch to alternate commented line below with correct offset.
@@ -41,21 +40,43 @@
 -- Slightly blurred Piezo_'s new excellent strut overlay.
 -- Kept increased 1.75 speed, but now make it increase gradually too.
 
--- Modifications by David G
 -- 2018-11-28
 -- Detect minetest version to automatically use appropriate set_attach offset.
 
+-- 2018-12-05
+-- Remove blank.png.
 
+-- 2018-12-07
+-- Unequip hangglider if it is not longer the wielded_item, while in use.
+-- Add AUX key as alternate equip option, to use with android clients.
+-- Disabled wear of hangglider for now.
+
+-- 2018-12-09
+-- Wear is back and better than ever. Breaks on unequip rather than equip.
+-- Adjust glider_uses below, default 50.
+
+-- 2019-02-19
+-- Add sound while gliding.
+
+-- Configuration variables
 local HUD_Overlay = true --show glider struts as overlay on HUD
 local debug = false --show debug info in top-center of hud
+local glider_uses = 50 -- define number of uses before hangglider wears out
+-- End configuration
+
 hangglider = {} --Make this global, so other mods can tell if hangglider exists.
+local handles = {}
 hangglider.use = {}
+local prev_equip_key = {}
 if HUD_Overlay then
 hangglider.id = {}  -- hud id for displaying overlay with struts
 end
 if debug then  hangglider.debug = {} end -- hud id for debug data
 hangglider.airbreak = {}  -- true if falling fast when equip
 
+local wear_incr = math.floor(65535 / glider_uses)
+local isFive = string.sub(minetest.get_version().string, 1, 1) == "5"
+
 minetest.register_entity("hangglider:airstopper", { --A one-instant entity that catches the player and slows them down.
 	hp_max = 3,
 	is_visible = false,
@@ -85,8 +106,9 @@ minetest.register_entity("hangglider:glider", {
 		if self.object:get_attach() then
 			local player = self.object:get_attach("parent")
 			if player then
-				local pos = player:getpos()
 				local pname = player:get_player_name()
+				local itemstack = player:get_wielded_item()
+				local pos = player:get_pos()
 				if hangglider.use[pname] then
 					local mrn_name = minetest.registered_nodes[minetest.get_node(vector.new(pos.x, pos.y-0.5, pos.z)).name]
 					if mrn_name then
@@ -153,6 +175,10 @@ minetest.register_entity("hangglider:glider", {
 								newspeed = -vel.y * 0.375 + 1  -- gradually increase from 1 to 1.75
 							end
 							player:set_physics_override({gravity = grav, speed = newspeed})
+							if not handles[pname] then
+								local handle = minetest.sound_play("hangglider_flying", {to_player = pname, gain = 0.5, loop = true})-- {object = self.object, loop = true})
+								handles[pname] = handle
+							end
 						end
 					end
 				end
@@ -163,10 +189,18 @@ minetest.register_entity("hangglider:glider", {
 						speed = 1,
 					})
 					hangglider.use[pname] = false
+					if handles[pname] then  -- stop sound if playing
+						minetest.sound_stop(handles[pname])
+						handles[pname] = nil
+					end
 					if HUD_Overlay then
-					player:hud_change(hangglider.id[pname], "text", "blank.png")
+					player:hud_change(hangglider.id[pname], "text", "")
 					end
 					hangglider.airbreak[pname] = false
+					if itemstack:get_wear() + wear_incr > 65535 then
+						player:set_wielded_item(nil)
+						minetest.sound_play("default_tool_breaks", {pos=pos, max_hear_distance = 8, gain = 1.0})
+					end
 				end
 			end
 		end
@@ -178,11 +212,14 @@ minetest.register_entity("hangglider:glider", {
 })
 
 minetest.register_on_dieplayer(function(player)
+	local pname = player:get_player_name()
 	player:set_physics_override({
 		gravity = 1,
 		jump = 1,
 	})
-	hangglider.use[player:get_player_name()] = false
+	hangglider.use[pname] = false
+	prev_equip_key[pname] = false
+	handles[pname] = nil
 end)
 
 
@@ -193,10 +230,12 @@ minetest.register_on_joinplayer(function(player)
 		jump = 1,
 	})
 	hangglider.use[pname] = false
+	handles[pname] = nil
+	prev_equip_key[pname] = false
 	if HUD_Overlay then
 	hangglider.id[pname] = player:hud_add({
 		hud_elem_type = "image",
-		text = "blank.png",
+		text = "",
 		position = {x=0, y=0},
 		scale = {x=-100, y=-100},
 		alignment = {x=1, y=1},
@@ -216,6 +255,8 @@ end)
 minetest.register_on_leaveplayer(function(player)
 	local pname = player:get_player_name()
 	hangglider.use[pname] = nil
+	handles[pname] = nil
+	prev_equip_key[pname] = nil
 	if HUD_Overlay then hangglider.id[pname] = nil end
 	if debug then hangglider.debug[pname] = nil end
 	hangglider.airbreak[pname] = nil
@@ -225,52 +266,115 @@ minetest.register_tool("hangglider:hangglider", {
 	description = "Glider",
 	inventory_image = "glider_item.png",
 	stack_max=1,
-	on_use = function(itemstack, user, pointed_thing)
-		if not user then
+	on_use = function(itemstack, player, pointed_thing)
+		if not player then
 			return
 		end
-		local pos = user:get_pos()
-		local pname = user:get_player_name()
-		if minetest.get_node(pos).name == "air" and not hangglider.use[pname] then --Equip
+		local pname = player:get_player_name()
+		local pos = player:get_pos()
+		if minetest.get_node(vector.add(pos, {x=0,y=-1,z=0})).name == "air" and not hangglider.use[pname] then --Equip
 			minetest.sound_play("bedsheet", {pos=pos, max_hear_distance = 8, gain = 1.0})
-			if HUD_Overlay then user:hud_change(hangglider.id[pname], "text", "glider_struts.png") end
-			local vel = user:get_player_velocity().y
+			if HUD_Overlay then player:hud_change(hangglider.id[pname], "text", "glider_struts.png") end
+			local vel = player:get_player_velocity().y
 			if vel < -2 then  -- engage mid-air, falling fast, so stop but ramp velocity more quickly
 				hangglider.airbreak[pname] = true
-				user:set_physics_override({
+				player:set_physics_override({
 					gravity = 1,
 					jump = 0,
 					speed = 1,
 				})
 				local stopper = minetest.add_entity(pos, "hangglider:airstopper")
-				stopper:get_luaentity().attach = user
-				user:set_attach( stopper, "", {x=0,y=0,z=0}, {x=0,y=0,z=0})
+				stopper:get_luaentity().attach = player
+				player:set_attach( stopper, "", {x=0,y=0,z=0}, {x=0,y=0,z=0})
 			else
-				user:set_physics_override({
+				player:set_physics_override({
 					gravity = 0.02,
 					jump = 0,
 					speed = 1,
 				})
 			end
 			hangglider.use[pname] = true
-			-- print(minetest.serialize(minetest.get_version()))
-			if string.sub(minetest.get_version().string, 1, 1) == "5" then
-				-- minetest 5.x, need positive offset
-				minetest.add_entity(user:get_pos(), "hangglider:glider"):set_attach(user, "", {x=0,y=10,z=0}, {x=0,y=0,z=0})
-			else
-				-- minetest 0.4.x, no offset needed
-				minetest.add_entity(user:get_pos(), "hangglider:glider"):set_attach(user, "", {x=0,y=0,z=0}, {x=0,y=0,z=0})
+			if isFive then  -- minetest 5.x, need positive offset
+				minetest.add_entity(player:get_pos(), "hangglider:glider"):set_attach(player, "", {x=0,y=10,z=0}, {x=0,y=0,z=0})
+			else  -- minetest 0.4.x, no offset needed
+				minetest.add_entity(player:get_pos(), "hangglider:glider"):set_attach(player, "", {x=0,y=0,z=0}, {x=0,y=0,z=0})
 			end
-			itemstack:set_wear(itemstack:get_wear() + 255)
+			itemstack:add_wear(wear_incr)
 			return itemstack
-		elseif hangglider.use[pname] then --Unequip
-			if HUD_Overlay then user:hud_change(hangglider.id[pname], "text", "blank.png") end
+		elseif minetest.get_node(pos).name == "air" and hangglider.use[pname] then --Unequip
+			if HUD_Overlay then player:hud_change(hangglider.id[pname], "text", "") end
 			hangglider.use[pname] = false
+			if itemstack:get_wear() + wear_incr > 65535 then
+				player:set_wielded_item(nil)
+				minetest.sound_play("default_tool_breaks", {pos=pos, max_hear_distance = 8, gain = 1.0})
+			end
 		end
 	end,
-	sound = {breaks = "default_tool_breaks"},
 })
 
+-- Also can equip hangglider by using AUX key (default 'E' key).
+-- Also checks that hangglider is wielded item.  If not it's unequiped.
+minetest.register_globalstep(function(dtime)
+    local players  = minetest.get_connected_players()
+    for i,player in ipairs(players) do
+		local pname = player:get_player_name()
+		local itemstack = player:get_wielded_item()
+		local pos = player:get_pos()
+		if string.sub(itemstack:get_name(), 0, 21)== "hangglider:hangglider" then -- wielding hangglider
+			local current_equip_key = player:get_player_control().aux1
+			if prev_equip_key[pname] == false and current_equip_key == true then -- equip key just pressed
+				if minetest.get_node(vector.add(pos, {x=0,y=-1,z=0})).name == "air" and not hangglider.use[pname] then --Equip
+					minetest.sound_play("bedsheet", {pos=pos, max_hear_distance = 8, gain = 1.0})
+					if HUD_Overlay then player:hud_change(hangglider.id[pname], "text", "glider_struts.png") end
+					local vel = player:get_player_velocity().y
+					if vel < -2 then  -- engage mid-air, falling fast, so stop but ramp velocity more quickly
+						hangglider.airbreak[pname] = true
+						player:set_physics_override({
+							gravity = 1,
+							jump = 0,
+							speed = 1,
+						})
+						local stopper = minetest.add_entity(pos, "hangglider:airstopper")
+						stopper:get_luaentity().attach = player
+						player:set_attach( stopper, "", {x=0,y=0,z=0}, {x=0,y=0,z=0})
+					else
+						player:set_physics_override({
+							gravity = 0.02,
+							jump = 0,
+							speed = 1,
+						})
+					end
+					hangglider.use[pname] = true
+					if isFive then  -- minetest 5.x, need positive offset
+						minetest.add_entity(player:get_pos(), "hangglider:glider"):set_attach(player, "", {x=0,y=10,z=0}, {x=0,y=0,z=0})
+					else  -- minetest 0.4.x, no offset needed
+						minetest.add_entity(player:get_pos(), "hangglider:glider"):set_attach(player, "", {x=0,y=0,z=0}, {x=0,y=0,z=0})
+					end
+					itemstack:add_wear(wear_incr)
+					player:set_wielded_item(itemstack)
+				elseif minetest.get_node(pos).name == "air" and hangglider.use[pname] then --Unequip
+					if HUD_Overlay then player:hud_change(hangglider.id[pname], "text", "") end
+					hangglider.use[pname] = false
+					if itemstack:get_wear() + wear_incr > 65535 then
+						player:set_wielded_item(nil)
+						minetest.sound_play("default_tool_breaks", {pos=pos, max_hear_distance = 8, gain = 1.0})
+					end
+				end
+			end
+			prev_equip_key[pname] = current_equip_key
+		else -- not wielding hangglider
+			if hangglider.use[pname] then --Unequip
+				if HUD_Overlay then player:hud_change(hangglider.id[pname], "text", "") end
+				hangglider.use[pname] = false
+				if itemstack:get_wear() + wear_incr > 65535 then
+					player:set_wielded_item(nil)
+					minetest.sound_play("default_tool_breaks", {pos=pos, max_hear_distance = 8, gain = 1.0})
+				end
+			end
+		end
+	end
+end)
+
 minetest.register_craft({
 	output = "hangglider:hangglider",
 	recipe = {