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 and
269 not placer:get_player_control().sneak then
270 return pdef.on_rightclick(pointed_thing.under,
271 node, placer, itemstack, pointed_thing)
274 if pdef and pdef.buildable_to then
275 pos = pointed_thing.under
277 pos = pointed_thing.above
278 node = minetest.get_node(pos)
279 pdef = minetest.registered_nodes[node.name]
280 if not pdef or not pdef.buildable_to then
285 local above = {x = pos.x, y = pos.y + 1, z = pos.z}
286 local top_node = minetest.get_node_or_nil(above)
287 local topdef = top_node and minetest.registered_nodes[top_node.name]
289 if not topdef or not topdef.buildable_to then
293 local pn = placer:get_player_name()
294 if minetest.is_protected(pos, pn) or minetest.is_protected(above, pn) then
298 local dir = minetest.dir_to_facedir(placer:get_look_dir())
301 {x = -1, y = 0, z = 0},
302 {x = 0, y = 0, z = 1},
303 {x = 1, y = 0, z = 0},
304 {x = 0, y = 0, z = -1},
308 x = pos.x + ref[dir + 1].x,
309 y = pos.y + ref[dir + 1].y,
310 z = pos.z + ref[dir + 1].z,
314 if minetest.get_item_group(minetest.get_node(aside).name, "door") == 1 then
316 minetest.set_node(pos, {name = name .. "_b", param2 = dir})
317 minetest.set_node(above, {name = "doors:hidden", param2 = (dir + 3) % 4})
319 minetest.set_node(pos, {name = name .. "_a", param2 = dir})
320 minetest.set_node(above, {name = "doors:hidden", param2 = dir})
323 local meta = minetest.get_meta(pos)
324 meta:set_int("state", state)
326 if def.protected then
327 meta:set_string("doors_owner", pn)
328 meta:set_string("infotext", "Owned by " .. pn)
331 if not minetest.setting_getbool("creative_mode") then
332 itemstack:take_item()
335 on_place_node(pos, minetest.get_node(pos),
336 placer, node, itemstack, pointed_thing)
341 def.inventory_image = nil
344 minetest.register_craft({
351 if not def.sounds then
352 def.sounds = default.node_sound_wood_defaults()
355 if not def.sound_open then
356 def.sound_open = "doors_door_open"
359 if not def.sound_close then
360 def.sound_close = "doors_door_close"
363 def.groups.not_in_creative_inventory = 1
368 sounds = { def.sound_close, def.sound_open },
371 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
372 _doors.door_toggle(pos, node, clicker)
375 def.after_dig_node = function(pos, node, meta, digger)
376 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
377 minetest.check_for_falling({x = pos.x, y = pos.y + 1, z = pos.z})
379 def.on_rotate = function(pos, node, user, mode, new_param2)
383 if def.protected then
384 def.can_dig = can_dig_door
385 def.on_blast = function() end
386 def.on_key_use = function(pos, player)
387 local door = doors.get(pos)
390 def.on_skeleton_key_use = function(pos, player, newsecret)
391 local meta = minetest.get_meta(pos)
392 local owner = meta:get_string("doors_owner")
393 local pname = player:get_player_name()
395 -- verify placer is owner of lockable door
396 if owner ~= pname then
397 minetest.record_protection_violation(pos, pname)
398 minetest.chat_send_player(pname, "You do not own this locked door.")
402 local secret = meta:get_string("key_lock_secret")
405 meta:set_string("key_lock_secret", secret)
408 return secret, "a locked door", owner
411 def.on_blast = function(pos, intensity)
412 minetest.remove_node(pos)
413 -- hidden node doesn't get blasted away.
414 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
419 def.on_destruct = function(pos)
420 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
423 def.drawtype = "mesh"
424 def.paramtype = "light"
425 def.paramtype2 = "facedir"
426 def.sunlight_propagates = true
428 def.is_ground_content = false
429 def.buildable_to = false
430 def.selection_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
431 def.collision_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
433 def.mesh = "door_a.obj"
434 minetest.register_node(":" .. name .. "_a", def)
436 def.mesh = "door_b.obj"
437 minetest.register_node(":" .. name .. "_b", def)
439 _doors.registered_doors[name .. "_a"] = true
440 _doors.registered_doors[name .. "_b"] = true
443 doors.register("door_wood", {
444 tiles = {{ name = "doors_door_wood.png", backface_culling = true }},
445 description = "Wooden Door",
446 inventory_image = "doors_item_wood.png",
447 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2},
449 {"group:wood", "group:wood"},
450 {"group:wood", "group:wood"},
451 {"group:wood", "group:wood"},
455 doors.register("door_steel", {
456 tiles = {{name = "doors_door_steel.png", backface_culling = true}},
457 description = "Steel Door",
458 inventory_image = "doors_item_steel.png",
460 groups = {cracky = 1, level = 2},
461 sounds = default.node_sound_metal_defaults(),
462 sound_open = "doors_steel_door_open",
463 sound_close = "doors_steel_door_close",
465 {"default:steel_ingot", "default:steel_ingot"},
466 {"default:steel_ingot", "default:steel_ingot"},
467 {"default:steel_ingot", "default:steel_ingot"},
471 doors.register("door_glass", {
472 tiles = {"doors_door_glass.png"},
473 description = "Glass Door",
474 inventory_image = "doors_item_glass.png",
475 groups = {cracky=3, oddly_breakable_by_hand=3},
476 sounds = default.node_sound_glass_defaults(),
477 sound_open = "doors_glass_door_open",
478 sound_close = "doors_glass_door_close",
480 {"default:glass", "default:glass"},
481 {"default:glass", "default:glass"},
482 {"default:glass", "default:glass"},
486 doors.register("door_obsidian_glass", {
487 tiles = {"doors_door_obsidian_glass.png"},
488 description = "Obsidian Glass Door",
489 inventory_image = "doors_item_obsidian_glass.png",
491 sounds = default.node_sound_glass_defaults(),
492 sound_open = "doors_glass_door_open",
493 sound_close = "doors_glass_door_close",
495 {"default:obsidian_glass", "default:obsidian_glass"},
496 {"default:obsidian_glass", "default:obsidian_glass"},
497 {"default:obsidian_glass", "default:obsidian_glass"},
501 -- Capture mods using the old API as best as possible.
502 function doors.register_door(name, def)
503 if def.only_placer_can_open then
506 def.only_placer_can_open = nil
508 local i = name:find(":")
509 local modname = name:sub(1, i - 1)
510 if not def.tiles then
511 if def.protected then
512 def.tiles = {{name = "doors_door_steel.png", backface_culling = true}}
514 def.tiles = {{name = "doors_door_wood.png", backface_culling = true}}
516 minetest.log("warning", modname .. " registered door \"" .. name .. "\" " ..
517 "using deprecated API method \"doors.register_door()\" but " ..
518 "did not provide the \"tiles\" parameter. A fallback tiledef " ..
519 "will be used instead.")
522 doors.register(name, def)
527 function _doors.trapdoor_toggle(pos, node, clicker)
528 node = node or minetest.get_node(pos)
529 if clicker and not minetest.check_player_privs(clicker, "protection_bypass") then
530 -- is player wielding the right key?
531 local item = clicker:get_wielded_item()
532 local meta = minetest.get_meta(pos)
533 local owner = meta:get_string("doors_owner")
534 if item:get_name() == "default:key" then
535 local key_meta = minetest.parse_json(item:get_metadata())
536 local secret = meta:get_string("key_lock_secret")
537 if secret ~= key_meta.secret then
541 elseif owner ~= "" then
542 if clicker:get_player_name() ~= owner then
548 local def = minetest.registered_nodes[node.name]
550 if string.sub(node.name, -5) == "_open" then
551 minetest.sound_play(def.sound_close,
552 {pos = pos, gain = 0.3, max_hear_distance = 10})
553 minetest.swap_node(pos, {name = string.sub(node.name, 1,
554 string.len(node.name) - 5), param1 = node.param1, param2 = node.param2})
556 minetest.sound_play(def.sound_open,
557 {pos = pos, gain = 0.3, max_hear_distance = 10})
558 minetest.swap_node(pos, {name = node.name .. "_open",
559 param1 = node.param1, param2 = node.param2})
563 function doors.register_trapdoor(name, def)
564 if not name:find(":") then
565 name = "doors:" .. name
568 local name_closed = name
569 local name_opened = name.."_open"
571 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
572 _doors.trapdoor_toggle(pos, node, clicker)
576 -- Common trapdoor configuration
577 def.drawtype = "nodebox"
578 def.paramtype = "light"
579 def.paramtype2 = "facedir"
580 def.is_ground_content = false
582 if def.protected then
583 def.can_dig = can_dig_door
584 def.after_place_node = function(pos, placer, itemstack, pointed_thing)
585 local pn = placer:get_player_name()
586 local meta = minetest.get_meta(pos)
587 meta:set_string("doors_owner", pn)
588 meta:set_string("infotext", "Owned by "..pn)
590 return minetest.setting_getbool("creative_mode")
593 def.on_blast = function() end
594 def.on_key_use = function(pos, player)
595 local door = doors.get(pos)
598 def.on_skeleton_key_use = function(pos, player, newsecret)
599 local meta = minetest.get_meta(pos)
600 local owner = meta:get_string("doors_owner")
601 local pname = player:get_player_name()
603 -- verify placer is owner of lockable door
604 if owner ~= pname then
605 minetest.record_protection_violation(pos, pname)
606 minetest.chat_send_player(pname, "You do not own this trapdoor.")
610 local secret = meta:get_string("key_lock_secret")
613 meta:set_string("key_lock_secret", secret)
616 return secret, "a locked trapdoor", owner
619 def.on_blast = function(pos, intensity)
620 minetest.remove_node(pos)
625 if not def.sounds then
626 def.sounds = default.node_sound_wood_defaults()
629 if not def.sound_open then
630 def.sound_open = "doors_door_open"
633 if not def.sound_close then
634 def.sound_close = "doors_door_close"
637 local def_opened = table.copy(def)
638 local def_closed = table.copy(def)
640 def_closed.node_box = {
642 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
644 def_closed.selection_box = {
646 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
648 def_closed.tiles = {def.tile_front,
649 def.tile_front .. '^[transformFY',
650 def.tile_side, def.tile_side,
651 def.tile_side, def.tile_side}
653 def_opened.node_box = {
655 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
657 def_opened.selection_box = {
659 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
661 def_opened.tiles = {def.tile_side, def.tile_side,
662 def.tile_side .. '^[transform3',
663 def.tile_side .. '^[transform1',
664 def.tile_front .. '^[transform46',
665 def.tile_front .. '^[transform6'}
667 def_opened.drop = name_closed
668 def_opened.groups.not_in_creative_inventory = 1
670 minetest.register_node(name_opened, def_opened)
671 minetest.register_node(name_closed, def_closed)
673 _doors.registered_trapdoors[name_opened] = true
674 _doors.registered_trapdoors[name_closed] = true
677 doors.register_trapdoor("doors:trapdoor", {
678 description = "Trapdoor",
679 inventory_image = "doors_trapdoor.png",
680 wield_image = "doors_trapdoor.png",
681 tile_front = "doors_trapdoor.png",
682 tile_side = "doors_trapdoor_side.png",
683 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2, door = 1},
686 doors.register_trapdoor("doors:trapdoor_steel", {
687 description = "Steel Trapdoor",
688 inventory_image = "doors_trapdoor_steel.png",
689 wield_image = "doors_trapdoor_steel.png",
690 tile_front = "doors_trapdoor_steel.png",
691 tile_side = "doors_trapdoor_steel_side.png",
693 sounds = default.node_sound_metal_defaults(),
694 sound_open = "doors_steel_door_open",
695 sound_close = "doors_steel_door_close",
696 groups = {cracky = 1, level = 2, door = 1},
699 minetest.register_craft({
700 output = 'doors:trapdoor 2',
702 {'group:wood', 'group:wood', 'group:wood'},
703 {'group:wood', 'group:wood', 'group:wood'},
708 minetest.register_craft({
709 output = 'doors:trapdoor_steel',
711 {'default:steel_ingot', 'default:steel_ingot'},
712 {'default:steel_ingot', 'default:steel_ingot'},
719 function doors.register_fencegate(name, def)
721 description = def.description,
723 tiles = {def.texture},
725 paramtype2 = "facedir",
726 sunlight_propagates = true,
727 is_ground_content = false,
728 drop = name .. "_closed",
729 connect_sides = {"left", "right"},
732 on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
733 local node_def = minetest.registered_nodes[node.name]
734 minetest.swap_node(pos, {name = node_def.gate, param2 = node.param2})
735 minetest.sound_play(node_def.sound, {pos = pos, gain = 0.3,
736 max_hear_distance = 8})
741 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
745 if not fence.sounds then
746 fence.sounds = default.node_sound_wood_defaults()
749 fence.groups.fence = 1
751 local fence_closed = table.copy(fence)
752 fence_closed.mesh = "doors_fencegate_closed.obj"
753 fence_closed.gate = name .. "_open"
754 fence_closed.sound = "doors_fencegate_open"
755 fence_closed.collision_box = {
757 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
760 local fence_open = table.copy(fence)
761 fence_open.mesh = "doors_fencegate_open.obj"
762 fence_open.gate = name .. "_closed"
763 fence_open.sound = "doors_fencegate_close"
764 fence_open.groups.not_in_creative_inventory = 1
765 fence_open.collision_box = {
767 fixed = {{-1/2, -1/2, -1/4, -3/8, 1/2, 1/4},
768 {-1/2, -3/8, -1/2, -3/8, 3/8, 0}},
771 minetest.register_node(":" .. name .. "_closed", fence_closed)
772 minetest.register_node(":" .. name .. "_open", fence_open)
774 minetest.register_craft({
775 output = name .. "_closed",
777 {"default:stick", def.material, "default:stick"},
778 {"default:stick", def.material, "default:stick"}
783 doors.register_fencegate("doors:gate_wood", {
784 description = "Wooden Fence Gate",
785 texture = "default_wood.png",
786 material = "default:wood",
787 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
790 doors.register_fencegate("doors:gate_acacia_wood", {
791 description = "Acacia Fence Gate",
792 texture = "default_acacia_wood.png",
793 material = "default:acacia_wood",
794 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
797 doors.register_fencegate("doors:gate_junglewood", {
798 description = "Junglewood Fence Gate",
799 texture = "default_junglewood.png",
800 material = "default:junglewood",
801 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
804 doors.register_fencegate("doors:gate_pine_wood", {
805 description = "Pine Fence Gate",
806 texture = "default_pine_wood.png",
807 material = "default:pine_wood",
808 groups = {choppy = 3, oddly_breakable_by_hand = 2, flammable = 3}
811 doors.register_fencegate("doors:gate_aspen_wood", {
812 description = "Aspen Fence Gate",
813 texture = "default_aspen_wood.png",
814 material = "default:aspen_wood",
815 groups = {choppy = 3, oddly_breakable_by_hand = 2, flammable = 3}
821 minetest.register_craft({
823 recipe = "doors:trapdoor",
827 minetest.register_craft({
829 recipe = "doors:door_wood",
833 minetest.register_craft({
835 recipe = "doors:gate_wood_closed",
839 minetest.register_craft({
841 recipe = "doors:gate_acacia_wood_closed",
845 minetest.register_craft({
847 recipe = "doors:gate_junglewood_closed",
851 minetest.register_craft({
853 recipe = "doors:gate_pine_wood_closed",
857 minetest.register_craft({
859 recipe = "doors:gate_aspen_wood_closed",