6 _doors.registered_doors = {}
7 _doors.registered_trapdoors = {}
9 -- returns an object to a door object or nil
10 function doors.get(pos)
11 local node_name = minetest.get_node(pos).name
12 if _doors.registered_doors[node_name] then
13 -- A normal upright door
16 open = function(self, player)
20 return _doors.door_toggle(self.pos, nil, player)
22 close = function(self, player)
23 if not self:state() then
26 return _doors.door_toggle(self.pos, nil, player)
28 toggle = function(self, player)
29 return _doors.door_toggle(self.pos, nil, player)
31 state = function(self)
32 local state = minetest.get_meta(self.pos):get_int("state")
36 elseif _doors.registered_trapdoors[node_name] then
40 open = function(self, player)
44 return _doors.trapdoor_toggle(self.pos, nil, player)
46 close = function(self, player)
47 if not self:state() then
50 return _doors.trapdoor_toggle(self.pos, nil, player)
52 toggle = function(self, player)
53 return _doors.trapdoor_toggle(self.pos, nil, player)
55 state = function(self)
56 return minetest.get_node(self.pos).name:sub(-5) == "_open"
64 -- this hidden node is placed on top of the bottom, and prevents
65 -- nodes from being placed in the top half of the door.
66 minetest.register_node("doors:hidden", {
67 description = "Hidden Door Segment",
68 -- can't use airlike otherwise falling nodes will turn to entities
69 -- and will be forever stuck until door is removed.
72 paramtype2 = "facedir",
73 sunlight_propagates = true,
74 -- has to be walkable for falling nodes to stop falling.
81 groups = {not_in_creative_inventory = 1},
82 on_blast = function() end,
83 tiles = {"doors_blank.png"},
84 -- 1px transparent block inside door hinge near node top.
87 fixed = {-15/32, 13/32, -15/32, -13/32, 1/2, -13/32},
89 -- collision_box needed otherise selection box would be full node size
92 fixed = {-15/32, 13/32, -15/32, -13/32, 1/2, -13/32},
96 -- table used to aid door opening/closing
99 {v = "_a", param2 = 3},
100 {v = "_a", param2 = 0},
101 {v = "_a", param2 = 1},
102 {v = "_a", param2 = 2},
105 {v = "_b", param2 = 1},
106 {v = "_b", param2 = 2},
107 {v = "_b", param2 = 3},
108 {v = "_b", param2 = 0},
111 {v = "_b", param2 = 1},
112 {v = "_b", param2 = 2},
113 {v = "_b", param2 = 3},
114 {v = "_b", param2 = 0},
117 {v = "_a", param2 = 3},
118 {v = "_a", param2 = 0},
119 {v = "_a", param2 = 1},
120 {v = "_a", param2 = 2},
124 function _doors.door_toggle(pos, node, clicker)
125 local meta = minetest.get_meta(pos)
126 node = node or minetest.get_node(pos)
127 local def = minetest.registered_nodes[node.name]
128 local name = def.door.name
130 local state = meta:get_string("state")
132 -- fix up lvm-placed right-hinged doors, default closed
133 if node.name:sub(-2) == "_b" then
139 state = tonumber(state)
142 if clicker and not minetest.check_player_privs(clicker, "protection_bypass") then
143 -- is player wielding the right key?
144 local item = clicker:get_wielded_item()
145 local owner = meta:get_string("doors_owner")
146 if item:get_name() == "default:key" then
147 local key_meta = minetest.parse_json(item:get_metadata())
148 local secret = meta:get_string("key_lock_secret")
149 if secret ~= key_meta.secret then
153 elseif owner ~= "" then
154 if clicker:get_player_name() ~= owner then
160 -- until Lua-5.2 we have no bitwise operators :(
161 if state % 2 == 1 then
167 local dir = node.param2
168 if state % 2 == 0 then
169 minetest.sound_play(def.door.sounds[1],
170 {pos = pos, gain = 0.3, max_hear_distance = 10})
172 minetest.sound_play(def.door.sounds[2],
173 {pos = pos, gain = 0.3, max_hear_distance = 10})
176 minetest.swap_node(pos, {
177 name = name .. transform[state + 1][dir+1].v,
178 param2 = transform[state + 1][dir+1].param2
180 meta:set_int("state", state)
186 local function on_place_node(place_to, newnode,
187 placer, oldnode, itemstack, pointed_thing)
189 for _, callback in ipairs(minetest.registered_on_placenodes) do
190 -- Deepcopy pos, node and pointed_thing because callback can modify them
191 local place_to_copy = {x = place_to.x, y = place_to.y, z = place_to.z}
193 {name = newnode.name, param1 = newnode.param1, param2 = newnode.param2}
195 {name = oldnode.name, param1 = oldnode.param1, param2 = oldnode.param2}
196 local pointed_thing_copy = {
197 type = pointed_thing.type,
198 above = vector.new(pointed_thing.above),
199 under = vector.new(pointed_thing.under),
200 ref = pointed_thing.ref,
202 callback(place_to_copy, newnode_copy, placer,
203 oldnode_copy, itemstack, pointed_thing_copy)
207 local function can_dig_door(pos, digger)
208 local digger_name = digger and digger:get_player_name()
209 if digger_name and minetest.get_player_privs(digger_name).protection_bypass then
212 return minetest.get_meta(pos):get_string("doors_owner") == digger_name
215 function doors.register(name, def)
216 if not name:find(":") then
217 name = "doors:" .. name
220 -- replace old doors of this type automatically
221 minetest.register_lbm({
222 name = ":doors:replace_" .. name:gsub(":", "_"),
223 nodenames = {name.."_b_1", name.."_b_2"},
224 action = function(pos, node)
225 local l = tonumber(node.name:sub(-1))
226 local meta = minetest.get_meta(pos)
227 local h = meta:get_int("right") + 1
228 local p2 = node.param2
230 {{type = "a", state = 0}, {type = "a", state = 3}},
231 {{type = "b", state = 1}, {type = "b", state = 2}}
233 local new = replace[l][h]
234 -- retain infotext and doors_owner fields
235 minetest.swap_node(pos, {name = name .. "_" .. new.type, param2 = p2})
236 meta:set_int("state", new.state)
237 -- properly place doors:hidden at the right spot
239 if new.state >= 2 then
242 if new.state % 2 == 1 then
243 if new.state >= 2 then
249 -- wipe meta on top node as it's unused
250 minetest.set_node({x = pos.x, y = pos.y + 1, z = pos.z},
251 {name = "doors:hidden", param2 = p3})
255 minetest.register_craftitem(":" .. name, {
256 description = def.description,
257 inventory_image = def.inventory_image,
259 on_place = function(itemstack, placer, pointed_thing)
262 if not pointed_thing.type == "node" then
266 local node = minetest.get_node(pointed_thing.under)
267 local pdef = minetest.registered_nodes[node.name]
268 if pdef and pdef.on_rightclick then
269 return pdef.on_rightclick(pointed_thing.under,
270 node, placer, itemstack, pointed_thing)
273 if pdef and pdef.buildable_to then
274 pos = pointed_thing.under
276 pos = pointed_thing.above
277 node = minetest.get_node(pos)
278 pdef = minetest.registered_nodes[node.name]
279 if not pdef or not pdef.buildable_to then
284 local above = {x = pos.x, y = pos.y + 1, z = pos.z}
285 local top_node = minetest.get_node_or_nil(above)
286 local topdef = top_node and minetest.registered_nodes[top_node.name]
288 if not topdef or not topdef.buildable_to then
292 local pn = placer:get_player_name()
293 if minetest.is_protected(pos, pn) or minetest.is_protected(above, pn) then
297 local dir = minetest.dir_to_facedir(placer:get_look_dir())
300 {x = -1, y = 0, z = 0},
301 {x = 0, y = 0, z = 1},
302 {x = 1, y = 0, z = 0},
303 {x = 0, y = 0, z = -1},
307 x = pos.x + ref[dir + 1].x,
308 y = pos.y + ref[dir + 1].y,
309 z = pos.z + ref[dir + 1].z,
313 if minetest.get_item_group(minetest.get_node(aside).name, "door") == 1 then
315 minetest.set_node(pos, {name = name .. "_b", param2 = dir})
316 minetest.set_node(above, {name = "doors:hidden", param2 = (dir + 3) % 4})
318 minetest.set_node(pos, {name = name .. "_a", param2 = dir})
319 minetest.set_node(above, {name = "doors:hidden", param2 = dir})
322 local meta = minetest.get_meta(pos)
323 meta:set_int("state", state)
325 if def.protected then
326 meta:set_string("doors_owner", pn)
327 meta:set_string("infotext", "Owned by " .. pn)
330 if not minetest.setting_getbool("creative_mode") then
331 itemstack:take_item()
334 on_place_node(pos, minetest.get_node(pos),
335 placer, node, itemstack, pointed_thing)
340 def.inventory_image = nil
343 minetest.register_craft({
350 if not def.sounds then
351 def.sounds = default.node_sound_wood_defaults()
354 if not def.sound_open then
355 def.sound_open = "doors_door_open"
358 if not def.sound_close then
359 def.sound_close = "doors_door_close"
362 def.groups.not_in_creative_inventory = 1
367 sounds = { def.sound_close, def.sound_open },
370 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
371 _doors.door_toggle(pos, node, clicker)
374 def.after_dig_node = function(pos, node, meta, digger)
375 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
376 minetest.check_for_falling({x = pos.x, y = pos.y + 1, z = pos.z})
378 def.on_rotate = false
380 if def.protected then
381 def.can_dig = can_dig_door
382 def.on_blast = function() end
383 def.on_key_use = function(pos, player)
384 local door = doors.get(pos)
387 def.on_skeleton_key_use = function(pos, player, newsecret)
388 local meta = minetest.get_meta(pos)
389 local owner = meta:get_string("doors_owner")
390 local pname = player:get_player_name()
392 -- verify placer is owner of lockable door
393 if owner ~= pname then
394 minetest.record_protection_violation(pos, pname)
395 minetest.chat_send_player(pname, "You do not own this locked door.")
399 local secret = meta:get_string("key_lock_secret")
402 meta:set_string("key_lock_secret", secret)
405 return secret, "a locked door", owner
408 def.on_blast = function(pos, intensity)
409 minetest.remove_node(pos)
410 -- hidden node doesn't get blasted away.
411 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
416 def.on_destruct = function(pos)
417 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
420 def.drawtype = "mesh"
421 def.paramtype = "light"
422 def.paramtype2 = "facedir"
423 def.sunlight_propagates = true
425 def.is_ground_content = false
426 def.buildable_to = false
427 def.selection_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
428 def.collision_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
430 def.mesh = "door_a.obj"
431 minetest.register_node(":" .. name .. "_a", def)
433 def.mesh = "door_b.obj"
434 minetest.register_node(":" .. name .. "_b", def)
436 _doors.registered_doors[name .. "_a"] = true
437 _doors.registered_doors[name .. "_b"] = true
440 doors.register("door_wood", {
441 tiles = {{ name = "doors_door_wood.png", backface_culling = true }},
442 description = "Wooden Door",
443 inventory_image = "doors_item_wood.png",
444 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2},
446 {"group:wood", "group:wood"},
447 {"group:wood", "group:wood"},
448 {"group:wood", "group:wood"},
452 doors.register("door_steel", {
453 tiles = {{name = "doors_door_steel.png", backface_culling = true}},
454 description = "Steel Door",
455 inventory_image = "doors_item_steel.png",
457 groups = {cracky = 1, level = 2},
458 sounds = default.node_sound_metal_defaults(),
459 sound_open = "doors_steel_door_open",
460 sound_close = "doors_steel_door_close",
462 {"default:steel_ingot", "default:steel_ingot"},
463 {"default:steel_ingot", "default:steel_ingot"},
464 {"default:steel_ingot", "default:steel_ingot"},
468 doors.register("door_glass", {
469 tiles = {"doors_door_glass.png"},
470 description = "Glass Door",
471 inventory_image = "doors_item_glass.png",
472 groups = {cracky=3, oddly_breakable_by_hand=3},
473 sounds = default.node_sound_glass_defaults(),
474 sound_open = "doors_glass_door_open",
475 sound_close = "doors_glass_door_close",
477 {"default:glass", "default:glass"},
478 {"default:glass", "default:glass"},
479 {"default:glass", "default:glass"},
483 doors.register("door_obsidian_glass", {
484 tiles = {"doors_door_obsidian_glass.png"},
485 description = "Obsidian Glass Door",
486 inventory_image = "doors_item_obsidian_glass.png",
488 sounds = default.node_sound_glass_defaults(),
489 sound_open = "doors_glass_door_open",
490 sound_close = "doors_glass_door_close",
492 {"default:obsidian_glass", "default:obsidian_glass"},
493 {"default:obsidian_glass", "default:obsidian_glass"},
494 {"default:obsidian_glass", "default:obsidian_glass"},
498 -- Capture mods using the old API as best as possible.
499 function doors.register_door(name, def)
500 if def.only_placer_can_open then
503 def.only_placer_can_open = nil
505 local i = name:find(":")
506 local modname = name:sub(1, i - 1)
507 if not def.tiles then
508 if def.protected then
509 def.tiles = {{name = "doors_door_steel.png", backface_culling = true}}
511 def.tiles = {{name = "doors_door_wood.png", backface_culling = true}}
513 minetest.log("warning", modname .. " registered door \"" .. name .. "\" " ..
514 "using deprecated API method \"doors.register_door()\" but " ..
515 "did not provide the \"tiles\" parameter. A fallback tiledef " ..
516 "will be used instead.")
519 doors.register(name, def)
524 function _doors.trapdoor_toggle(pos, node, clicker)
525 node = node or minetest.get_node(pos)
526 if clicker and not minetest.check_player_privs(clicker, "protection_bypass") then
527 -- is player wielding the right key?
528 local item = clicker:get_wielded_item()
529 local meta = minetest.get_meta(pos)
530 local owner = meta:get_string("doors_owner")
531 if item:get_name() == "default:key" then
532 local key_meta = minetest.parse_json(item:get_metadata())
533 local secret = meta:get_string("key_lock_secret")
534 if secret ~= key_meta.secret then
538 elseif owner ~= "" then
539 if clicker:get_player_name() ~= owner then
545 local def = minetest.registered_nodes[node.name]
547 if string.sub(node.name, -5) == "_open" then
548 minetest.sound_play(def.sound_close,
549 {pos = pos, gain = 0.3, max_hear_distance = 10})
550 minetest.swap_node(pos, {name = string.sub(node.name, 1,
551 string.len(node.name) - 5), param1 = node.param1, param2 = node.param2})
553 minetest.sound_play(def.sound_open,
554 {pos = pos, gain = 0.3, max_hear_distance = 10})
555 minetest.swap_node(pos, {name = node.name .. "_open",
556 param1 = node.param1, param2 = node.param2})
560 function doors.register_trapdoor(name, def)
561 if not name:find(":") then
562 name = "doors:" .. name
565 local name_closed = name
566 local name_opened = name.."_open"
568 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
569 _doors.trapdoor_toggle(pos, node, clicker)
573 -- Common trapdoor configuration
574 def.drawtype = "nodebox"
575 def.paramtype = "light"
576 def.paramtype2 = "facedir"
577 def.is_ground_content = false
579 if def.protected then
580 def.can_dig = can_dig_door
581 def.after_place_node = function(pos, placer, itemstack, pointed_thing)
582 local pn = placer:get_player_name()
583 local meta = minetest.get_meta(pos)
584 meta:set_string("doors_owner", pn)
585 meta:set_string("infotext", "Owned by "..pn)
587 return minetest.setting_getbool("creative_mode")
590 def.on_blast = function() end
591 def.on_key_use = function(pos, player)
592 local door = doors.get(pos)
595 def.on_skeleton_key_use = function(pos, player, newsecret)
596 local meta = minetest.get_meta(pos)
597 local owner = meta:get_string("doors_owner")
598 local pname = player:get_player_name()
600 -- verify placer is owner of lockable door
601 if owner ~= pname then
602 minetest.record_protection_violation(pos, pname)
603 minetest.chat_send_player(pname, "You do not own this trapdoor.")
607 local secret = meta:get_string("key_lock_secret")
610 meta:set_string("key_lock_secret", secret)
613 return secret, "a locked trapdoor", owner
616 def.on_blast = function(pos, intensity)
617 minetest.remove_node(pos)
622 if not def.sounds then
623 def.sounds = default.node_sound_wood_defaults()
626 if not def.sound_open then
627 def.sound_open = "doors_door_open"
630 if not def.sound_close then
631 def.sound_close = "doors_door_close"
634 local def_opened = table.copy(def)
635 local def_closed = table.copy(def)
637 def_closed.node_box = {
639 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
641 def_closed.selection_box = {
643 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
645 def_closed.tiles = {def.tile_front,
646 def.tile_front .. '^[transformFY',
647 def.tile_side, def.tile_side,
648 def.tile_side, def.tile_side}
650 def_opened.node_box = {
652 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
654 def_opened.selection_box = {
656 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
658 def_opened.tiles = {def.tile_side, def.tile_side,
659 def.tile_side .. '^[transform3',
660 def.tile_side .. '^[transform1',
661 def.tile_front .. '^[transform46',
662 def.tile_front .. '^[transform6'}
664 def_opened.drop = name_closed
665 def_opened.groups.not_in_creative_inventory = 1
667 minetest.register_node(name_opened, def_opened)
668 minetest.register_node(name_closed, def_closed)
670 _doors.registered_trapdoors[name_opened] = true
671 _doors.registered_trapdoors[name_closed] = true
674 doors.register_trapdoor("doors:trapdoor", {
675 description = "Trapdoor",
676 inventory_image = "doors_trapdoor.png",
677 wield_image = "doors_trapdoor.png",
678 tile_front = "doors_trapdoor.png",
679 tile_side = "doors_trapdoor_side.png",
680 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2, door = 1},
683 doors.register_trapdoor("doors:trapdoor_steel", {
684 description = "Steel Trapdoor",
685 inventory_image = "doors_trapdoor_steel.png",
686 wield_image = "doors_trapdoor_steel.png",
687 tile_front = "doors_trapdoor_steel.png",
688 tile_side = "doors_trapdoor_steel_side.png",
690 sounds = default.node_sound_metal_defaults(),
691 sound_open = "doors_steel_door_open",
692 sound_close = "doors_steel_door_close",
693 groups = {cracky = 1, level = 2, door = 1},
696 minetest.register_craft({
697 output = 'doors:trapdoor 2',
699 {'group:wood', 'group:wood', 'group:wood'},
700 {'group:wood', 'group:wood', 'group:wood'},
705 minetest.register_craft({
706 output = 'doors:trapdoor_steel',
708 {'default:steel_ingot', 'default:steel_ingot'},
709 {'default:steel_ingot', 'default:steel_ingot'},
716 function doors.register_fencegate(name, def)
718 description = def.description,
720 tiles = {def.texture},
722 paramtype2 = "facedir",
723 sunlight_propagates = true,
724 is_ground_content = false,
725 drop = name .. "_closed",
726 connect_sides = {"left", "right"},
729 on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
730 local node_def = minetest.registered_nodes[node.name]
731 minetest.swap_node(pos, {name = node_def.gate, param2 = node.param2})
732 minetest.sound_play(node_def.sound, {pos = pos, gain = 0.3,
733 max_hear_distance = 8})
738 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
742 if not fence.sounds then
743 fence.sounds = default.node_sound_wood_defaults()
746 fence.groups.fence = 1
748 local fence_closed = table.copy(fence)
749 fence_closed.mesh = "doors_fencegate_closed.obj"
750 fence_closed.gate = name .. "_open"
751 fence_closed.sound = "doors_fencegate_open"
752 fence_closed.collision_box = {
754 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
757 local fence_open = table.copy(fence)
758 fence_open.mesh = "doors_fencegate_open.obj"
759 fence_open.gate = name .. "_closed"
760 fence_open.sound = "doors_fencegate_close"
761 fence_open.groups.not_in_creative_inventory = 1
762 fence_open.collision_box = {
764 fixed = {{-1/2, -1/2, -1/4, -3/8, 1/2, 1/4},
765 {-1/2, -3/8, -1/2, -3/8, 3/8, 0}},
768 minetest.register_node(":" .. name .. "_closed", fence_closed)
769 minetest.register_node(":" .. name .. "_open", fence_open)
771 minetest.register_craft({
772 output = name .. "_closed",
774 {"default:stick", def.material, "default:stick"},
775 {"default:stick", def.material, "default:stick"}
780 doors.register_fencegate("doors:gate_wood", {
781 description = "Wooden Fence Gate",
782 texture = "default_wood.png",
783 material = "default:wood",
784 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
787 doors.register_fencegate("doors:gate_acacia_wood", {
788 description = "Acacia Fence Gate",
789 texture = "default_acacia_wood.png",
790 material = "default:acacia_wood",
791 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
794 doors.register_fencegate("doors:gate_junglewood", {
795 description = "Junglewood Fence Gate",
796 texture = "default_junglewood.png",
797 material = "default:junglewood",
798 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
801 doors.register_fencegate("doors:gate_pine_wood", {
802 description = "Pine Fence Gate",
803 texture = "default_pine_wood.png",
804 material = "default:pine_wood",
805 groups = {choppy = 3, oddly_breakable_by_hand = 2, flammable = 3}
808 doors.register_fencegate("doors:gate_aspen_wood", {
809 description = "Aspen Fence Gate",
810 texture = "default_aspen_wood.png",
811 material = "default:aspen_wood",
812 groups = {choppy = 3, oddly_breakable_by_hand = 2, flammable = 3}
818 minetest.register_craft({
820 recipe = "doors:trapdoor",
824 minetest.register_craft({
826 recipe = "doors:door_wood",
830 minetest.register_craft({
832 recipe = "doors:gate_wood_closed",
836 minetest.register_craft({
838 recipe = "doors:gate_acacia_wood_closed",
842 minetest.register_craft({
844 recipe = "doors:gate_junglewood_closed",
848 minetest.register_craft({
850 recipe = "doors:gate_pine_wood_closed",
854 minetest.register_craft({
856 recipe = "doors:gate_aspen_wood_closed",