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 = item:get_meta()
148 local secret = meta:get_string("key_lock_secret")
150 if key_meta:get_string("secret") == "" then
151 key_meta:set_string("secret", minetest.parse_json(item:get_metadata()).secret)
152 item:set_metadata("")
155 if secret ~= key_meta:get_string("secret") then
159 elseif owner ~= "" then
160 if clicker:get_player_name() ~= owner then
166 -- until Lua-5.2 we have no bitwise operators :(
167 if state % 2 == 1 then
173 local dir = node.param2
174 if state % 2 == 0 then
175 minetest.sound_play(def.door.sounds[1],
176 {pos = pos, gain = 0.3, max_hear_distance = 10})
178 minetest.sound_play(def.door.sounds[2],
179 {pos = pos, gain = 0.3, max_hear_distance = 10})
182 minetest.swap_node(pos, {
183 name = name .. transform[state + 1][dir+1].v,
184 param2 = transform[state + 1][dir+1].param2
186 meta:set_int("state", state)
192 local function on_place_node(place_to, newnode,
193 placer, oldnode, itemstack, pointed_thing)
195 for _, callback in ipairs(minetest.registered_on_placenodes) do
196 -- Deepcopy pos, node and pointed_thing because callback can modify them
197 local place_to_copy = {x = place_to.x, y = place_to.y, z = place_to.z}
199 {name = newnode.name, param1 = newnode.param1, param2 = newnode.param2}
201 {name = oldnode.name, param1 = oldnode.param1, param2 = oldnode.param2}
202 local pointed_thing_copy = {
203 type = pointed_thing.type,
204 above = vector.new(pointed_thing.above),
205 under = vector.new(pointed_thing.under),
206 ref = pointed_thing.ref,
208 callback(place_to_copy, newnode_copy, placer,
209 oldnode_copy, itemstack, pointed_thing_copy)
213 local function can_dig_door(pos, digger)
214 local digger_name = digger and digger:get_player_name()
215 if digger_name and minetest.get_player_privs(digger_name).protection_bypass then
218 return minetest.get_meta(pos):get_string("doors_owner") == digger_name
221 function doors.register(name, def)
222 if not name:find(":") then
223 name = "doors:" .. name
226 -- replace old doors of this type automatically
227 minetest.register_lbm({
228 name = ":doors:replace_" .. name:gsub(":", "_"),
229 nodenames = {name.."_b_1", name.."_b_2"},
230 action = function(pos, node)
231 local l = tonumber(node.name:sub(-1))
232 local meta = minetest.get_meta(pos)
233 local h = meta:get_int("right") + 1
234 local p2 = node.param2
236 {{type = "a", state = 0}, {type = "a", state = 3}},
237 {{type = "b", state = 1}, {type = "b", state = 2}}
239 local new = replace[l][h]
240 -- retain infotext and doors_owner fields
241 minetest.swap_node(pos, {name = name .. "_" .. new.type, param2 = p2})
242 meta:set_int("state", new.state)
243 -- properly place doors:hidden at the right spot
245 if new.state >= 2 then
248 if new.state % 2 == 1 then
249 if new.state >= 2 then
255 -- wipe meta on top node as it's unused
256 minetest.set_node({x = pos.x, y = pos.y + 1, z = pos.z},
257 {name = "doors:hidden", param2 = p3})
261 minetest.register_craftitem(":" .. name, {
262 description = def.description,
263 inventory_image = def.inventory_image,
265 on_place = function(itemstack, placer, pointed_thing)
268 if not pointed_thing.type == "node" then
272 local node = minetest.get_node(pointed_thing.under)
273 local pdef = minetest.registered_nodes[node.name]
274 if pdef and pdef.on_rightclick and
275 not placer:get_player_control().sneak then
276 return pdef.on_rightclick(pointed_thing.under,
277 node, placer, itemstack, pointed_thing)
280 if pdef and pdef.buildable_to then
281 pos = pointed_thing.under
283 pos = pointed_thing.above
284 node = minetest.get_node(pos)
285 pdef = minetest.registered_nodes[node.name]
286 if not pdef or not pdef.buildable_to then
291 local above = {x = pos.x, y = pos.y + 1, z = pos.z}
292 local top_node = minetest.get_node_or_nil(above)
293 local topdef = top_node and minetest.registered_nodes[top_node.name]
295 if not topdef or not topdef.buildable_to then
299 local pn = placer:get_player_name()
300 if minetest.is_protected(pos, pn) or minetest.is_protected(above, pn) then
304 local dir = minetest.dir_to_facedir(placer:get_look_dir())
307 {x = -1, y = 0, z = 0},
308 {x = 0, y = 0, z = 1},
309 {x = 1, y = 0, z = 0},
310 {x = 0, y = 0, z = -1},
314 x = pos.x + ref[dir + 1].x,
315 y = pos.y + ref[dir + 1].y,
316 z = pos.z + ref[dir + 1].z,
320 if minetest.get_item_group(minetest.get_node(aside).name, "door") == 1 then
322 minetest.set_node(pos, {name = name .. "_b", param2 = dir})
323 minetest.set_node(above, {name = "doors:hidden", param2 = (dir + 3) % 4})
325 minetest.set_node(pos, {name = name .. "_a", param2 = dir})
326 minetest.set_node(above, {name = "doors:hidden", param2 = dir})
329 local meta = minetest.get_meta(pos)
330 meta:set_int("state", state)
332 if def.protected then
333 meta:set_string("doors_owner", pn)
334 meta:set_string("infotext", "Owned by " .. pn)
337 if not minetest.setting_getbool("creative_mode") then
338 itemstack:take_item()
341 on_place_node(pos, minetest.get_node(pos),
342 placer, node, itemstack, pointed_thing)
347 def.inventory_image = nil
350 minetest.register_craft({
357 if not def.sounds then
358 def.sounds = default.node_sound_wood_defaults()
361 if not def.sound_open then
362 def.sound_open = "doors_door_open"
365 if not def.sound_close then
366 def.sound_close = "doors_door_close"
369 def.groups.not_in_creative_inventory = 1
374 sounds = { def.sound_close, def.sound_open },
377 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
378 _doors.door_toggle(pos, node, clicker)
381 def.after_dig_node = function(pos, node, meta, digger)
382 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
383 minetest.check_for_falling({x = pos.x, y = pos.y + 1, z = pos.z})
385 def.on_rotate = function(pos, node, user, mode, new_param2)
389 if def.protected then
390 def.can_dig = can_dig_door
391 def.on_blast = function() end
392 def.on_key_use = function(pos, player)
393 local door = doors.get(pos)
396 def.on_skeleton_key_use = function(pos, player, newsecret)
397 local meta = minetest.get_meta(pos)
398 local owner = meta:get_string("doors_owner")
399 local pname = player:get_player_name()
401 -- verify placer is owner of lockable door
402 if owner ~= pname then
403 minetest.record_protection_violation(pos, pname)
404 minetest.chat_send_player(pname, "You do not own this locked door.")
408 local secret = meta:get_string("key_lock_secret")
411 meta:set_string("key_lock_secret", secret)
414 return secret, "a locked door", owner
417 def.on_blast = function(pos, intensity)
418 minetest.remove_node(pos)
419 -- hidden node doesn't get blasted away.
420 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
425 def.on_destruct = function(pos)
426 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
429 def.drawtype = "mesh"
430 def.paramtype = "light"
431 def.paramtype2 = "facedir"
432 def.sunlight_propagates = true
434 def.is_ground_content = false
435 def.buildable_to = false
436 def.selection_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
437 def.collision_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
439 def.mesh = "door_a.obj"
440 minetest.register_node(":" .. name .. "_a", def)
442 def.mesh = "door_b.obj"
443 minetest.register_node(":" .. name .. "_b", def)
445 _doors.registered_doors[name .. "_a"] = true
446 _doors.registered_doors[name .. "_b"] = true
449 doors.register("door_wood", {
450 tiles = {{ name = "doors_door_wood.png", backface_culling = true }},
451 description = "Wooden Door",
452 inventory_image = "doors_item_wood.png",
453 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2},
455 {"group:wood", "group:wood"},
456 {"group:wood", "group:wood"},
457 {"group:wood", "group:wood"},
461 doors.register("door_steel", {
462 tiles = {{name = "doors_door_steel.png", backface_culling = true}},
463 description = "Steel Door",
464 inventory_image = "doors_item_steel.png",
466 groups = {cracky = 1, level = 2},
467 sounds = default.node_sound_metal_defaults(),
468 sound_open = "doors_steel_door_open",
469 sound_close = "doors_steel_door_close",
471 {"default:steel_ingot", "default:steel_ingot"},
472 {"default:steel_ingot", "default:steel_ingot"},
473 {"default:steel_ingot", "default:steel_ingot"},
477 doors.register("door_glass", {
478 tiles = {"doors_door_glass.png"},
479 description = "Glass Door",
480 inventory_image = "doors_item_glass.png",
481 groups = {cracky=3, oddly_breakable_by_hand=3},
482 sounds = default.node_sound_glass_defaults(),
483 sound_open = "doors_glass_door_open",
484 sound_close = "doors_glass_door_close",
486 {"default:glass", "default:glass"},
487 {"default:glass", "default:glass"},
488 {"default:glass", "default:glass"},
492 doors.register("door_obsidian_glass", {
493 tiles = {"doors_door_obsidian_glass.png"},
494 description = "Obsidian Glass Door",
495 inventory_image = "doors_item_obsidian_glass.png",
497 sounds = default.node_sound_glass_defaults(),
498 sound_open = "doors_glass_door_open",
499 sound_close = "doors_glass_door_close",
501 {"default:obsidian_glass", "default:obsidian_glass"},
502 {"default:obsidian_glass", "default:obsidian_glass"},
503 {"default:obsidian_glass", "default:obsidian_glass"},
507 -- Capture mods using the old API as best as possible.
508 function doors.register_door(name, def)
509 if def.only_placer_can_open then
512 def.only_placer_can_open = nil
514 local i = name:find(":")
515 local modname = name:sub(1, i - 1)
516 if not def.tiles then
517 if def.protected then
518 def.tiles = {{name = "doors_door_steel.png", backface_culling = true}}
520 def.tiles = {{name = "doors_door_wood.png", backface_culling = true}}
522 minetest.log("warning", modname .. " registered door \"" .. name .. "\" " ..
523 "using deprecated API method \"doors.register_door()\" but " ..
524 "did not provide the \"tiles\" parameter. A fallback tiledef " ..
525 "will be used instead.")
528 doors.register(name, def)
533 function _doors.trapdoor_toggle(pos, node, clicker)
534 node = node or minetest.get_node(pos)
535 if clicker and not minetest.check_player_privs(clicker, "protection_bypass") then
536 -- is player wielding the right key?
537 local item = clicker:get_wielded_item()
538 local meta = minetest.get_meta(pos)
539 local owner = meta:get_string("doors_owner")
540 if item:get_name() == "default:key" then
541 local key_meta = item:get_meta()
542 local secret = meta:get_string("key_lock_secret")
544 if key_meta:get_string("secret") == "" then
545 key_meta:set_string("secret", minetest.parse_json(item:get_metadata()).secret)
548 if secret ~= key_meta:get_string("secret") then
552 elseif owner ~= "" then
553 if clicker:get_player_name() ~= owner then
559 local def = minetest.registered_nodes[node.name]
561 if string.sub(node.name, -5) == "_open" then
562 minetest.sound_play(def.sound_close,
563 {pos = pos, gain = 0.3, max_hear_distance = 10})
564 minetest.swap_node(pos, {name = string.sub(node.name, 1,
565 string.len(node.name) - 5), param1 = node.param1, param2 = node.param2})
567 minetest.sound_play(def.sound_open,
568 {pos = pos, gain = 0.3, max_hear_distance = 10})
569 minetest.swap_node(pos, {name = node.name .. "_open",
570 param1 = node.param1, param2 = node.param2})
574 function doors.register_trapdoor(name, def)
575 if not name:find(":") then
576 name = "doors:" .. name
579 local name_closed = name
580 local name_opened = name.."_open"
582 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
583 _doors.trapdoor_toggle(pos, node, clicker)
587 -- Common trapdoor configuration
588 def.drawtype = "nodebox"
589 def.paramtype = "light"
590 def.paramtype2 = "facedir"
591 def.is_ground_content = false
593 if def.protected then
594 def.can_dig = can_dig_door
595 def.after_place_node = function(pos, placer, itemstack, pointed_thing)
596 local pn = placer:get_player_name()
597 local meta = minetest.get_meta(pos)
598 meta:set_string("doors_owner", pn)
599 meta:set_string("infotext", "Owned by "..pn)
601 return minetest.setting_getbool("creative_mode")
604 def.on_blast = function() end
605 def.on_key_use = function(pos, player)
606 local door = doors.get(pos)
609 def.on_skeleton_key_use = function(pos, player, newsecret)
610 local meta = minetest.get_meta(pos)
611 local owner = meta:get_string("doors_owner")
612 local pname = player:get_player_name()
614 -- verify placer is owner of lockable door
615 if owner ~= pname then
616 minetest.record_protection_violation(pos, pname)
617 minetest.chat_send_player(pname, "You do not own this trapdoor.")
621 local secret = meta:get_string("key_lock_secret")
624 meta:set_string("key_lock_secret", secret)
627 return secret, "a locked trapdoor", owner
630 def.on_blast = function(pos, intensity)
631 minetest.remove_node(pos)
636 if not def.sounds then
637 def.sounds = default.node_sound_wood_defaults()
640 if not def.sound_open then
641 def.sound_open = "doors_door_open"
644 if not def.sound_close then
645 def.sound_close = "doors_door_close"
648 local def_opened = table.copy(def)
649 local def_closed = table.copy(def)
651 def_closed.node_box = {
653 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
655 def_closed.selection_box = {
657 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
659 def_closed.tiles = {def.tile_front,
660 def.tile_front .. '^[transformFY',
661 def.tile_side, def.tile_side,
662 def.tile_side, def.tile_side}
664 def_opened.node_box = {
666 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
668 def_opened.selection_box = {
670 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
672 def_opened.tiles = {def.tile_side, def.tile_side,
673 def.tile_side .. '^[transform3',
674 def.tile_side .. '^[transform1',
675 def.tile_front .. '^[transform46',
676 def.tile_front .. '^[transform6'}
678 def_opened.drop = name_closed
679 def_opened.groups.not_in_creative_inventory = 1
681 minetest.register_node(name_opened, def_opened)
682 minetest.register_node(name_closed, def_closed)
684 _doors.registered_trapdoors[name_opened] = true
685 _doors.registered_trapdoors[name_closed] = true
688 doors.register_trapdoor("doors:trapdoor", {
689 description = "Trapdoor",
690 inventory_image = "doors_trapdoor.png",
691 wield_image = "doors_trapdoor.png",
692 tile_front = "doors_trapdoor.png",
693 tile_side = "doors_trapdoor_side.png",
694 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2, door = 1},
697 doors.register_trapdoor("doors:trapdoor_steel", {
698 description = "Steel Trapdoor",
699 inventory_image = "doors_trapdoor_steel.png",
700 wield_image = "doors_trapdoor_steel.png",
701 tile_front = "doors_trapdoor_steel.png",
702 tile_side = "doors_trapdoor_steel_side.png",
704 sounds = default.node_sound_metal_defaults(),
705 sound_open = "doors_steel_door_open",
706 sound_close = "doors_steel_door_close",
707 groups = {cracky = 1, level = 2, door = 1},
710 minetest.register_craft({
711 output = 'doors:trapdoor 2',
713 {'group:wood', 'group:wood', 'group:wood'},
714 {'group:wood', 'group:wood', 'group:wood'},
719 minetest.register_craft({
720 output = 'doors:trapdoor_steel',
722 {'default:steel_ingot', 'default:steel_ingot'},
723 {'default:steel_ingot', 'default:steel_ingot'},
730 function doors.register_fencegate(name, def)
732 description = def.description,
734 tiles = {def.texture},
736 paramtype2 = "facedir",
737 sunlight_propagates = true,
738 is_ground_content = false,
739 drop = name .. "_closed",
740 connect_sides = {"left", "right"},
743 on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
744 local node_def = minetest.registered_nodes[node.name]
745 minetest.swap_node(pos, {name = node_def.gate, param2 = node.param2})
746 minetest.sound_play(node_def.sound, {pos = pos, gain = 0.3,
747 max_hear_distance = 8})
752 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
756 if not fence.sounds then
757 fence.sounds = default.node_sound_wood_defaults()
760 fence.groups.fence = 1
762 local fence_closed = table.copy(fence)
763 fence_closed.mesh = "doors_fencegate_closed.obj"
764 fence_closed.gate = name .. "_open"
765 fence_closed.sound = "doors_fencegate_open"
766 fence_closed.collision_box = {
768 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
771 local fence_open = table.copy(fence)
772 fence_open.mesh = "doors_fencegate_open.obj"
773 fence_open.gate = name .. "_closed"
774 fence_open.sound = "doors_fencegate_close"
775 fence_open.groups.not_in_creative_inventory = 1
776 fence_open.collision_box = {
778 fixed = {{-1/2, -1/2, -1/4, -3/8, 1/2, 1/4},
779 {-1/2, -3/8, -1/2, -3/8, 3/8, 0}},
782 minetest.register_node(":" .. name .. "_closed", fence_closed)
783 minetest.register_node(":" .. name .. "_open", fence_open)
785 minetest.register_craft({
786 output = name .. "_closed",
788 {"default:stick", def.material, "default:stick"},
789 {"default:stick", def.material, "default:stick"}
794 doors.register_fencegate("doors:gate_wood", {
795 description = "Wooden Fence Gate",
796 texture = "default_wood.png",
797 material = "default:wood",
798 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
801 doors.register_fencegate("doors:gate_acacia_wood", {
802 description = "Acacia Fence Gate",
803 texture = "default_acacia_wood.png",
804 material = "default:acacia_wood",
805 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
808 doors.register_fencegate("doors:gate_junglewood", {
809 description = "Junglewood Fence Gate",
810 texture = "default_junglewood.png",
811 material = "default:junglewood",
812 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
815 doors.register_fencegate("doors:gate_pine_wood", {
816 description = "Pine Fence Gate",
817 texture = "default_pine_wood.png",
818 material = "default:pine_wood",
819 groups = {choppy = 3, oddly_breakable_by_hand = 2, flammable = 3}
822 doors.register_fencegate("doors:gate_aspen_wood", {
823 description = "Aspen Fence Gate",
824 texture = "default_aspen_wood.png",
825 material = "default:aspen_wood",
826 groups = {choppy = 3, oddly_breakable_by_hand = 2, flammable = 3}
832 minetest.register_craft({
834 recipe = "doors:trapdoor",
838 minetest.register_craft({
840 recipe = "doors:door_wood",
844 minetest.register_craft({
846 recipe = "doors:gate_wood_closed",
850 minetest.register_craft({
852 recipe = "doors:gate_acacia_wood_closed",
856 minetest.register_craft({
858 recipe = "doors:gate_junglewood_closed",
862 minetest.register_craft({
864 recipe = "doors:gate_pine_wood_closed",
868 minetest.register_craft({
870 recipe = "doors:gate_aspen_wood_closed",