4 doors.registered_doors = {}
5 doors.registered_trapdoors = {}
7 local function replace_old_owner_information(pos)
8 local meta = minetest.get_meta(pos)
9 local owner = meta:get_string("doors_owner")
10 if owner and owner ~= "" then
11 meta:set_string("owner", owner)
12 meta:set_string("doors_owner", "")
16 -- returns an object to a door object or nil
17 function doors.get(pos)
18 local node_name = minetest.get_node(pos).name
19 if doors.registered_doors[node_name] then
20 -- A normal upright door
23 open = function(self, player)
27 return doors.door_toggle(self.pos, nil, player)
29 close = function(self, player)
30 if not self:state() then
33 return doors.door_toggle(self.pos, nil, player)
35 toggle = function(self, player)
36 return doors.door_toggle(self.pos, nil, player)
38 state = function(self)
39 local state = minetest.get_meta(self.pos):get_int("state")
43 elseif doors.registered_trapdoors[node_name] then
47 open = function(self, player)
51 return doors.trapdoor_toggle(self.pos, nil, player)
53 close = function(self, player)
54 if not self:state() then
57 return doors.trapdoor_toggle(self.pos, nil, player)
59 toggle = function(self, player)
60 return doors.trapdoor_toggle(self.pos, nil, player)
62 state = function(self)
63 return minetest.get_node(self.pos).name:sub(-5) == "_open"
71 -- this hidden node is placed on top of the bottom, and prevents
72 -- nodes from being placed in the top half of the door.
73 minetest.register_node("doors:hidden", {
74 description = "Hidden Door Segment",
75 -- can't use airlike otherwise falling nodes will turn to entities
76 -- and will be forever stuck until door is removed.
79 paramtype2 = "facedir",
80 sunlight_propagates = true,
81 -- has to be walkable for falling nodes to stop falling.
88 groups = {not_in_creative_inventory = 1},
89 on_blast = function() end,
90 tiles = {"doors_blank.png"},
91 -- 1px transparent block inside door hinge near node top.
94 fixed = {-15/32, 13/32, -15/32, -13/32, 1/2, -13/32},
96 -- collision_box needed otherise selection box would be full node size
99 fixed = {-15/32, 13/32, -15/32, -13/32, 1/2, -13/32},
103 -- table used to aid door opening/closing
106 {v = "_a", param2 = 3},
107 {v = "_a", param2 = 0},
108 {v = "_a", param2 = 1},
109 {v = "_a", param2 = 2},
112 {v = "_b", param2 = 1},
113 {v = "_b", param2 = 2},
114 {v = "_b", param2 = 3},
115 {v = "_b", param2 = 0},
118 {v = "_b", param2 = 1},
119 {v = "_b", param2 = 2},
120 {v = "_b", param2 = 3},
121 {v = "_b", param2 = 0},
124 {v = "_a", param2 = 3},
125 {v = "_a", param2 = 0},
126 {v = "_a", param2 = 1},
127 {v = "_a", param2 = 2},
131 function doors.door_toggle(pos, node, clicker)
132 local meta = minetest.get_meta(pos)
133 node = node or minetest.get_node(pos)
134 local def = minetest.registered_nodes[node.name]
135 local name = def.door.name
137 local state = meta:get_string("state")
139 -- fix up lvm-placed right-hinged doors, default closed
140 if node.name:sub(-2) == "_b" then
146 state = tonumber(state)
149 replace_old_owner_information(pos)
151 if clicker and not default.can_interact_with_node(clicker, pos) then
155 -- until Lua-5.2 we have no bitwise operators :(
156 if state % 2 == 1 then
162 local dir = node.param2
164 -- It's possible param2 is messed up, so, validate before using
165 -- the input data. This indicates something may have rotated
166 -- the door, even though that is not supported.
167 if not transform[state + 1] or not transform[state + 1][dir + 1] then
171 if state % 2 == 0 then
172 minetest.sound_play(def.door.sounds[1],
173 {pos = pos, gain = 0.3, max_hear_distance = 10})
175 minetest.sound_play(def.door.sounds[2],
176 {pos = pos, gain = 0.3, max_hear_distance = 10})
179 minetest.swap_node(pos, {
180 name = name .. transform[state + 1][dir+1].v,
181 param2 = transform[state + 1][dir+1].param2
183 meta:set_int("state", state)
189 local function on_place_node(place_to, newnode,
190 placer, oldnode, itemstack, pointed_thing)
192 for _, callback in ipairs(minetest.registered_on_placenodes) do
193 -- Deepcopy pos, node and pointed_thing because callback can modify them
194 local place_to_copy = {x = place_to.x, y = place_to.y, z = place_to.z}
196 {name = newnode.name, param1 = newnode.param1, param2 = newnode.param2}
198 {name = oldnode.name, param1 = oldnode.param1, param2 = oldnode.param2}
199 local pointed_thing_copy = {
200 type = pointed_thing.type,
201 above = vector.new(pointed_thing.above),
202 under = vector.new(pointed_thing.under),
203 ref = pointed_thing.ref,
205 callback(place_to_copy, newnode_copy, placer,
206 oldnode_copy, itemstack, pointed_thing_copy)
210 local function can_dig_door(pos, digger)
211 replace_old_owner_information(pos)
212 return default.can_interact_with_node(digger, pos)
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,
258 groups = table.copy(def.groups),
260 on_place = function(itemstack, placer, pointed_thing)
263 if not pointed_thing.type == "node" then
267 local node = minetest.get_node(pointed_thing.under)
268 local pdef = minetest.registered_nodes[node.name]
269 if pdef and pdef.on_rightclick and
270 not (placer and placer:is_player() and
271 placer:get_player_control().sneak) then
272 return pdef.on_rightclick(pointed_thing.under,
273 node, placer, itemstack, pointed_thing)
276 if pdef and pdef.buildable_to then
277 pos = pointed_thing.under
279 pos = pointed_thing.above
280 node = minetest.get_node(pos)
281 pdef = minetest.registered_nodes[node.name]
282 if not pdef or not pdef.buildable_to then
287 local above = {x = pos.x, y = pos.y + 1, z = pos.z}
288 local top_node = minetest.get_node_or_nil(above)
289 local topdef = top_node and minetest.registered_nodes[top_node.name]
291 if not topdef or not topdef.buildable_to then
295 local pn = placer and placer:get_player_name() or ""
296 if minetest.is_protected(pos, pn) or minetest.is_protected(above, pn) then
300 local dir = placer and minetest.dir_to_facedir(placer:get_look_dir()) or 0
303 {x = -1, y = 0, z = 0},
304 {x = 0, y = 0, z = 1},
305 {x = 1, y = 0, z = 0},
306 {x = 0, y = 0, z = -1},
310 x = pos.x + ref[dir + 1].x,
311 y = pos.y + ref[dir + 1].y,
312 z = pos.z + ref[dir + 1].z,
316 if minetest.get_item_group(minetest.get_node(aside).name, "door") == 1 then
318 minetest.set_node(pos, {name = name .. "_b", param2 = dir})
319 minetest.set_node(above, {name = "doors:hidden", param2 = (dir + 3) % 4})
321 minetest.set_node(pos, {name = name .. "_a", param2 = dir})
322 minetest.set_node(above, {name = "doors:hidden", param2 = dir})
325 local meta = minetest.get_meta(pos)
326 meta:set_int("state", state)
328 if def.protected then
329 meta:set_string("owner", pn)
330 meta:set_string("infotext", "Owned by " .. pn)
333 if not (creative and creative.is_enabled_for and creative.is_enabled_for(pn)) then
334 itemstack:take_item()
337 minetest.sound_play(def.sounds.place, {pos = pos})
339 on_place_node(pos, minetest.get_node(pos),
340 placer, node, itemstack, pointed_thing)
345 def.inventory_image = nil
348 minetest.register_craft({
355 if not def.sounds then
356 def.sounds = default.node_sound_wood_defaults()
359 if not def.sound_open then
360 def.sound_open = "doors_door_open"
363 if not def.sound_close then
364 def.sound_close = "doors_door_close"
367 def.groups.not_in_creative_inventory = 1
372 sounds = { def.sound_close, def.sound_open },
374 if not def.on_rightclick then
375 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
376 doors.door_toggle(pos, node, clicker)
380 def.after_dig_node = function(pos, node, meta, digger)
381 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
382 minetest.check_for_falling({x = pos.x, y = pos.y + 1, z = pos.z})
384 def.on_rotate = function(pos, node, user, mode, new_param2)
388 if def.protected then
389 def.can_dig = can_dig_door
390 def.on_blast = function() end
391 def.on_key_use = function(pos, player)
392 local door = doors.get(pos)
395 def.on_skeleton_key_use = function(pos, player, newsecret)
396 replace_old_owner_information(pos)
397 local meta = minetest.get_meta(pos)
398 local owner = meta:get_string("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
416 def.node_dig_prediction = ""
418 def.on_blast = function(pos, intensity)
419 minetest.remove_node(pos)
420 -- hidden node doesn't get blasted away.
421 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
426 def.on_destruct = function(pos)
427 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
430 def.drawtype = "mesh"
431 def.paramtype = "light"
432 def.paramtype2 = "facedir"
433 def.sunlight_propagates = true
435 def.is_ground_content = false
436 def.buildable_to = false
437 def.selection_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
438 def.collision_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
440 def.mesh = "door_a.obj"
441 minetest.register_node(":" .. name .. "_a", def)
443 def.mesh = "door_b.obj"
444 minetest.register_node(":" .. name .. "_b", def)
446 doors.registered_doors[name .. "_a"] = true
447 doors.registered_doors[name .. "_b"] = true
450 doors.register("door_wood", {
451 tiles = {{ name = "doors_door_wood.png", backface_culling = true }},
452 description = "Wooden Door",
453 inventory_image = "doors_item_wood.png",
454 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2},
456 {"group:wood", "group:wood"},
457 {"group:wood", "group:wood"},
458 {"group:wood", "group:wood"},
462 doors.register("door_steel", {
463 tiles = {{name = "doors_door_steel.png", backface_culling = true}},
464 description = "Steel Door",
465 inventory_image = "doors_item_steel.png",
467 groups = {cracky = 1, level = 2},
468 sounds = default.node_sound_metal_defaults(),
469 sound_open = "doors_steel_door_open",
470 sound_close = "doors_steel_door_close",
472 {"default:steel_ingot", "default:steel_ingot"},
473 {"default:steel_ingot", "default:steel_ingot"},
474 {"default:steel_ingot", "default:steel_ingot"},
478 doors.register("door_glass", {
479 tiles = {"doors_door_glass.png"},
480 description = "Glass Door",
481 inventory_image = "doors_item_glass.png",
482 groups = {cracky=3, oddly_breakable_by_hand=3},
483 sounds = default.node_sound_glass_defaults(),
484 sound_open = "doors_glass_door_open",
485 sound_close = "doors_glass_door_close",
487 {"default:glass", "default:glass"},
488 {"default:glass", "default:glass"},
489 {"default:glass", "default:glass"},
493 doors.register("door_obsidian_glass", {
494 tiles = {"doors_door_obsidian_glass.png"},
495 description = "Obsidian Glass Door",
496 inventory_image = "doors_item_obsidian_glass.png",
498 sounds = default.node_sound_glass_defaults(),
499 sound_open = "doors_glass_door_open",
500 sound_close = "doors_glass_door_close",
502 {"default:obsidian_glass", "default:obsidian_glass"},
503 {"default:obsidian_glass", "default:obsidian_glass"},
504 {"default:obsidian_glass", "default:obsidian_glass"},
508 -- Capture mods using the old API as best as possible.
509 function doors.register_door(name, def)
510 if def.only_placer_can_open then
513 def.only_placer_can_open = nil
515 local i = name:find(":")
516 local modname = name:sub(1, i - 1)
517 if not def.tiles then
518 if def.protected then
519 def.tiles = {{name = "doors_door_steel.png", backface_culling = true}}
521 def.tiles = {{name = "doors_door_wood.png", backface_culling = true}}
523 minetest.log("warning", modname .. " registered door \"" .. name .. "\" " ..
524 "using deprecated API method \"doors.register_door()\" but " ..
525 "did not provide the \"tiles\" parameter. A fallback tiledef " ..
526 "will be used instead.")
529 doors.register(name, def)
534 function doors.trapdoor_toggle(pos, node, clicker)
535 node = node or minetest.get_node(pos)
537 replace_old_owner_information(pos)
539 if clicker and not default.can_interact_with_node(clicker, pos) then
543 local def = minetest.registered_nodes[node.name]
545 if string.sub(node.name, -5) == "_open" then
546 minetest.sound_play(def.sound_close,
547 {pos = pos, gain = 0.3, max_hear_distance = 10})
548 minetest.swap_node(pos, {name = string.sub(node.name, 1,
549 string.len(node.name) - 5), param1 = node.param1, param2 = node.param2})
551 minetest.sound_play(def.sound_open,
552 {pos = pos, gain = 0.3, max_hear_distance = 10})
553 minetest.swap_node(pos, {name = node.name .. "_open",
554 param1 = node.param1, param2 = node.param2})
558 function doors.register_trapdoor(name, def)
559 if not name:find(":") then
560 name = "doors:" .. name
563 local name_closed = name
564 local name_opened = name.."_open"
566 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
567 doors.trapdoor_toggle(pos, node, clicker)
571 -- Common trapdoor configuration
572 def.drawtype = "nodebox"
573 def.paramtype = "light"
574 def.paramtype2 = "facedir"
575 def.is_ground_content = false
577 if def.protected then
578 def.can_dig = can_dig_door
579 def.after_place_node = function(pos, placer, itemstack, pointed_thing)
580 local pn = placer:get_player_name()
581 local meta = minetest.get_meta(pos)
582 meta:set_string("owner", pn)
583 meta:set_string("infotext", "Owned by "..pn)
585 return (creative and creative.is_enabled_for and creative.is_enabled_for(pn))
588 def.on_blast = function() end
589 def.on_key_use = function(pos, player)
590 local door = doors.get(pos)
593 def.on_skeleton_key_use = function(pos, player, newsecret)
594 replace_old_owner_information(pos)
595 local meta = minetest.get_meta(pos)
596 local owner = meta:get_string("owner")
597 local pname = player:get_player_name()
599 -- verify placer is owner of lockable door
600 if owner ~= pname then
601 minetest.record_protection_violation(pos, pname)
602 minetest.chat_send_player(pname, "You do not own this trapdoor.")
606 local secret = meta:get_string("key_lock_secret")
609 meta:set_string("key_lock_secret", secret)
612 return secret, "a locked trapdoor", owner
614 def.node_dig_prediction = ""
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 = "Wooden 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,
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},
743 if type(def.texture) == "string" then
744 fence.tiles[1] = {name = def.texture, backface_culling = true}
745 elseif def.texture.backface_culling == nil then
746 fence.tiles[1] = table.copy(def.texture)
747 fence.tiles[1].backface_culling = true
749 fence.tiles[1] = def.texture
752 if not fence.sounds then
753 fence.sounds = default.node_sound_wood_defaults()
756 fence.groups.fence = 1
758 local fence_closed = table.copy(fence)
759 fence_closed.mesh = "doors_fencegate_closed.obj"
760 fence_closed.gate = name .. "_open"
761 fence_closed.sound = "doors_fencegate_open"
762 fence_closed.collision_box = {
764 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
767 local fence_open = table.copy(fence)
768 fence_open.mesh = "doors_fencegate_open.obj"
769 fence_open.gate = name .. "_closed"
770 fence_open.sound = "doors_fencegate_close"
771 fence_open.groups.not_in_creative_inventory = 1
772 fence_open.collision_box = {
774 fixed = {{-1/2, -1/2, -1/4, -3/8, 1/2, 1/4},
775 {-1/2, -3/8, -1/2, -3/8, 3/8, 0}},
778 minetest.register_node(":" .. name .. "_closed", fence_closed)
779 minetest.register_node(":" .. name .. "_open", fence_open)
781 minetest.register_craft({
782 output = name .. "_closed",
784 {"group:stick", def.material, "group:stick"},
785 {"group:stick", def.material, "group:stick"}
790 doors.register_fencegate("doors:gate_wood", {
791 description = "Apple Wood Fence Gate",
792 texture = "default_wood.png",
793 material = "default:wood",
794 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
797 doors.register_fencegate("doors:gate_acacia_wood", {
798 description = "Acacia Wood Fence Gate",
799 texture = "default_acacia_wood.png",
800 material = "default:acacia_wood",
801 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
804 doors.register_fencegate("doors:gate_junglewood", {
805 description = "Jungle Wood Fence Gate",
806 texture = "default_junglewood.png",
807 material = "default:junglewood",
808 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
811 doors.register_fencegate("doors:gate_pine_wood", {
812 description = "Pine Wood Fence Gate",
813 texture = "default_pine_wood.png",
814 material = "default:pine_wood",
815 groups = {choppy = 3, oddly_breakable_by_hand = 2, flammable = 3}
818 doors.register_fencegate("doors:gate_aspen_wood", {
819 description = "Aspen Wood Fence Gate",
820 texture = "default_aspen_wood.png",
821 material = "default:aspen_wood",
822 groups = {choppy = 3, oddly_breakable_by_hand = 2, flammable = 3}
828 minetest.register_craft({
830 recipe = "doors:trapdoor",
834 minetest.register_craft({
836 recipe = "doors:door_wood",
840 minetest.register_craft({
842 recipe = "doors:gate_wood_closed",
846 minetest.register_craft({
848 recipe = "doors:gate_acacia_wood_closed",
852 minetest.register_craft({
854 recipe = "doors:gate_junglewood_closed",
858 minetest.register_craft({
860 recipe = "doors:gate_pine_wood_closed",
864 minetest.register_craft({
866 recipe = "doors:gate_aspen_wood_closed",