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
147 state = tonumber(state)
150 if clicker and not minetest.check_player_privs(clicker, "protection_bypass") then
151 local owner = meta:get_string("doors_owner")
153 if clicker:get_player_name() ~= owner then
160 -- until Lua-5.2 we have no bitwise operators :(
161 if state % 2 == 1 then
167 local dir = minetest.get_node(pos).param2
168 if state % 2 == 0 then
169 minetest.sound_play(def.door.sounds[1], {pos = pos, gain = 0.3, max_hear_distance = 10})
171 minetest.sound_play(def.door.sounds[2], {pos = pos, gain = 0.3, max_hear_distance = 10})
174 minetest.swap_node(pos, {
175 name = name .. transform[state + 1][dir+1].v,
176 param2 = transform[state + 1][dir+1].param2
178 meta:set_int("state", state)
184 local function on_place_node(place_to, newnode, placer, oldnode, itemstack, pointed_thing)
187 for _, callback in ipairs(core.registered_on_placenodes) do
188 -- Deepcopy pos, node and pointed_thing because callback can modify them
189 local place_to_copy = {x = place_to.x, y = place_to.y, z = place_to.z}
190 local newnode_copy = {name = newnode.name, param1 = newnode.param1, param2 = newnode.param2}
191 local oldnode_copy = {name = oldnode.name, param1 = oldnode.param1, param2 = oldnode.param2}
192 local pointed_thing_copy = {
193 type = pointed_thing.type,
194 above = vector.new(pointed_thing.above),
195 under = vector.new(pointed_thing.under),
196 ref = pointed_thing.ref,
198 callback(place_to_copy, newnode_copy, placer, oldnode_copy, itemstack, pointed_thing_copy)
202 function doors.register(name, def)
203 if not name:find(":") then
204 name = "doors:" .. name
207 -- replace old doors of this type automatically
208 minetest.register_lbm({
209 name = ":doors:replace_" .. name:gsub(":", "_"),
210 nodenames = {name.."_b_1", name.."_b_2"},
211 action = function(pos, node)
212 local l = tonumber(node.name:sub(-1))
213 local meta = minetest.get_meta(pos)
214 local h = meta:get_int("right") + 1
215 local p2 = node.param2
217 { { type = "a", state = 0 }, { type = "a", state = 3 } },
218 { { type = "b", state = 1 }, { type = "b", state = 2 } }
220 local new = replace[l][h]
221 -- retain infotext and doors_owner fields
222 minetest.swap_node(pos, {name = name .. "_" .. new.type, param2 = p2})
223 meta:set_int("state", new.state)
224 -- properly place doors:hidden at the right spot
226 if new.state >= 2 then
229 if new.state % 2 == 1 then
230 if new.state >= 2 then
236 -- wipe meta on top node as it's unused
237 minetest.set_node({x = pos.x, y = pos.y + 1, z = pos.z},
238 {name = "doors:hidden", param2 = p3})
242 minetest.register_craftitem(":" .. name, {
243 description = def.description,
244 inventory_image = def.inventory_image,
246 on_place = function(itemstack, placer, pointed_thing)
249 if not pointed_thing.type == "node" then
253 local node = minetest.get_node(pointed_thing.under)
254 local pdef = minetest.registered_nodes[node.name]
255 if pdef and pdef.on_rightclick then
256 return pdef.on_rightclick(pointed_thing.under,
257 node, placer, itemstack)
260 if pdef and pdef.buildable_to then
261 pos = pointed_thing.under
263 pos = pointed_thing.above
264 node = minetest.get_node(pos)
265 pdef = minetest.registered_nodes[node.name]
266 if not pdef or not pdef.buildable_to then
271 local above = { x = pos.x, y = pos.y + 1, z = pos.z }
272 if not minetest.registered_nodes[minetest.get_node(above).name].buildable_to then
276 local pn = placer:get_player_name()
277 if minetest.is_protected(pos, pn) or minetest.is_protected(above, pn) then
281 local dir = minetest.dir_to_facedir(placer:get_look_dir())
284 { x = -1, y = 0, z = 0 },
285 { x = 0, y = 0, z = 1 },
286 { x = 1, y = 0, z = 0 },
287 { x = 0, y = 0, z = -1 },
291 x = pos.x + ref[dir + 1].x,
292 y = pos.y + ref[dir + 1].y,
293 z = pos.z + ref[dir + 1].z,
297 if minetest.get_item_group(minetest.get_node(aside).name, "door") == 1 then
299 minetest.set_node(pos, {name = name .. "_b", param2 = dir})
300 minetest.set_node(above, {name = "doors:hidden", param2 = (dir + 3) % 4})
302 minetest.set_node(pos, {name = name .. "_a", param2 = dir})
303 minetest.set_node(above, {name = "doors:hidden", param2 = dir})
306 local meta = minetest.get_meta(pos)
307 meta:set_int("state", state)
309 if def.protected then
310 local pn = placer:get_player_name()
311 meta:set_string("doors_owner", pn)
312 meta:set_string("infotext", "Owned by " .. pn)
315 if not minetest.setting_getbool("creative_mode") then
316 itemstack:take_item()
319 on_place_node(pos, minetest.get_node(pos), placer, node, itemstack, pointed_thing)
325 local can_dig = function(pos, digger)
326 if not def.protected then
329 if minetest.check_player_privs(digger, "protection_bypass") then
332 local meta = minetest.get_meta(pos)
335 name = digger:get_player_name()
337 return meta:get_string("doors_owner") == name
340 if not def.sounds then
341 def.sounds = default.node_sound_wood_defaults()
344 if not def.sound_open then
345 def.sound_open = "doors_door_open"
348 if not def.sound_close then
349 def.sound_close = "doors_door_close"
352 def.groups.not_in_creative_inventory = 1
357 sounds = { def.sound_close, def.sound_open },
360 def.on_rightclick = function(pos, node, clicker)
361 _doors.door_toggle(pos, clicker)
363 def.after_dig_node = function(pos, node, meta, digger)
364 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
365 nodeupdate({x = pos.x, y = pos.y + 1, z = pos.z})
367 def.can_dig = function(pos, player)
368 return can_dig(pos, player)
370 def.on_rotate = function(pos, node, user, mode, new_param2)
374 if def.protected then
375 def.on_blast = function() end
377 def.on_blast = function(pos, intensity)
378 minetest.remove_node(pos)
379 -- hidden node doesn't get blasted away.
380 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
385 def.on_destruct = function(pos)
386 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
389 minetest.register_node(":" .. name .. "_a", {
390 description = def.description,
396 paramtype2 = "facedir",
397 sunlight_propagates = 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,
431 is_ground_content = false,
432 buildable_to = false,
437 on_rightclick = def.on_rightclick,
438 after_dig_node = def.after_dig_node,
439 can_dig = def.can_dig,
440 on_rotate = def.on_rotate,
441 on_blast = def.on_blast,
442 on_destruct = def.on_destruct,
445 fixed = { -1/2,-1/2,-1/2,1/2,3/2,-6/16}
449 fixed = { -1/2,-1/2,-1/2,1/2,3/2,-6/16}
454 minetest.register_craft({
460 _doors.registered_doors[name .. "_a"] = true
461 _doors.registered_doors[name .. "_b"] = true
464 doors.register("door_wood", {
465 tiles = {{ name = "doors_door_wood.png", backface_culling = true }},
466 description = "Wooden Door",
467 inventory_image = "doors_item_wood.png",
468 groups = { snappy = 1, choppy = 2, oddly_breakable_by_hand = 2, flammable = 2 },
470 {"group:wood", "group:wood"},
471 {"group:wood", "group:wood"},
472 {"group:wood", "group:wood"},
476 doors.register("door_steel", {
477 tiles = {{ name = "doors_door_steel.png", backface_culling = true }},
478 description = "Steel Door",
479 inventory_image = "doors_item_steel.png",
481 groups = { snappy = 1, bendy = 2, cracky = 1, melty = 2, level = 2 },
482 sound_open = "doors_steel_door_open",
483 sound_close = "doors_steel_door_close",
485 {"default:steel_ingot", "default:steel_ingot"},
486 {"default:steel_ingot", "default:steel_ingot"},
487 {"default:steel_ingot", "default:steel_ingot"},
491 doors.register("door_glass", {
492 tiles = { "doors_door_glass.png"},
493 description = "Glass Door",
494 inventory_image = "doors_item_glass.png",
495 groups = { snappy=1, cracky=1, oddly_breakable_by_hand=3 },
496 sounds = default.node_sound_glass_defaults(),
498 {"default:glass", "default:glass"},
499 {"default:glass", "default:glass"},
500 {"default:glass", "default:glass"},
504 doors.register("door_obsidian_glass", {
505 tiles = { "doors_door_obsidian_glass.png" },
506 description = "Obsidian Glass Door",
507 inventory_image = "doors_item_obsidian_glass.png",
508 groups = { snappy=1, cracky=1, oddly_breakable_by_hand=3 },
509 sounds = default.node_sound_glass_defaults(),
511 {"default:obsidian_glass", "default:obsidian_glass"},
512 {"default:obsidian_glass", "default:obsidian_glass"},
513 {"default:obsidian_glass", "default:obsidian_glass"},
517 -- Capture mods using the old API as best as possible.
518 function doors.register_door(name, def)
519 if def.only_placer_can_open then
522 def.only_placer_can_open = nil
524 local i = name:find(":")
525 local modname = name:sub(1, i - 1)
526 if not def.tiles then
527 if def.protected then
528 def.tiles = {{name = "doors_door_steel.png", backface_culling = true}}
530 def.tiles = {{name = "doors_door_wood.png", backface_culling = true}}
532 minetest.log("warning", modname .. " registered door \"" .. name .. "\" " ..
533 "using deprecated API method \"doors.register_door()\" but " ..
534 "did not provide the \"tiles\" parameter. A fallback tiledef " ..
535 "will be used instead.")
538 doors.register(name, def)
543 function _doors.trapdoor_toggle(pos, clicker)
544 if clicker and not minetest.check_player_privs(clicker, "protection_bypass") then
545 local meta = minetest.get_meta(pos)
546 local owner = meta:get_string("doors_owner")
548 if clicker:get_player_name() ~= owner then
554 local node = minetest.get_node(pos)
555 local def = minetest.registered_nodes[node.name]
557 if string.sub(node.name, -5) == "_open" then
558 minetest.sound_play(def.sound_close, {pos = pos, gain = 0.3, max_hear_distance = 10})
559 minetest.swap_node(pos, {name = string.sub(node.name, 1, string.len(node.name) - 5), param1 = node.param1, param2 = node.param2})
561 minetest.sound_play(def.sound_open, {pos = pos, gain = 0.3, max_hear_distance = 10})
562 minetest.swap_node(pos, {name = node.name .. "_open", param1 = node.param1, param2 = node.param2})
566 function doors.register_trapdoor(name, def)
567 local name_closed = name
568 local name_opened = name.."_open"
570 local function check_player_priv(pos, player)
571 if not def.protected or minetest.check_player_privs(player, "protection_bypass") then
574 local meta = minetest.get_meta(pos)
575 local pn = player:get_player_name()
576 return meta:get_string("doors_owner") == pn
579 def.on_rightclick = function(pos, node, clicker)
580 _doors.trapdoor_toggle(pos, clicker)
583 -- Common trapdoor configuration
584 def.drawtype = "nodebox"
585 def.paramtype = "light"
586 def.paramtype2 = "facedir"
587 def.is_ground_content = false
588 def.can_dig = check_player_priv
590 if def.protected then
591 def.after_place_node = function(pos, placer, itemstack, pointed_thing)
592 local pn = placer:get_player_name()
593 local meta = minetest.get_meta(pos)
594 meta:set_string("doors_owner", pn)
595 meta:set_string("infotext", "Owned by "..pn)
597 return minetest.setting_getbool("creative_mode")
600 def.on_blast = function() end
602 def.on_blast = function(pos, intensity)
603 minetest.remove_node(pos)
604 minetest.remove_node({ x = pos.x, y = pos.y + 1, z = pos.z})
609 if not def.sounds then
610 def.sounds = default.node_sound_wood_defaults()
613 if not def.sound_open then
614 def.sound_open = "doors_door_open"
617 if not def.sound_close then
618 def.sound_close = "doors_door_close"
621 local def_opened = table.copy(def)
622 local def_closed = table.copy(def)
624 def_closed.node_box = {
626 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
628 def_closed.selection_box = {
630 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
632 def_closed.tiles = { def.tile_front, def.tile_front, def.tile_side, def.tile_side,
633 def.tile_side, def.tile_side }
635 def_opened.node_box = {
637 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
639 def_opened.selection_box = {
641 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
643 def_opened.tiles = { def.tile_side, def.tile_side,
644 def.tile_side .. '^[transform3',
645 def.tile_side .. '^[transform1',
646 def.tile_front, def.tile_front }
648 def_opened.drop = name_closed
649 def_opened.groups.not_in_creative_inventory = 1
651 minetest.register_node(name_opened, def_opened)
652 minetest.register_node(name_closed, def_closed)
654 _doors.registered_trapdoors[name_opened] = true
655 _doors.registered_trapdoors[name_closed] = true
658 doors.register_trapdoor("doors:trapdoor", {
659 description = "Trapdoor",
660 inventory_image = "doors_trapdoor.png",
661 wield_image = "doors_trapdoor.png",
662 tile_front = "doors_trapdoor.png",
663 tile_side = "doors_trapdoor_side.png",
664 groups = {snappy=1, choppy=2, oddly_breakable_by_hand=2, flammable=2, door=1},
667 doors.register_trapdoor("doors:trapdoor_steel", {
668 description = "Steel Trapdoor",
669 inventory_image = "doors_trapdoor_steel.png",
670 wield_image = "doors_trapdoor_steel.png",
671 tile_front = "doors_trapdoor_steel.png",
672 tile_side = "doors_trapdoor_steel_side.png",
674 sound_open = "doors_steel_door_open",
675 sound_close = "doors_steel_door_close",
676 groups = {snappy=1, bendy=2, cracky=1, melty=2, level=2, door=1},
679 minetest.register_craft({
680 output = 'doors:trapdoor 2',
682 {'group:wood', 'group:wood', 'group:wood'},
683 {'group:wood', 'group:wood', 'group:wood'},
688 minetest.register_craft({
689 output = 'doors:trapdoor_steel',
691 {'default:steel_ingot', 'default:steel_ingot'},
692 {'default:steel_ingot', 'default:steel_ingot'},
699 function doors.register_fencegate(name, def)
701 description = def.description,
703 tiles = { def.texture },
705 paramtype2 = "facedir",
706 sunlight_propagates = true,
707 is_ground_content = false,
708 drop = name .. "_closed",
709 connect_sides = { "left", "right" },
712 on_rightclick = function(pos, clicker)
713 local node = minetest.get_node(pos)
714 local node_def = minetest.registered_nodes[node.name]
715 minetest.swap_node(pos, {name = node_def.gate, param2 = node.param2})
716 minetest.sound_play(node_def.sound, {pos = pos, gain = 0.3,
717 max_hear_distance = 8})
721 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
725 if not fence.sounds then
726 fence.sounds = default.node_sound_wood_defaults()
729 fence.groups.fence = 1
731 local fence_closed = table.copy(fence)
732 fence_closed.mesh = "doors_fencegate_closed.obj"
733 fence_closed.gate = name .. "_open"
734 fence_closed.sound = "doors_fencegate_open"
735 fence_closed.collision_box = {
737 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
740 local fence_open = table.copy(fence)
741 fence_open.mesh = "doors_fencegate_open.obj"
742 fence_open.gate = name .. "_closed"
743 fence_open.sound = "doors_fencegate_close"
744 fence_open.groups.not_in_creative_inventory = 1
745 fence_open.collision_box = {
747 fixed = {{-1/2, -1/2, -1/4, -3/8, 1/2, 1/4},
748 {-5/8, -3/8, -14/16, -3/8, 3/8, 0}},
751 minetest.register_node(":" .. name .. "_closed", fence_closed)
752 minetest.register_node(":" .. name .. "_open", fence_open)
754 minetest.register_craft({
755 output = name .. "_closed",
757 {"default:stick", def.material, "default:stick"},
758 {"default:stick", def.material, "default:stick"}
763 doors.register_fencegate("doors:gate_wood", {
764 description = "Wooden Fence Gate",
765 texture = "default_wood.png",
766 material = "default:wood",
767 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
770 doors.register_fencegate("doors:gate_acacia_wood", {
771 description = "Acacia Fence Gate",
772 texture = "default_acacia_wood.png",
773 material = "default:acacia_wood",
774 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
777 doors.register_fencegate("doors:gate_junglewood", {
778 description = "Junglewood Fence Gate",
779 texture = "default_junglewood.png",
780 material = "default:junglewood",
781 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
784 doors.register_fencegate("doors:gate_pine_wood", {
785 description = "Pine Fence Gate",
786 texture = "default_pine_wood.png",
787 material = "default:pine_wood",
788 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
791 doors.register_fencegate("doors:gate_aspen_wood", {
792 description = "Aspen Fence Gate",
793 texture = "default_aspen_wood.png",
794 material = "default:aspen_wood",
795 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}