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