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 local node_name = minetest.get_node(pos).name
20 if _doors.registered_doors[node_name] then
21 -- A normal upright door
24 open = function(self, player)
28 return _doors.door_toggle(self.pos, nil, player)
30 close = function(self, player)
31 if not self:state() then
34 return _doors.door_toggle(self.pos, nil, player)
36 toggle = function(self, player)
37 return _doors.door_toggle(self.pos, nil, player)
39 state = function(self)
40 local state = minetest.get_meta(self.pos):get_int("state")
44 elseif _doors.registered_trapdoors[node_name] then
48 open = function(self, player)
52 return _doors.trapdoor_toggle(self.pos, nil, player)
54 close = function(self, player)
55 if not self:state() then
58 return _doors.trapdoor_toggle(self.pos, nil, player)
60 toggle = function(self, player)
61 return _doors.trapdoor_toggle(self.pos, nil, player)
63 state = function(self)
64 return minetest.get_node(self.pos).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, node, clicker)
133 local meta = minetest.get_meta(pos)
134 node = node or minetest.get_node(pos)
135 local def = minetest.registered_nodes[node.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 node.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
159 -- until Lua-5.2 we have no bitwise operators :(
160 if state % 2 == 1 then
166 local dir = node.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)
188 for _, callback in ipairs(core.registered_on_placenodes) do
189 -- Deepcopy pos, node and pointed_thing because callback can modify them
190 local place_to_copy = {x = place_to.x, y = place_to.y, z = place_to.z}
192 {name = newnode.name, param1 = newnode.param1, param2 = newnode.param2}
194 {name = oldnode.name, param1 = oldnode.param1, param2 = oldnode.param2}
195 local pointed_thing_copy = {
196 type = pointed_thing.type,
197 above = vector.new(pointed_thing.above),
198 under = vector.new(pointed_thing.under),
199 ref = pointed_thing.ref,
201 callback(place_to_copy, newnode_copy, placer,
202 oldnode_copy, itemstack, pointed_thing_copy)
206 function doors.register(name, def)
207 if not name:find(":") then
208 name = "doors:" .. name
211 -- replace old doors of this type automatically
212 minetest.register_lbm({
213 name = ":doors:replace_" .. name:gsub(":", "_"),
214 nodenames = {name.."_b_1", name.."_b_2"},
215 action = function(pos, node)
216 local l = tonumber(node.name:sub(-1))
217 local meta = minetest.get_meta(pos)
218 local h = meta:get_int("right") + 1
219 local p2 = node.param2
221 {{type = "a", state = 0}, {type = "a", state = 3}},
222 {{type = "b", state = 1}, {type = "b", state = 2}}
224 local new = replace[l][h]
225 -- retain infotext and doors_owner fields
226 minetest.swap_node(pos, {name = name .. "_" .. new.type, param2 = p2})
227 meta:set_int("state", new.state)
228 -- properly place doors:hidden at the right spot
230 if new.state >= 2 then
233 if new.state % 2 == 1 then
234 if new.state >= 2 then
240 -- wipe meta on top node as it's unused
241 minetest.set_node({x = pos.x, y = pos.y + 1, z = pos.z},
242 {name = "doors:hidden", param2 = p3})
246 minetest.register_craftitem(":" .. name, {
247 description = def.description,
248 inventory_image = def.inventory_image,
250 on_place = function(itemstack, placer, pointed_thing)
253 if not pointed_thing.type == "node" then
257 local node = minetest.get_node(pointed_thing.under)
258 local pdef = minetest.registered_nodes[node.name]
259 if pdef and pdef.on_rightclick then
260 return pdef.on_rightclick(pointed_thing.under,
261 node, placer, itemstack, pointed_thing)
264 if pdef and pdef.buildable_to then
265 pos = pointed_thing.under
267 pos = pointed_thing.above
268 node = minetest.get_node(pos)
269 pdef = minetest.registered_nodes[node.name]
270 if not pdef or not pdef.buildable_to then
275 local above = {x = pos.x, y = pos.y + 1, z = pos.z}
276 if not minetest.registered_nodes[
277 minetest.get_node(above).name].buildable_to then
281 local pn = placer:get_player_name()
282 if minetest.is_protected(pos, pn) or minetest.is_protected(above, pn) then
286 local dir = minetest.dir_to_facedir(placer:get_look_dir())
289 {x = -1, y = 0, z = 0},
290 {x = 0, y = 0, z = 1},
291 {x = 1, y = 0, z = 0},
292 {x = 0, y = 0, z = -1},
296 x = pos.x + ref[dir + 1].x,
297 y = pos.y + ref[dir + 1].y,
298 z = pos.z + ref[dir + 1].z,
302 if minetest.get_item_group(minetest.get_node(aside).name, "door") == 1 then
304 minetest.set_node(pos, {name = name .. "_b", param2 = dir})
305 minetest.set_node(above, {name = "doors:hidden", param2 = (dir + 3) % 4})
307 minetest.set_node(pos, {name = name .. "_a", param2 = dir})
308 minetest.set_node(above, {name = "doors:hidden", param2 = dir})
311 local meta = minetest.get_meta(pos)
312 meta:set_int("state", state)
314 if def.protected then
315 meta:set_string("doors_owner", pn)
316 meta:set_string("infotext", "Owned by " .. pn)
319 if not minetest.setting_getbool("creative_mode") then
320 itemstack:take_item()
323 on_place_node(pos, minetest.get_node(pos),
324 placer, node, itemstack, pointed_thing)
329 def.inventory_image = nil
332 minetest.register_craft({
339 local can_dig = function(pos, digger)
340 if not def.protected then
343 if minetest.check_player_privs(digger, "protection_bypass") then
346 local meta = minetest.get_meta(pos)
349 name = digger:get_player_name()
351 return meta:get_string("doors_owner") == name
354 if not def.sounds then
355 def.sounds = default.node_sound_wood_defaults()
358 if not def.sound_open then
359 def.sound_open = "doors_door_open"
362 if not def.sound_close then
363 def.sound_close = "doors_door_close"
366 def.groups.not_in_creative_inventory = 1
371 sounds = { def.sound_close, def.sound_open },
374 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
375 _doors.door_toggle(pos, node, clicker)
378 def.after_dig_node = function(pos, node, meta, digger)
379 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
380 nodeupdate({x = pos.x, y = pos.y + 1, z = pos.z})
382 def.can_dig = function(pos, player)
383 return can_dig(pos, player)
385 def.on_rotate = function(pos, node, user, mode, new_param2)
389 if def.protected then
390 def.on_blast = function() end
392 def.on_blast = function(pos, intensity)
393 minetest.remove_node(pos)
394 -- hidden node doesn't get blasted away.
395 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
400 def.on_destruct = function(pos)
401 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
404 def.drawtype = "mesh"
405 def.paramtype = "light"
406 def.paramtype2 = "facedir"
407 def.sunlight_propagates = true
409 def.is_ground_content = false
410 def.buildable_to = false
411 def.selection_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
412 def.collision_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
414 def.mesh = "door_a.obj"
415 minetest.register_node(":" .. name .. "_a", def)
417 def.mesh = "door_b.obj"
418 minetest.register_node(":" .. name .. "_b", def)
420 _doors.registered_doors[name .. "_a"] = true
421 _doors.registered_doors[name .. "_b"] = true
424 doors.register("door_wood", {
425 tiles = {{ name = "doors_door_wood.png", backface_culling = true }},
426 description = "Wooden Door",
427 inventory_image = "doors_item_wood.png",
428 groups = {snappy = 1, choppy = 2, oddly_breakable_by_hand = 2, flammable = 2},
430 {"group:wood", "group:wood"},
431 {"group:wood", "group:wood"},
432 {"group:wood", "group:wood"},
436 doors.register("door_steel", {
437 tiles = {{name = "doors_door_steel.png", backface_culling = true}},
438 description = "Steel Door",
439 inventory_image = "doors_item_steel.png",
441 groups = {snappy = 1, cracky = 1, level = 2},
442 sounds = default.node_sound_stone_defaults(),
443 sound_open = "doors_steel_door_open",
444 sound_close = "doors_steel_door_close",
446 {"default:steel_ingot", "default:steel_ingot"},
447 {"default:steel_ingot", "default:steel_ingot"},
448 {"default:steel_ingot", "default:steel_ingot"},
452 doors.register("door_glass", {
453 tiles = {"doors_door_glass.png"},
454 description = "Glass Door",
455 inventory_image = "doors_item_glass.png",
456 groups = {snappy=1, cracky=1, oddly_breakable_by_hand=3},
457 sounds = default.node_sound_glass_defaults(),
458 sound_open = "doors_glass_door_open",
459 sound_close = "doors_glass_door_close",
461 {"default:glass", "default:glass"},
462 {"default:glass", "default:glass"},
463 {"default:glass", "default:glass"},
467 doors.register("door_obsidian_glass", {
468 tiles = {"doors_door_obsidian_glass.png"},
469 description = "Obsidian Glass Door",
470 inventory_image = "doors_item_obsidian_glass.png",
471 groups = {snappy=1, cracky=1, oddly_breakable_by_hand=3},
472 sounds = default.node_sound_glass_defaults(),
473 sound_open = "doors_glass_door_open",
474 sound_close = "doors_glass_door_close",
476 {"default:obsidian_glass", "default:obsidian_glass"},
477 {"default:obsidian_glass", "default:obsidian_glass"},
478 {"default:obsidian_glass", "default:obsidian_glass"},
482 -- Capture mods using the old API as best as possible.
483 function doors.register_door(name, def)
484 if def.only_placer_can_open then
487 def.only_placer_can_open = nil
489 local i = name:find(":")
490 local modname = name:sub(1, i - 1)
491 if not def.tiles then
492 if def.protected then
493 def.tiles = {{name = "doors_door_steel.png", backface_culling = true}}
495 def.tiles = {{name = "doors_door_wood.png", backface_culling = true}}
497 minetest.log("warning", modname .. " registered door \"" .. name .. "\" " ..
498 "using deprecated API method \"doors.register_door()\" but " ..
499 "did not provide the \"tiles\" parameter. A fallback tiledef " ..
500 "will be used instead.")
503 doors.register(name, def)
508 function _doors.trapdoor_toggle(pos, node, clicker)
509 node = node or minetest.get_node(pos)
510 if clicker and not minetest.check_player_privs(clicker, "protection_bypass") then
511 local meta = minetest.get_meta(pos)
512 local owner = meta:get_string("doors_owner")
514 if clicker:get_player_name() ~= owner then
520 local def = minetest.registered_nodes[node.name]
522 if string.sub(node.name, -5) == "_open" then
523 minetest.sound_play(def.sound_close,
524 {pos = pos, gain = 0.3, max_hear_distance = 10})
525 minetest.swap_node(pos, {name = string.sub(node.name, 1,
526 string.len(node.name) - 5), param1 = node.param1, param2 = node.param2})
528 minetest.sound_play(def.sound_open,
529 {pos = pos, gain = 0.3, max_hear_distance = 10})
530 minetest.swap_node(pos, {name = node.name .. "_open",
531 param1 = node.param1, param2 = node.param2})
535 function doors.register_trapdoor(name, def)
536 local name_closed = name
537 local name_opened = name.."_open"
539 local function check_player_priv(pos, player)
540 if not def.protected or
541 minetest.check_player_privs(player, "protection_bypass") then
544 local meta = minetest.get_meta(pos)
545 local player_name = player and player:get_player_name()
546 return meta:get_string("doors_owner") == player_name
549 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
550 _doors.trapdoor_toggle(pos, node, clicker)
554 -- Common trapdoor configuration
555 def.drawtype = "nodebox"
556 def.paramtype = "light"
557 def.paramtype2 = "facedir"
558 def.is_ground_content = false
559 def.can_dig = check_player_priv
561 if def.protected then
562 def.after_place_node = function(pos, placer, itemstack, pointed_thing)
563 local pn = placer:get_player_name()
564 local meta = minetest.get_meta(pos)
565 meta:set_string("doors_owner", pn)
566 meta:set_string("infotext", "Owned by "..pn)
568 return minetest.setting_getbool("creative_mode")
571 def.on_blast = function() end
573 def.on_blast = function(pos, intensity)
574 minetest.remove_node(pos)
575 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
580 if not def.sounds then
581 def.sounds = default.node_sound_wood_defaults()
584 if not def.sound_open then
585 def.sound_open = "doors_door_open"
588 if not def.sound_close then
589 def.sound_close = "doors_door_close"
592 local def_opened = table.copy(def)
593 local def_closed = table.copy(def)
595 def_closed.node_box = {
597 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
599 def_closed.selection_box = {
601 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
603 def_closed.tiles = {def.tile_front, def.tile_front, def.tile_side, def.tile_side,
604 def.tile_side, def.tile_side}
606 def_opened.node_box = {
608 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
610 def_opened.selection_box = {
612 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
614 def_opened.tiles = {def.tile_side, def.tile_side,
615 def.tile_side .. '^[transform3',
616 def.tile_side .. '^[transform1',
617 def.tile_front, def.tile_front}
619 def_opened.drop = name_closed
620 def_opened.groups.not_in_creative_inventory = 1
622 minetest.register_node(name_opened, def_opened)
623 minetest.register_node(name_closed, def_closed)
625 _doors.registered_trapdoors[name_opened] = true
626 _doors.registered_trapdoors[name_closed] = true
629 doors.register_trapdoor("doors:trapdoor", {
630 description = "Trapdoor",
631 inventory_image = "doors_trapdoor.png",
632 wield_image = "doors_trapdoor.png",
633 tile_front = "doors_trapdoor.png",
634 tile_side = "doors_trapdoor_side.png",
635 groups = {snappy=1, choppy=2, oddly_breakable_by_hand=2, flammable=2, door=1},
638 doors.register_trapdoor("doors:trapdoor_steel", {
639 description = "Steel Trapdoor",
640 inventory_image = "doors_trapdoor_steel.png",
641 wield_image = "doors_trapdoor_steel.png",
642 tile_front = "doors_trapdoor_steel.png",
643 tile_side = "doors_trapdoor_steel_side.png",
645 sounds = default.node_sound_stone_defaults(),
646 sound_open = "doors_steel_door_open",
647 sound_close = "doors_steel_door_close",
648 groups = {snappy=1, cracky=1, level=2, door=1},
651 minetest.register_craft({
652 output = 'doors:trapdoor 2',
654 {'group:wood', 'group:wood', 'group:wood'},
655 {'group:wood', 'group:wood', 'group:wood'},
660 minetest.register_craft({
661 output = 'doors:trapdoor_steel',
663 {'default:steel_ingot', 'default:steel_ingot'},
664 {'default:steel_ingot', 'default:steel_ingot'},
671 function doors.register_fencegate(name, def)
673 description = def.description,
675 tiles = {def.texture},
677 paramtype2 = "facedir",
678 sunlight_propagates = true,
679 is_ground_content = false,
680 drop = name .. "_closed",
681 connect_sides = {"left", "right"},
684 on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
685 local node_def = minetest.registered_nodes[node.name]
686 minetest.swap_node(pos, {name = node_def.gate, param2 = node.param2})
687 minetest.sound_play(node_def.sound, {pos = pos, gain = 0.3,
688 max_hear_distance = 8})
693 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
697 if not fence.sounds then
698 fence.sounds = default.node_sound_wood_defaults()
701 fence.groups.fence = 1
703 local fence_closed = table.copy(fence)
704 fence_closed.mesh = "doors_fencegate_closed.obj"
705 fence_closed.gate = name .. "_open"
706 fence_closed.sound = "doors_fencegate_open"
707 fence_closed.collision_box = {
709 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
712 local fence_open = table.copy(fence)
713 fence_open.mesh = "doors_fencegate_open.obj"
714 fence_open.gate = name .. "_closed"
715 fence_open.sound = "doors_fencegate_close"
716 fence_open.groups.not_in_creative_inventory = 1
717 fence_open.collision_box = {
719 fixed = {{-1/2, -1/2, -1/4, -3/8, 1/2, 1/4},
720 {-5/8, -3/8, -14/16, -3/8, 3/8, 0}},
723 minetest.register_node(":" .. name .. "_closed", fence_closed)
724 minetest.register_node(":" .. name .. "_open", fence_open)
726 minetest.register_craft({
727 output = name .. "_closed",
729 {"default:stick", def.material, "default:stick"},
730 {"default:stick", def.material, "default:stick"}
735 doors.register_fencegate("doors:gate_wood", {
736 description = "Wooden Fence Gate",
737 texture = "default_wood.png",
738 material = "default:wood",
739 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
742 doors.register_fencegate("doors:gate_acacia_wood", {
743 description = "Acacia Fence Gate",
744 texture = "default_acacia_wood.png",
745 material = "default:acacia_wood",
746 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
749 doors.register_fencegate("doors:gate_junglewood", {
750 description = "Junglewood Fence Gate",
751 texture = "default_junglewood.png",
752 material = "default:junglewood",
753 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
756 doors.register_fencegate("doors:gate_pine_wood", {
757 description = "Pine Fence Gate",
758 texture = "default_pine_wood.png",
759 material = "default:pine_wood",
760 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
763 doors.register_fencegate("doors:gate_aspen_wood", {
764 description = "Aspen Fence Gate",
765 texture = "default_aspen_wood.png",
766 material = "default:aspen_wood",
767 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}