mods/default/functions.lua

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