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(minetest.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 local function can_dig_door(pos, digger)
207 local digger_name = digger and digger:get_player_name()
208 if digger_name and minetest.get_player_privs(digger_name).protection_bypass then
211 return minetest.get_meta(pos):get_string("doors_owner") == digger_name
214 function doors.register(name, def)
215 if not name:find(":") then
216 name = "doors:" .. name
219 -- replace old doors of this type automatically
220 minetest.register_lbm({
221 name = ":doors:replace_" .. name:gsub(":", "_"),
222 nodenames = {name.."_b_1", name.."_b_2"},
223 action = function(pos, node)
224 local l = tonumber(node.name:sub(-1))
225 local meta = minetest.get_meta(pos)
226 local h = meta:get_int("right") + 1
227 local p2 = node.param2
229 {{type = "a", state = 0}, {type = "a", state = 3}},
230 {{type = "b", state = 1}, {type = "b", state = 2}}
232 local new = replace[l][h]
233 -- retain infotext and doors_owner fields
234 minetest.swap_node(pos, {name = name .. "_" .. new.type, param2 = p2})
235 meta:set_int("state", new.state)
236 -- properly place doors:hidden at the right spot
238 if new.state >= 2 then
241 if new.state % 2 == 1 then
242 if new.state >= 2 then
248 -- wipe meta on top node as it's unused
249 minetest.set_node({x = pos.x, y = pos.y + 1, z = pos.z},
250 {name = "doors:hidden", param2 = p3})
254 minetest.register_craftitem(":" .. name, {
255 description = def.description,
256 inventory_image = def.inventory_image,
258 on_place = function(itemstack, placer, pointed_thing)
261 if not pointed_thing.type == "node" then
265 local node = minetest.get_node(pointed_thing.under)
266 local pdef = minetest.registered_nodes[node.name]
267 if pdef and pdef.on_rightclick then
268 return pdef.on_rightclick(pointed_thing.under,
269 node, placer, itemstack, pointed_thing)
272 if pdef and pdef.buildable_to then
273 pos = pointed_thing.under
275 pos = pointed_thing.above
276 node = minetest.get_node(pos)
277 pdef = minetest.registered_nodes[node.name]
278 if not pdef or not pdef.buildable_to then
283 local above = {x = pos.x, y = pos.y + 1, z = pos.z}
284 local top_node = minetest.get_node_or_nil(above)
285 local topdef = top_node and minetest.registered_nodes[top_node.name]
287 if not topdef or not topdef.buildable_to then
291 local pn = placer:get_player_name()
292 if minetest.is_protected(pos, pn) or minetest.is_protected(above, pn) then
296 local dir = minetest.dir_to_facedir(placer:get_look_dir())
299 {x = -1, y = 0, z = 0},
300 {x = 0, y = 0, z = 1},
301 {x = 1, y = 0, z = 0},
302 {x = 0, y = 0, z = -1},
306 x = pos.x + ref[dir + 1].x,
307 y = pos.y + ref[dir + 1].y,
308 z = pos.z + ref[dir + 1].z,
312 if minetest.get_item_group(minetest.get_node(aside).name, "door") == 1 then
314 minetest.set_node(pos, {name = name .. "_b", param2 = dir})
315 minetest.set_node(above, {name = "doors:hidden", param2 = (dir + 3) % 4})
317 minetest.set_node(pos, {name = name .. "_a", param2 = dir})
318 minetest.set_node(above, {name = "doors:hidden", param2 = dir})
321 local meta = minetest.get_meta(pos)
322 meta:set_int("state", state)
324 if def.protected then
325 meta:set_string("doors_owner", pn)
326 meta:set_string("infotext", "Owned by " .. pn)
329 if not minetest.setting_getbool("creative_mode") then
330 itemstack:take_item()
333 on_place_node(pos, minetest.get_node(pos),
334 placer, node, itemstack, pointed_thing)
339 def.inventory_image = nil
342 minetest.register_craft({
349 if not def.sounds then
350 def.sounds = default.node_sound_wood_defaults()
353 if not def.sound_open then
354 def.sound_open = "doors_door_open"
357 if not def.sound_close then
358 def.sound_close = "doors_door_close"
361 def.groups.not_in_creative_inventory = 1
366 sounds = { def.sound_close, def.sound_open },
369 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
370 _doors.door_toggle(pos, node, clicker)
373 def.after_dig_node = function(pos, node, meta, digger)
374 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
375 nodeupdate({x = pos.x, y = pos.y + 1, z = pos.z})
377 def.on_rotate = screwdriver and screwdriver.rotate_simple or false
379 if def.protected then
380 def.can_dig = can_dig_door
381 def.on_blast = function() end
383 def.on_blast = function(pos, intensity)
384 minetest.remove_node(pos)
385 -- hidden node doesn't get blasted away.
386 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
391 def.on_destruct = function(pos)
392 minetest.remove_node({x = pos.x, y = pos.y + 1, z = pos.z})
395 def.drawtype = "mesh"
396 def.paramtype = "light"
397 def.paramtype2 = "facedir"
398 def.sunlight_propagates = true
400 def.is_ground_content = false
401 def.buildable_to = false
402 def.selection_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
403 def.collision_box = {type = "fixed", fixed = {-1/2,-1/2,-1/2,1/2,3/2,-6/16}}
405 def.mesh = "door_a.obj"
406 minetest.register_node(":" .. name .. "_a", def)
408 def.mesh = "door_b.obj"
409 minetest.register_node(":" .. name .. "_b", def)
411 _doors.registered_doors[name .. "_a"] = true
412 _doors.registered_doors[name .. "_b"] = true
415 doors.register("door_wood", {
416 tiles = {{ name = "doors_door_wood.png", backface_culling = true }},
417 description = "Wooden Door",
418 inventory_image = "doors_item_wood.png",
419 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2},
421 {"group:wood", "group:wood"},
422 {"group:wood", "group:wood"},
423 {"group:wood", "group:wood"},
427 doors.register("door_steel", {
428 tiles = {{name = "doors_door_steel.png", backface_culling = true}},
429 description = "Steel Door",
430 inventory_image = "doors_item_steel.png",
432 groups = {cracky = 1, level = 2},
433 sounds = default.node_sound_stone_defaults(),
434 sound_open = "doors_steel_door_open",
435 sound_close = "doors_steel_door_close",
437 {"default:steel_ingot", "default:steel_ingot"},
438 {"default:steel_ingot", "default:steel_ingot"},
439 {"default:steel_ingot", "default:steel_ingot"},
443 doors.register("door_glass", {
444 tiles = {"doors_door_glass.png"},
445 description = "Glass Door",
446 inventory_image = "doors_item_glass.png",
447 groups = {cracky=3, oddly_breakable_by_hand=3},
448 sounds = default.node_sound_glass_defaults(),
449 sound_open = "doors_glass_door_open",
450 sound_close = "doors_glass_door_close",
452 {"default:glass", "default:glass"},
453 {"default:glass", "default:glass"},
454 {"default:glass", "default:glass"},
458 doors.register("door_obsidian_glass", {
459 tiles = {"doors_door_obsidian_glass.png"},
460 description = "Obsidian Glass Door",
461 inventory_image = "doors_item_obsidian_glass.png",
463 sounds = default.node_sound_glass_defaults(),
464 sound_open = "doors_glass_door_open",
465 sound_close = "doors_glass_door_close",
467 {"default:obsidian_glass", "default:obsidian_glass"},
468 {"default:obsidian_glass", "default:obsidian_glass"},
469 {"default:obsidian_glass", "default:obsidian_glass"},
473 -- Capture mods using the old API as best as possible.
474 function doors.register_door(name, def)
475 if def.only_placer_can_open then
478 def.only_placer_can_open = nil
480 local i = name:find(":")
481 local modname = name:sub(1, i - 1)
482 if not def.tiles then
483 if def.protected then
484 def.tiles = {{name = "doors_door_steel.png", backface_culling = true}}
486 def.tiles = {{name = "doors_door_wood.png", backface_culling = true}}
488 minetest.log("warning", modname .. " registered door \"" .. name .. "\" " ..
489 "using deprecated API method \"doors.register_door()\" but " ..
490 "did not provide the \"tiles\" parameter. A fallback tiledef " ..
491 "will be used instead.")
494 doors.register(name, def)
499 function _doors.trapdoor_toggle(pos, node, clicker)
500 node = node or minetest.get_node(pos)
501 if clicker and not minetest.check_player_privs(clicker, "protection_bypass") then
502 local meta = minetest.get_meta(pos)
503 local owner = meta:get_string("doors_owner")
505 if clicker:get_player_name() ~= owner then
511 local def = minetest.registered_nodes[node.name]
513 if string.sub(node.name, -5) == "_open" then
514 minetest.sound_play(def.sound_close,
515 {pos = pos, gain = 0.3, max_hear_distance = 10})
516 minetest.swap_node(pos, {name = string.sub(node.name, 1,
517 string.len(node.name) - 5), param1 = node.param1, param2 = node.param2})
519 minetest.sound_play(def.sound_open,
520 {pos = pos, gain = 0.3, max_hear_distance = 10})
521 minetest.swap_node(pos, {name = node.name .. "_open",
522 param1 = node.param1, param2 = node.param2})
526 function doors.register_trapdoor(name, def)
527 if not name:find(":") then
528 name = "doors:" .. name
531 local name_closed = name
532 local name_opened = name.."_open"
534 def.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
535 _doors.trapdoor_toggle(pos, node, clicker)
539 -- Common trapdoor configuration
540 def.drawtype = "nodebox"
541 def.paramtype = "light"
542 def.paramtype2 = "facedir"
543 def.is_ground_content = false
545 if def.protected then
546 def.can_dig = can_dig_door
547 def.after_place_node = function(pos, placer, itemstack, pointed_thing)
548 local pn = placer:get_player_name()
549 local meta = minetest.get_meta(pos)
550 meta:set_string("doors_owner", pn)
551 meta:set_string("infotext", "Owned by "..pn)
553 return minetest.setting_getbool("creative_mode")
556 def.on_blast = function() end
558 def.on_blast = function(pos, intensity)
559 minetest.remove_node(pos)
564 if not def.sounds then
565 def.sounds = default.node_sound_wood_defaults()
568 if not def.sound_open then
569 def.sound_open = "doors_door_open"
572 if not def.sound_close then
573 def.sound_close = "doors_door_close"
576 local def_opened = table.copy(def)
577 local def_closed = table.copy(def)
579 def_closed.node_box = {
581 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
583 def_closed.selection_box = {
585 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
587 def_closed.tiles = {def.tile_front,
588 def.tile_front .. '^[transformFY',
589 def.tile_side, def.tile_side,
590 def.tile_side, def.tile_side}
592 def_opened.node_box = {
594 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
596 def_opened.selection_box = {
598 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
600 def_opened.tiles = {def.tile_side, def.tile_side,
601 def.tile_side .. '^[transform3',
602 def.tile_side .. '^[transform1',
603 def.tile_front .. '^[transform46',
604 def.tile_front .. '^[transform6'}
606 def_opened.drop = name_closed
607 def_opened.groups.not_in_creative_inventory = 1
609 minetest.register_node(name_opened, def_opened)
610 minetest.register_node(name_closed, def_closed)
612 _doors.registered_trapdoors[name_opened] = true
613 _doors.registered_trapdoors[name_closed] = true
616 doors.register_trapdoor("doors:trapdoor", {
617 description = "Trapdoor",
618 inventory_image = "doors_trapdoor.png",
619 wield_image = "doors_trapdoor.png",
620 tile_front = "doors_trapdoor.png",
621 tile_side = "doors_trapdoor_side.png",
622 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2, door = 1},
625 doors.register_trapdoor("doors:trapdoor_steel", {
626 description = "Steel Trapdoor",
627 inventory_image = "doors_trapdoor_steel.png",
628 wield_image = "doors_trapdoor_steel.png",
629 tile_front = "doors_trapdoor_steel.png",
630 tile_side = "doors_trapdoor_steel_side.png",
632 sounds = default.node_sound_stone_defaults(),
633 sound_open = "doors_steel_door_open",
634 sound_close = "doors_steel_door_close",
635 groups = {cracky = 1, level = 2, door = 1},
638 minetest.register_craft({
639 output = 'doors:trapdoor 2',
641 {'group:wood', 'group:wood', 'group:wood'},
642 {'group:wood', 'group:wood', 'group:wood'},
647 minetest.register_craft({
648 output = 'doors:trapdoor_steel',
650 {'default:steel_ingot', 'default:steel_ingot'},
651 {'default:steel_ingot', 'default:steel_ingot'},
658 function doors.register_fencegate(name, def)
660 description = def.description,
662 tiles = {def.texture},
664 paramtype2 = "facedir",
665 sunlight_propagates = true,
666 is_ground_content = false,
667 drop = name .. "_closed",
668 connect_sides = {"left", "right"},
671 on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
672 local node_def = minetest.registered_nodes[node.name]
673 minetest.swap_node(pos, {name = node_def.gate, param2 = node.param2})
674 minetest.sound_play(node_def.sound, {pos = pos, gain = 0.3,
675 max_hear_distance = 8})
680 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
684 if not fence.sounds then
685 fence.sounds = default.node_sound_wood_defaults()
688 fence.groups.fence = 1
690 local fence_closed = table.copy(fence)
691 fence_closed.mesh = "doors_fencegate_closed.obj"
692 fence_closed.gate = name .. "_open"
693 fence_closed.sound = "doors_fencegate_open"
694 fence_closed.collision_box = {
696 fixed = {-1/2, -1/2, -1/4, 1/2, 1/2, 1/4},
699 local fence_open = table.copy(fence)
700 fence_open.mesh = "doors_fencegate_open.obj"
701 fence_open.gate = name .. "_closed"
702 fence_open.sound = "doors_fencegate_close"
703 fence_open.groups.not_in_creative_inventory = 1
704 fence_open.collision_box = {
706 fixed = {{-1/2, -1/2, -1/4, -3/8, 1/2, 1/4},
707 {-5/8, -3/8, -1/2, -3/8, 3/8, 0}},
710 minetest.register_node(":" .. name .. "_closed", fence_closed)
711 minetest.register_node(":" .. name .. "_open", fence_open)
713 minetest.register_craft({
714 output = name .. "_closed",
716 {"default:stick", def.material, "default:stick"},
717 {"default:stick", def.material, "default:stick"}
722 doors.register_fencegate("doors:gate_wood", {
723 description = "Wooden Fence Gate",
724 texture = "default_wood.png",
725 material = "default:wood",
726 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
729 doors.register_fencegate("doors:gate_acacia_wood", {
730 description = "Acacia Fence Gate",
731 texture = "default_acacia_wood.png",
732 material = "default:acacia_wood",
733 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
736 doors.register_fencegate("doors:gate_junglewood", {
737 description = "Junglewood Fence Gate",
738 texture = "default_junglewood.png",
739 material = "default:junglewood",
740 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
743 doors.register_fencegate("doors:gate_pine_wood", {
744 description = "Pine Fence Gate",
745 texture = "default_pine_wood.png",
746 material = "default:pine_wood",
747 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}
750 doors.register_fencegate("doors:gate_aspen_wood", {
751 description = "Aspen Fence Gate",
752 texture = "default_aspen_wood.png",
753 material = "default:aspen_wood",
754 groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}