Clean up door tops if fire destroys bottom.
[oweals/minetest_game.git] / mods / doors / init.lua
1
2 --[[
3
4 Copyright (C) 2012 PilzAdam
5   modified by BlockMen (added sounds, glassdoors[glass, obsidian glass], trapdoor)
6 Copyright (C) 2015 - Auke Kok <sofar@foo-projects.org>
7
8 --]]
9
10 -- our API object
11 doors = {}
12
13 -- private data
14 local _doors = {}
15 _doors.registered_doors = {}
16 _doors.registered_trapdoors = {}
17
18 -- returns an object to a door object or nil
19 function doors.get(pos)
20         if _doors.registered_doors[minetest.get_node(pos).name] then
21                 -- A normal upright door
22                 return {
23                         pos = pos,
24                         open = function(self, player)
25                                 if self:state() then
26                                         return false
27                                 end
28                                 return _doors.door_toggle(self.pos, player)
29                         end,
30                         close = function(self, player)
31                                 if not self:state() then
32                                         return false
33                                 end
34                                 return _doors.door_toggle(self.pos, player)
35                         end,
36                         toggle = function(self, player)
37                                 return _doors.door_toggle(self.pos, player)
38                         end,
39                         state = function(self)
40                                 local state = minetest.get_meta(self.pos):get_int("state")
41                                 return state %2 == 1
42                         end
43                 }
44         elseif _doors.registered_trapdoors[minetest.get_node(pos).name] then
45                 -- A trapdoor
46                 return {
47                         pos = pos,
48                         open = function(self, player)
49                                 if self:state() then
50                                         return false
51                                 end
52                                 return _doors.trapdoor_toggle(self.pos, player)
53                         end,
54                         close = function(self, player)
55                                 if not self:state() then
56                                         return false
57                                 end
58                                 return _doors.trapdoor_toggle(self.pos, player)
59                         end,
60                         toggle = function(self, player)
61                                 return _doors.trapdoor_toggle(self.pos, player)
62                         end,
63                         state = function(self)
64                                 local name = minetest.get_node(pos).name
65                                 return name:sub(-5) == "_open"
66                         end
67                 }
68         else
69                 return nil
70         end
71 end
72
73 -- this hidden node is placed on top of the bottom, and prevents
74 -- nodes from being placed in the top half of the door.
75 minetest.register_node("doors:hidden", {
76         description = "Hidden Door Segment",
77         drawtype = "airlike",
78         paramtype = "light",
79         sunlight_propagates = true,
80         walkable = false,
81         pointable = false,
82         diggable = false,
83         buildable_to = false,
84         floodable = false,
85         drop = "",
86         groups = { not_in_creative_inventory = 1 },
87         on_blast = function() end
88 })
89
90 -- table used to aid door opening/closing
91 local transform = {
92         {
93                 { v = "_a", param2 = 3 },
94                 { v = "_a", param2 = 0 },
95                 { v = "_a", param2 = 1 },
96                 { v = "_a", param2 = 2 },
97         },
98         {
99                 { v = "_b", param2 = 1 },
100                 { v = "_b", param2 = 2 },
101                 { v = "_b", param2 = 3 },
102                 { v = "_b", param2 = 0 },
103         },
104         {
105                 { v = "_b", param2 = 1 },
106                 { v = "_b", param2 = 2 },
107                 { v = "_b", param2 = 3 },
108                 { v = "_b", param2 = 0 },
109         },
110         {
111                 { v = "_a", param2 = 3 },
112                 { v = "_a", param2 = 0 },
113                 { v = "_a", param2 = 1 },
114                 { v = "_a", param2 = 2 },
115         },
116 }
117
118 function _doors.door_toggle(pos, clicker)
119         local meta = minetest.get_meta(pos)
120         local state = meta:get_int("state")
121         local def = minetest.registered_nodes[minetest.get_node(pos).name]
122         local name = def.door.name
123
124         if clicker and not minetest.check_player_privs(clicker, "protection_bypass") then
125                 local owner = meta:get_string("doors_owner")
126                 if owner ~= "" then
127                         if clicker:get_player_name() ~= owner then
128                                 return false
129                         end
130                 end
131         end
132
133         local old = state
134         -- until Lua-5.2 we have no bitwise operators :(
135         if state % 2 == 1 then
136                 state = state - 1
137         else
138                 state = state + 1
139         end
140
141         local dir = minetest.get_node(pos).param2
142         if state % 2 == 0 then
143                 minetest.sound_play(def.door.sounds[1], {pos = pos, gain = 0.3, max_hear_distance = 10})
144         else
145                 minetest.sound_play(def.door.sounds[2], {pos = pos, gain = 0.3, max_hear_distance = 10})
146         end
147
148         minetest.swap_node(pos, {
149                 name = name .. transform[state + 1][dir+1].v,
150                 param2 = transform[state + 1][dir+1].param2
151         })
152         meta:set_int("state", state)
153
154         return true
155 end
156
157
158 local function on_place_node(place_to, newnode, placer, oldnode, itemstack, pointed_thing)
159         -- Run script hook
160         local _, callback
161         for _, callback in ipairs(core.registered_on_placenodes) do
162                 -- Deepcopy pos, node and pointed_thing because callback can modify them
163                 local place_to_copy = {x = place_to.x, y = place_to.y, z = place_to.z}
164                 local newnode_copy = {name = newnode.name, param1 = newnode.param1, param2 = newnode.param2}
165                 local oldnode_copy = {name = oldnode.name, param1 = oldnode.param1, param2 = oldnode.param2}
166                 local pointed_thing_copy = {
167                         type  = pointed_thing.type,
168                         above = vector.new(pointed_thing.above),
169                         under = vector.new(pointed_thing.under),
170                         ref   = pointed_thing.ref,
171                 }
172                 callback(place_to_copy, newnode_copy, placer, oldnode_copy, itemstack, pointed_thing_copy)
173         end
174 end
175
176 function doors.register(name, def)
177         if not name:find(":") then
178                 name = "doors:" .. name
179         end
180
181         -- replace old doors of this type automatically
182         minetest.register_abm({
183                 nodenames = {name.."_b_1", name.."_b_2"},
184                 interval = 7.0,
185                 chance = 1,
186                 action = function(pos, node, active_object_count, active_object_count_wider)
187                         local l = tonumber(node.name:sub(-1))
188                         local meta = minetest.get_meta(pos)
189                         local h = meta:get_int("right") + 1
190                         local p2 = node.param2
191                         local replace = {
192                                 { { type = "a", state = 0 }, { type = "a", state = 3 } },
193                                 { { type = "b", state = 1 }, { type = "b", state = 2 } }
194                         }
195                         local new = replace[l][h]
196                         -- retain infotext and doors_owner fields
197                         minetest.swap_node(pos, {name = name .. "_" .. new.type, param2 = p2})
198                         meta:set_int("state", new.state)
199                         -- wipe meta on top node as it's unused
200                         minetest.set_node({x = pos.x, y = pos.y + 1, z = pos.z}, { name = "doors:hidden" })
201                 end
202         })
203
204         minetest.register_craftitem(":" .. name, {
205                 description = def.description,
206                 inventory_image = def.inventory_image,
207
208                 on_place = function(itemstack, placer, pointed_thing)
209                         local pos = nil
210
211                         if not pointed_thing.type == "node" then
212                                 return itemstack
213                         end
214
215                         local node = minetest.get_node(pointed_thing.under)
216                         local pdef = minetest.registered_nodes[node.name]
217                         if pdef and pdef.on_rightclick then
218                                 return pdef.on_rightclick(pointed_thing.under,
219                                                 node, placer, itemstack)
220                         end
221
222                         if pdef and pdef.buildable_to then
223                                 pos = pointed_thing.under
224                         else
225                                 pos = pointed_thing.above
226                                 node = minetest.get_node(pos)
227                                 pdef = minetest.registered_nodes[node.name]
228                                 if not pdef or not pdef.buildable_to then
229                                         return itemstack
230                                 end
231                         end
232
233                         local above = { x = pos.x, y = pos.y + 1, z = pos.z }
234                         if not minetest.registered_nodes[minetest.get_node(above).name].buildable_to then
235                                 return itemstack
236                         end
237
238                         local pn = placer:get_player_name()
239                         if minetest.is_protected(pos, pn) or minetest.is_protected(above, pn) then
240                                 return itemstack
241                         end
242
243                         local dir = minetest.dir_to_facedir(placer:get_look_dir())
244
245                         local ref = {
246                                 { x = -1, y = 0, z = 0 },
247                                 { x = 0, y = 0, z = 1 },
248                                 { x = 1, y = 0, z = 0 },
249                                 { x = 0, y = 0, z = -1 },
250                         }
251
252                         local aside = {
253                                 x = pos.x + ref[dir + 1].x,
254                                 y = pos.y + ref[dir + 1].y,
255                                 z = pos.z + ref[dir + 1].z,
256                         }
257
258                         local state = 0
259                         if minetest.get_item_group(minetest.get_node(aside).name, "door") == 1 then
260                                 state = state + 2
261                                 minetest.set_node(pos, {name = name .. "_b", param2 = dir})
262                         else
263                                 minetest.set_node(pos, {name = name .. "_a", param2 = dir})
264                         end
265                         minetest.set_node(above, { name = "doors:hidden" })
266
267                         local meta = minetest.get_meta(pos)
268                         meta:set_int("state", state)
269
270                         if def.protected then
271                                 local pn = placer:get_player_name()
272                                 meta:set_string("doors_owner", pn)
273                                 meta:set_string("infotext", "Owned by " .. pn)
274                         end
275
276                         if not minetest.setting_getbool("creative_mode") then
277                                 itemstack:take_item()
278                         end
279
280                         on_place_node(pos, minetest.get_node(pos), placer, node, itemstack, pointed_thing)
281
282                         return itemstack
283                 end
284         })
285
286         local can_dig = function(pos, digger)
287                 if not def.protected then
288                         return true
289                 end
290                 local meta = minetest.get_meta(pos)
291                 local name = ""
292                 if digger then
293                         name = digger:get_player_name()
294                 end
295                 return meta:get_string("doors_owner") == name
296         end
297
298         if not def.sounds then
299                 def.sounds = default.node_sound_wood_defaults()
300         end
301
302         if not def.sound_open then
303                 def.sound_open = "doors_door_open"
304         end
305
306         if not def.sound_close then
307                 def.sound_close = "doors_door_close"
308         end
309
310         def.groups.not_in_creative_inventory = 1
311         def.groups.door = 1
312         def.drop = name
313         def.door = {
314                 name = name,
315                 sounds = { def.sound_close, def.sound_open },
316         }
317
318         def.on_rightclick = function(pos, node, clicker)
319                 _doors.door_toggle(pos, clicker)
320         end
321         def.after_dig_node = function(pos, node, meta, digger)
322                 minetest.remove_node({ x = pos.x, y = pos.y + 1, z = pos.z})
323         end
324         def.can_dig = function(pos, player)
325                 return can_dig(pos, player)
326         end
327         def.on_rotate = function(pos, node, user, mode, new_param2)
328                 return false
329         end
330
331         if def.protected then
332                 def.on_blast = function() end
333         else
334                 def.on_blast = function(pos, intensity)
335                         minetest.remove_node(pos)
336                         -- hidden node doesn't get blasted away.
337                         minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
338                         return {name}
339                 end
340         end
341
342         def.on_destruct = function(pos)
343                 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
344         end
345
346         minetest.register_node(":" .. name .. "_a", {
347                 description = def.description,
348                 visual = "mesh",
349                 mesh = "door_a.obj",
350                 tiles = def.tiles,
351                 drawtype = "mesh",
352                 paramtype = "light",
353                 paramtype2 = "facedir",
354                 sunlight_propagates = true,
355                 use_texture_alpha = true,
356                 walkable = true,
357                 is_ground_content = false,
358                 buildable_to = false,
359                 drop = def.drop,
360                 groups = def.groups,
361                 sounds = def.sounds,
362                 door = def.door,
363                 on_rightclick = def.on_rightclick,
364                 after_dig_node = def.after_dig_node,
365                 can_dig = def.can_dig,
366                 on_rotate = def.on_rotate,
367                 on_blast = def.on_blast,
368                 on_destruct = def.on_destruct,
369                 selection_box = {
370                         type = "fixed",
371                         fixed = { -1/2,-1/2,-1/2,1/2,3/2,-6/16}
372                 },
373                 collision_box = {
374                         type = "fixed",
375                         fixed = { -1/2,-1/2,-1/2,1/2,3/2,-6/16}
376                 },
377         })
378
379         minetest.register_node(":" .. name .. "_b", {
380                 description = def.description,
381                 visual = "mesh",
382                 mesh = "door_b.obj",
383                 tiles = def.tiles,
384                 drawtype = "mesh",
385                 paramtype = "light",
386                 paramtype2 = "facedir",
387                 sunlight_propagates = true,
388                 use_texture_alpha = true,
389                 walkable = true,
390                 is_ground_content = false,
391                 buildable_to = false,
392                 drop = def.drop,
393                 groups = def.groups,
394                 sounds = def.sounds,
395                 door = def.door,
396                 on_rightclick = def.on_rightclick,
397                 after_dig_node = def.after_dig_node,
398                 can_dig = def.can_dig,
399                 on_rotate = def.on_rotate,
400                 on_blast = def.on_blast,
401                 on_destruct = def.on_destruct,
402                 selection_box = {
403                         type = "fixed",
404                         fixed = { -1/2,-1/2,-1/2,1/2,3/2,-6/16}
405                 },
406                 collision_box = {
407                         type = "fixed",
408                         fixed = { -1/2,-1/2,-1/2,1/2,3/2,-6/16}
409                 },
410         })
411
412         if def.recipe then
413                 minetest.register_craft({
414                         output = name,
415                         recipe = def.recipe,
416                 })
417         end
418
419         _doors.registered_doors[name .. "_a"] = true
420         _doors.registered_doors[name .. "_b"] = true
421 end
422
423 doors.register("door_wood", {
424                 tiles = {{ name = "doors_door_wood.png", backface_culling = true }},
425                 description = "Wooden Door",
426                 inventory_image = "doors_item_wood.png",
427                 groups = { snappy = 1, choppy = 2, oddly_breakable_by_hand = 2, flammable = 2 },
428                 recipe = {
429                         {"group:wood", "group:wood"},
430                         {"group:wood", "group:wood"},
431                         {"group:wood", "group:wood"},
432                 }
433 })
434
435 doors.register("door_steel", {
436                 tiles = {{ name = "doors_door_steel.png", backface_culling = true }},
437                 description = "Steel Door",
438                 inventory_image = "doors_item_steel.png",
439                 protected = true,
440                 groups = { snappy = 1, bendy = 2, cracky = 1, melty = 2, level = 2 },
441                 recipe = {
442                         {"default:steel_ingot", "default:steel_ingot"},
443                         {"default:steel_ingot", "default:steel_ingot"},
444                         {"default:steel_ingot", "default:steel_ingot"},
445                 }
446 })
447
448 doors.register("door_glass", {
449                 tiles = { "doors_door_glass.png"},
450                 description = "Glass Door",
451                 inventory_image = "doors_item_glass.png",
452                 groups = { snappy=1, cracky=1, oddly_breakable_by_hand=3 },
453                 sounds = default.node_sound_glass_defaults(),
454                 recipe = {
455                         {"default:glass", "default:glass"},
456                         {"default:glass", "default:glass"},
457                         {"default:glass", "default:glass"},
458                 }
459 })
460
461 doors.register("door_obsidian_glass", {
462                 tiles = { "doors_door_obsidian_glass.png" },
463                 description = "Glass Door",
464                 inventory_image = "doors_item_obsidian_glass.png",
465                 groups = { snappy=1, cracky=1, oddly_breakable_by_hand=3 },
466                 sounds = default.node_sound_glass_defaults(),
467                 recipe = {
468                         {"default:obsidian_glass", "default:obsidian_glass"},
469                         {"default:obsidian_glass", "default:obsidian_glass"},
470                         {"default:obsidian_glass", "default:obsidian_glass"},
471                 },
472 })
473
474 -- Capture mods using the old API as best as possible.
475 function doors.register_door(name, def)
476         if def.only_placer_can_open then
477                 def.protected = true
478         end
479         def.only_placer_can_open = nil
480
481         local i = name:find(":")
482         local modname = name:sub(1, i - 1)
483         if not def.tiles then
484                 if def.protected then
485                         def.tiles = {{name = "doors_door_steel.png", backface_culling = true}}
486                 else
487                         def.tiles = {{name = "doors_door_wood.png", backface_culling = true}}
488                 end
489                 minetest.log("warning", modname .. " registered door \"" .. name .. "\" " ..
490                                 "using deprecated API method \"doors.register_door()\" but " ..
491                                 "did not provide the \"tiles\" parameter. A fallback tiledef " ..
492                                 "will be used instead.")
493         end
494
495         doors.register(name, def)
496 end
497
498 ----trapdoor----
499
500 function _doors.trapdoor_toggle(pos, clicker)
501         if clicker and not minetest.check_player_privs(clicker, "protection_bypass") then
502                 local meta = minetest.get_meta(pos)
503                 local owner = meta:get_string("doors_owner")
504                 if owner ~= "" then
505                         if clicker:get_player_name() ~= owner then
506                                 return false
507                         end
508                 end
509         end
510
511         local node = minetest.get_node(pos)
512         local def = minetest.registered_nodes[node.name]
513
514         if string.sub(node.name, -5) == "_open" then
515                 minetest.sound_play(def.sound_close, {pos = pos, gain = 0.3, max_hear_distance = 10})
516                 minetest.swap_node(pos, {name = string.sub(node.name, 1, string.len(node.name) - 5), param1 = node.param1, param2 = node.param2})
517         else
518                 minetest.sound_play(def.sound_open, {pos = pos, gain = 0.3, max_hear_distance = 10})
519                 minetest.swap_node(pos, {name = node.name .. "_open", param1 = node.param1, param2 = node.param2})
520         end
521 end
522
523 function doors.register_trapdoor(name, def)
524         local name_closed = name
525         local name_opened = name.."_open"
526
527         local function check_player_priv(pos, player)
528                 if not def.protected or minetest.check_player_privs(player, "protection_bypass") then
529                         return true
530                 end
531                 local meta = minetest.get_meta(pos)
532                 local pn = player:get_player_name()
533                 return meta:get_string("doors_owner") == pn
534         end
535
536         def.on_rightclick = function(pos, node, clicker)
537                 _doors.trapdoor_toggle(pos, clicker)
538         end
539
540         -- Common trapdoor configuration
541         def.drawtype = "nodebox"
542         def.paramtype = "light"
543         def.paramtype2 = "facedir"
544         def.is_ground_content = false
545         def.can_dig = check_player_priv
546
547         if def.protected then
548                 def.after_place_node = function(pos, placer, itemstack, pointed_thing)
549                         local pn = placer:get_player_name()
550                         local meta = minetest.get_meta(pos)
551                         meta:set_string("doors_owner", pn)
552                         meta:set_string("infotext", "Owned by "..pn)
553
554                         return minetest.setting_getbool("creative_mode")
555                 end
556
557                 def.on_blast = function() end
558         else
559                 def.on_blast = function(pos, intensity)
560                         minetest.remove_node(pos)
561                         minetest.remove_node({ x = pos.x, y = pos.y + 1, z = pos.z})
562                         return { name }
563                 end
564         end
565
566         if not def.sounds then
567                 def.sounds = default.node_sound_wood_defaults()
568         end
569
570         if not def.sound_open then
571                 def.sound_open = "doors_door_open"
572         end
573
574         if not def.sound_close then
575                 def.sound_close = "doors_door_close"
576         end
577
578         local def_opened = table.copy(def)
579         local def_closed = table.copy(def)
580
581         def_closed.node_box = {
582                 type = "fixed",
583                 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
584         }
585         def_closed.selection_box = {
586                 type = "fixed",
587                 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
588         }
589         def_closed.tiles = { def.tile_front, def.tile_front, def.tile_side, def.tile_side,
590                 def.tile_side, def.tile_side }
591
592         def_opened.node_box = {
593                 type = "fixed",
594                 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
595         }
596         def_opened.selection_box = {
597                 type = "fixed",
598                 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
599         }
600         def_opened.tiles = { def.tile_side, def.tile_side,
601                         def.tile_side .. '^[transform3',
602                         def.tile_side .. '^[transform1',
603                         def.tile_front, def.tile_front }
604
605         def_opened.drop = name_closed
606         def_opened.groups.not_in_creative_inventory = 1
607
608         minetest.register_node(name_opened, def_opened)
609         minetest.register_node(name_closed, def_closed)
610
611         _doors.registered_trapdoors[name_opened] = true
612         _doors.registered_trapdoors[name_closed] = true
613 end
614
615 doors.register_trapdoor("doors:trapdoor", {
616         description = "Trapdoor",
617         inventory_image = "doors_trapdoor.png",
618         wield_image = "doors_trapdoor.png",
619         tile_front = "doors_trapdoor.png",
620         tile_side = "doors_trapdoor_side.png",
621         groups = {snappy=1, choppy=2, oddly_breakable_by_hand=2, flammable=2, door=1},
622 })
623
624 doors.register_trapdoor("doors:trapdoor_steel", {
625         description = "Steel Trapdoor",
626         inventory_image = "doors_trapdoor_steel.png",
627         wield_image = "doors_trapdoor_steel.png",
628         tile_front = "doors_trapdoor_steel.png",
629         tile_side = "doors_trapdoor_steel_side.png",
630         protected = true,
631         groups = {snappy=1, bendy=2, cracky=1, melty=2, level=2, door=1},
632 })
633
634 minetest.register_craft({
635         output = 'doors:trapdoor 2',
636         recipe = {
637                 {'group:wood', 'group:wood', 'group:wood'},
638                 {'group:wood', 'group:wood', 'group:wood'},
639                 {'', '', ''},
640         }
641 })
642
643 minetest.register_craft({
644         output = 'doors:trapdoor_steel',
645         recipe = {
646                 {'default:steel_ingot', 'default:steel_ingot'},
647                 {'default:steel_ingot', 'default:steel_ingot'},
648         }
649 })
650
651
652 ----fence gate----
653
654 local fence = {
655         description = "Fence Gate",
656         drawtype = "mesh",
657         tiles = {"default_wood.png"},
658         paramtype = "light",
659         paramtype2 = "facedir",
660         sunlight_propagates = true,
661         is_ground_content = false,
662         drop = "doors:gate_closed",
663         connect_sides = { "left", "right" },
664         groups = {snappy = 1, choppy = 2, oddly_breakable_by_hand = 2,
665                 flammable = 2, fence = 1},
666         on_rightclick = function(pos, clicker)
667                 local node = minetest.get_node(pos)
668                 local def = minetest.registered_nodes[node.name]
669                 minetest.swap_node(pos, {name = def.gate, param2 = node.param2})
670                 minetest.sound_play(def.sound, {pos = pos, gain = 0.3,
671                         max_hear_distance = 8})
672         end,
673         selection_box = {
674                 type = "fixed",
675                 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
676         },
677 }
678
679 local fence_closed = table.copy(fence)
680 fence_closed.mesh = "doors_fencegate_closed.obj"
681 fence_closed.gate = "doors:gate_open"
682 fence_closed.sound = "doors_fencegate_open"
683 fence_closed.collision_box = {
684         type = "fixed",
685         fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
686 }
687
688 local fence_open = table.copy(fence)
689 fence_open.mesh = "doors_fencegate_open.obj"
690 fence_open.gate = "doors:gate_closed"
691 fence_open.sound = "doors_fencegate_close"
692 fence_open.groups.not_in_creative_inventory = 1
693 fence_open.collision_box = {
694         type = "fixed",
695         fixed = {{-1/2, -1/2, -1/4, -3/8, 1/2, 1/4},
696                 {-5/8, -3/8, -14/16, -3/8, 3/8, 0}},
697 }
698
699 minetest.register_node("doors:gate_closed", fence_closed)
700 minetest.register_node("doors:gate_open", fence_open)
701
702 minetest.register_craft({
703         output = "doors:gate_closed",
704         recipe = {
705                 {"default:stick", "group:wood", "default:stick"},
706                 {"default:stick", "group:wood", "default:stick"},
707         },
708 })
709