mods/default/functions.lua

   1 -- mods/default/functions.lua
   2
   3 --
   4 -- Sounds
   5 --
   6
   7 function default.node_sound_defaults(table)
   8         table = table or {}
   9         table.footstep = table.footstep or
  10                         {name = "", gain = 1.0}
  11         table.dug = table.dug or
  12                         {name = "default_dug_node", gain = 0.25}
  13         table.place = table.place or
  14                         {name = "default_place_node_hard", gain = 1.0}
  15         return table
  16 end
  17
  18 function default.node_sound_stone_defaults(table)
  19         table = table or {}
  20         table.footstep = table.footstep or
  21                         {name = "default_hard_footstep", gain = 0.3}
  22         table.dug = table.dug or
  23                         {name = "default_hard_footstep", gain = 1.0}
  24         default.node_sound_defaults(table)
  25         return table
  26 end
  27
  28 function default.node_sound_dirt_defaults(table)
  29         table = table or {}
  30         table.footstep = table.footstep or
  31                         {name = "default_dirt_footstep", gain = 0.4}
  32         table.dug = table.dug or
  33                         {name = "default_dirt_footstep", gain = 1.0}
  34         table.place = table.place or
  35                         {name = "default_place_node", gain = 1.0}
  36         default.node_sound_defaults(table)
  37         return table
  38 end
  39
  40 function default.node_sound_sand_defaults(table)
  41         table = table or {}
  42         table.footstep = table.footstep or
  43                         {name = "default_sand_footstep", gain = 0.12}
  44         table.dug = table.dug or
  45                         {name = "default_sand_footstep", gain = 0.24}
  46         table.place = table.place or
  47                         {name = "default_place_node", gain = 1.0}
  48         default.node_sound_defaults(table)
  49         return table
  50 end
  51
  52 function default.node_sound_gravel_defaults(table)
  53         table = table or {}
  54         table.footstep = table.footstep or
  55                         {name = "default_gravel_footstep", gain = 0.4}
  56         table.dug = table.dug or
  57                         {name = "default_gravel_footstep", gain = 1.0}
  58         table.place = table.place or
  59                         {name = "default_place_node", gain = 1.0}
  60         default.node_sound_defaults(table)
  61         return table
  62 end
  63
  64 function default.node_sound_wood_defaults(table)
  65         table = table or {}
  66         table.footstep = table.footstep or
  67                         {name = "default_wood_footstep", gain = 0.3}
  68         table.dug = table.dug or
  69                         {name = "default_wood_footstep", gain = 1.0}
  70         default.node_sound_defaults(table)
  71         return table
  72 end
  73
  74 function default.node_sound_leaves_defaults(table)
  75         table = table or {}
  76         table.footstep = table.footstep or
  77                         {name = "default_grass_footstep", gain = 0.45}
  78         table.dug = table.dug or
  79                         {name = "default_grass_footstep", gain = 0.7}
  80         table.place = table.place or
  81                         {name = "default_place_node", gain = 1.0}
  82         default.node_sound_defaults(table)
  83         return table
  84 end
  85
  86 function default.node_sound_glass_defaults(table)
  87         table = table or {}
  88         table.footstep = table.footstep or
  89                         {name = "default_glass_footstep", gain = 0.3}
  90         table.dig = table.dig or
  91                         {name = "default_glass_footstep", gain = 0.5}
  92         table.dug = table.dug or
  93                         {name = "default_break_glass", gain = 1.0}
  94         default.node_sound_defaults(table)
  95         return table
  96 end
  97
  98 function default.node_sound_metal_defaults(table)
  99         table = table or {}
 100         table.footstep = table.footstep or
 101                         {name = "default_metal_footstep", gain = 0.4}
 102         table.dig = table.dig or
 103                         {name = "default_dig_metal", gain = 0.5}
 104         table.dug = table.dug or
 105                         {name = "default_dug_metal", gain = 0.5}
 106         table.place = table.place or
 107                         {name = "default_place_node_metal", gain = 0.5}
 108         default.node_sound_defaults(table)
 109         return table
 110 end
 111
 112 function default.node_sound_water_defaults(table)
 113         table = table or {}
 114         table.footstep = table.footstep or
 115                         {name = "default_water_footstep", gain = 0.2}
 116         default.node_sound_defaults(table)
 117         return table
 118 end
 119
 120 --
 121 -- Lavacooling
 122 --
 123
 124 default.cool_lava = function(pos, node)
 125         if node.name == "default:lava_source" then
 126                 minetest.set_node(pos, {name = "default:obsidian"})
 127         else -- Lava flowing
 128                 minetest.set_node(pos, {name = "default:stone"})
 129         end
 130         minetest.sound_play("default_cool_lava",
 131                 {pos = pos, max_hear_distance = 16, gain = 0.25})
 132 end
 133
 134 if minetest.setting_getbool("enable_lavacooling") ~= false then
 135         minetest.register_abm({
 136                 label = "Lava cooling",
 137                 nodenames = {"default:lava_source", "default:lava_flowing"},
 138                 neighbors = {"group:cools_lava", "group:water"},
 139                 interval = 1,
 140                 chance = 2,
 141                 catch_up = false,
 142                 action = default.cool_lava,
 143         })
 144 end
 145
 146 --
 147 -- optimized helper to put all items in an inventory into a drops list
 148 --
 149
 150 function default.get_inventory_drops(pos, inventory, drops)
 151         local inv = minetest.get_meta(pos):get_inventory()
 152         local n = #drops
 153         for i = 1, inv:get_size(inventory) do
 154                 local stack = inv:get_stack(inventory, i)
 155                 if stack:get_count() > 0 then
 156                         drops[n+1] = stack:to_table()
 157                         n = n + 1
 158                 end
 159         end
 160 end
 161
 162 --
 163 -- Papyrus and cactus growing
 164 --
 165
 166 -- wrapping the functions in abm action is necessary to make overriding them possible
 167
 168 function default.grow_cactus(pos, node)
 169         if node.param2 >= 4 then
 170                 return
 171         end
 172         pos.y = pos.y - 1
 173         if minetest.get_item_group(minetest.get_node(pos).name, "sand") == 0 then
 174                 return
 175         end
 176         pos.y = pos.y + 1
 177         local height = 0
 178         while node.name == "default:cactus" and height < 4 do
 179                 height = height + 1
 180                 pos.y = pos.y + 1
 181                 node = minetest.get_node(pos)
 182         end
 183         if height == 4 or node.name ~= "air" then
 184                 return
 185         end
 186         if minetest.get_node_light(pos) < 13 then
 187                 return
 188         end
 189         minetest.set_node(pos, {name = "default:cactus"})
 190         return true
 191 end
 192
 193 function default.grow_papyrus(pos, node)
 194         pos.y = pos.y - 1
 195         local name = minetest.get_node(pos).name
 196         if name ~= "default:dirt_with_grass" and name ~= "default:dirt" then
 197                 return
 198         end
 199         if not minetest.find_node_near(pos, 3, {"group:water"}) then
 200                 return
 201         end
 202         pos.y = pos.y + 1
 203         local height = 0
 204         while node.name == "default:papyrus" and height < 4 do
 205                 height = height + 1
 206                 pos.y = pos.y + 1
 207                 node = minetest.get_node(pos)
 208         end
 209         if height == 4 or node.name ~= "air" then
 210                 return
 211         end
 212         if minetest.get_node_light(pos) < 13 then
 213                 return
 214         end
 215         minetest.set_node(pos, {name = "default:papyrus"})
 216         return true
 217 end
 218
 219 minetest.register_abm({
 220         label = "Grow cactus",
 221         nodenames = {"default:cactus"},
 222         neighbors = {"group:sand"},
 223         interval = 12,
 224         chance = 83,
 225         action = default.grow_cactus
 226 })
 227
 228 minetest.register_abm({
 229         label = "Grow papyrus",
 230         nodenames = {"default:papyrus"},
 231         neighbors = {"default:dirt", "default:dirt_with_grass"},
 232         interval = 14,
 233         chance = 71,
 234         action = default.grow_papyrus
 235 })
 236
 237
 238 --
 239 -- dig upwards
 240 --
 241
 242 function default.dig_up(pos, node, digger)
 243         if digger == nil then return end
 244         local np = {x = pos.x, y = pos.y + 1, z = pos.z}
 245         local nn = minetest.get_node(np)
 246         if nn.name == node.name then
 247                 minetest.node_dig(np, nn, digger)
 248         end
 249 end
 250
 251
 252 --
 253 -- Fence registration helper
 254 --
 255
 256 function default.register_fence(name, def)
 257         minetest.register_craft({
 258                 output = name .. " 4",
 259                 recipe = {
 260                         { def.material, 'group:stick', def.material },
 261                         { def.material, 'group:stick', def.material },
 262                 }
 263         })
 264
 265         local fence_texture = "default_fence_overlay.png^" .. def.texture ..
 266                         "^default_fence_overlay.png^[makealpha:255,126,126"
 267         -- Allow almost everything to be overridden
 268         local default_fields = {
 269                 paramtype = "light",
 270                 drawtype = "nodebox",
 271                 node_box = {
 272                         type = "connected",
 273                         fixed = {{-1/8, -1/2, -1/8, 1/8, 1/2, 1/8}},
 274                         -- connect_top =
 275                         -- connect_bottom =
 276                         connect_front = {{-1/16,3/16,-1/2,1/16,5/16,-1/8},
 277                                 {-1/16,-5/16,-1/2,1/16,-3/16,-1/8}},
 278                         connect_left = {{-1/2,3/16,-1/16,-1/8,5/16,1/16},
 279                                 {-1/2,-5/16,-1/16,-1/8,-3/16,1/16}},
 280                         connect_back = {{-1/16,3/16,1/8,1/16,5/16,1/2},
 281                                 {-1/16,-5/16,1/8,1/16,-3/16,1/2}},
 282                         connect_right = {{1/8,3/16,-1/16,1/2,5/16,1/16},
 283                                 {1/8,-5/16,-1/16,1/2,-3/16,1/16}},
 284                 },
 285                 connects_to = {"group:fence", "group:wood", "group:tree"},
 286                 inventory_image = fence_texture,
 287                 wield_image = fence_texture,
 288                 tiles = {def.texture},
 289                 sunlight_propagates = true,
 290                 is_ground_content = false,
 291                 groups = {},
 292         }
 293         for k, v in pairs(default_fields) do
 294                 if not def[k] then
 295                         def[k] = v
 296                 end
 297         end
 298
 299         -- Always add to the fence group, even if no group provided
 300         def.groups.fence = 1
 301
 302         def.texture = nil
 303         def.material = nil
 304
 305         minetest.register_node(name, def)
 306 end
 307
 308
 309 --
 310 -- Leafdecay
 311 --
 312
 313 -- Prevent decay of placed leaves
 314
 315 default.after_place_leaves = function(pos, placer, itemstack, pointed_thing)
 316         if placer and not placer:get_player_control().sneak then
 317                 local node = minetest.get_node(pos)
 318                 node.param2 = 1
 319                 minetest.set_node(pos, node)
 320         end
 321 end
 322
 323 -- Leafdecay
 324 local function leafdecay_after_destruct(pos, oldnode, def)
 325         for _, v in pairs(minetest.find_nodes_in_area(vector.subtract(pos, def.radius),
 326                         vector.add(pos, def.radius), def.leaves)) do
 327                 local node = minetest.get_node(v)
 328                 local timer = minetest.get_node_timer(v)
 329                 if node.param2 == 0 and not timer:is_started() then
 330                         timer:start(math.random(20, 120) / 10)
 331                 end
 332         end
 333 end
 334
 335 local function leafdecay_on_timer(pos, def)
 336         if minetest.find_node_near(pos, def.radius, def.trunks) then
 337                 return false
 338         end
 339
 340         local node = minetest.get_node(pos)
 341         local drops = minetest.get_node_drops(node.name)
 342         for _, item in ipairs(drops) do
 343                 local is_leaf
 344                 for _, v in pairs(def.leaves) do
 345                         if v == item then
 346                                 is_leaf = true
 347                         end
 348                 end
 349                 if minetest.get_item_group(item, "leafdecay_drop") ~= 0 or
 350                                 not is_leaf then
 351                         minetest.add_item({
 352                                 x = pos.x - 0.5 + math.random(),
 353                                 y = pos.y - 0.5 + math.random(),
 354                                 z = pos.z - 0.5 + math.random(),
 355                         }, item)
 356                 end
 357         end
 358
 359         minetest.remove_node(pos)
 360         minetest.check_for_falling(pos)
 361 end
 362
 363 function default.register_leafdecay(def)
 364         assert(def.leaves)
 365         assert(def.trunks)
 366         assert(def.radius)
 367         for _, v in pairs(def.trunks) do
 368                 minetest.override_item(v, {
 369                         after_destruct = function(pos, oldnode)
 370                                 leafdecay_after_destruct(pos, oldnode, def)
 371                         end,
 372                 })
 373         end
 374         for _, v in pairs(def.leaves) do
 375                 minetest.override_item(v, {
 376                         on_timer = function(pos)
 377                                 leafdecay_on_timer(pos, def)
 378                         end,
 379                 })
 380         end
 381 end
 382
 383 --
 384 -- Convert dirt to something that fits the environment
 385 --
 386
 387 minetest.register_abm({
 388         label = "Grass spread",
 389         nodenames = {"default:dirt"},
 390         neighbors = {
 391                 "air",
 392                 "group:grass",
 393                 "group:dry_grass",
 394                 "default:snow",
 395         },
 396         interval = 6,
 397         chance = 50,
 398         catch_up = false,
 399         action = function(pos, node)
 400                 -- Check for darkness: night, shadow or under a light-blocking node
 401                 -- Returns if ignore above
 402                 local above = {x = pos.x, y = pos.y + 1, z = pos.z}
 403                 if (minetest.get_node_light(above) or 0) < 13 then
 404                         return
 405                 end
 406
 407                 -- Look for spreading dirt-type neighbours
 408                 local p2 = minetest.find_node_near(pos, 1, "group:spreading_dirt_type")
 409                 if p2 then
 410                         local n3 = minetest.get_node(p2)
 411                         minetest.set_node(pos, {name = n3.name})
 412                         return
 413                 end
 414
 415                 -- Else, any seeding nodes on top?
 416                 local name = minetest.get_node(above).name
 417                 -- Snow check is cheapest, so comes first
 418                 if name == "default:snow" then
 419                         minetest.set_node(pos, {name = "default:dirt_with_snow"})
 420                 -- Most likely case first
 421                 elseif minetest.get_item_group(name, "grass") ~= 0 then
 422                         minetest.set_node(pos, {name = "default:dirt_with_grass"})
 423                 elseif minetest.get_item_group(name, "dry_grass") ~= 0 then
 424                         minetest.set_node(pos, {name = "default:dirt_with_dry_grass"})
 425                 end
 426         end
 427 })
 428
 429
 430 --
 431 -- Grass and dry grass removed in darkness
 432 --
 433
 434 minetest.register_abm({
 435         label = "Grass covered",
 436         nodenames = {"group:spreading_dirt_type"},
 437         interval = 8,
 438         chance = 50,
 439         catch_up = false,
 440         action = function(pos, node)
 441                 local above = {x = pos.x, y = pos.y + 1, z = pos.z}
 442                 local name = minetest.get_node(above).name
 443                 local nodedef = minetest.registered_nodes[name]
 444                 if name ~= "ignore" and nodedef and not ((nodedef.sunlight_propagates or
 445                                 nodedef.paramtype == "light") and
 446                                 nodedef.liquidtype == "none") then
 447                         minetest.set_node(pos, {name = "default:dirt"})
 448                 end
 449         end
 450 })
 451
 452
 453 --
 454 -- Moss growth on cobble near water
 455 --
 456
 457 minetest.register_abm({
 458         label = "Moss growth",
 459         nodenames = {"default:cobble", "stairs:slab_cobble", "stairs:stair_cobble", "walls:cobble"},
 460         neighbors = {"group:water"},
 461         interval = 16,
 462         chance = 200,
 463         catch_up = false,
 464         action = function(pos, node)
 465                 if node.name == "default:cobble" then
 466                         minetest.set_node(pos, {name = "default:mossycobble"})
 467                 elseif node.name == "stairs:slab_cobble" then
 468                         minetest.set_node(pos, {name = "stairs:slab_mossycobble", param2 = node.param2})
 469                 elseif node.name == "stairs:stair_cobble" then
 470                         minetest.set_node(pos, {name = "stairs:stair_mossycobble", param2 = node.param2})
 471                 elseif node.name == "walls:cobble" then
 472                         minetest.set_node(pos, {name = "walls:mossycobble", param2 = node.param2})
 473                 end
 474         end
 475 })
 476
 477
 478 --
 479 -- Checks if specified volume intersects a protected volume
 480 --
 481
 482 function default.intersects_protection(minp, maxp, player_name, interval)
 483         -- 'interval' is the largest allowed interval for the 3D lattice of checks
 484
 485         -- Compute the optimal float step 'd' for each axis so that all corners and
 486         -- borders are checked. 'd' will be smaller or equal to 'interval'.
 487         -- Subtracting 1e-4 ensures that the max co-ordinate will be reached by the
 488         -- for loop (which might otherwise not be the case due to rounding errors).
 489         local d = {}
 490         for _, c in pairs({"x", "y", "z"}) do
 491                 if maxp[c] > minp[c] then
 492                         d[c] = (maxp[c] - minp[c]) / math.ceil((maxp[c] - minp[c]) / interval) - 1e-4
 493                 elseif maxp[c] == minp[c] then
 494                         d[c] = 1 -- Any value larger than 0 to avoid division by zero
 495                 else -- maxp[c] < minp[c], print error and treat as protection intersected
 496                         minetest.log("error", "maxp < minp in 'default.intersects_protection()'")
 497                         return true
 498                 end
 499         end
 500
 501         for zf = minp.z, maxp.z, d.z do
 502                 local z = math.floor(zf + 0.5)
 503                 for yf = minp.y, maxp.y, d.y do
 504                         local y = math.floor(yf + 0.5)
 505                         for xf = minp.x, maxp.x, d.x do
 506                                 local x = math.floor(xf + 0.5)
 507                                 if minetest.is_protected({x = x, y = y, z = z}, player_name) then
 508                                         return true
 509                                 end
 510                         end
 511                 end
 512         end
 513
 514         return false
 515 end
 516
 517
 518 --
 519 -- Coral death near air
 520 --
 521
 522 minetest.register_abm({
 523         nodenames = {"default:coral_brown", "default:coral_orange"},
 524         neighbors = {"air"},
 525         interval = 17,
 526         chance = 5,
 527         catch_up = false,
 528         action = function(pos, node)
 529                 minetest.set_node(pos, {name = "default:coral_skeleton"})
 530         end,
 531 })
 532
 533
 534 --
 535 -- NOTICE: This method is not an official part of the API yet!
 536 -- This method may change in future.
 537 --
 538
 539 function default.can_interact_with_node(player, pos)
 540         if player then
 541                 if minetest.check_player_privs(player, "protection_bypass") then
 542                         return true
 543                 end
 544         else
 545                 return false
 546         end
 547
 548         local meta = minetest.get_meta(pos)
 549         local owner = meta:get_string("owner")
 550
 551         if not owner or owner == "" or owner == player:get_player_name() then
 552                 return true
 553         end
 554
 555         -- is player wielding the right key?
 556         local item = player:get_wielded_item()
 557         if item:get_name() == "default:key" then
 558                 local key_meta = item:get_meta()
 559
 560                 if key_meta:get_string("secret") == "" then
 561                         local key_oldmeta = item:get_metadata()
 562                         if key_oldmeta == "" or not minetest.parse_json(key_oldmeta) then
 563                                 return false
 564                         end
 565
 566                         key_meta:set_string("secret", minetest.parse_json(key_oldmeta).secret)
 567                         item:set_metadata("")
 568                 end
 569
 570                 return meta:get_string("key_lock_secret") == key_meta:get_string("secret")
 571         end
 572
 573         return false
 574 end