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