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 local fence_collision_extra = minetest.settings:get_bool("enable_fence_tall") and 3/8 or 0
 277
 278 function default.register_fence(name, def)
 279         minetest.register_craft({
 280                 output = name .. " 4",
 281                 recipe = {
 282                         { def.material, 'group:stick', def.material },
 283                         { def.material, 'group:stick', def.material },
 284                 }
 285         })
 286
 287         local fence_texture = "default_fence_overlay.png^" .. def.texture ..
 288                         "^default_fence_overlay.png^[makealpha:255,126,126"
 289         -- Allow almost everything to be overridden
 290         local default_fields = {
 291                 paramtype = "light",
 292                 drawtype = "nodebox",
 293                 node_box = {
 294                         type = "connected",
 295                         fixed = {-1/8, -1/2, -1/8, 1/8, 1/2, 1/8},
 296                         -- connect_top =
 297                         -- connect_bottom =
 298                         connect_front = {{-1/16,  3/16, -1/2,   1/16,  5/16, -1/8 },
 299                                          {-1/16, -5/16, -1/2,   1/16, -3/16, -1/8 }},
 300                         connect_left =  {{-1/2,   3/16, -1/16, -1/8,   5/16,  1/16},
 301                                          {-1/2,  -5/16, -1/16, -1/8,  -3/16,  1/16}},
 302                         connect_back =  {{-1/16,  3/16,  1/8,   1/16,  5/16,  1/2 },
 303                                          {-1/16, -5/16,  1/8,   1/16, -3/16,  1/2 }},
 304                         connect_right = {{ 1/8,   3/16, -1/16,  1/2,   5/16,  1/16},
 305                                          { 1/8,  -5/16, -1/16,  1/2,  -3/16,  1/16}}
 306                 },
 307                 collision_box = {
 308                         type = "connected",
 309                         fixed = {-1/8, -1/2, -1/8, 1/8, 1/2 + fence_collision_extra, 1/8},
 310                         -- connect_top =
 311                         -- connect_bottom =
 312                         connect_front = {-1/8, -1/2, -1/2,  1/8, 1/2 + fence_collision_extra, -1/8},
 313                         connect_left =  {-1/2, -1/2, -1/8, -1/8, 1/2 + fence_collision_extra,  1/8},
 314                         connect_back =  {-1/8, -1/2,  1/8,  1/8, 1/2 + fence_collision_extra,  1/2},
 315                         connect_right = { 1/8, -1/2, -1/8,  1/2, 1/2 + fence_collision_extra,  1/8}
 316                 },
 317                 connects_to = {"group:fence", "group:wood", "group:tree", "group:wall"},
 318                 inventory_image = fence_texture,
 319                 wield_image = fence_texture,
 320                 tiles = {def.texture},
 321                 sunlight_propagates = true,
 322                 is_ground_content = false,
 323                 groups = {},
 324         }
 325         for k, v in pairs(default_fields) do
 326                 if def[k] == nil then
 327                         def[k] = v
 328                 end
 329         end
 330
 331         -- Always add to the fence group, even if no group provided
 332         def.groups.fence = 1
 333
 334         def.texture = nil
 335         def.material = nil
 336
 337         minetest.register_node(name, def)
 338 end
 339
 340
 341 --
 342 -- Fence rail registration helper
 343 --
 344
 345 function default.register_fence_rail(name, def)
 346         minetest.register_craft({
 347                 output = name .. " 16",
 348                 recipe = {
 349                         { def.material, def.material },
 350                         { "", ""},
 351                         { def.material, def.material },
 352                 }
 353         })
 354
 355         local fence_rail_texture = "default_fence_rail_overlay.png^" .. def.texture ..
 356                         "^default_fence_rail_overlay.png^[makealpha:255,126,126"
 357         -- Allow almost everything to be overridden
 358         local default_fields = {
 359                 paramtype = "light",
 360                 drawtype = "nodebox",
 361                 node_box = {
 362                         type = "connected",
 363                         fixed = {{-1/16,  3/16, -1/16, 1/16,  5/16, 1/16},
 364                                  {-1/16, -3/16, -1/16, 1/16, -5/16, 1/16}},
 365                         -- connect_top =
 366                         -- connect_bottom =
 367                         connect_front = {{-1/16,  3/16, -1/2,   1/16,  5/16, -1/16},
 368                                          {-1/16, -5/16, -1/2,   1/16, -3/16, -1/16}},
 369                         connect_left =  {{-1/2,   3/16, -1/16, -1/16,  5/16,  1/16},
 370                                          {-1/2,  -5/16, -1/16, -1/16, -3/16,  1/16}},
 371                         connect_back =  {{-1/16,  3/16,  1/16,  1/16,  5/16,  1/2 },
 372                                          {-1/16, -5/16,  1/16,  1/16, -3/16,  1/2 }},
 373                         connect_right = {{ 1/16,  3/16, -1/16,  1/2,   5/16,  1/16},
 374                                          { 1/16, -5/16, -1/16,  1/2,  -3/16,  1/16}}
 375                 },
 376                 collision_box = {
 377                         type = "connected",
 378                         fixed = {-1/8, -1/2, -1/8, 1/8, 1/2 + fence_collision_extra, 1/8},
 379                         -- connect_top =
 380                         -- connect_bottom =
 381                         connect_front = {-1/8, -1/2, -1/2,  1/8, 1/2 + fence_collision_extra, -1/8},
 382                         connect_left =  {-1/2, -1/2, -1/8, -1/8, 1/2 + fence_collision_extra,  1/8},
 383                         connect_back =  {-1/8, -1/2,  1/8,  1/8, 1/2 + fence_collision_extra,  1/2},
 384                         connect_right = { 1/8, -1/2, -1/8,  1/2, 1/2 + fence_collision_extra,  1/8}
 385                 },
 386                 connects_to = {"group:fence", "group:wall"},
 387                 inventory_image = fence_rail_texture,
 388                 wield_image = fence_rail_texture,
 389                 tiles = {def.texture},
 390                 sunlight_propagates = true,
 391                 is_ground_content = false,
 392                 groups = {},
 393         }
 394         for k, v in pairs(default_fields) do
 395                 if def[k] == nil then
 396                         def[k] = v
 397                 end
 398         end
 399
 400         -- Always add to the fence group, even if no group provided
 401         def.groups.fence = 1
 402
 403         def.texture = nil
 404         def.material = nil
 405
 406         minetest.register_node(name, def)
 407 end
 408
 409
 410 --
 411 -- Leafdecay
 412 --
 413
 414 -- Prevent decay of placed leaves
 415
 416 default.after_place_leaves = function(pos, placer, itemstack, pointed_thing)
 417         if placer and placer:is_player() then
 418                 local node = minetest.get_node(pos)
 419                 node.param2 = 1
 420                 minetest.set_node(pos, node)
 421         end
 422 end
 423
 424 -- Leafdecay
 425 local function leafdecay_after_destruct(pos, oldnode, def)
 426         for _, v in pairs(minetest.find_nodes_in_area(vector.subtract(pos, def.radius),
 427                         vector.add(pos, def.radius), def.leaves)) do
 428                 local node = minetest.get_node(v)
 429                 local timer = minetest.get_node_timer(v)
 430                 if node.param2 ~= 1 and not timer:is_started() then
 431                         timer:start(math.random(20, 120) / 10)
 432                 end
 433         end
 434 end
 435
 436 local function leafdecay_on_timer(pos, def)
 437         if minetest.find_node_near(pos, def.radius, def.trunks) then
 438                 return false
 439         end
 440
 441         local node = minetest.get_node(pos)
 442         local drops = minetest.get_node_drops(node.name)
 443         for _, item in ipairs(drops) do
 444                 local is_leaf
 445                 for _, v in pairs(def.leaves) do
 446                         if v == item then
 447                                 is_leaf = true
 448                         end
 449                 end
 450                 if minetest.get_item_group(item, "leafdecay_drop") ~= 0 or
 451                                 not is_leaf then
 452                         minetest.add_item({
 453                                 x = pos.x - 0.5 + math.random(),
 454                                 y = pos.y - 0.5 + math.random(),
 455                                 z = pos.z - 0.5 + math.random(),
 456                         }, item)
 457                 end
 458         end
 459
 460         minetest.remove_node(pos)
 461         minetest.check_for_falling(pos)
 462 end
 463
 464 function default.register_leafdecay(def)
 465         assert(def.leaves)
 466         assert(def.trunks)
 467         assert(def.radius)
 468         for _, v in pairs(def.trunks) do
 469                 minetest.override_item(v, {
 470                         after_destruct = function(pos, oldnode)
 471                                 leafdecay_after_destruct(pos, oldnode, def)
 472                         end,
 473                 })
 474         end
 475         for _, v in pairs(def.leaves) do
 476                 minetest.override_item(v, {
 477                         on_timer = function(pos)
 478                                 leafdecay_on_timer(pos, def)
 479                         end,
 480                 })
 481         end
 482 end
 483
 484
 485 --
 486 -- Convert dirt to something that fits the environment
 487 --
 488
 489 minetest.register_abm({
 490         label = "Grass spread",
 491         nodenames = {"default:dirt"},
 492         neighbors = {
 493                 "air",
 494                 "group:grass",
 495                 "default:snow",
 496         },
 497         interval = 6,
 498         chance = 50,
 499         catch_up = false,
 500         action = function(pos, node)
 501                 -- Check for darkness: night, shadow or under a light-blocking node
 502                 -- Returns if ignore above
 503                 local above = {x = pos.x, y = pos.y + 1, z = pos.z}
 504                 if (minetest.get_node_light(above) or 0) < 13 then
 505                         return
 506                 end
 507
 508                 -- Look for spreading dirt-type neighbours
 509                 local p2 = minetest.find_node_near(pos, 1, "group:spreading_dirt_type")
 510                 if p2 then
 511                         local n3 = minetest.get_node(p2)
 512                         minetest.set_node(pos, {name = n3.name})
 513                         return
 514                 end
 515
 516                 -- Else, any seeding nodes on top?
 517                 local name = minetest.get_node(above).name
 518                 -- Snow check is cheapest, so comes first
 519                 if name == "default:snow" then
 520                         minetest.set_node(pos, {name = "default:dirt_with_snow"})
 521                 elseif minetest.get_item_group(name, "grass") ~= 0 then
 522                         minetest.set_node(pos, {name = "default:dirt_with_grass"})
 523                 end
 524         end
 525 })
 526
 527
 528 --
 529 -- Grass and dry grass removed in darkness
 530 --
 531
 532 minetest.register_abm({
 533         label = "Grass covered",
 534         nodenames = {"group:spreading_dirt_type", "default:dry_dirt_with_dry_grass"},
 535         interval = 8,
 536         chance = 50,
 537         catch_up = false,
 538         action = function(pos, node)
 539                 local above = {x = pos.x, y = pos.y + 1, z = pos.z}
 540                 local name = minetest.get_node(above).name
 541                 local nodedef = minetest.registered_nodes[name]
 542                 if name ~= "ignore" and nodedef and not ((nodedef.sunlight_propagates or
 543                                 nodedef.paramtype == "light") and
 544                                 nodedef.liquidtype == "none") then
 545                         if node.name == "default:dry_dirt_with_dry_grass" then
 546                                 minetest.set_node(pos, {name = "default:dry_dirt"})
 547                         else
 548                                 minetest.set_node(pos, {name = "default:dirt"})
 549                         end
 550                 end
 551         end
 552 })
 553
 554
 555 --
 556 -- Moss growth on cobble near water
 557 --
 558
 559 local moss_correspondences = {
 560         ["default:cobble"] = "default:mossycobble",
 561         ["stairs:slab_cobble"] = "stairs:slab_mossycobble",
 562         ["stairs:stair_cobble"] = "stairs:stair_mossycobble",
 563         ["stairs:stair_inner_cobble"] = "stairs:stair_inner_mossycobble",
 564         ["stairs:stair_outer_cobble"] = "stairs:stair_outer_mossycobble",
 565         ["walls:cobble"] = "walls:mossycobble",
 566 }
 567 minetest.register_abm({
 568         label = "Moss growth",
 569         nodenames = {"default:cobble", "stairs:slab_cobble", "stairs:stair_cobble",
 570                 "stairs:stair_inner_cobble", "stairs:stair_outer_cobble",
 571                 "walls:cobble"},
 572         neighbors = {"group:water"},
 573         interval = 16,
 574         chance = 200,
 575         catch_up = false,
 576         action = function(pos, node)
 577                 node.name = moss_correspondences[node.name]
 578                 if node.name then
 579                         minetest.set_node(pos, node)
 580                 end
 581         end
 582 })
 583
 584 --
 585 -- Register a craft to copy the metadata of items
 586 --
 587
 588 function default.register_craft_metadata_copy(ingredient, result)
 589         minetest.register_craft({
 590                 type = "shapeless",
 591                 output = result,
 592                 recipe = {ingredient, result}
 593         })
 594
 595         minetest.register_on_craft(function(itemstack, player, old_craft_grid, craft_inv)
 596                 if itemstack:get_name() ~= result then
 597                         return
 598                 end
 599
 600                 local original
 601                 local index
 602                 for i = 1, #old_craft_grid do
 603                         if old_craft_grid[i]:get_name() == result then
 604                                 original = old_craft_grid[i]
 605                                 index = i
 606                         end
 607                 end
 608                 if not original then
 609                         return
 610                 end
 611                 local copymeta = original:get_meta():to_table()
 612                 itemstack:get_meta():from_table(copymeta)
 613                 -- put the book with metadata back in the craft grid
 614                 craft_inv:set_stack("craft", index, original)
 615         end)
 616 end
 617
 618
 619 --
 620 -- NOTICE: This method is not an official part of the API yet.
 621 -- This method may change in future.
 622 --
 623
 624 function default.can_interact_with_node(player, pos)
 625         if player and player:is_player() then
 626                 if minetest.check_player_privs(player, "protection_bypass") then
 627                         return true
 628                 end
 629         else
 630                 return false
 631         end
 632
 633         local meta = minetest.get_meta(pos)
 634         local owner = meta:get_string("owner")
 635
 636         if not owner or owner == "" or owner == player:get_player_name() then
 637                 return true
 638         end
 639
 640         -- Is player wielding the right key?
 641         local item = player:get_wielded_item()
 642         if item:get_name() == "default:key" then
 643                 local key_meta = item:get_meta()
 644
 645                 if key_meta:get_string("secret") == "" then
 646                         local key_oldmeta = item:get_metadata()
 647                         if key_oldmeta == "" or not minetest.parse_json(key_oldmeta) then
 648                                 return false
 649                         end
 650
 651                         key_meta:set_string("secret", minetest.parse_json(key_oldmeta).secret)
 652                         item:set_metadata("")
 653                 end
 654
 655                 return meta:get_string("key_lock_secret") == key_meta:get_string("secret")
 656         end
 657
 658         return false
 659 end