6 doors.registered_doors = {}
7 doors.registered_trapdoors = {}
9 -- Load support for MT game translation.
10 local S = minetest.get_translator("doors")
13 local function replace_old_owner_information(pos)
14 local meta = minetest.get_meta(pos)
15 local owner = meta:get_string("doors_owner")
16 if owner and owner ~= "" then
17 meta:set_string("owner", owner)
18 meta:set_string("doors_owner", "")
22 -- returns an object to a door object or nil
23 function doors.get(pos)
24 local node_name = minetest.get_node(pos).name
25 if doors.registered_doors[node_name] then
26 -- A normal upright door
29 open = function(self, player)
33 return doors.door_toggle(self.pos, nil, player)
35 close = function(self, player)
36 if not self:state() then
39 return doors.door_toggle(self.pos, nil, player)
41 toggle = function(self, player)
42 return doors.door_toggle(self.pos, nil, player)
44 state = function(self)
45 local state = minetest.get_meta(self.pos):get_int("state")
49 elseif doors.registered_trapdoors[node_name] then
53 open = function(self, player)
57 return doors.trapdoor_toggle(self.pos, nil, player)
59 close = function(self, player)
60 if not self:state() then
63 return doors.trapdoor_toggle(self.pos, nil, player)
65 toggle = function(self, player)
66 return doors.trapdoor_toggle(self.pos, nil, player)
68 state = function(self)
69 return minetest.get_node(self.pos).name:sub(-5) == "_open"
77 -- this hidden node is placed on top of the bottom, and prevents
78 -- nodes from being placed in the top half of the door.
79 minetest.register_node("doors:hidden", {
80 description = S("Hidden Door Segment"),
81 -- can't use airlike otherwise falling nodes will turn to entities
82 -- and will be forever stuck until door is removed.
85 paramtype2 = "facedir",
86 sunlight_propagates = true,
87 -- has to be walkable for falling nodes to stop falling.
94 groups = {not_in_creative_inventory = 1},
95 on_blast = function() end,
96 tiles = {"doors_blank.png"},
97 -- 1px transparent block inside door hinge near node top.
100 fixed = {-15/32, 13/32, -15/32, -13/32, 1/2, -13/32},
102 -- collision_box needed otherise selection box would be full node size
105 fixed = {-15/32, 13/32, -15/32, -13/32, 1/2, -13/32},
109 -- table used to aid door opening/closing
112 {v = "_a", param2 = 3},
113 {v = "_a", param2 = 0},
114 {v = "_a", param2 = 1},
115 {v = "_a", param2 = 2},
118 {v = "_b", param2 = 1},
119 {v = "_b", param2 = 2},
120 {v = "_b", param2 = 3},
121 {v = "_b", param2 = 0},
124 {v = "_b", param2 = 1},
125 {v = "_b", param2 = 2},
126 {v = "_b", param2 = 3},
127 {v = "_b", param2 = 0},
130 {v = "_a", param2 = 3},
131 {v = "_a", param2 = 0},
132 {v = "_a", param2 = 1},
133 {v = "_a", param2 = 2},
137 function doors.door_toggle(pos, node, clicker)
138 local meta = minetest.get_meta(pos)
139 node = node or minetest.get_node(pos)
140 local def = minetest.registered_nodes[node.name]
141 local name = def.door.name
143 local state = meta:get_string("state")
145 -- fix up lvm-placed right-hinged doors, default closed
146 if node.name:sub(-2) == "_b" then
152 state = tonumber(state)
155 replace_old_owner_information(pos)
157 if clicker and not default.can_interact_with_node(clicker, pos) then
161 -- until Lua-5.2 we have no bitwise operators :(
162 if state % 2 == 1 then
168 local dir = node.param2
170 -- It's possible param2 is messed up, so, validate before using
171 -- the input data. This indicates something may have rotated
172 -- the door, even though that is not supported.
173 if not transform[state + 1] or not transform[state + 1][dir + 1] then
177 if state % 2 == 0 then
178 minetest.sound_play(def.door.sounds[1],
179 {pos = pos, gain = 0.3, max_hear_distance = 10}, true)
181 minetest.sound_play(def.door.sounds[2],
182 {pos = pos, gain = 0.3, max_hear_distance = 10}, true)
185 minetest.swap_node(pos, {
186 name = name .. transform[state + 1][dir+1].v,
187 param2 = transform[state + 1][dir+1].param2
189 meta:set_int("state", state)
195 local function on_place_node(place_to, newnode,
196 placer, oldnode, itemstack, pointed_thing)
198 for _, callback in ipairs(minetest.registered_on_placenodes) do
199 -- Deepcopy pos, node and pointed_thing because callback can modify them
200 local place_to_copy = {x = place_to.x, y = place_to.y, z = place_to.z}
202 {name = newnode.name, param1 = newnode.param1, param2 = newnode.param2}
204 {name = oldnode.name, param1 = oldnode.param1, param2 = oldnode.param2}
205 local pointed_thing_copy = {
206 type = pointed_thing.type,
207 above = vector.new(pointed_thing.above),
208 under = vector.new(pointed_thing.under),
209 ref = pointed_thing.ref,
211 callback(place_to_copy, newnode_copy, placer,
212 oldnode_copy, itemstack, pointed_thing_copy)
216 local function can_dig_door(pos, digger)
217 replace_old_owner_information(pos)
218 return default.can_interact_with_node(digger, pos)
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,
264 groups = table.copy(def.groups),
266 on_place = function(itemstack, placer, pointed_thing)
269 if not pointed_thing.type == "node" then
273 local node = minetest.get_node(pointed_thing.under)
274 local pdef = minetest.registered_nodes[node.name]
275 if pdef and pdef.on_rightclick and
276 not (placer and placer:is_player() and
277 placer:get_player_control().sneak) then
278 return pdef.on_rightclick(pointed_thing.under,
279 node, placer, itemstack, pointed_thing)
282 if pdef and pdef.buildable_to then
283 pos = pointed_thing.under
285 pos = pointed_thing.above
286 node = minetest.get_node(pos)
287 pdef = minetest.registered_nodes[node.name]
288 if not pdef or not pdef.buildable_to then
293 local above = {x = pos.x, y = pos.y + 1, z = pos.z}
294 local top_node = minetest.get_node_or_nil(above)
295 local topdef = top_node and minetest.registered_nodes[top_node.name]
297 if not topdef or not topdef.buildable_to then
301 local pn = placer and placer:get_player_name() or ""
302 if minetest.is_protected(pos, pn) or minetest.is_protected(above, pn) then
306 local dir = placer and minetest.dir_to_facedir(placer:get_look_dir()) or 0
309 {x = -1, y = 0, z = 0},
310 {x = 0, y = 0, z = 1},
311 {x = 1, y = 0, z = 0},
312 {x = 0, y = 0, z = -1},
316 x = pos.x + ref[dir + 1].x,
317 y = pos.y + ref[dir + 1].y,
318 z = pos.z + ref[dir + 1].z,
322 if minetest.get_item_group(minetest.get_node(aside).name, "door") == 1 then
324 minetest.set_node(pos, {name = name .. "_b", param2 = dir})
325 minetest.set_node(above, {name = "doors:hidden", param2 = (dir + 3) % 4})
327 minetest.set_node(pos, {name = name .. "_a", param2 = dir})
328 minetest.set_node(above, {name = "doors:hidden", param2 = dir})
331 local meta = minetest.get_meta(pos)
332 meta:set_int("state", state)
334 if def.protected then
335 meta:set_string("owner", pn)
336 meta:set_string("infotext", def.description .. "\n" .. S("Owned by @1", pn))
339 if not (creative and creative.is_enabled_for and creative.is_enabled_for(pn)) then
340 itemstack:take_item()
343 minetest.sound_play(def.sounds.place, {pos = pos}, true)
345 on_place_node(pos, minetest.get_node(pos),
346 placer, node, itemstack, pointed_thing)
351 def.inventory_image = nil
354 minetest.register_craft({
361 if not def.sounds then
362 def.sounds = default.node_sound_wood_defaults()
365 if not def.sound_open then
366 def.sound_open = "doors_door_open"
369 if not def.sound_close then
370 def.sound_close = "doors_door_close"
373 def.groups.not_in_creative_inventory = 1
378 sounds = { def.sound_close, def.sound_open },
380 if not def.on_rightclick then
381 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
382 doors.door_toggle(pos, node, clicker)
386 def.after_dig_node = function(pos, node, meta, digger)
387 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
388 minetest.check_for_falling({x = pos.x, y = pos.y + 1, z = pos.z})
390 def.on_rotate = function(pos, node, user, mode, new_param2)
394 if def.protected then
395 def.can_dig = can_dig_door
396 def.on_blast = function() end
397 def.on_key_use = function(pos, player)
398 local door = doors.get(pos)
401 def.on_skeleton_key_use = function(pos, player, newsecret)
402 replace_old_owner_information(pos)
403 local meta = minetest.get_meta(pos)
404 local owner = meta:get_string("owner")
405 local pname = player:get_player_name()
407 -- verify placer is owner of lockable door
408 if owner ~= pname then
409 minetest.record_protection_violation(pos, pname)
410 minetest.chat_send_player(pname, S("You do not own this locked door."))
414 local secret = meta:get_string("key_lock_secret")
417 meta:set_string("key_lock_secret", secret)
420 return secret, S("a locked door"), owner
422 def.node_dig_prediction = ""
424 def.on_blast = function(pos, intensity)
425 minetest.remove_node(pos)
426 -- hidden node doesn't get blasted away.
427 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
432 def.on_destruct = function(pos)
433 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
436 def.drawtype = "mesh"
437 def.paramtype = "light"
438 def.paramtype2 = "facedir"
439 def.sunlight_propagates = true
441 def.is_ground_content = false
442 def.buildable_to = false
443 def.selection_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
444 def.collision_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
446 def.mesh = "door_a.obj"
447 minetest.register_node(":" .. name .. "_a", def)
449 def.mesh = "door_b.obj"
450 minetest.register_node(":" .. name .. "_b", def)
452 doors.registered_doors[name .. "_a"] = true
453 doors.registered_doors[name .. "_b"] = true
456 doors.register("door_wood", {
457 tiles = {{ name = "doors_door_wood.png", backface_culling = true }},
458 description = S("Wooden Door"),
459 inventory_image = "doors_item_wood.png",
460 groups = {node = 1, choppy = 2, oddly_breakable_by_hand = 2, flammable = 2},
462 {"group:wood", "group:wood"},
463 {"group:wood", "group:wood"},
464 {"group:wood", "group:wood"},
468 doors.register("door_steel", {
469 tiles = {{name = "doors_door_steel.png", backface_culling = true}},
470 description = S("Steel Door"),
471 inventory_image = "doors_item_steel.png",
473 groups = {node = 1, cracky = 1, level = 2},
474 sounds = default.node_sound_metal_defaults(),
475 sound_open = "doors_steel_door_open",
476 sound_close = "doors_steel_door_close",
478 {"default:steel_ingot", "default:steel_ingot"},
479 {"default:steel_ingot", "default:steel_ingot"},
480 {"default:steel_ingot", "default:steel_ingot"},
484 doors.register("door_glass", {
485 tiles = {"doors_door_glass.png"},
486 description = S("Glass Door"),
487 inventory_image = "doors_item_glass.png",
488 groups = {node = 1, cracky=3, oddly_breakable_by_hand=3},
489 sounds = default.node_sound_glass_defaults(),
490 sound_open = "doors_glass_door_open",
491 sound_close = "doors_glass_door_close",
493 {"default:glass", "default:glass"},
494 {"default:glass", "default:glass"},
495 {"default:glass", "default:glass"},
499 doors.register("door_obsidian_glass", {
500 tiles = {"doors_door_obsidian_glass.png"},
501 description = S("Obsidian Glass Door"),
502 inventory_image = "doors_item_obsidian_glass.png",
503 groups = {node = 1, cracky=3},
504 sounds = default.node_sound_glass_defaults(),
505 sound_open = "doors_glass_door_open",
506 sound_close = "doors_glass_door_close",
508 {"default:obsidian_glass", "default:obsidian_glass"},
509 {"default:obsidian_glass", "default:obsidian_glass"},
510 {"default:obsidian_glass", "default:obsidian_glass"},
514 -- Capture mods using the old API as best as possible.
515 function doors.register_door(name, def)
516 if def.only_placer_can_open then
519 def.only_placer_can_open = nil
521 local i = name:find(":")
522 local modname = name:sub(1, i - 1)
523 if not def.tiles then
524 if def.protected then
525 def.tiles = {{name = "doors_door_steel.png", backface_culling = true}}
527 def.tiles = {{name = "doors_door_wood.png", backface_culling = true}}
529 minetest.log("warning", modname .. " registered door \"" .. name .. "\" " ..
530 "using deprecated API method \"doors.register_door()\" but " ..
531 "did not provide the \"tiles\" parameter. A fallback tiledef " ..
532 "will be used instead.")
535 doors.register(name, def)
540 function doors.trapdoor_toggle(pos, node, clicker)
541 node = node or minetest.get_node(pos)
543 replace_old_owner_information(pos)
545 if clicker and not default.can_interact_with_node(clicker, pos) then
549 local def = minetest.registered_nodes[node.name]
551 if string.sub(node.name, -5) == "_open" then
552 minetest.sound_play(def.sound_close,
553 {pos = pos, gain = 0.3, max_hear_distance = 10}, true)
554 minetest.swap_node(pos, {name = string.sub(node.name, 1,
555 string.len(node.name) - 5), param1 = node.param1, param2 = node.param2})
557 minetest.sound_play(def.sound_open,
558 {pos = pos, gain = 0.3, max_hear_distance = 10}, true)
559 minetest.swap_node(pos, {name = node.name .. "_open",
560 param1 = node.param1, param2 = node.param2})
564 function doors.register_trapdoor(name, def)
565 if not name:find(":") then
566 name = "doors:" .. name
569 local name_closed = name
570 local name_opened = name.."_open"
572 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
573 doors.trapdoor_toggle(pos, node, clicker)
577 -- Common trapdoor configuration
578 def.drawtype = "nodebox"
579 def.paramtype = "light"
580 def.paramtype2 = "facedir"
581 def.is_ground_content = false
583 if def.protected then
584 def.can_dig = can_dig_door
585 def.after_place_node = function(pos, placer, itemstack, pointed_thing)
586 local pn = placer:get_player_name()
587 local meta = minetest.get_meta(pos)
588 meta:set_string("owner", pn)
589 meta:set_string("infotext", def.description .. "\n" .. S("Owned by @1", pn))
591 return (creative and creative.is_enabled_for and creative.is_enabled_for(pn))
594 def.on_blast = function() end
595 def.on_key_use = function(pos, player)
596 local door = doors.get(pos)
599 def.on_skeleton_key_use = function(pos, player, newsecret)
600 replace_old_owner_information(pos)
601 local meta = minetest.get_meta(pos)
602 local owner = meta:get_string("owner")
603 local pname = player:get_player_name()
605 -- verify placer is owner of lockable door
606 if owner ~= pname then
607 minetest.record_protection_violation(pos, pname)
608 minetest.chat_send_player(pname, S("You do not own this trapdoor."))
612 local secret = meta:get_string("key_lock_secret")
615 meta:set_string("key_lock_secret", secret)
618 return secret, S("a locked trapdoor"), owner
620 def.node_dig_prediction = ""
622 def.on_blast = function(pos, intensity)
623 minetest.remove_node(pos)
628 if not def.sounds then
629 def.sounds = default.node_sound_wood_defaults()
632 if not def.sound_open then
633 def.sound_open = "doors_door_open"
636 if not def.sound_close then
637 def.sound_close = "doors_door_close"
640 local def_opened = table.copy(def)
641 local def_closed = table.copy(def)
643 def_closed.node_box = {
645 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
647 def_closed.selection_box = {
649 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
653 def.tile_front .. '^[transformFY',
660 def_opened.node_box = {
662 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
664 def_opened.selection_box = {
666 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
670 def.tile_side .. '^[transform2',
671 def.tile_side .. '^[transform3',
672 def.tile_side .. '^[transform1',
673 def.tile_front .. '^[transform46',
674 def.tile_front .. '^[transform6'
677 def_opened.drop = name_closed
678 def_opened.groups.not_in_creative_inventory = 1
680 minetest.register_node(name_opened, def_opened)
681 minetest.register_node(name_closed, def_closed)
683 doors.registered_trapdoors[name_opened] = true
684 doors.registered_trapdoors[name_closed] = true
687 doors.register_trapdoor("doors:trapdoor", {
688 description = S("Wooden Trapdoor"),
689 inventory_image = "doors_trapdoor.png",
690 wield_image = "doors_trapdoor.png",
691 tile_front = "doors_trapdoor.png",
692 tile_side = "doors_trapdoor_side.png",
693 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2, door = 1},
696 doors.register_trapdoor("doors:trapdoor_steel", {
697 description = S("Steel Trapdoor"),
698 inventory_image = "doors_trapdoor_steel.png",
699 wield_image = "doors_trapdoor_steel.png",
700 tile_front = "doors_trapdoor_steel.png",
701 tile_side = "doors_trapdoor_steel_side.png",
703 sounds = default.node_sound_metal_defaults(),
704 sound_open = "doors_steel_door_open",
705 sound_close = "doors_steel_door_close",
706 groups = {cracky = 1, level = 2, door = 1},
709 minetest.register_craft({
710 output = "doors:trapdoor 2",
712 {"group:wood", "group:wood", "group:wood"},
713 {"group:wood", "group:wood", "group:wood"},
718 minetest.register_craft({
719 output = "doors:trapdoor_steel",
721 {"default:steel_ingot", "default:steel_ingot"},
722 {"default:steel_ingot", "default:steel_ingot"},
728 local fence_collision_extra = minetest.settings:get_bool("enable_fence_tall") and 3/8 or 0
730 function doors.register_fencegate(name, def)
732 description = def.description,
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}, true)
752 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4}
757 if type(def.texture) == "string" then
758 fence.tiles[1] = {name = def.texture, backface_culling = true}
759 elseif def.texture.backface_culling == nil then
760 fence.tiles[1] = table.copy(def.texture)
761 fence.tiles[1].backface_culling = true
763 fence.tiles[1] = def.texture
766 if not fence.sounds then
767 fence.sounds = default.node_sound_wood_defaults()
770 fence.groups.fence = 1
772 local fence_closed = table.copy(fence)
773 fence_closed.mesh = "doors_fencegate_closed.obj"
774 fence_closed.gate = name .. "_open"
775 fence_closed.sound = "doors_fencegate_open"
776 fence_closed.collision_box = {
778 fixed = {-1/2, -1/2, -1/8, 1/2, 1/2 + fence_collision_extra, 1/8}
781 local fence_open = table.copy(fence)
782 fence_open.mesh = "doors_fencegate_open.obj"
783 fence_open.gate = name .. "_closed"
784 fence_open.sound = "doors_fencegate_close"
785 fence_open.groups.not_in_creative_inventory = 1
786 fence_open.collision_box = {
788 fixed = {{-1/2, -1/2, -1/8, -3/8, 1/2 + fence_collision_extra, 1/8},
789 {-1/2, -3/8, -1/2, -3/8, 3/8, 0 }}
792 minetest.register_node(":" .. name .. "_closed", fence_closed)
793 minetest.register_node(":" .. name .. "_open", fence_open)
795 minetest.register_craft({
796 output = name .. "_closed",
798 {"group:stick", def.material, "group:stick"},
799 {"group:stick", def.material, "group:stick"}
804 doors.register_fencegate("doors:gate_wood", {
805 description = S("Apple Wood Fence Gate"),
806 texture = "default_wood.png",
807 material = "default:wood",
808 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
811 doors.register_fencegate("doors:gate_acacia_wood", {
812 description = S("Acacia Wood Fence Gate"),
813 texture = "default_acacia_wood.png",
814 material = "default:acacia_wood",
815 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
818 doors.register_fencegate("doors:gate_junglewood", {
819 description = S("Jungle Wood Fence Gate"),
820 texture = "default_junglewood.png",
821 material = "default:junglewood",
822 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
825 doors.register_fencegate("doors:gate_pine_wood", {
826 description = S("Pine Wood Fence Gate"),
827 texture = "default_pine_wood.png",
828 material = "default:pine_wood",
829 groups = {choppy = 3, oddly_breakable_by_hand = 2, flammable = 3}
832 doors.register_fencegate("doors:gate_aspen_wood", {
833 description = S("Aspen Wood Fence Gate"),
834 texture = "default_aspen_wood.png",
835 material = "default:aspen_wood",
836 groups = {choppy = 3, oddly_breakable_by_hand = 2, flammable = 3}
842 minetest.register_craft({
844 recipe = "doors:trapdoor",
848 minetest.register_craft({
850 recipe = "doors:door_wood",
854 minetest.register_craft({
856 recipe = "doors:gate_wood_closed",
860 minetest.register_craft({
862 recipe = "doors:gate_acacia_wood_closed",
866 minetest.register_craft({
868 recipe = "doors:gate_junglewood_closed",
872 minetest.register_craft({
874 recipe = "doors:gate_pine_wood_closed",
878 minetest.register_craft({
880 recipe = "doors:gate_aspen_wood_closed",