e96a7f536bab635cb0928aee0b292a18ad65c28e
[oweals/minetest_game.git] / mods / doors / init.lua
1
2 --[[
3
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>
7
8 --]]
9
10 -- our API object
11 doors = {}
12
13 -- private data
14 local _doors = {}
15 _doors.registered_doors = {}
16 _doors.registered_trapdoors = {}
17
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
22                 return {
23                         pos = pos,
24                         open = function(self, player)
25                                 if self:state() then
26                                         return false
27                                 end
28                                 return _doors.door_toggle(self.pos, player)
29                         end,
30                         close = function(self, player)
31                                 if not self:state() then
32                                         return false
33                                 end
34                                 return _doors.door_toggle(self.pos, player)
35                         end,
36                         toggle = function(self, player)
37                                 return _doors.door_toggle(self.pos, player)
38                         end,
39                         state = function(self)
40                                 local state = minetest.get_meta(self.pos):get_int("state")
41                                 return state %2 == 1
42                         end
43                 }
44         elseif _doors.registered_trapdoors[minetest.get_node(pos).name] then
45                 -- A trapdoor
46                 return {
47                         pos = pos,
48                         open = function(self, player)
49                                 if self:state() then
50                                         return false
51                                 end
52                                 return _doors.trapdoor_toggle(self.pos, player)
53                         end,
54                         close = function(self, player)
55                                 if not self:state() then
56                                         return false
57                                 end
58                                 return _doors.trapdoor_toggle(self.pos, player)
59                         end,
60                         toggle = function(self, player)
61                                 return _doors.trapdoor_toggle(self.pos, player)
62                         end,
63                         state = function(self)
64                                 local name = minetest.get_node(pos).name
65                                 return name:sub(-5) == "_open"
66                         end
67                 }
68         else
69                 return nil
70         end
71 end
72
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         drawtype = "airlike",
78         paramtype = "light",
79         sunlight_propagates = true,
80         walkable = false,
81         pointable = false,
82         diggable = false,
83         buildable_to = false,
84         floodable = false,
85         drop = "",
86         groups = { not_in_creative_inventory = 1 },
87         on_blast = function() end
88 })
89
90 -- table used to aid door opening/closing
91 local transform = {
92         {
93                 { v = "_a", param2 = 3 },
94                 { v = "_a", param2 = 0 },
95                 { v = "_a", param2 = 1 },
96                 { v = "_a", param2 = 2 },
97         },
98         {
99                 { v = "_b", param2 = 1 },
100                 { v = "_b", param2 = 2 },
101                 { v = "_b", param2 = 3 },
102                 { v = "_b", param2 = 0 },
103         },
104         {
105                 { v = "_b", param2 = 1 },
106                 { v = "_b", param2 = 2 },
107                 { v = "_b", param2 = 3 },
108                 { v = "_b", param2 = 0 },
109         },
110         {
111                 { v = "_a", param2 = 3 },
112                 { v = "_a", param2 = 0 },
113                 { v = "_a", param2 = 1 },
114                 { v = "_a", param2 = 2 },
115         },
116 }
117
118 function _doors.door_toggle(pos, clicker)
119         local meta = minetest.get_meta(pos)
120         local state = meta:get_int("state")
121         local def = minetest.registered_nodes[minetest.get_node(pos).name]
122         local name = def.door.basename
123
124         if clicker then
125                 local owner = meta:get_string("doors_owner")
126                 if owner ~= "" then
127                         if clicker:get_player_name() ~= owner then
128                                 return false
129                         end
130                 end
131         end
132
133         local old = state
134         -- until Lua-5.2 we have no bitwise operators :(
135         if state % 2 == 1 then
136                 state = state - 1
137         else
138                 state = state + 1
139         end
140
141         local dir = minetest.get_node(pos).param2
142         if state % 2 == 0 then
143                 minetest.sound_play(def.door.sounds[1], {pos = pos, gain = 0.3, max_hear_distance = 10})
144         else
145                 minetest.sound_play(def.door.sounds[2], {pos = pos, gain = 0.3, max_hear_distance = 10})
146         end
147
148         minetest.swap_node(pos, {
149                 name = "doors:" .. name .. transform[state + 1][dir+1].v,
150                 param2 = transform[state + 1][dir+1].param2
151         })
152         meta:set_int("state", state)
153
154         return true
155 end
156
157 function doors.register(name, def)
158         -- replace old doors of this type automatically
159         minetest.register_abm({
160                 nodenames = {"doors:"..name.."_b_1", "doors:"..name.."_b_2"},
161                 interval = 7.0,
162                 chance = 1,
163                 action = function(pos, node, active_object_count, active_object_count_wider)
164                         local l = tonumber(node.name:sub(-1))
165                         local meta = minetest.get_meta(pos)
166                         local h = meta:get_int("right") + 1
167                         local p2 = node.param2
168                         local replace = {
169                                 { { type = "a", state = 0 }, { type = "a", state = 3 } },
170                                 { { type = "b", state = 1 }, { type = "b", state = 2 } }
171                         }
172                         local new = replace[l][h]
173                         -- retain infotext and doors_owner fields
174                         minetest.swap_node(pos, { name = "doors:" .. name .. "_" .. new.type, param2 = p2})
175                         meta:set_int("state", new.state)
176                         -- wipe meta on top node as it's unused
177                         minetest.set_node({x = pos.x, y = pos.y + 1, z = pos.z}, { name = "doors:hidden" })
178                 end
179         })
180
181         minetest.register_craftitem(":doors:" .. name, {
182                 description = def.description,
183                 inventory_image = def.inventory_image,
184
185                 on_place = function(itemstack, placer, pointed_thing)
186                         local pos = pointed_thing.above
187                         local node = minetest.get_node(pos)
188
189                         if not minetest.registered_nodes[node.name].buildable_to then
190                                 return itemstack
191                         end
192
193                         local above = { x = pos.x, y = pos.y + 1, z = pos.z }
194                         if not minetest.registered_nodes[minetest.get_node(above).name].buildable_to then
195                                 return itemstack
196                         end
197
198                         local dir = minetest.dir_to_facedir(placer:get_look_dir())
199
200                         local ref = {
201                                 { x = -1, y = 0, z = 0 },
202                                 { x = 0, y = 0, z = 1 },
203                                 { x = 1, y = 0, z = 0 },
204                                 { x = 0, y = 0, z = -1 },
205                         }
206
207                         local aside = {
208                                 x = pos.x + ref[dir + 1].x,
209                                 y = pos.y + ref[dir + 1].y,
210                                 z = pos.z + ref[dir + 1].z,
211                         }
212
213                         local state = 0
214                         if minetest.get_item_group(minetest.get_node(aside).name, "door") == 1 then
215                                 state = state + 2
216                                 minetest.set_node(pos, {name = "doors:" .. name .. "_b", param2 = dir})
217                         else
218                                 minetest.set_node(pos, {name = "doors:" .. name .. "_a", param2 = dir})
219                         end
220                         minetest.set_node(above, { name = "doors:hidden" })
221
222                         local meta = minetest.get_meta(pos)
223                         meta:set_int("state", state)
224
225                         if def.protected then
226                                 local pn = placer:get_player_name()
227                                 meta:set_string("doors_owner", pn)
228                                 meta:set_string("infotext", "Owned by " .. pn)
229                         end
230
231                         if not minetest.setting_getbool("creative_mode") then
232                                 itemstack:take_item()
233                         end
234
235                         return itemstack
236                 end
237         })
238
239         local can_dig = function(pos, digger)
240                 if not def.protected then
241                         return true
242                 end
243                 local meta = minetest.get_meta(pos)
244                 return meta:get_string("doors_owner") == digger:get_player_name()
245         end
246
247         if not def.sounds then
248                 def.sounds = default.node_sound_wood_defaults()
249         end
250
251         if not def.sound_open then
252                 def.sound_open = "doors_door_open"
253         end
254
255         if not def.sound_close then
256                 def.sound_close = "doors_door_close"
257         end
258
259         def.groups.not_in_creative_inventory = 1
260         def.groups.door = 1
261         def.drop = "doors:" .. name
262         def.door = {
263                 basename = name,
264                 sounds = { def.sound_close, def.sound_open },
265         }
266
267         def.on_rightclick = function(pos, node, clicker)
268                 _doors.door_toggle(pos, clicker)
269         end
270         def.after_dig_node = function(pos, node, meta, digger)
271                 minetest.remove_node({ x = pos.x, y = pos.y + 1, z = pos.z})
272         end
273         def.can_dig = function(pos, player)
274                 return can_dig(pos, player)
275         end
276         def.on_rotate = function(pos, node, user, mode, new_param2)
277                 return false
278         end
279
280         if def.protected then
281                 def.on_blast = function() end
282         else
283                 def.on_blast = function(pos, intensity)
284                         minetest.remove_node(pos)
285                         -- hidden node doesn't get blasted away.
286                         minetest.remove_node({ x = pos.x, y = pos.y + 1, z = pos.z})
287                         return { "doors:" .. name }
288                 end
289         end
290
291         minetest.register_node(":doors:" .. name .. "_a", {
292                 description = def.description,
293                 visual = "mesh",
294                 mesh = "door_a.obj",
295                 tiles = def.tiles,
296                 drawtype = "mesh",
297                 paramtype = "light",
298                 paramtype2 = "facedir",
299                 sunlight_propagates = true,
300                 use_texture_alpha = true,
301                 walkable = true,
302                 is_ground_content = false,
303                 buildable_to = false,
304                 drop = def.drop,
305                 groups = def.groups,
306                 sounds = def.sounds,
307                 door = def.door,
308                 on_rightclick = def.on_rightclick,
309                 after_dig_node = def.after_dig_node,
310                 can_dig = def.can_dig,
311                 on_rotate = def.on_rotate,
312                 on_blast = def.on_blast,
313                 selection_box = {
314                         type = "fixed",
315                         fixed = { -1/2,-1/2,-1/2,1/2,3/2,-6/16}
316                 },
317                 collision_box = {
318                         type = "fixed",
319                         fixed = { -1/2,-1/2,-1/2,1/2,3/2,-6/16}
320                 },
321         })
322
323         minetest.register_node(":doors:" .. name .. "_b", {
324                 description = def.description,
325                 visual = "mesh",
326                 mesh = "door_b.obj",
327                 tiles = def.tiles,
328                 drawtype = "mesh",
329                 paramtype = "light",
330                 paramtype2 = "facedir",
331                 sunlight_propagates = true,
332                 use_texture_alpha = true,
333                 walkable = true,
334                 is_ground_content = false,
335                 buildable_to = false,
336                 drop = def.drop,
337                 groups = def.groups,
338                 sounds = def.sounds,
339                 door = def.door,
340                 on_rightclick = def.on_rightclick,
341                 after_dig_node = def.after_dig_node,
342                 can_dig = def.can_dig,
343                 on_rotate = def.on_rotate,
344                 on_blast = def.on_blast,
345                 selection_box = {
346                         type = "fixed",
347                         fixed = { -1/2,-1/2,-1/2,1/2,3/2,-6/16}
348                 },
349                 collision_box = {
350                         type = "fixed",
351                         fixed = { -1/2,-1/2,-1/2,1/2,3/2,-6/16}
352                 },
353         })
354
355         minetest.register_craft({
356                 output = "doors:" .. name,
357                 recipe = {
358                         {def.material,def.material};
359                         {def.material,def.material};
360                         {def.material,def.material};
361                 }
362         })
363
364         _doors.registered_doors["doors:" .. name .. "_a"] = true
365         _doors.registered_doors["doors:" .. name .. "_b"] = true
366 end
367
368 doors.register("door_wood", {
369                 tiles = {{ name = "doors_door_wood.png", backface_culling = true }},
370                 description = "Wooden Door",
371                 inventory_image = "doors_item_wood.png",
372                 groups = { snappy = 1, choppy = 2, oddly_breakable_by_hand = 2, flammable = 2 },
373                 material = "group:wood",
374 })
375
376 doors.register("door_steel", {
377                 tiles = {{ name = "doors_door_steel.png", backface_culling = true }},
378                 description = "Steel Door",
379                 inventory_image = "doors_item_steel.png",
380                 protected = true,
381                 groups = { snappy = 1, bendy = 2, cracky = 1, melty = 2, level = 2 },
382                 material = "default:steel_ingot",
383 })
384
385 doors.register("door_glass", {
386                 tiles = { "doors_door_glass.png"},
387                 description = "Glass Door",
388                 inventory_image = "doors_item_glass.png",
389                 groups = { snappy=1, cracky=1, oddly_breakable_by_hand=3 },
390                 material = "default:glass",
391                 sounds = default.node_sound_glass_defaults(),
392 })
393
394 doors.register("door_obsidian_glass", {
395                 tiles = { "doors_door_obsidian_glass.png" },
396                 description = "Glass Door",
397                 inventory_image = "doors_item_obsidian_glass.png",
398                 groups = { snappy=1, cracky=1, oddly_breakable_by_hand=3 },
399                 material = "default:obsidian_glass",
400                 sounds = default.node_sound_glass_defaults(),
401 })
402
403 ----trapdoor----
404
405 function _doors.trapdoor_toggle(pos, clicker)
406         if clicker then
407                 local meta = minetest.get_meta(pos)
408                 local owner = meta:get_string("doors_owner")
409                 if owner ~= "" then
410                         if clicker:get_player_name() ~= owner then
411                                 return false
412                         end
413                 end
414         end
415
416         local node = minetest.get_node(pos)
417         local def = minetest.registered_nodes[node.name]
418
419         if string.sub(node.name, -5) == "_open" then
420                 minetest.sound_play(def.sound_close, {pos = pos, gain = 0.3, max_hear_distance = 10})
421                 minetest.swap_node(pos, {name = string.sub(node.name, 1, string.len(node.name) - 5), param1 = node.param1, param2 = node.param2})
422         else
423                 minetest.sound_play(def.sound_open, {pos = pos, gain = 0.3, max_hear_distance = 10})
424                 minetest.swap_node(pos, {name = node.name .. "_open", param1 = node.param1, param2 = node.param2})
425         end
426 end
427
428 function doors.register_trapdoor(name, def)
429         local name_closed = name
430         local name_opened = name.."_open"
431
432         local function check_player_priv(pos, player)
433                 if not def.protected then
434                         return true
435                 end
436                 local meta = minetest.get_meta(pos)
437                 local pn = player:get_player_name()
438                 return meta:get_string("doors_owner") == pn
439         end
440
441         def.on_rightclick = function(pos, node, clicker)
442                 _doors.trapdoor_toggle(pos, clicker)
443         end
444
445         -- Common trapdoor configuration
446         def.drawtype = "nodebox"
447         def.paramtype = "light"
448         def.paramtype2 = "facedir"
449         def.is_ground_content = false
450         def.can_dig = check_player_priv
451
452         if def.protected then
453                 def.after_place_node = function(pos, placer, itemstack, pointed_thing)
454                         local pn = placer:get_player_name()
455                         local meta = minetest.get_meta(pos)
456                         meta:set_string("doors_owner", pn)
457                         meta:set_string("infotext", "Owned by "..pn)
458
459                         return minetest.setting_getbool("creative_mode")
460                 end
461
462                 def.on_blast = function() end
463         else
464                 def.on_blast = function(pos, intensity)
465                         minetest.remove_node(pos)
466                         minetest.remove_node({ x = pos.x, y = pos.y + 1, z = pos.z})
467                         return { name }
468                 end
469         end
470
471         if not def.sounds then
472                 def.sounds = default.node_sound_wood_defaults()
473         end
474
475         if not def.sound_open then
476                 def.sound_open = "doors_door_open"
477         end
478
479         if not def.sound_close then
480                 def.sound_close = "doors_door_close"
481         end
482
483         local def_opened = table.copy(def)
484         local def_closed = table.copy(def)
485
486         def_closed.node_box = {
487                 type = "fixed",
488                 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
489         }
490         def_closed.selection_box = {
491                 type = "fixed",
492                 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
493         }
494         def_closed.tiles = { def.tile_front, def.tile_front, def.tile_side, def.tile_side,
495                 def.tile_side, def.tile_side }
496
497         def_opened.node_box = {
498                 type = "fixed",
499                 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
500         }
501         def_opened.selection_box = {
502                 type = "fixed",
503                 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
504         }
505         def_opened.tiles = { def.tile_side, def.tile_side,
506                         def.tile_side .. '^[transform3',
507                         def.tile_side .. '^[transform1',
508                         def.tile_front, def.tile_front }
509
510         def_opened.drop = name_closed
511         def_opened.groups.not_in_creative_inventory = 1
512
513         minetest.register_node(name_opened, def_opened)
514         minetest.register_node(name_closed, def_closed)
515
516         _doors.registered_trapdoors[name_opened] = true
517         _doors.registered_trapdoors[name_closed] = true
518 end
519
520 doors.register_trapdoor("doors:trapdoor", {
521         description = "Trapdoor",
522         inventory_image = "doors_trapdoor.png",
523         wield_image = "doors_trapdoor.png",
524         tile_front = "doors_trapdoor.png",
525         tile_side = "doors_trapdoor_side.png",
526         groups = {snappy=1, choppy=2, oddly_breakable_by_hand=2, flammable=2, door=1},
527 })
528
529 doors.register_trapdoor("doors:trapdoor_steel", {
530         description = "Steel Trapdoor",
531         inventory_image = "doors_trapdoor_steel.png",
532         wield_image = "doors_trapdoor_steel.png",
533         tile_front = "doors_trapdoor_steel.png",
534         tile_side = "doors_trapdoor_steel_side.png",
535         protected = true,
536         groups = {snappy=1, bendy=2, cracky=1, melty=2, level=2, door=1},
537 })
538
539 minetest.register_craft({
540         output = 'doors:trapdoor 2',
541         recipe = {
542                 {'group:wood', 'group:wood', 'group:wood'},
543                 {'group:wood', 'group:wood', 'group:wood'},
544                 {'', '', ''},
545         }
546 })
547
548 minetest.register_craft({
549         output = 'doors:trapdoor_steel',
550         recipe = {
551                 {'default:steel_ingot', 'default:steel_ingot'},
552                 {'default:steel_ingot', 'default:steel_ingot'},
553         }
554 })
555