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