4 Copyright (C) 2012 PilzAdam
5 modified by BlockMen (added sounds, glassdoors[glass, obsidian glass], trapdoor)
6 Copyright (C) 2015 - Auke Kok <sofar@foo-projects.org>
15 _doors.registered_doors = {}
16 _doors.registered_trapdoors = {}
18 -- returns an object to a door object or nil
19 function doors.get(pos)
20 if _doors.registered_doors[minetest.get_node(pos).name] then
21 -- A normal upright door
24 open = function(self, player)
28 return _doors.door_toggle(self.pos, player)
30 close = function(self, player)
31 if not self:state() then
34 return _doors.door_toggle(self.pos, player)
36 toggle = function(self, player)
37 return _doors.door_toggle(self.pos, player)
39 state = function(self)
40 local state = minetest.get_meta(self.pos):get_int("state")
44 elseif _doors.registered_trapdoors[minetest.get_node(pos).name] then
48 open = function(self, player)
52 return _doors.trapdoor_toggle(self.pos, player)
54 close = function(self, player)
55 if not self:state() then
58 return _doors.trapdoor_toggle(self.pos, player)
60 toggle = function(self, player)
61 return _doors.trapdoor_toggle(self.pos, player)
63 state = function(self)
64 local name = minetest.get_node(pos).name
65 return 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, clicker)
134 local meta = minetest.get_meta(pos)
135 local def = minetest.registered_nodes[minetest.get_node(pos).name]
136 local name = def.door.name
138 local state = meta:get_string("state")
140 -- fix up lvm-placed right-hinged doors, default closed
141 if minetest.get_node(pos).name:sub(-2) == "_b" then
145 state = tonumber(state)
148 if clicker and not minetest.check_player_privs(clicker, "protection_bypass") then
149 local owner = meta:get_string("doors_owner")
151 if clicker:get_player_name() ~= owner then
158 -- until Lua-5.2 we have no bitwise operators :(
159 if state % 2 == 1 then
165 local dir = minetest.get_node(pos).param2
166 if state % 2 == 0 then
167 minetest.sound_play(def.door.sounds[1], {pos = pos, gain = 0.3, max_hear_distance = 10})
169 minetest.sound_play(def.door.sounds[2], {pos = pos, gain = 0.3, max_hear_distance = 10})
172 minetest.swap_node(pos, {
173 name = name .. transform[state + 1][dir+1].v,
174 param2 = transform[state + 1][dir+1].param2
176 meta:set_int("state", state)
182 local function on_place_node(place_to, newnode, placer, oldnode, itemstack, pointed_thing)
185 for _, callback in ipairs(core.registered_on_placenodes) do
186 -- Deepcopy pos, node and pointed_thing because callback can modify them
187 local place_to_copy = {x = place_to.x, y = place_to.y, z = place_to.z}
188 local newnode_copy = {name = newnode.name, param1 = newnode.param1, param2 = newnode.param2}
189 local oldnode_copy = {name = oldnode.name, param1 = oldnode.param1, param2 = oldnode.param2}
190 local pointed_thing_copy = {
191 type = pointed_thing.type,
192 above = vector.new(pointed_thing.above),
193 under = vector.new(pointed_thing.under),
194 ref = pointed_thing.ref,
196 callback(place_to_copy, newnode_copy, placer, oldnode_copy, itemstack, pointed_thing_copy)
200 function doors.register(name, def)
201 if not name:find(":") then
202 name = "doors:" .. name
205 -- replace old doors of this type automatically
206 minetest.register_abm({
207 nodenames = {name.."_b_1", name.."_b_2"},
210 action = function(pos, node, active_object_count, active_object_count_wider)
211 local l = tonumber(node.name:sub(-1))
212 local meta = minetest.get_meta(pos)
213 local h = meta:get_int("right") + 1
214 local p2 = node.param2
216 { { type = "a", state = 0 }, { type = "a", state = 3 } },
217 { { type = "b", state = 1 }, { type = "b", state = 2 } }
219 local new = replace[l][h]
220 -- retain infotext and doors_owner fields
221 minetest.swap_node(pos, {name = name .. "_" .. new.type, param2 = p2})
222 meta:set_int("state", new.state)
223 -- properly place doors:hidden at the right spot
225 if new.state >= 2 then
228 if new.state % 2 == 1 then
229 if new.state >= 2 then
235 -- wipe meta on top node as it's unused
236 minetest.set_node({x = pos.x, y = pos.y + 1, z = pos.z},
237 {name = "doors:hidden", param2 = p3})
241 minetest.register_craftitem(":" .. name, {
242 description = def.description,
243 inventory_image = def.inventory_image,
245 on_place = function(itemstack, placer, pointed_thing)
248 if not pointed_thing.type == "node" then
252 local node = minetest.get_node(pointed_thing.under)
253 local pdef = minetest.registered_nodes[node.name]
254 if pdef and pdef.on_rightclick then
255 return pdef.on_rightclick(pointed_thing.under,
256 node, placer, itemstack)
259 if pdef and pdef.buildable_to then
260 pos = pointed_thing.under
262 pos = pointed_thing.above
263 node = minetest.get_node(pos)
264 pdef = minetest.registered_nodes[node.name]
265 if not pdef or not pdef.buildable_to then
270 local above = { x = pos.x, y = pos.y + 1, z = pos.z }
271 if not minetest.registered_nodes[minetest.get_node(above).name].buildable_to then
275 local pn = placer:get_player_name()
276 if minetest.is_protected(pos, pn) or minetest.is_protected(above, pn) then
280 local dir = minetest.dir_to_facedir(placer:get_look_dir())
283 { x = -1, y = 0, z = 0 },
284 { x = 0, y = 0, z = 1 },
285 { x = 1, y = 0, z = 0 },
286 { x = 0, y = 0, z = -1 },
290 x = pos.x + ref[dir + 1].x,
291 y = pos.y + ref[dir + 1].y,
292 z = pos.z + ref[dir + 1].z,
296 if minetest.get_item_group(minetest.get_node(aside).name, "door") == 1 then
298 minetest.set_node(pos, {name = name .. "_b", param2 = dir})
299 minetest.set_node(above, {name = "doors:hidden", param2 = (dir + 3) % 4})
301 minetest.set_node(pos, {name = name .. "_a", param2 = dir})
302 minetest.set_node(above, {name = "doors:hidden", param2 = dir})
305 local meta = minetest.get_meta(pos)
306 meta:set_int("state", state)
308 if def.protected then
309 local pn = placer:get_player_name()
310 meta:set_string("doors_owner", pn)
311 meta:set_string("infotext", "Owned by " .. pn)
314 if not minetest.setting_getbool("creative_mode") then
315 itemstack:take_item()
318 on_place_node(pos, minetest.get_node(pos), placer, node, itemstack, pointed_thing)
324 local can_dig = function(pos, digger)
325 if not def.protected then
328 if minetest.check_player_privs(digger, "protection_bypass") then
331 local meta = minetest.get_meta(pos)
334 name = digger:get_player_name()
336 return meta:get_string("doors_owner") == name
339 if not def.sounds then
340 def.sounds = default.node_sound_wood_defaults()
343 if not def.sound_open then
344 def.sound_open = "doors_door_open"
347 if not def.sound_close then
348 def.sound_close = "doors_door_close"
351 def.groups.not_in_creative_inventory = 1
356 sounds = { def.sound_close, def.sound_open },
359 def.on_rightclick = function(pos, node, clicker)
360 _doors.door_toggle(pos, clicker)
362 def.after_dig_node = function(pos, node, meta, digger)
363 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
364 nodeupdate({x = pos.x, y = pos.y + 1, z = pos.z})
366 def.can_dig = function(pos, player)
367 return can_dig(pos, player)
369 def.on_rotate = function(pos, node, user, mode, new_param2)
373 if def.protected then
374 def.on_blast = function() end
376 def.on_blast = function(pos, intensity)
377 minetest.remove_node(pos)
378 -- hidden node doesn't get blasted away.
379 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
384 def.on_destruct = function(pos)
385 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
388 minetest.register_node(":" .. name .. "_a", {
389 description = def.description,
395 paramtype2 = "facedir",
396 sunlight_propagates = true,
397 use_texture_alpha = true,
399 is_ground_content = false,
400 buildable_to = false,
405 on_rightclick = def.on_rightclick,
406 after_dig_node = def.after_dig_node,
407 can_dig = def.can_dig,
408 on_rotate = def.on_rotate,
409 on_blast = def.on_blast,
410 on_destruct = def.on_destruct,
413 fixed = { -1/2,-1/2,-1/2,1/2,3/2,-6/16}
417 fixed = { -1/2,-1/2,-1/2,1/2,3/2,-6/16}
421 minetest.register_node(":" .. name .. "_b", {
422 description = def.description,
428 paramtype2 = "facedir",
429 sunlight_propagates = true,
430 use_texture_alpha = true,
432 is_ground_content = false,
433 buildable_to = false,
438 on_rightclick = def.on_rightclick,
439 after_dig_node = def.after_dig_node,
440 can_dig = def.can_dig,
441 on_rotate = def.on_rotate,
442 on_blast = def.on_blast,
443 on_destruct = def.on_destruct,
446 fixed = { -1/2,-1/2,-1/2,1/2,3/2,-6/16}
450 fixed = { -1/2,-1/2,-1/2,1/2,3/2,-6/16}
455 minetest.register_craft({
461 _doors.registered_doors[name .. "_a"] = true
462 _doors.registered_doors[name .. "_b"] = true
465 doors.register("door_wood", {
466 tiles = {{ name = "doors_door_wood.png", backface_culling = true }},
467 description = "Wooden Door",
468 inventory_image = "doors_item_wood.png",
469 groups = { snappy = 1, choppy = 2, oddly_breakable_by_hand = 2, flammable = 2 },
471 {"group:wood", "group:wood"},
472 {"group:wood", "group:wood"},
473 {"group:wood", "group:wood"},
477 doors.register("door_steel", {
478 tiles = {{ name = "doors_door_steel.png", backface_culling = true }},
479 description = "Steel Door",
480 inventory_image = "doors_item_steel.png",
482 groups = { snappy = 1, bendy = 2, cracky = 1, melty = 2, level = 2 },
483 sound_open = "doors_steel_door_open",
484 sound_close = "doors_steel_door_close",
486 {"default:steel_ingot", "default:steel_ingot"},
487 {"default:steel_ingot", "default:steel_ingot"},
488 {"default:steel_ingot", "default:steel_ingot"},
492 doors.register("door_glass", {
493 tiles = { "doors_door_glass.png"},
494 description = "Glass Door",
495 inventory_image = "doors_item_glass.png",
496 groups = { snappy=1, cracky=1, oddly_breakable_by_hand=3 },
497 sounds = default.node_sound_glass_defaults(),
499 {"default:glass", "default:glass"},
500 {"default:glass", "default:glass"},
501 {"default:glass", "default:glass"},
505 doors.register("door_obsidian_glass", {
506 tiles = { "doors_door_obsidian_glass.png" },
507 description = "Glass Door",
508 inventory_image = "doors_item_obsidian_glass.png",
509 groups = { snappy=1, cracky=1, oddly_breakable_by_hand=3 },
510 sounds = default.node_sound_glass_defaults(),
512 {"default:obsidian_glass", "default:obsidian_glass"},
513 {"default:obsidian_glass", "default:obsidian_glass"},
514 {"default:obsidian_glass", "default:obsidian_glass"},
518 -- Capture mods using the old API as best as possible.
519 function doors.register_door(name, def)
520 if def.only_placer_can_open then
523 def.only_placer_can_open = nil
525 local i = name:find(":")
526 local modname = name:sub(1, i - 1)
527 if not def.tiles then
528 if def.protected then
529 def.tiles = {{name = "doors_door_steel.png", backface_culling = true}}
531 def.tiles = {{name = "doors_door_wood.png", backface_culling = true}}
533 minetest.log("warning", modname .. " registered door \"" .. name .. "\" " ..
534 "using deprecated API method \"doors.register_door()\" but " ..
535 "did not provide the \"tiles\" parameter. A fallback tiledef " ..
536 "will be used instead.")
539 doors.register(name, def)
544 function _doors.trapdoor_toggle(pos, clicker)
545 if clicker and not minetest.check_player_privs(clicker, "protection_bypass") then
546 local meta = minetest.get_meta(pos)
547 local owner = meta:get_string("doors_owner")
549 if clicker:get_player_name() ~= owner then
555 local node = minetest.get_node(pos)
556 local def = minetest.registered_nodes[node.name]
558 if string.sub(node.name, -5) == "_open" then
559 minetest.sound_play(def.sound_close, {pos = pos, gain = 0.3, max_hear_distance = 10})
560 minetest.swap_node(pos, {name = string.sub(node.name, 1, string.len(node.name) - 5), param1 = node.param1, param2 = node.param2})
562 minetest.sound_play(def.sound_open, {pos = pos, gain = 0.3, max_hear_distance = 10})
563 minetest.swap_node(pos, {name = node.name .. "_open", param1 = node.param1, param2 = node.param2})
567 function doors.register_trapdoor(name, def)
568 local name_closed = name
569 local name_opened = name.."_open"
571 local function check_player_priv(pos, player)
572 if not def.protected or minetest.check_player_privs(player, "protection_bypass") then
575 local meta = minetest.get_meta(pos)
576 local pn = player:get_player_name()
577 return meta:get_string("doors_owner") == pn
580 def.on_rightclick = function(pos, node, clicker)
581 _doors.trapdoor_toggle(pos, clicker)
584 -- Common trapdoor configuration
585 def.drawtype = "nodebox"
586 def.paramtype = "light"
587 def.paramtype2 = "facedir"
588 def.is_ground_content = false
589 def.can_dig = check_player_priv
591 if def.protected then
592 def.after_place_node = function(pos, placer, itemstack, pointed_thing)
593 local pn = placer:get_player_name()
594 local meta = minetest.get_meta(pos)
595 meta:set_string("doors_owner", pn)
596 meta:set_string("infotext", "Owned by "..pn)
598 return minetest.setting_getbool("creative_mode")
601 def.on_blast = function() end
603 def.on_blast = function(pos, intensity)
604 minetest.remove_node(pos)
605 minetest.remove_node({ x = pos.x, y = pos.y + 1, z = pos.z})
610 if not def.sounds then
611 def.sounds = default.node_sound_wood_defaults()
614 if not def.sound_open then
615 def.sound_open = "doors_door_open"
618 if not def.sound_close then
619 def.sound_close = "doors_door_close"
622 local def_opened = table.copy(def)
623 local def_closed = table.copy(def)
625 def_closed.node_box = {
627 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
629 def_closed.selection_box = {
631 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
633 def_closed.tiles = { def.tile_front, def.tile_front, def.tile_side, def.tile_side,
634 def.tile_side, def.tile_side }
636 def_opened.node_box = {
638 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
640 def_opened.selection_box = {
642 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
644 def_opened.tiles = { def.tile_side, def.tile_side,
645 def.tile_side .. '^[transform3',
646 def.tile_side .. '^[transform1',
647 def.tile_front, def.tile_front }
649 def_opened.drop = name_closed
650 def_opened.groups.not_in_creative_inventory = 1
652 minetest.register_node(name_opened, def_opened)
653 minetest.register_node(name_closed, def_closed)
655 _doors.registered_trapdoors[name_opened] = true
656 _doors.registered_trapdoors[name_closed] = true
659 doors.register_trapdoor("doors:trapdoor", {
660 description = "Trapdoor",
661 inventory_image = "doors_trapdoor.png",
662 wield_image = "doors_trapdoor.png",
663 tile_front = "doors_trapdoor.png",
664 tile_side = "doors_trapdoor_side.png",
665 groups = {snappy=1, choppy=2, oddly_breakable_by_hand=2, flammable=2, door=1},
668 doors.register_trapdoor("doors:trapdoor_steel", {
669 description = "Steel Trapdoor",
670 inventory_image = "doors_trapdoor_steel.png",
671 wield_image = "doors_trapdoor_steel.png",
672 tile_front = "doors_trapdoor_steel.png",
673 tile_side = "doors_trapdoor_steel_side.png",
675 sound_open = "doors_steel_door_open",
676 sound_close = "doors_steel_door_close",
677 groups = {snappy=1, bendy=2, cracky=1, melty=2, level=2, door=1},
680 minetest.register_craft({
681 output = 'doors:trapdoor 2',
683 {'group:wood', 'group:wood', 'group:wood'},
684 {'group:wood', 'group:wood', 'group:wood'},
689 minetest.register_craft({
690 output = 'doors:trapdoor_steel',
692 {'default:steel_ingot', 'default:steel_ingot'},
693 {'default:steel_ingot', 'default:steel_ingot'},
700 function doors.register_fencegate(name, def)
702 description = def.description,
704 tiles = { def.texture },
706 paramtype2 = "facedir",
707 sunlight_propagates = true,
708 is_ground_content = false,
709 drop = name .. "_closed",
710 connect_sides = { "left", "right" },
713 on_rightclick = function(pos, clicker)
714 local node = minetest.get_node(pos)
715 local node_def = minetest.registered_nodes[node.name]
716 minetest.swap_node(pos, {name = node_def.gate, param2 = node.param2})
717 minetest.sound_play(node_def.sound, {pos = pos, gain = 0.3,
718 max_hear_distance = 8})
722 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
726 if not fence.sounds then
727 fence.sounds = default.node_sound_wood_defaults()
730 fence.groups.fence = 1
732 local fence_closed = table.copy(fence)
733 fence_closed.mesh = "doors_fencegate_closed.obj"
734 fence_closed.gate = name .. "_open"
735 fence_closed.sound = "doors_fencegate_open"
736 fence_closed.collision_box = {
738 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
741 local fence_open = table.copy(fence)
742 fence_open.mesh = "doors_fencegate_open.obj"
743 fence_open.gate = name .. "_closed"
744 fence_open.sound = "doors_fencegate_close"
745 fence_open.groups.not_in_creative_inventory = 1
746 fence_open.collision_box = {
748 fixed = {{-1/2, -1/2, -1/4, -3/8, 1/2, 1/4},
749 {-5/8, -3/8, -14/16, -3/8, 3/8, 0}},
752 minetest.register_node(":" .. name .. "_closed", fence_closed)
753 minetest.register_node(":" .. name .. "_open", fence_open)
755 minetest.register_craft({
756 output = name .. "_closed",
758 {"default:stick", def.material, "default:stick"},
759 {"default:stick", def.material, "default:stick"}
764 doors.register_fencegate("doors:gate_wood", {
765 description = "Wooden Fence Gate",
766 texture = "default_wood.png",
767 material = "default:wood",
768 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
771 doors.register_fencegate("doors:gate_acacia_wood", {
772 description = "Acacia Fence Gate",
773 texture = "default_acacia_wood.png",
774 material = "default:acacia_wood",
775 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
778 doors.register_fencegate("doors:gate_junglewood", {
779 description = "Junglewood Fence Gate",
780 texture = "default_junglewood.png",
781 material = "default:junglewood",
782 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
785 doors.register_fencegate("doors:gate_pine_wood", {
786 description = "Pine Fence Gate",
787 texture = "default_pine_wood.png",
788 material = "default:pine_wood",
789 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
792 doors.register_fencegate("doors:gate_aspen_wood", {
793 description = "Aspen Fence Gate",
794 texture = "default_aspen_wood.png",
795 material = "default:aspen_wood",
796 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}