6 _doors.registered_doors = {}
7 _doors.registered_trapdoors = {}
9 local function replace_old_owner_information(pos)
10 local meta = minetest.get_meta(pos)
11 local owner = meta:get_string("doors_owner")
12 if owner and owner ~= "" then
13 meta:set_string("owner", owner)
14 meta:set_string("doors_owner", "")
18 -- returns an object to a door object or nil
19 function doors.get(pos)
20 local node_name = minetest.get_node(pos).name
21 if _doors.registered_doors[node_name] then
22 -- A normal upright door
25 open = function(self, player)
29 return _doors.door_toggle(self.pos, nil, player)
31 close = function(self, player)
32 if not self:state() then
35 return _doors.door_toggle(self.pos, nil, player)
37 toggle = function(self, player)
38 return _doors.door_toggle(self.pos, nil, player)
40 state = function(self)
41 local state = minetest.get_meta(self.pos):get_int("state")
45 elseif _doors.registered_trapdoors[node_name] then
49 open = function(self, player)
53 return _doors.trapdoor_toggle(self.pos, nil, player)
55 close = function(self, player)
56 if not self:state() then
59 return _doors.trapdoor_toggle(self.pos, nil, player)
61 toggle = function(self, player)
62 return _doors.trapdoor_toggle(self.pos, nil, player)
64 state = function(self)
65 return minetest.get_node(self.pos).name:sub(-5) == "_open"
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 -- can't use airlike otherwise falling nodes will turn to entities
78 -- and will be forever stuck until door is removed.
81 paramtype2 = "facedir",
82 sunlight_propagates = true,
83 -- has to be walkable for falling nodes to stop falling.
90 groups = {not_in_creative_inventory = 1},
91 on_blast = function() end,
92 tiles = {"doors_blank.png"},
93 -- 1px transparent block inside door hinge near node top.
96 fixed = {-15/32, 13/32, -15/32, -13/32, 1/2, -13/32},
98 -- collision_box needed otherise selection box would be full node size
101 fixed = {-15/32, 13/32, -15/32, -13/32, 1/2, -13/32},
105 -- table used to aid door opening/closing
108 {v = "_a", param2 = 3},
109 {v = "_a", param2 = 0},
110 {v = "_a", param2 = 1},
111 {v = "_a", param2 = 2},
114 {v = "_b", param2 = 1},
115 {v = "_b", param2 = 2},
116 {v = "_b", param2 = 3},
117 {v = "_b", param2 = 0},
120 {v = "_b", param2 = 1},
121 {v = "_b", param2 = 2},
122 {v = "_b", param2 = 3},
123 {v = "_b", param2 = 0},
126 {v = "_a", param2 = 3},
127 {v = "_a", param2 = 0},
128 {v = "_a", param2 = 1},
129 {v = "_a", param2 = 2},
133 function _doors.door_toggle(pos, node, clicker)
134 local meta = minetest.get_meta(pos)
135 node = node or minetest.get_node(pos)
136 local def = minetest.registered_nodes[node.name]
137 local name = def.door.name
139 local state = meta:get_string("state")
141 -- fix up lvm-placed right-hinged doors, default closed
142 if node.name:sub(-2) == "_b" then
148 state = tonumber(state)
151 replace_old_owner_information(pos)
153 if clicker and not default.can_interact_with_node(clicker, pos) then
157 -- until Lua-5.2 we have no bitwise operators :(
158 if state % 2 == 1 then
164 local dir = node.param2
165 if state % 2 == 0 then
166 minetest.sound_play(def.door.sounds[1],
167 {pos = pos, gain = 0.3, max_hear_distance = 10})
169 minetest.sound_play(def.door.sounds[2],
170 {pos = pos, gain = 0.3, max_hear_distance = 10})
173 minetest.swap_node(pos, {
174 name = name .. transform[state + 1][dir+1].v,
175 param2 = transform[state + 1][dir+1].param2
177 meta:set_int("state", state)
183 local function on_place_node(place_to, newnode,
184 placer, oldnode, itemstack, pointed_thing)
186 for _, callback in ipairs(minetest.registered_on_placenodes) do
187 -- Deepcopy pos, node and pointed_thing because callback can modify them
188 local place_to_copy = {x = place_to.x, y = place_to.y, z = place_to.z}
190 {name = newnode.name, param1 = newnode.param1, param2 = newnode.param2}
192 {name = oldnode.name, param1 = oldnode.param1, param2 = oldnode.param2}
193 local pointed_thing_copy = {
194 type = pointed_thing.type,
195 above = vector.new(pointed_thing.above),
196 under = vector.new(pointed_thing.under),
197 ref = pointed_thing.ref,
199 callback(place_to_copy, newnode_copy, placer,
200 oldnode_copy, itemstack, pointed_thing_copy)
204 local function can_dig_door(pos, digger)
205 replace_old_owner_information(pos)
206 if default.can_interact_with_node(digger, pos) then
209 minetest.record_protection_violation(pos, digger:get_player_name())
214 function doors.register(name, def)
215 if not name:find(":") then
216 name = "doors:" .. name
219 -- replace old doors of this type automatically
220 minetest.register_lbm({
221 name = ":doors:replace_" .. name:gsub(":", "_"),
222 nodenames = {name.."_b_1", name.."_b_2"},
223 action = function(pos, node)
224 local l = tonumber(node.name:sub(-1))
225 local meta = minetest.get_meta(pos)
226 local h = meta:get_int("right") + 1
227 local p2 = node.param2
229 {{type = "a", state = 0}, {type = "a", state = 3}},
230 {{type = "b", state = 1}, {type = "b", state = 2}}
232 local new = replace[l][h]
233 -- retain infotext and doors_owner fields
234 minetest.swap_node(pos, {name = name .. "_" .. new.type, param2 = p2})
235 meta:set_int("state", new.state)
236 -- properly place doors:hidden at the right spot
238 if new.state >= 2 then
241 if new.state % 2 == 1 then
242 if new.state >= 2 then
248 -- wipe meta on top node as it's unused
249 minetest.set_node({x = pos.x, y = pos.y + 1, z = pos.z},
250 {name = "doors:hidden", param2 = p3})
254 minetest.register_craftitem(":" .. name, {
255 description = def.description,
256 inventory_image = def.inventory_image,
257 groups = table.copy(def.groups),
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 and placer:is_player() and
270 placer:get_player_control().sneak) then
271 return pdef.on_rightclick(pointed_thing.under,
272 node, placer, itemstack, pointed_thing)
275 if pdef and pdef.buildable_to then
276 pos = pointed_thing.under
278 pos = pointed_thing.above
279 node = minetest.get_node(pos)
280 pdef = minetest.registered_nodes[node.name]
281 if not pdef or not pdef.buildable_to then
286 local above = {x = pos.x, y = pos.y + 1, z = pos.z}
287 local top_node = minetest.get_node_or_nil(above)
288 local topdef = top_node and minetest.registered_nodes[top_node.name]
290 if not topdef or not topdef.buildable_to then
294 local pn = placer and placer:get_player_name() or ""
295 if minetest.is_protected(pos, pn) or minetest.is_protected(above, pn) then
299 local dir = placer and minetest.dir_to_facedir(placer:get_look_dir()) or 0
302 {x = -1, y = 0, z = 0},
303 {x = 0, y = 0, z = 1},
304 {x = 1, y = 0, z = 0},
305 {x = 0, y = 0, z = -1},
309 x = pos.x + ref[dir + 1].x,
310 y = pos.y + ref[dir + 1].y,
311 z = pos.z + ref[dir + 1].z,
315 if minetest.get_item_group(minetest.get_node(aside).name, "door") == 1 then
317 minetest.set_node(pos, {name = name .. "_b", param2 = dir})
318 minetest.set_node(above, {name = "doors:hidden", param2 = (dir + 3) % 4})
320 minetest.set_node(pos, {name = name .. "_a", param2 = dir})
321 minetest.set_node(above, {name = "doors:hidden", param2 = dir})
324 local meta = minetest.get_meta(pos)
325 meta:set_int("state", state)
327 if def.protected then
328 meta:set_string("owner", pn)
329 meta:set_string("infotext", "Owned by " .. pn)
332 if not (creative and creative.is_enabled_for and creative.is_enabled_for(pn)) then
333 itemstack:take_item()
336 minetest.sound_play(def.sounds.place, {pos = pos})
338 on_place_node(pos, minetest.get_node(pos),
339 placer, node, itemstack, pointed_thing)
344 def.inventory_image = nil
347 minetest.register_craft({
354 if not def.sounds then
355 def.sounds = default.node_sound_wood_defaults()
358 if not def.sound_open then
359 def.sound_open = "doors_door_open"
362 if not def.sound_close then
363 def.sound_close = "doors_door_close"
366 def.groups.not_in_creative_inventory = 1
371 sounds = { def.sound_close, def.sound_open },
374 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
375 _doors.door_toggle(pos, node, clicker)
378 def.after_dig_node = function(pos, node, meta, digger)
379 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
380 minetest.check_for_falling({x = pos.x, y = pos.y + 1, z = pos.z})
382 def.on_rotate = function(pos, node, user, mode, new_param2)
386 if def.protected then
387 def.can_dig = can_dig_door
388 def.on_blast = function() end
389 def.on_key_use = function(pos, player)
390 local door = doors.get(pos)
393 def.on_skeleton_key_use = function(pos, player, newsecret)
394 replace_old_owner_information(pos)
395 local meta = minetest.get_meta(pos)
396 local owner = meta:get_string("owner")
397 local pname = player:get_player_name()
399 -- verify placer is owner of lockable door
400 if owner ~= pname then
401 minetest.record_protection_violation(pos, pname)
402 minetest.chat_send_player(pname, "You do not own this locked door.")
406 local secret = meta:get_string("key_lock_secret")
409 meta:set_string("key_lock_secret", secret)
412 return secret, "a locked door", owner
415 def.on_blast = function(pos, intensity)
416 minetest.remove_node(pos)
417 -- hidden node doesn't get blasted away.
418 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
423 def.on_destruct = function(pos)
424 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
427 def.drawtype = "mesh"
428 def.paramtype = "light"
429 def.paramtype2 = "facedir"
430 def.sunlight_propagates = true
432 def.is_ground_content = false
433 def.buildable_to = false
434 def.selection_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
435 def.collision_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
437 def.mesh = "door_a.obj"
438 minetest.register_node(":" .. name .. "_a", def)
440 def.mesh = "door_b.obj"
441 minetest.register_node(":" .. name .. "_b", def)
443 _doors.registered_doors[name .. "_a"] = true
444 _doors.registered_doors[name .. "_b"] = true
447 doors.register("door_wood", {
448 tiles = {{ name = "doors_door_wood.png", backface_culling = true }},
449 description = "Wooden Door",
450 inventory_image = "doors_item_wood.png",
451 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2},
453 {"group:wood", "group:wood"},
454 {"group:wood", "group:wood"},
455 {"group:wood", "group:wood"},
459 doors.register("door_steel", {
460 tiles = {{name = "doors_door_steel.png", backface_culling = true}},
461 description = "Steel Door",
462 inventory_image = "doors_item_steel.png",
464 groups = {cracky = 1, level = 2},
465 sounds = default.node_sound_metal_defaults(),
466 sound_open = "doors_steel_door_open",
467 sound_close = "doors_steel_door_close",
469 {"default:steel_ingot", "default:steel_ingot"},
470 {"default:steel_ingot", "default:steel_ingot"},
471 {"default:steel_ingot", "default:steel_ingot"},
475 doors.register("door_glass", {
476 tiles = {"doors_door_glass.png"},
477 description = "Glass Door",
478 inventory_image = "doors_item_glass.png",
479 groups = {cracky=3, oddly_breakable_by_hand=3},
480 sounds = default.node_sound_glass_defaults(),
481 sound_open = "doors_glass_door_open",
482 sound_close = "doors_glass_door_close",
484 {"default:glass", "default:glass"},
485 {"default:glass", "default:glass"},
486 {"default:glass", "default:glass"},
490 doors.register("door_obsidian_glass", {
491 tiles = {"doors_door_obsidian_glass.png"},
492 description = "Obsidian Glass Door",
493 inventory_image = "doors_item_obsidian_glass.png",
495 sounds = default.node_sound_glass_defaults(),
496 sound_open = "doors_glass_door_open",
497 sound_close = "doors_glass_door_close",
499 {"default:obsidian_glass", "default:obsidian_glass"},
500 {"default:obsidian_glass", "default:obsidian_glass"},
501 {"default:obsidian_glass", "default:obsidian_glass"},
505 -- Capture mods using the old API as best as possible.
506 function doors.register_door(name, def)
507 if def.only_placer_can_open then
510 def.only_placer_can_open = nil
512 local i = name:find(":")
513 local modname = name:sub(1, i - 1)
514 if not def.tiles then
515 if def.protected then
516 def.tiles = {{name = "doors_door_steel.png", backface_culling = true}}
518 def.tiles = {{name = "doors_door_wood.png", backface_culling = true}}
520 minetest.log("warning", modname .. " registered door \"" .. name .. "\" " ..
521 "using deprecated API method \"doors.register_door()\" but " ..
522 "did not provide the \"tiles\" parameter. A fallback tiledef " ..
523 "will be used instead.")
526 doors.register(name, def)
531 function _doors.trapdoor_toggle(pos, node, clicker)
532 node = node or minetest.get_node(pos)
534 replace_old_owner_information(pos)
536 if clicker and not default.can_interact_with_node(clicker, pos) then
540 local def = minetest.registered_nodes[node.name]
542 if string.sub(node.name, -5) == "_open" then
543 minetest.sound_play(def.sound_close,
544 {pos = pos, gain = 0.3, max_hear_distance = 10})
545 minetest.swap_node(pos, {name = string.sub(node.name, 1,
546 string.len(node.name) - 5), param1 = node.param1, param2 = node.param2})
548 minetest.sound_play(def.sound_open,
549 {pos = pos, gain = 0.3, max_hear_distance = 10})
550 minetest.swap_node(pos, {name = node.name .. "_open",
551 param1 = node.param1, param2 = node.param2})
555 function doors.register_trapdoor(name, def)
556 if not name:find(":") then
557 name = "doors:" .. name
560 local name_closed = name
561 local name_opened = name.."_open"
563 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
564 _doors.trapdoor_toggle(pos, node, clicker)
568 -- Common trapdoor configuration
569 def.drawtype = "nodebox"
570 def.paramtype = "light"
571 def.paramtype2 = "facedir"
572 def.is_ground_content = false
574 if def.protected then
575 def.can_dig = can_dig_door
576 def.after_place_node = function(pos, placer, itemstack, pointed_thing)
577 local pn = placer:get_player_name()
578 local meta = minetest.get_meta(pos)
579 meta:set_string("owner", pn)
580 meta:set_string("infotext", "Owned by "..pn)
582 return (creative and creative.is_enabled_for and creative.is_enabled_for(pn))
585 def.on_blast = function() end
586 def.on_key_use = function(pos, player)
587 local door = doors.get(pos)
590 def.on_skeleton_key_use = function(pos, player, newsecret)
591 replace_old_owner_information(pos)
592 local meta = minetest.get_meta(pos)
593 local owner = meta:get_string("owner")
594 local pname = player:get_player_name()
596 -- verify placer is owner of lockable door
597 if owner ~= pname then
598 minetest.record_protection_violation(pos, pname)
599 minetest.chat_send_player(pname, "You do not own this trapdoor.")
603 local secret = meta:get_string("key_lock_secret")
606 meta:set_string("key_lock_secret", secret)
609 return secret, "a locked trapdoor", owner
612 def.on_blast = function(pos, intensity)
613 minetest.remove_node(pos)
618 if not def.sounds then
619 def.sounds = default.node_sound_wood_defaults()
622 if not def.sound_open then
623 def.sound_open = "doors_door_open"
626 if not def.sound_close then
627 def.sound_close = "doors_door_close"
630 local def_opened = table.copy(def)
631 local def_closed = table.copy(def)
633 def_closed.node_box = {
635 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
637 def_closed.selection_box = {
639 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
641 def_closed.tiles = {def.tile_front,
642 def.tile_front .. '^[transformFY',
643 def.tile_side, def.tile_side,
644 def.tile_side, def.tile_side}
646 def_opened.node_box = {
648 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
650 def_opened.selection_box = {
652 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
654 def_opened.tiles = {def.tile_side, def.tile_side,
655 def.tile_side .. '^[transform3',
656 def.tile_side .. '^[transform1',
657 def.tile_front .. '^[transform46',
658 def.tile_front .. '^[transform6'}
660 def_opened.drop = name_closed
661 def_opened.groups.not_in_creative_inventory = 1
663 minetest.register_node(name_opened, def_opened)
664 minetest.register_node(name_closed, def_closed)
666 _doors.registered_trapdoors[name_opened] = true
667 _doors.registered_trapdoors[name_closed] = true
670 doors.register_trapdoor("doors:trapdoor", {
671 description = "Trapdoor",
672 inventory_image = "doors_trapdoor.png",
673 wield_image = "doors_trapdoor.png",
674 tile_front = "doors_trapdoor.png",
675 tile_side = "doors_trapdoor_side.png",
676 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2, door = 1},
679 doors.register_trapdoor("doors:trapdoor_steel", {
680 description = "Steel Trapdoor",
681 inventory_image = "doors_trapdoor_steel.png",
682 wield_image = "doors_trapdoor_steel.png",
683 tile_front = "doors_trapdoor_steel.png",
684 tile_side = "doors_trapdoor_steel_side.png",
686 sounds = default.node_sound_metal_defaults(),
687 sound_open = "doors_steel_door_open",
688 sound_close = "doors_steel_door_close",
689 groups = {cracky = 1, level = 2, door = 1},
692 minetest.register_craft({
693 output = 'doors:trapdoor 2',
695 {'group:wood', 'group:wood', 'group:wood'},
696 {'group:wood', 'group:wood', 'group:wood'},
701 minetest.register_craft({
702 output = 'doors:trapdoor_steel',
704 {'default:steel_ingot', 'default:steel_ingot'},
705 {'default:steel_ingot', 'default:steel_ingot'},
712 function doors.register_fencegate(name, def)
714 description = def.description,
718 paramtype2 = "facedir",
719 sunlight_propagates = true,
720 is_ground_content = false,
721 drop = name .. "_closed",
722 connect_sides = {"left", "right"},
725 on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
726 local node_def = minetest.registered_nodes[node.name]
727 minetest.swap_node(pos, {name = node_def.gate, param2 = node.param2})
728 minetest.sound_play(node_def.sound, {pos = pos, gain = 0.3,
729 max_hear_distance = 8})
734 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
739 if type(def.texture) == "string" then
740 fence.tiles[1] = {name = def.texture, backface_culling = true}
741 elseif def.texture.backface_culling == nil then
742 fence.tiles[1] = table.copy(def.texture)
743 fence.tiles[1].backface_culling = true
745 fence.tiles[1] = def.texture
748 if not fence.sounds then
749 fence.sounds = default.node_sound_wood_defaults()
752 fence.groups.fence = 1
754 local fence_closed = table.copy(fence)
755 fence_closed.mesh = "doors_fencegate_closed.obj"
756 fence_closed.gate = name .. "_open"
757 fence_closed.sound = "doors_fencegate_open"
758 fence_closed.collision_box = {
760 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
763 local fence_open = table.copy(fence)
764 fence_open.mesh = "doors_fencegate_open.obj"
765 fence_open.gate = name .. "_closed"
766 fence_open.sound = "doors_fencegate_close"
767 fence_open.groups.not_in_creative_inventory = 1
768 fence_open.collision_box = {
770 fixed = {{-1/2, -1/2, -1/4, -3/8, 1/2, 1/4},
771 {-1/2, -3/8, -1/2, -3/8, 3/8, 0}},
774 minetest.register_node(":" .. name .. "_closed", fence_closed)
775 minetest.register_node(":" .. name .. "_open", fence_open)
777 minetest.register_craft({
778 output = name .. "_closed",
780 {"default:stick", def.material, "default:stick"},
781 {"default:stick", def.material, "default:stick"}
786 doors.register_fencegate("doors:gate_wood", {
787 description = "Wooden Fence Gate",
788 texture = "default_wood.png",
789 material = "default:wood",
790 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
793 doors.register_fencegate("doors:gate_acacia_wood", {
794 description = "Acacia Fence Gate",
795 texture = "default_acacia_wood.png",
796 material = "default:acacia_wood",
797 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
800 doors.register_fencegate("doors:gate_junglewood", {
801 description = "Jungle Wood Fence Gate",
802 texture = "default_junglewood.png",
803 material = "default:junglewood",
804 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
807 doors.register_fencegate("doors:gate_pine_wood", {
808 description = "Pine Fence Gate",
809 texture = "default_pine_wood.png",
810 material = "default:pine_wood",
811 groups = {choppy = 3, oddly_breakable_by_hand = 2, flammable = 3}
814 doors.register_fencegate("doors:gate_aspen_wood", {
815 description = "Aspen Fence Gate",
816 texture = "default_aspen_wood.png",
817 material = "default:aspen_wood",
818 groups = {choppy = 3, oddly_breakable_by_hand = 2, flammable = 3}
824 minetest.register_craft({
826 recipe = "doors:trapdoor",
830 minetest.register_craft({
832 recipe = "doors:door_wood",
836 minetest.register_craft({
838 recipe = "doors:gate_wood_closed",
842 minetest.register_craft({
844 recipe = "doors:gate_acacia_wood_closed",
848 minetest.register_craft({
850 recipe = "doors:gate_junglewood_closed",
854 minetest.register_craft({
856 recipe = "doors:gate_pine_wood_closed",
860 minetest.register_craft({
862 recipe = "doors:gate_aspen_wood_closed",