3 Copyright (C) 2012 PilzAdam
4 modified by BlockMen (added sounds, glassdoors[glass, obsidian glass], trapdoor)
5 Copyright (C) 2015 - Auke Kok <sofar@foo-projects.org>
14 _doors.registered_doors = {}
15 _doors.registered_trapdoors = {}
17 -- returns an object to a door object or nil
18 function doors.get(pos)
19 if _doors.registered_doors[minetest.get_node(pos).name] then
20 -- A normal upright door
23 open = function(self, player)
27 return _doors.door_toggle(self.pos, player)
29 close = function(self, player)
30 if not self:state() then
33 return _doors.door_toggle(self.pos, player)
35 toggle = function(self, player)
36 return _doors.door_toggle(self.pos, player)
38 state = function(self)
39 local state = minetest.get_meta(self.pos):get_int("state")
43 elseif _doors.registered_trapdoors[minetest.get_node(pos).name] then
47 open = function(self, player)
51 return _doors.trapdoor_toggle(self.pos, player)
53 close = function(self, player)
54 if not self:state() then
57 return _doors.trapdoor_toggle(self.pos, player)
59 toggle = function(self, player)
60 return _doors.trapdoor_toggle(self.pos, player)
62 state = function(self)
63 local name = minetest.get_node(pos).name
64 return name:sub(-5) == "_open"
72 -- this hidden node is placed on top of the bottom, and prevents
73 -- nodes from being placed in the top half of the door.
74 minetest.register_node("doors:hidden", {
75 description = "Hidden Door Segment",
76 -- can't use airlike otherwise falling nodes will turn to entities
77 -- and will be forever stuck until door is removed.
80 paramtype2 = "facedir",
81 sunlight_propagates = true,
82 -- has to be walkable for falling nodes to stop falling.
89 groups = {not_in_creative_inventory = 1},
90 on_blast = function() end,
91 tiles = {"doors_blank.png"},
92 -- 1px transparent block inside door hinge near node top.
95 fixed = {-15/32, 13/32, -15/32, -13/32, 1/2, -13/32},
97 -- collision_box needed otherise selection box would be full node size
100 fixed = {-15/32, 13/32, -15/32, -13/32, 1/2, -13/32},
104 -- table used to aid door opening/closing
107 {v = "_a", param2 = 3},
108 {v = "_a", param2 = 0},
109 {v = "_a", param2 = 1},
110 {v = "_a", param2 = 2},
113 {v = "_b", param2 = 1},
114 {v = "_b", param2 = 2},
115 {v = "_b", param2 = 3},
116 {v = "_b", param2 = 0},
119 {v = "_b", param2 = 1},
120 {v = "_b", param2 = 2},
121 {v = "_b", param2 = 3},
122 {v = "_b", param2 = 0},
125 {v = "_a", param2 = 3},
126 {v = "_a", param2 = 0},
127 {v = "_a", param2 = 1},
128 {v = "_a", param2 = 2},
132 function _doors.door_toggle(pos, clicker)
133 local meta = minetest.get_meta(pos)
134 local def = minetest.registered_nodes[minetest.get_node(pos).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 minetest.get_node(pos).name:sub(-2) == "_b" then
146 state = tonumber(state)
149 if clicker and not minetest.check_player_privs(clicker, "protection_bypass") then
150 local owner = meta:get_string("doors_owner")
152 if clicker:get_player_name() ~= owner then
159 -- until Lua-5.2 we have no bitwise operators :(
160 if state % 2 == 1 then
166 local dir = minetest.get_node(pos).param2
167 if state % 2 == 0 then
168 minetest.sound_play(def.door.sounds[1],
169 {pos = pos, gain = 0.3, max_hear_distance = 10})
171 minetest.sound_play(def.door.sounds[2],
172 {pos = pos, gain = 0.3, max_hear_distance = 10})
175 minetest.swap_node(pos, {
176 name = name .. transform[state + 1][dir+1].v,
177 param2 = transform[state + 1][dir+1].param2
179 meta:set_int("state", state)
185 local function on_place_node(place_to, newnode,
186 placer, oldnode, itemstack, pointed_thing)
189 for _, callback in ipairs(core.registered_on_placenodes) do
190 -- Deepcopy pos, node and pointed_thing because callback can modify them
191 local place_to_copy = {x = place_to.x, y = place_to.y, z = place_to.z}
193 {name = newnode.name, param1 = newnode.param1, param2 = newnode.param2}
195 {name = oldnode.name, param1 = oldnode.param1, param2 = oldnode.param2}
196 local pointed_thing_copy = {
197 type = pointed_thing.type,
198 above = vector.new(pointed_thing.above),
199 under = vector.new(pointed_thing.under),
200 ref = pointed_thing.ref,
202 callback(place_to_copy, newnode_copy, placer,
203 oldnode_copy, itemstack, pointed_thing_copy)
207 function doors.register(name, def)
208 if not name:find(":") then
209 name = "doors:" .. name
212 -- replace old doors of this type automatically
213 minetest.register_lbm({
214 name = ":doors:replace_" .. name:gsub(":", "_"),
215 nodenames = {name.."_b_1", name.."_b_2"},
216 action = function(pos, node)
217 local l = tonumber(node.name:sub(-1))
218 local meta = minetest.get_meta(pos)
219 local h = meta:get_int("right") + 1
220 local p2 = node.param2
222 {{type = "a", state = 0}, {type = "a", state = 3}},
223 {{type = "b", state = 1}, {type = "b", state = 2}}
225 local new = replace[l][h]
226 -- retain infotext and doors_owner fields
227 minetest.swap_node(pos, {name = name .. "_" .. new.type, param2 = p2})
228 meta:set_int("state", new.state)
229 -- properly place doors:hidden at the right spot
231 if new.state >= 2 then
234 if new.state % 2 == 1 then
235 if new.state >= 2 then
241 -- wipe meta on top node as it's unused
242 minetest.set_node({x = pos.x, y = pos.y + 1, z = pos.z},
243 {name = "doors:hidden", param2 = p3})
247 minetest.register_craftitem(":" .. name, {
248 description = def.description,
249 inventory_image = def.inventory_image,
251 on_place = function(itemstack, placer, pointed_thing)
254 if not pointed_thing.type == "node" then
258 local node = minetest.get_node(pointed_thing.under)
259 local pdef = minetest.registered_nodes[node.name]
260 if pdef and pdef.on_rightclick then
261 return pdef.on_rightclick(pointed_thing.under,
262 node, placer, itemstack, pointed_thing)
265 if pdef and pdef.buildable_to then
266 pos = pointed_thing.under
268 pos = pointed_thing.above
269 node = minetest.get_node(pos)
270 pdef = minetest.registered_nodes[node.name]
271 if not pdef or not pdef.buildable_to then
276 local above = {x = pos.x, y = pos.y + 1, z = pos.z}
277 if not minetest.registered_nodes[
278 minetest.get_node(above).name].buildable_to then
282 local pn = placer:get_player_name()
283 if minetest.is_protected(pos, pn) or minetest.is_protected(above, pn) then
287 local dir = minetest.dir_to_facedir(placer:get_look_dir())
290 {x = -1, y = 0, z = 0},
291 {x = 0, y = 0, z = 1},
292 {x = 1, y = 0, z = 0},
293 {x = 0, y = 0, z = -1},
297 x = pos.x + ref[dir + 1].x,
298 y = pos.y + ref[dir + 1].y,
299 z = pos.z + ref[dir + 1].z,
303 if minetest.get_item_group(minetest.get_node(aside).name, "door") == 1 then
305 minetest.set_node(pos, {name = name .. "_b", param2 = dir})
306 minetest.set_node(above, {name = "doors:hidden", param2 = (dir + 3) % 4})
308 minetest.set_node(pos, {name = name .. "_a", param2 = dir})
309 minetest.set_node(above, {name = "doors:hidden", param2 = dir})
312 local meta = minetest.get_meta(pos)
313 meta:set_int("state", state)
315 if def.protected then
316 local pn = placer:get_player_name()
317 meta:set_string("doors_owner", pn)
318 meta:set_string("infotext", "Owned by " .. pn)
321 if not minetest.setting_getbool("creative_mode") then
322 itemstack:take_item()
325 on_place_node(pos, minetest.get_node(pos),
326 placer, node, itemstack, pointed_thing)
331 def.inventory_image = nil
334 minetest.register_craft({
341 local can_dig = function(pos, digger)
342 if not def.protected then
345 if minetest.check_player_privs(digger, "protection_bypass") then
348 local meta = minetest.get_meta(pos)
351 name = digger:get_player_name()
353 return meta:get_string("doors_owner") == name
356 if not def.sounds then
357 def.sounds = default.node_sound_wood_defaults()
360 if not def.sound_open then
361 def.sound_open = "doors_door_open"
364 if not def.sound_close then
365 def.sound_close = "doors_door_close"
368 def.groups.not_in_creative_inventory = 1
373 sounds = { def.sound_close, def.sound_open },
376 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
377 _doors.door_toggle(pos, 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 nodeupdate({x = pos.x, y = pos.y + 1, z = pos.z})
384 def.can_dig = function(pos, player)
385 return can_dig(pos, player)
387 def.on_rotate = function(pos, node, user, mode, new_param2)
391 if def.protected then
392 def.on_blast = function() end
394 def.on_blast = function(pos, intensity)
395 minetest.remove_node(pos)
396 -- hidden node doesn't get blasted away.
397 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
402 def.on_destruct = function(pos)
403 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
406 def.drawtype = "mesh"
407 def.paramtype = "light"
408 def.paramtype2 = "facedir"
409 def.sunlight_propagates = true
411 def.is_ground_content = false
412 def.buildable_to = false
413 def.selection_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
414 def.collision_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
416 def.mesh = "door_a.obj"
417 minetest.register_node(":" .. name .. "_a", def)
419 def.mesh = "door_b.obj"
420 minetest.register_node(":" .. name .. "_b", def)
422 _doors.registered_doors[name .. "_a"] = true
423 _doors.registered_doors[name .. "_b"] = true
426 doors.register("door_wood", {
427 tiles = {{ name = "doors_door_wood.png", backface_culling = true }},
428 description = "Wooden Door",
429 inventory_image = "doors_item_wood.png",
430 groups = {snappy = 1, choppy = 2, oddly_breakable_by_hand = 2, flammable = 2},
432 {"group:wood", "group:wood"},
433 {"group:wood", "group:wood"},
434 {"group:wood", "group:wood"},
438 doors.register("door_steel", {
439 tiles = {{name = "doors_door_steel.png", backface_culling = true}},
440 description = "Steel Door",
441 inventory_image = "doors_item_steel.png",
443 groups = {snappy = 1, cracky = 1, level = 2},
444 sounds = default.node_sound_stone_defaults(),
445 sound_open = "doors_steel_door_open",
446 sound_close = "doors_steel_door_close",
448 {"default:steel_ingot", "default:steel_ingot"},
449 {"default:steel_ingot", "default:steel_ingot"},
450 {"default:steel_ingot", "default:steel_ingot"},
454 doors.register("door_glass", {
455 tiles = {"doors_door_glass.png"},
456 description = "Glass Door",
457 inventory_image = "doors_item_glass.png",
458 groups = {snappy=1, cracky=1, oddly_breakable_by_hand=3},
459 sounds = default.node_sound_glass_defaults(),
460 sound_open = "doors_glass_door_open",
461 sound_close = "doors_glass_door_close",
463 {"default:glass", "default:glass"},
464 {"default:glass", "default:glass"},
465 {"default:glass", "default:glass"},
469 doors.register("door_obsidian_glass", {
470 tiles = {"doors_door_obsidian_glass.png"},
471 description = "Obsidian Glass Door",
472 inventory_image = "doors_item_obsidian_glass.png",
473 groups = {snappy=1, cracky=1, oddly_breakable_by_hand=3},
474 sounds = default.node_sound_glass_defaults(),
475 sound_open = "doors_glass_door_open",
476 sound_close = "doors_glass_door_close",
478 {"default:obsidian_glass", "default:obsidian_glass"},
479 {"default:obsidian_glass", "default:obsidian_glass"},
480 {"default:obsidian_glass", "default:obsidian_glass"},
484 -- Capture mods using the old API as best as possible.
485 function doors.register_door(name, def)
486 if def.only_placer_can_open then
489 def.only_placer_can_open = nil
491 local i = name:find(":")
492 local modname = name:sub(1, i - 1)
493 if not def.tiles then
494 if def.protected then
495 def.tiles = {{name = "doors_door_steel.png", backface_culling = true}}
497 def.tiles = {{name = "doors_door_wood.png", backface_culling = true}}
499 minetest.log("warning", modname .. " registered door \"" .. name .. "\" " ..
500 "using deprecated API method \"doors.register_door()\" but " ..
501 "did not provide the \"tiles\" parameter. A fallback tiledef " ..
502 "will be used instead.")
505 doors.register(name, def)
510 function _doors.trapdoor_toggle(pos, clicker)
511 if clicker and not minetest.check_player_privs(clicker, "protection_bypass") then
512 local meta = minetest.get_meta(pos)
513 local owner = meta:get_string("doors_owner")
515 if clicker:get_player_name() ~= owner then
521 local node = minetest.get_node(pos)
522 local def = minetest.registered_nodes[node.name]
524 if string.sub(node.name, -5) == "_open" then
525 minetest.sound_play(def.sound_close,
526 {pos = pos, gain = 0.3, max_hear_distance = 10})
527 minetest.swap_node(pos, {name = string.sub(node.name, 1,
528 string.len(node.name) - 5), param1 = node.param1, param2 = node.param2})
530 minetest.sound_play(def.sound_open,
531 {pos = pos, gain = 0.3, max_hear_distance = 10})
532 minetest.swap_node(pos, {name = node.name .. "_open",
533 param1 = node.param1, param2 = node.param2})
537 function doors.register_trapdoor(name, def)
538 local name_closed = name
539 local name_opened = name.."_open"
541 local function check_player_priv(pos, player)
542 if not def.protected or
543 minetest.check_player_privs(player, "protection_bypass") then
546 local meta = minetest.get_meta(pos)
547 local pn = player:get_player_name()
548 return meta:get_string("doors_owner") == pn
551 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
552 _doors.trapdoor_toggle(pos, clicker)
556 -- Common trapdoor configuration
557 def.drawtype = "nodebox"
558 def.paramtype = "light"
559 def.paramtype2 = "facedir"
560 def.is_ground_content = false
561 def.can_dig = check_player_priv
563 if def.protected then
564 def.after_place_node = function(pos, placer, itemstack, pointed_thing)
565 local pn = placer:get_player_name()
566 local meta = minetest.get_meta(pos)
567 meta:set_string("doors_owner", pn)
568 meta:set_string("infotext", "Owned by "..pn)
570 return minetest.setting_getbool("creative_mode")
573 def.on_blast = function() end
575 def.on_blast = function(pos, intensity)
576 minetest.remove_node(pos)
577 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
582 if not def.sounds then
583 def.sounds = default.node_sound_wood_defaults()
586 if not def.sound_open then
587 def.sound_open = "doors_door_open"
590 if not def.sound_close then
591 def.sound_close = "doors_door_close"
594 local def_opened = table.copy(def)
595 local def_closed = table.copy(def)
597 def_closed.node_box = {
599 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
601 def_closed.selection_box = {
603 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
605 def_closed.tiles = {def.tile_front, def.tile_front, def.tile_side, def.tile_side,
606 def.tile_side, def.tile_side}
608 def_opened.node_box = {
610 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
612 def_opened.selection_box = {
614 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
616 def_opened.tiles = {def.tile_side, def.tile_side,
617 def.tile_side .. '^[transform3',
618 def.tile_side .. '^[transform1',
619 def.tile_front, def.tile_front}
621 def_opened.drop = name_closed
622 def_opened.groups.not_in_creative_inventory = 1
624 minetest.register_node(name_opened, def_opened)
625 minetest.register_node(name_closed, def_closed)
627 _doors.registered_trapdoors[name_opened] = true
628 _doors.registered_trapdoors[name_closed] = true
631 doors.register_trapdoor("doors:trapdoor", {
632 description = "Trapdoor",
633 inventory_image = "doors_trapdoor.png",
634 wield_image = "doors_trapdoor.png",
635 tile_front = "doors_trapdoor.png",
636 tile_side = "doors_trapdoor_side.png",
637 groups = {snappy=1, choppy=2, oddly_breakable_by_hand=2, flammable=2, door=1},
640 doors.register_trapdoor("doors:trapdoor_steel", {
641 description = "Steel Trapdoor",
642 inventory_image = "doors_trapdoor_steel.png",
643 wield_image = "doors_trapdoor_steel.png",
644 tile_front = "doors_trapdoor_steel.png",
645 tile_side = "doors_trapdoor_steel_side.png",
647 sounds = default.node_sound_stone_defaults(),
648 sound_open = "doors_steel_door_open",
649 sound_close = "doors_steel_door_close",
650 groups = {snappy=1, cracky=1, level=2, door=1},
653 minetest.register_craft({
654 output = 'doors:trapdoor 2',
656 {'group:wood', 'group:wood', 'group:wood'},
657 {'group:wood', 'group:wood', 'group:wood'},
662 minetest.register_craft({
663 output = 'doors:trapdoor_steel',
665 {'default:steel_ingot', 'default:steel_ingot'},
666 {'default:steel_ingot', 'default:steel_ingot'},
673 function doors.register_fencegate(name, def)
675 description = def.description,
677 tiles = {def.texture},
679 paramtype2 = "facedir",
680 sunlight_propagates = true,
681 is_ground_content = false,
682 drop = name .. "_closed",
683 connect_sides = {"left", "right"},
686 on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
687 local node = minetest.get_node(pos)
688 local node_def = minetest.registered_nodes[node.name]
689 minetest.swap_node(pos, {name = node_def.gate, param2 = node.param2})
690 minetest.sound_play(node_def.sound, {pos = pos, gain = 0.3,
691 max_hear_distance = 8})
696 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
700 if not fence.sounds then
701 fence.sounds = default.node_sound_wood_defaults()
704 fence.groups.fence = 1
706 local fence_closed = table.copy(fence)
707 fence_closed.mesh = "doors_fencegate_closed.obj"
708 fence_closed.gate = name .. "_open"
709 fence_closed.sound = "doors_fencegate_open"
710 fence_closed.collision_box = {
712 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
715 local fence_open = table.copy(fence)
716 fence_open.mesh = "doors_fencegate_open.obj"
717 fence_open.gate = name .. "_closed"
718 fence_open.sound = "doors_fencegate_close"
719 fence_open.groups.not_in_creative_inventory = 1
720 fence_open.collision_box = {
722 fixed = {{-1/2, -1/2, -1/4, -3/8, 1/2, 1/4},
723 {-5/8, -3/8, -14/16, -3/8, 3/8, 0}},
726 minetest.register_node(":" .. name .. "_closed", fence_closed)
727 minetest.register_node(":" .. name .. "_open", fence_open)
729 minetest.register_craft({
730 output = name .. "_closed",
732 {"default:stick", def.material, "default:stick"},
733 {"default:stick", def.material, "default:stick"}
738 doors.register_fencegate("doors:gate_wood", {
739 description = "Wooden Fence Gate",
740 texture = "default_wood.png",
741 material = "default:wood",
742 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
745 doors.register_fencegate("doors:gate_acacia_wood", {
746 description = "Acacia Fence Gate",
747 texture = "default_acacia_wood.png",
748 material = "default:acacia_wood",
749 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
752 doors.register_fencegate("doors:gate_junglewood", {
753 description = "Junglewood Fence Gate",
754 texture = "default_junglewood.png",
755 material = "default:junglewood",
756 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
759 doors.register_fencegate("doors:gate_pine_wood", {
760 description = "Pine Fence Gate",
761 texture = "default_pine_wood.png",
762 material = "default:pine_wood",
763 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
766 doors.register_fencegate("doors:gate_aspen_wood", {
767 description = "Aspen Fence Gate",
768 texture = "default_aspen_wood.png",
769 material = "default:aspen_wood",
770 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}