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
160 -- until Lua-5.2 we have no bitwise operators :(
161 if state % 2 == 1 then
167 local dir = node.param2
168 if state % 2 == 0 then
169 minetest.sound_play(def.door.sounds[1],
170 {pos = pos, gain = 0.3, max_hear_distance = 10})
172 minetest.sound_play(def.door.sounds[2],
173 {pos = pos, gain = 0.3, max_hear_distance = 10})
176 minetest.swap_node(pos, {
177 name = name .. transform[state + 1][dir+1].v,
178 param2 = transform[state + 1][dir+1].param2
180 meta:set_int("state", state)
186 local function on_place_node(place_to, newnode,
187 placer, oldnode, itemstack, pointed_thing)
190 for _, callback in ipairs(core.registered_on_placenodes) do
191 -- Deepcopy pos, node and pointed_thing because callback can modify them
192 local place_to_copy = {x = place_to.x, y = place_to.y, z = place_to.z}
194 {name = newnode.name, param1 = newnode.param1, param2 = newnode.param2}
196 {name = oldnode.name, param1 = oldnode.param1, param2 = oldnode.param2}
197 local pointed_thing_copy = {
198 type = pointed_thing.type,
199 above = vector.new(pointed_thing.above),
200 under = vector.new(pointed_thing.under),
201 ref = pointed_thing.ref,
203 callback(place_to_copy, newnode_copy, placer,
204 oldnode_copy, itemstack, pointed_thing_copy)
208 function doors.register(name, def)
209 if not name:find(":") then
210 name = "doors:" .. name
213 -- replace old doors of this type automatically
214 minetest.register_lbm({
215 name = ":doors:replace_" .. name:gsub(":", "_"),
216 nodenames = {name.."_b_1", name.."_b_2"},
217 action = function(pos, node)
218 local l = tonumber(node.name:sub(-1))
219 local meta = minetest.get_meta(pos)
220 local h = meta:get_int("right") + 1
221 local p2 = node.param2
223 {{type = "a", state = 0}, {type = "a", state = 3}},
224 {{type = "b", state = 1}, {type = "b", state = 2}}
226 local new = replace[l][h]
227 -- retain infotext and doors_owner fields
228 minetest.swap_node(pos, {name = name .. "_" .. new.type, param2 = p2})
229 meta:set_int("state", new.state)
230 -- properly place doors:hidden at the right spot
232 if new.state >= 2 then
235 if new.state % 2 == 1 then
236 if new.state >= 2 then
242 -- wipe meta on top node as it's unused
243 minetest.set_node({x = pos.x, y = pos.y + 1, z = pos.z},
244 {name = "doors:hidden", param2 = p3})
248 minetest.register_craftitem(":" .. name, {
249 description = def.description,
250 inventory_image = def.inventory_image,
252 on_place = function(itemstack, placer, pointed_thing)
255 if not pointed_thing.type == "node" then
259 local node = minetest.get_node(pointed_thing.under)
260 local pdef = minetest.registered_nodes[node.name]
261 if pdef and pdef.on_rightclick then
262 return pdef.on_rightclick(pointed_thing.under,
263 node, placer, itemstack, pointed_thing)
266 if pdef and pdef.buildable_to then
267 pos = pointed_thing.under
269 pos = pointed_thing.above
270 node = minetest.get_node(pos)
271 pdef = minetest.registered_nodes[node.name]
272 if not pdef or not pdef.buildable_to then
277 local above = {x = pos.x, y = pos.y + 1, z = pos.z}
278 if not minetest.registered_nodes[
279 minetest.get_node(above).name].buildable_to then
283 local pn = placer:get_player_name()
284 if minetest.is_protected(pos, pn) or minetest.is_protected(above, pn) then
288 local dir = minetest.dir_to_facedir(placer:get_look_dir())
291 {x = -1, y = 0, z = 0},
292 {x = 0, y = 0, z = 1},
293 {x = 1, y = 0, z = 0},
294 {x = 0, y = 0, z = -1},
298 x = pos.x + ref[dir + 1].x,
299 y = pos.y + ref[dir + 1].y,
300 z = pos.z + ref[dir + 1].z,
304 if minetest.get_item_group(minetest.get_node(aside).name, "door") == 1 then
306 minetest.set_node(pos, {name = name .. "_b", param2 = dir})
307 minetest.set_node(above, {name = "doors:hidden", param2 = (dir + 3) % 4})
309 minetest.set_node(pos, {name = name .. "_a", param2 = dir})
310 minetest.set_node(above, {name = "doors:hidden", param2 = dir})
313 local meta = minetest.get_meta(pos)
314 meta:set_int("state", state)
316 if def.protected then
317 local pn = placer:get_player_name()
318 meta:set_string("doors_owner", pn)
319 meta:set_string("infotext", "Owned by " .. pn)
322 if not minetest.setting_getbool("creative_mode") then
323 itemstack:take_item()
326 on_place_node(pos, minetest.get_node(pos),
327 placer, node, itemstack, pointed_thing)
332 def.inventory_image = nil
335 minetest.register_craft({
342 local can_dig = function(pos, digger)
343 if not def.protected then
346 if minetest.check_player_privs(digger, "protection_bypass") then
349 local meta = minetest.get_meta(pos)
352 name = digger:get_player_name()
354 return meta:get_string("doors_owner") == name
357 if not def.sounds then
358 def.sounds = default.node_sound_wood_defaults()
361 if not def.sound_open then
362 def.sound_open = "doors_door_open"
365 if not def.sound_close then
366 def.sound_close = "doors_door_close"
369 def.groups.not_in_creative_inventory = 1
374 sounds = { def.sound_close, def.sound_open },
377 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
378 _doors.door_toggle(pos, node, clicker)
381 def.after_dig_node = function(pos, node, meta, digger)
382 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
383 nodeupdate({x = pos.x, y = pos.y + 1, z = pos.z})
385 def.can_dig = function(pos, player)
386 return can_dig(pos, player)
388 def.on_rotate = function(pos, node, user, mode, new_param2)
392 if def.protected then
393 def.on_blast = function() end
395 def.on_blast = function(pos, intensity)
396 minetest.remove_node(pos)
397 -- hidden node doesn't get blasted away.
398 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
403 def.on_destruct = function(pos)
404 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
407 def.drawtype = "mesh"
408 def.paramtype = "light"
409 def.paramtype2 = "facedir"
410 def.sunlight_propagates = true
412 def.is_ground_content = false
413 def.buildable_to = false
414 def.selection_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
415 def.collision_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
417 def.mesh = "door_a.obj"
418 minetest.register_node(":" .. name .. "_a", def)
420 def.mesh = "door_b.obj"
421 minetest.register_node(":" .. name .. "_b", def)
423 _doors.registered_doors[name .. "_a"] = true
424 _doors.registered_doors[name .. "_b"] = true
427 doors.register("door_wood", {
428 tiles = {{ name = "doors_door_wood.png", backface_culling = true }},
429 description = "Wooden Door",
430 inventory_image = "doors_item_wood.png",
431 groups = {snappy = 1, choppy = 2, oddly_breakable_by_hand = 2, flammable = 2},
433 {"group:wood", "group:wood"},
434 {"group:wood", "group:wood"},
435 {"group:wood", "group:wood"},
439 doors.register("door_steel", {
440 tiles = {{name = "doors_door_steel.png", backface_culling = true}},
441 description = "Steel Door",
442 inventory_image = "doors_item_steel.png",
444 groups = {snappy = 1, cracky = 1, level = 2},
445 sounds = default.node_sound_stone_defaults(),
446 sound_open = "doors_steel_door_open",
447 sound_close = "doors_steel_door_close",
449 {"default:steel_ingot", "default:steel_ingot"},
450 {"default:steel_ingot", "default:steel_ingot"},
451 {"default:steel_ingot", "default:steel_ingot"},
455 doors.register("door_glass", {
456 tiles = {"doors_door_glass.png"},
457 description = "Glass Door",
458 inventory_image = "doors_item_glass.png",
459 groups = {snappy=1, cracky=1, oddly_breakable_by_hand=3},
460 sounds = default.node_sound_glass_defaults(),
461 sound_open = "doors_glass_door_open",
462 sound_close = "doors_glass_door_close",
464 {"default:glass", "default:glass"},
465 {"default:glass", "default:glass"},
466 {"default:glass", "default:glass"},
470 doors.register("door_obsidian_glass", {
471 tiles = {"doors_door_obsidian_glass.png"},
472 description = "Obsidian Glass Door",
473 inventory_image = "doors_item_obsidian_glass.png",
474 groups = {snappy=1, cracky=1, oddly_breakable_by_hand=3},
475 sounds = default.node_sound_glass_defaults(),
476 sound_open = "doors_glass_door_open",
477 sound_close = "doors_glass_door_close",
479 {"default:obsidian_glass", "default:obsidian_glass"},
480 {"default:obsidian_glass", "default:obsidian_glass"},
481 {"default:obsidian_glass", "default:obsidian_glass"},
485 -- Capture mods using the old API as best as possible.
486 function doors.register_door(name, def)
487 if def.only_placer_can_open then
490 def.only_placer_can_open = nil
492 local i = name:find(":")
493 local modname = name:sub(1, i - 1)
494 if not def.tiles then
495 if def.protected then
496 def.tiles = {{name = "doors_door_steel.png", backface_culling = true}}
498 def.tiles = {{name = "doors_door_wood.png", backface_culling = true}}
500 minetest.log("warning", modname .. " registered door \"" .. name .. "\" " ..
501 "using deprecated API method \"doors.register_door()\" but " ..
502 "did not provide the \"tiles\" parameter. A fallback tiledef " ..
503 "will be used instead.")
506 doors.register(name, def)
511 function _doors.trapdoor_toggle(pos, node, clicker)
512 node = node or minetest.get_node(pos)
513 if clicker and not minetest.check_player_privs(clicker, "protection_bypass") then
514 local meta = minetest.get_meta(pos)
515 local owner = meta:get_string("doors_owner")
517 if clicker:get_player_name() ~= owner then
523 local def = minetest.registered_nodes[node.name]
525 if string.sub(node.name, -5) == "_open" then
526 minetest.sound_play(def.sound_close,
527 {pos = pos, gain = 0.3, max_hear_distance = 10})
528 minetest.swap_node(pos, {name = string.sub(node.name, 1,
529 string.len(node.name) - 5), param1 = node.param1, param2 = node.param2})
531 minetest.sound_play(def.sound_open,
532 {pos = pos, gain = 0.3, max_hear_distance = 10})
533 minetest.swap_node(pos, {name = node.name .. "_open",
534 param1 = node.param1, param2 = node.param2})
538 function doors.register_trapdoor(name, def)
539 local name_closed = name
540 local name_opened = name.."_open"
542 local function check_player_priv(pos, player)
543 if not def.protected or
544 minetest.check_player_privs(player, "protection_bypass") then
547 local meta = minetest.get_meta(pos)
548 local player_name = player and player:get_player_name()
549 return meta:get_string("doors_owner") == player_name
552 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
553 _doors.trapdoor_toggle(pos, node, clicker)
557 -- Common trapdoor configuration
558 def.drawtype = "nodebox"
559 def.paramtype = "light"
560 def.paramtype2 = "facedir"
561 def.is_ground_content = false
562 def.can_dig = check_player_priv
564 if def.protected then
565 def.after_place_node = function(pos, placer, itemstack, pointed_thing)
566 local pn = placer:get_player_name()
567 local meta = minetest.get_meta(pos)
568 meta:set_string("doors_owner", pn)
569 meta:set_string("infotext", "Owned by "..pn)
571 return minetest.setting_getbool("creative_mode")
574 def.on_blast = function() end
576 def.on_blast = function(pos, intensity)
577 minetest.remove_node(pos)
578 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
583 if not def.sounds then
584 def.sounds = default.node_sound_wood_defaults()
587 if not def.sound_open then
588 def.sound_open = "doors_door_open"
591 if not def.sound_close then
592 def.sound_close = "doors_door_close"
595 local def_opened = table.copy(def)
596 local def_closed = table.copy(def)
598 def_closed.node_box = {
600 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
602 def_closed.selection_box = {
604 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
606 def_closed.tiles = {def.tile_front, def.tile_front, def.tile_side, def.tile_side,
607 def.tile_side, def.tile_side}
609 def_opened.node_box = {
611 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
613 def_opened.selection_box = {
615 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
617 def_opened.tiles = {def.tile_side, def.tile_side,
618 def.tile_side .. '^[transform3',
619 def.tile_side .. '^[transform1',
620 def.tile_front, def.tile_front}
622 def_opened.drop = name_closed
623 def_opened.groups.not_in_creative_inventory = 1
625 minetest.register_node(name_opened, def_opened)
626 minetest.register_node(name_closed, def_closed)
628 _doors.registered_trapdoors[name_opened] = true
629 _doors.registered_trapdoors[name_closed] = true
632 doors.register_trapdoor("doors:trapdoor", {
633 description = "Trapdoor",
634 inventory_image = "doors_trapdoor.png",
635 wield_image = "doors_trapdoor.png",
636 tile_front = "doors_trapdoor.png",
637 tile_side = "doors_trapdoor_side.png",
638 groups = {snappy=1, choppy=2, oddly_breakable_by_hand=2, flammable=2, door=1},
641 doors.register_trapdoor("doors:trapdoor_steel", {
642 description = "Steel Trapdoor",
643 inventory_image = "doors_trapdoor_steel.png",
644 wield_image = "doors_trapdoor_steel.png",
645 tile_front = "doors_trapdoor_steel.png",
646 tile_side = "doors_trapdoor_steel_side.png",
648 sounds = default.node_sound_stone_defaults(),
649 sound_open = "doors_steel_door_open",
650 sound_close = "doors_steel_door_close",
651 groups = {snappy=1, cracky=1, level=2, door=1},
654 minetest.register_craft({
655 output = 'doors:trapdoor 2',
657 {'group:wood', 'group:wood', 'group:wood'},
658 {'group:wood', 'group:wood', 'group:wood'},
663 minetest.register_craft({
664 output = 'doors:trapdoor_steel',
666 {'default:steel_ingot', 'default:steel_ingot'},
667 {'default:steel_ingot', 'default:steel_ingot'},
674 function doors.register_fencegate(name, def)
676 description = def.description,
678 tiles = {def.texture},
680 paramtype2 = "facedir",
681 sunlight_propagates = true,
682 is_ground_content = false,
683 drop = name .. "_closed",
684 connect_sides = {"left", "right"},
687 on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
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}