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 -- Modifications by gpcf
  44 -- 2018-12-09
  45 -- get shot down while flying over protected areas marked as no-fly-zones (flak, from German Flugabwehrkanone)
  46 --  set these areas with the /area_flak command
  47
  48
  49
  50 local HUD_Overlay = true --show glider struts as overlay on HUD
  51 local debug = false --show debug info in top-center of hud
  52 local moveModelUp = false
  53 if tonumber(string.sub(minetest.get_version().string, 1, 1)) and tonumber(string.sub(minetest.get_version().string, 1, 1)) > 4 then
  54         moveModelUp = true
  55 end
  56 hangglider = {} --Make this global, so other mods can tell if hangglider exists.
  57 hangglider.use = {}
  58 if HUD_Overlay then
  59 hangglider.id = {}  -- hud id for displaying overlay with struts
  60 end
  61 if debug then  hangglider.debug = {} end -- hud id for debug data
  62 --hangglider.airbreak = {}  -- true if falling fast when equip
  63 --[[
  64 minetest.register_entity("hangglider:airstopper", { --A one-instant entity that catches the player and stops them.
  65         is_visible = false,
  66         physical = false,
  67         immortal = true,
  68         attach = nil,
  69         on_step = function(self, _)
  70                 local canExist = false
  71                 if self.attach then
  72                         local player = self.attach
  73                         if player:is_player() then
  74                                 local pname = player:get_player_name()
  75                                 canExist = true
  76                                 if player:get_player_velocity().y < 0.5 and player:get_player_velocity().y > -0.5 then
  77                                         --Let go when the player actually stops, as that's the whole point.
  78                                         if hangglider.use[pname] then
  79                                                 if moveModelUp then
  80                                                         minetest.add_entity(player:get_pos(), "hangglider:glider"):set_attach(player, "", {x=0,y=10,z=0}, {x=0,y=0,z=0})
  81                                                 else
  82                                                         minetest.add_entity(player:get_pos(), "hangglider:glider"):set_attach(player, "", {x=0,y=0,z=0}, {x=0,y=0,z=0})
  83                                                 end
  84                                         end
  85                                         canExist = false
  86                                 end
  87                         end
  88                         if not canExist then
  89                                 player:set_detach()
  90                         end
  91                 end
  92                 if not canExist then
  93                         self.object:remove()
  94                 end
  95         end
  96 })]]
  97
  98 if areas then
  99         hangglider.flak = true
 100         -- chat command definition essentially copied from areas mod.
 101         minetest.register_chatcommand("area_flak",{
 102                 params = "<ID>",
 103                 description = "Toggle airspace restrictions for area <ID>",
 104                 func = function(name, param)
 105                         local id = tonumber(param)
 106                         if not id then
 107                                 return false, "Invalid usage, see /help area_flak."
 108                         end
 109
 110                         if not areas:isAreaOwner(id, name) then
 111                                 return false, "Area "..id.." does not exist"
 112                                         .." or is not owned by you."
 113                         end
 114                         local open = not areas.areas[id].flak
 115                         -- Save false as nil to avoid inflating the DB.
 116                         areas.areas[id].flak = open or nil
 117                         areas:save()
 118                         return true, ("Area's airspace %s."):format(open and "closed" or "opened")
 119                 end
 120         })
 121 end
 122
 123 if minetestd and minetestd.services.gravityctl.enabled then
 124 minetestd.gravityctl.register_gravity_effect("hangglider",
 125         function(player)
 126                 return hangglider.use[player:get_player_name()]
 127         end,
 128         function(gravity, player)
 129                 local vel = player:get_player_velocity()
 130                 if debug then player:hud_change(hangglider.debug[pname].id, "text", vel.y..', '..player:get_physics_override().gravity..', '..tostring(hangglider.airbreak[pname])) end
 131                 return ((vel.y + 3)/20)
 132         end,
 133         7,
 134         1000
 135 )
 136 end
 137
 138 hangglider.can_fly = function (pname, pos)
 139         -- Checks if the player will get shot down at the position
 140         if wardzones then
 141                 local zone = wardzones.getZone(pos)
 142                 if zone then
 143                         return (minetest.check_player_privs(pname, {protection_bypass=true}) or wardzones.checkPlayerZoneAccess(pname, zone) or not zone["data"]["no_fly"])
 144                 end
 145         end
 146         if areas and minetest.is_protected(vector.round(pos), pname) then
 147                 if hangglider.flak then
 148                         for id, area in pairs(areas:getAreasAtPos(pos)) do
 149                                 if area.flak then
 150                                         return false
 151                                 end
 152                         end
 153                 end
 154         end
 155         return true
 156 end
 157
 158 hangglider.shot_sound = function (pos)
 159         minetest.sound_play("hangglider_flak_shot", {
 160                                                         pos = pos,
 161                                                         max_hear_distance = 30,
 162                                                         gain = 10.0,
 163         })
 164 end
 165
 166 local step_v
 167 minetest.register_entity("hangglider:glider", {
 168         visual = "mesh",
 169         visual_size = {x = 12, y = 12},
 170         mesh = "glider.obj",
 171         immortal = true,
 172         static_save = false,
 173         textures = {"wool_white.png","default_wood.png"},
 174         on_step = function(self, dtime)
 175                 local canExist = false
 176                 if self.object:get_attach() then
 177                         local player = self.object:get_attach("parent")
 178                         if player then
 179                                 local pos = player:getpos()
 180                                 local pname = player:get_player_name()
 181                                 if hangglider.use[pname] then
 182                                         local mrn_name = minetest.registered_nodes[minetest.get_node(vector.new(pos.x, pos.y-0.5, pos.z)).name]
 183                                         if mrn_name then
 184                                                 if not (mrn_name.walkable or mrn_name.liquidtype ~= "none") then
 185                                                         canExist = true
 186                                                         step_v = player:get_player_velocity().y
 187                                                         if step_v < 0 and step_v > -3 then
 188                                                                 player:set_physics_override({speed=math.abs(step_v/2) + 0.75})
 189                                                         elseif step_v <= -3 then --Cap our gliding movement speed.
 190                                                                 player:set_physics_override({speed=2.25})
 191                                                         else
 192                                                                 player:set_physics_override({speed=1})
 193                                                         end
 194                                                         if not minetestd then
 195                                                                 if debug then player:hud_change(hangglider.debug[pname].id, "text", step_v..', '..player:get_physics_override().gravity..', '..tostring(hangglider.airbreak[pname])) end
 196                                                                 player:set_physics_override({gravity=((step_v + 3)/20)})
 197                                                         end
 198                                                         --[[local vel = player:get_player_velocity()
 199                                                         if debug then player:hud_change(hangglider.debug[pname].id, "text", vel.y..', '..grav..', '..tostring(hangglider.airbreak[pname])) end
 200
 201                                                         player:set_physics_override({gravity = (vel.y + 2.0)/20})
 202                                                 ]]end
 203                                         end
 204                                 end
 205                                 if not hangglider.can_fly(pname,pos) then
 206                                     if not self.warned then -- warning shot
 207                                                 self.warned = 0
 208                                                 hangglider.shot_sound(pos)
 209                                                 minetest.chat_send_player(pname, "Protected area! You will be shot down in two seconds by anti-aircraft guns!")
 210                                     end
 211                                     self.warned = self.warned + dtime
 212                                     if self.warned > 2 then -- shoot down
 213                                                 player:set_hp(1)
 214                                                 player:get_inventory():remove_item("main", ItemStack("hangglider:hangglider"))
 215                                                 hangglider.shot_sound(pos)
 216                                                 canExist = false
 217                                     end
 218                                 end
 219                                 if not canExist then
 220                                         player:set_physics_override({
 221                                                 jump = 1,
 222                                                 speed = 1,
 223                                         })
 224                                         if not minetestd then
 225                                                 player:set_physics_override({gravity=1})
 226                                         end
 227                                         hangglider.use[pname] = false
 228                                         if HUD_Overlay then
 229                                         player:hud_change(hangglider.id[pname], "text", "blank.png")
 230                                         end
 231                                         --hangglider.airbreak[pname] = false
 232                                 end
 233                         end
 234                 end
 235                 if not canExist then
 236                         self.object:set_detach()
 237                         self.object:remove()
 238                 end
 239         end
 240 })
 241
 242 minetest.register_on_dieplayer(function(player)
 243         player:set_physics_override({
 244                 gravity = 1,
 245                 jump = 1,
 246         })
 247         hangglider.use[player:get_player_name()] = false
 248 end)
 249
 250
 251 minetest.register_on_joinplayer(function(player)
 252         local pname = player:get_player_name()
 253         player:set_physics_override({
 254                 gravity = 1,
 255                 jump = 1,
 256         })
 257         hangglider.use[pname] = false
 258         if HUD_Overlay then
 259         hangglider.id[pname] = player:hud_add({
 260                 hud_elem_type = "image",
 261                 text = "blank.png",
 262                 position = {x=0, y=0},
 263                 scale = {x=-100, y=-100},
 264                 alignment = {x=1, y=1},
 265                 offset = {x=0, y=0}
 266         }) end
 267         if debug then
 268                 hangglider.debug[pname] = {id = player:hud_add({hud_elem_type = "text",
 269                         position = {x=0.5, y=0.1},
 270                         text = "-",
 271                         number = 0xFF0000}),  -- red text
 272                         -- ht = {50,50,50},
 273                 }
 274         end
 275         --hangglider.airbreak[pname] = false
 276 end)
 277
 278 minetest.register_on_leaveplayer(function(player)
 279         local pname = player:get_player_name()
 280         hangglider.use[pname] = nil
 281         if HUD_Overlay then hangglider.id[pname] = nil end
 282         if debug then hangglider.debug[pname] = nil end
 283         --hangglider.airbreak[pname] = nil
 284 end)
 285
 286 minetest.register_tool("hangglider:hangglider", {
 287         description = "Glider",
 288         inventory_image = "glider_item.png",
 289         stack_max=1,
 290         on_use = function(itemstack, player, pointed_thing)
 291                 if not player then
 292                         return
 293                 end
 294                 local pos = player:get_pos()
 295                 local pname = player:get_player_name()
 296                 if not hangglider.use[pname] then --Equip
 297                         minetest.sound_play("bedsheet", {pos=pos, max_hear_distance = 8, gain = 1.0})
 298                         if HUD_Overlay then player:hud_change(hangglider.id[pname], "text", "glider_struts.png") end
 299                         local airbreak = false
 300                         local vel = player:get_player_velocity().y
 301                         --[[if vel < -1.5 then  -- engage mid-air, falling fast, so stop but ramp velocity more quickly
 302                                 --hangglider.airbreak[pname] = true
 303                                 airbreak = true
 304                                 local stopper = minetest.add_entity(pos, "hangglider:airstopper")
 305                                 minetest.after(0, function(stopper, player) --"Extreme Measures"
 306                                         stopper:set_pos(player:get_pos())
 307                                         stopper:get_luaentity().attach = player
 308                                         player:set_attach( stopper, "", {x=0,y=0,z=0}, {x=0,y=0,z=0})
 309                                 end, stopper, player)
 310                         end]]
 311                         if not airbreak then
 312                                 if moveModelUp then
 313                                         minetest.add_entity(pos, "hangglider:glider"):set_attach(player, "", {x=0,y=10,z=0}, {x=0,y=0,z=0})
 314                                 else
 315                                         minetest.add_entity(pos, "hangglider:glider"):set_attach(player, "", {x=0,y=0,z=0}, {x=0,y=0,z=0})
 316                                 end
 317                         end
 318                         hangglider.use[pname] = true
 319                         player:set_physics_override({jump = 0})
 320                         -- if minetest 0.4.x use this:
 321
 322                         -- if minetest 5.x use this:
 323                         -- minetest.add_entity(player:get_pos(), "hangglider:glider"):set_attach(player, "", {x=0,y=10,z=0}, {x=0,y=0,z=0})
 324                         itemstack:set_wear(itemstack:get_wear() + 255)
 325                         return itemstack
 326                 elseif hangglider.use[pname] then --Unequip
 327                         if HUD_Overlay then player:hud_change(hangglider.id[pname], "text", "default_wood.png^[colorize:#0000:255") end
 328                         hangglider.use[pname] = false
 329                 end
 330         end,
 331         sound = {breaks = "default_tool_breaks"},
 332 })
 333
 334 minetest.register_craft({
 335         type = "shapeless",
 336         output = "hangglider:hangglider",
 337         recipe = {"default:paper", "default:paper", "default:paper", "default:paper", "hangglider:hangglider", "default:paper", "default:paper", "default:paper", "default:paper"},
 338 })
 339
 340 minetest.register_craft({
 341         output = "hangglider:hangglider",
 342         recipe = {
 343                 {"wool:white", "wool:white", "wool:white"},
 344                 {"default:stick", "", "default:stick"},
 345                 {"", "default:stick", ""},
 346         }
 347 })