]> git.lizzy.rs Git - hangglider.git/blob - init.lua
An entire commit just for one comment
[hangglider.git] / init.lua
1 -- Hangglider mod for Minetest
2 -- Original code by Piezo_ (orderofthefourthwall@gmail.com)
3 -- 2018-11-14
4
5 -- Modifications by David G (kestral246@gmail.com)
6 -- 2018-11-24
7 -- For Minetest 5.x, glider's set_attach needs to be offset by 1 node
8 --     Switch to alternate commented line below with correct offset.
9 -- Additional tuning of parameters.
10 -- Commented out debug hud display code, prefixed with "--debug:".
11
12 -- 2018-11-22
13 -- Give visual indication that hangglider is equiped.
14 --     Display simple overlay with blurred struts when equiped.
15 --     Issue: don't know how to disable overlay in third person view.
16 -- Also Unequip hangglider when landing on water.
17 -- Attempt to linearize parabolic flight path.
18 --     Start gravity stronger, but gradually reduce it as descent velocity increases.
19 --     Don't use airstopper when equipped from the ground (descent velocity is low).
20 --     Slightly increase flight speed to 1.25.
21 -- Unequip/equip cycling mid-flight should not fly farther than continuous flight.
22 --     When equipping mid-air (descent velocity higher), use airstopper but increase descent slope afterwards.
23 --     Create airbreak flag so all equips mid-flight use faster descent.
24 --     Reset airbreak flag only when land (canExist goes false).
25 --     Issue: it wouldn't reset if land in water, use fly, and launch from air, before I added test for water,
26 --            not sure if there are other such cases.
27 -- Temporarily add hud debug display to show descent velocity, gravity override, and airbreak flag.
28 --     Still in process of tuning all the parameters.
29
30
31 -- Modifications by Piezo_
32 -- 2018-11-25
33 -- hud overlay and debug can be enabled/disabled
34 -- Added blender-rendered overlay for struts using the actual model.
35 -- Reduced airbreak penalty severity
36 -- gave glider limited durability.
37 -- Improved gravity adjustment function.
38 -- Changed airbreaking process 
39 -- Removed airbreak penalty, as any 'advantage' seems minimal after new adjustments
40 -- Removed airbreak until minetest devs are smart enough to implement better serverside players.
41 -- Simplified liquid check.
42
43 local HUD_Overlay = true --show glider struts as overlay on HUD
44 local debug = false --show debug info in top-center of hud
45 local moveModelUp = false
46 if tonumber(string.sub(minetest.get_version().string, 1, 1)) and tonumber(string.sub(minetest.get_version().string, 1, 1)) > 4 then
47         moveModelUp = true
48 end
49 hangglider = {} --Make this global, so other mods can tell if hangglider exists.
50 hangglider.use = {}
51 if HUD_Overlay then
52 hangglider.id = {}  -- hud id for displaying overlay with struts
53 end
54 if debug then  hangglider.debug = {} end -- hud id for debug data
55 --hangglider.airbreak = {}  -- true if falling fast when equip
56 --[[
57 minetest.register_entity("hangglider:airstopper", { --A one-instant entity that catches the player and stops them.
58         is_visible = false,
59         physical = false,
60         immortal = true,
61         attach = nil,
62         on_step = function(self, _)
63                 local canExist = false
64                 if self.attach then
65                         local player = self.attach
66                         if player:is_player() then
67                                 local pname = player:get_player_name()
68                                 canExist = true
69                                 if player:get_player_velocity().y < 0.5 and player:get_player_velocity().y > -0.5 then 
70                                         --Let go when the player actually stops, as that's the whole point.
71                                         if hangglider.use[pname] then
72                                                 if moveModelUp then
73                                                         minetest.add_entity(player:get_pos(), "hangglider:glider"):set_attach(player, "", {x=0,y=10,z=0}, {x=0,y=0,z=0})
74                                                 else
75                                                         minetest.add_entity(player:get_pos(), "hangglider:glider"):set_attach(player, "", {x=0,y=0,z=0}, {x=0,y=0,z=0})
76                                                 end
77                                         end
78                                         canExist = false
79                                 end
80                         end
81                         if not canExist then
82                                 player:set_detach()
83                         end
84                 end
85                 if not canExist then
86                         self.object:remove()
87                 end
88         end
89 })]]
90
91 if minetestd and minetestd.services.gravityctl.enabled then
92 minetestd.gravityctl.register_gravity_effect("hangglider", 
93         function(player) 
94                 return hangglider.use[player:get_player_name()] 
95         end,
96         function(gravity, player) 
97                 local vel = player:get_player_velocity()
98                 if debug then player:hud_change(hangglider.debug[pname].id, "text", vel.y..', '..player:get_physics_override().gravity..', '..tostring(hangglider.airbreak[pname])) end
99                 return ((vel.y + 3)/20)
100         end,
101         7,
102         1000
103 )
104 end
105
106 local step_v
107 minetest.register_entity("hangglider:glider", {
108         visual = "mesh",
109         visual_size = {x = 12, y = 12},
110         mesh = "glider.obj",
111         immortal = true,
112         static_save = false,
113         textures = {"wool_white.png","default_wood.png"},
114         on_step = function(self, _)
115                 local canExist = false
116                 if self.object:get_attach() then
117                         local player = self.object:get_attach("parent")
118                         if player then
119                                 local pos = player:getpos()
120                                 local pname = player:get_player_name()
121                                 if hangglider.use[pname] then
122                                         local mrn_name = minetest.registered_nodes[minetest.get_node(vector.new(pos.x, pos.y-0.5, pos.z)).name]
123                                         if mrn_name then
124                                                 if not (mrn_name.walkable or mrn_name.liquidtype ~= "none") then
125                                                         canExist = true
126                                                         step_v = player:get_player_velocity().y
127                                                         if step_v < 0 and step_v > -3 then
128                                                                 player:set_physics_override({speed=math.abs(step_v/2) + 0.75})
129                                                         elseif step_v <= -3 then --Cap our gliding movement speed.
130                                                                 player:set_physics_override({speed=2.25})
131                                                         else
132                                                                 player:set_physics_override({speed=1})
133                                                         end
134                                                         if not minetestd then
135                                                                 if debug then player:hud_change(hangglider.debug[pname].id, "text", step_v..', '..player:get_physics_override().gravity..', '..tostring(hangglider.airbreak[pname])) end
136                                                                 player:set_physics_override({gravity=((step_v + 3)/20)})
137                                                         end
138                                                         --[[local vel = player:get_player_velocity()
139                                                         if debug then player:hud_change(hangglider.debug[pname].id, "text", vel.y..', '..grav..', '..tostring(hangglider.airbreak[pname])) end
140                                                         
141                                                         player:set_physics_override({gravity = (vel.y + 2.0)/20})
142                                                 ]]end
143                                         end
144                                 end
145                                 if not canExist then
146                                         player:set_physics_override({
147                                                 jump = 1,
148                                                 speed = 1,
149                                         })
150                                         if not minetestd then
151                                                 player:set_physics_override({gravity=1})
152                                         end
153                                         hangglider.use[pname] = false
154                                         if HUD_Overlay then
155                                         player:hud_change(hangglider.id[pname], "text", "blank.png")
156                                         end
157                                         --hangglider.airbreak[pname] = false
158                                 end
159                         end
160                 end
161                 if not canExist then 
162                         self.object:set_detach()
163                         self.object:remove() 
164                 end
165         end
166 })
167
168 minetest.register_on_dieplayer(function(player)
169         player:set_physics_override({
170                 gravity = 1,
171                 jump = 1,
172         })
173         hangglider.use[player:get_player_name()] = false
174 end)
175
176
177 minetest.register_on_joinplayer(function(player)
178         local pname = player:get_player_name()
179         player:set_physics_override({
180                 gravity = 1,
181                 jump = 1,
182         })
183         hangglider.use[pname] = false
184         if HUD_Overlay then
185         hangglider.id[pname] = player:hud_add({
186                 hud_elem_type = "image",
187                 text = "blank.png",
188                 position = {x=0, y=0},
189                 scale = {x=-100, y=-100},
190                 alignment = {x=1, y=1},
191                 offset = {x=0, y=0}
192         }) end
193         if debug then 
194                 hangglider.debug[pname] = {id = player:hud_add({hud_elem_type = "text",
195                         position = {x=0.5, y=0.1},
196                         text = "-",
197                         number = 0xFF0000}),  -- red text
198                         -- ht = {50,50,50},
199                 }
200         end
201         --hangglider.airbreak[pname] = false
202 end)
203
204 minetest.register_on_leaveplayer(function(player)
205         local pname = player:get_player_name()
206         hangglider.use[pname] = nil
207         if HUD_Overlay then hangglider.id[pname] = nil end
208         if debug then hangglider.debug[pname] = nil end
209         --hangglider.airbreak[pname] = nil
210 end)
211
212 minetest.register_tool("hangglider:hangglider", {
213         description = "Glider",
214         inventory_image = "glider_item.png",
215         stack_max=1,
216         on_use = function(itemstack, player, pointed_thing)
217                 if not player then
218                         return
219                 end
220                 local pos = player:get_pos()
221                 local pname = player:get_player_name()
222                 if minetest.get_node(pos).name == "air" and not hangglider.use[pname] then --Equip
223                         minetest.sound_play("bedsheet", {pos=pos, max_hear_distance = 8, gain = 1.0})
224                         if HUD_Overlay then player:hud_change(hangglider.id[pname], "text", "glider_struts.png") end
225                         local airbreak = false
226                         local vel = player:get_player_velocity().y
227                         --[[if vel < -1.5 then  -- engage mid-air, falling fast, so stop but ramp velocity more quickly
228                                 --hangglider.airbreak[pname] = true
229                                 airbreak = true
230                                 local stopper = minetest.add_entity(pos, "hangglider:airstopper")
231                                 minetest.after(0, function(stopper, player) --"Extreme Measures"
232                                         stopper:set_pos(player:get_pos())
233                                         stopper:get_luaentity().attach = player
234                                         player:set_attach( stopper, "", {x=0,y=0,z=0}, {x=0,y=0,z=0})
235                                 end, stopper, player)
236                         end]]
237                         if not airbreak then 
238                                 if moveModelUp then
239                                         minetest.add_entity(pos, "hangglider:glider"):set_attach(player, "", {x=0,y=10,z=0}, {x=0,y=0,z=0})
240                                 else
241                                         minetest.add_entity(pos, "hangglider:glider"):set_attach(player, "", {x=0,y=0,z=0}, {x=0,y=0,z=0})
242                                 end
243                         end
244                         hangglider.use[pname] = true
245                         player:set_physics_override({jump = 0})
246                         -- if minetest 0.4.x use this:
247                         
248                         -- if minetest 5.x use this:
249                         -- minetest.add_entity(player:get_pos(), "hangglider:glider"):set_attach(player, "", {x=0,y=10,z=0}, {x=0,y=0,z=0})
250                         itemstack:set_wear(itemstack:get_wear() + 255)
251                         return itemstack
252                 elseif hangglider.use[pname] then --Unequip
253                         if HUD_Overlay then player:hud_change(hangglider.id[pname], "text", "default_wood.png^[colorize:#0000:255") end
254                         hangglider.use[pname] = false
255                 end
256         end,
257         sound = {breaks = "default_tool_breaks"},
258 })
259
260 minetest.register_craft({
261         type = "shapeless",
262         output = "hangglider:hangglider",
263         recipe = {"default:paper", "default:paper", "default:paper", "default:paper", "hangglider:hangglider", "default:paper", "default:paper", "default:paper", "default:paper"},
264 })
265
266 minetest.register_craft({
267         output = "hangglider:hangglider",
268         recipe = {
269                 {"wool:white", "wool:white", "wool:white"},
270                 {"default:stick", "", "default:stick"},
271                 {"", "default:stick", ""},
272         }
273 })