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