Call on_place_node() callbacks after placing door.
[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
158 local function on_place_node(place_to, newnode, placer, oldnode, itemstack, pointed_thing)
159         -- Run script hook
160         local _, callback
161         for _, callback in ipairs(core.registered_on_placenodes) do
162                 -- Deepcopy pos, node and pointed_thing because callback can modify them
163                 local place_to_copy = {x = place_to.x, y = place_to.y, z = place_to.z}
164                 local newnode_copy = {name = newnode.name, param1 = newnode.param1, param2 = newnode.param2}
165                 local oldnode_copy = {name = oldnode.name, param1 = oldnode.param1, param2 = oldnode.param2}
166                 local pointed_thing_copy = {
167                         type  = pointed_thing.type,
168                         above = vector.new(pointed_thing.above),
169                         under = vector.new(pointed_thing.under),
170                         ref   = pointed_thing.ref,
171                 }
172                 callback(place_to_copy, newnode_copy, placer, oldnode_copy, itemstack, pointed_thing_copy)
173         end
174 end
175
176 function doors.register(name, def)
177         -- replace old doors of this type automatically
178         minetest.register_abm({
179                 nodenames = {"doors:"..name.."_b_1", "doors:"..name.."_b_2"},
180                 interval = 7.0,
181                 chance = 1,
182                 action = function(pos, node, active_object_count, active_object_count_wider)
183                         local l = tonumber(node.name:sub(-1))
184                         local meta = minetest.get_meta(pos)
185                         local h = meta:get_int("right") + 1
186                         local p2 = node.param2
187                         local replace = {
188                                 { { type = "a", state = 0 }, { type = "a", state = 3 } },
189                                 { { type = "b", state = 1 }, { type = "b", state = 2 } }
190                         }
191                         local new = replace[l][h]
192                         -- retain infotext and doors_owner fields
193                         minetest.swap_node(pos, { name = "doors:" .. name .. "_" .. new.type, param2 = p2})
194                         meta:set_int("state", new.state)
195                         -- wipe meta on top node as it's unused
196                         minetest.set_node({x = pos.x, y = pos.y + 1, z = pos.z}, { name = "doors:hidden" })
197                 end
198         })
199
200         minetest.register_craftitem(":doors:" .. name, {
201                 description = def.description,
202                 inventory_image = def.inventory_image,
203
204                 on_place = function(itemstack, placer, pointed_thing)
205                         local pos = nil
206
207                         if not pointed_thing.type == "node" then
208                                 return itemstack
209                         end
210
211                         local node = minetest.get_node(pointed_thing.under)
212                         local def = minetest.registered_nodes[node.name]
213                         if def and def.on_rightclick then
214                                 return def.on_rightclick(pointed_thing.under,
215                                                 node, placer, itemstack)
216                         end
217
218                         if def and def.buildable_to then
219                                 pos = pointed_thing.under
220                         else
221                                 pos = pointed_thing.above
222                                 node = minetest.get_node(pos)
223                                 def = minetest.registered_nodes[node.name]
224                                 if not def or not def.buildable_to then
225                                         return itemstack
226                                 end
227                         end
228
229                         local above = { x = pos.x, y = pos.y + 1, z = pos.z }
230                         if not minetest.registered_nodes[minetest.get_node(above).name].buildable_to then
231                                 return itemstack
232                         end
233
234                         local dir = minetest.dir_to_facedir(placer:get_look_dir())
235
236                         local ref = {
237                                 { x = -1, y = 0, z = 0 },
238                                 { x = 0, y = 0, z = 1 },
239                                 { x = 1, y = 0, z = 0 },
240                                 { x = 0, y = 0, z = -1 },
241                         }
242
243                         local aside = {
244                                 x = pos.x + ref[dir + 1].x,
245                                 y = pos.y + ref[dir + 1].y,
246                                 z = pos.z + ref[dir + 1].z,
247                         }
248
249                         local state = 0
250                         if minetest.get_item_group(minetest.get_node(aside).name, "door") == 1 then
251                                 state = state + 2
252                                 minetest.set_node(pos, {name = "doors:" .. name .. "_b", param2 = dir})
253                         else
254                                 minetest.set_node(pos, {name = "doors:" .. name .. "_a", param2 = dir})
255                         end
256                         minetest.set_node(above, { name = "doors:hidden" })
257
258                         local meta = minetest.get_meta(pos)
259                         meta:set_int("state", state)
260
261                         if def.protected then
262                                 local pn = placer:get_player_name()
263                                 meta:set_string("doors_owner", pn)
264                                 meta:set_string("infotext", "Owned by " .. pn)
265                         end
266
267                         if not minetest.setting_getbool("creative_mode") then
268                                 itemstack:take_item()
269                         end
270
271                         on_place_node(pos, minetest.get_node(pos), placer, node, itemstack, pointed_thing)
272
273                         return itemstack
274                 end
275         })
276
277         local can_dig = function(pos, digger)
278                 if not def.protected then
279                         return true
280                 end
281                 local meta = minetest.get_meta(pos)
282                 return meta:get_string("doors_owner") == digger:get_player_name()
283         end
284
285         if not def.sounds then
286                 def.sounds = default.node_sound_wood_defaults()
287         end
288
289         if not def.sound_open then
290                 def.sound_open = "doors_door_open"
291         end
292
293         if not def.sound_close then
294                 def.sound_close = "doors_door_close"
295         end
296
297         def.groups.not_in_creative_inventory = 1
298         def.groups.door = 1
299         def.drop = "doors:" .. name
300         def.door = {
301                 basename = name,
302                 sounds = { def.sound_close, def.sound_open },
303         }
304
305         def.on_rightclick = function(pos, node, clicker)
306                 _doors.door_toggle(pos, clicker)
307         end
308         def.after_dig_node = function(pos, node, meta, digger)
309                 minetest.remove_node({ x = pos.x, y = pos.y + 1, z = pos.z})
310         end
311         def.can_dig = function(pos, player)
312                 return can_dig(pos, player)
313         end
314         def.on_rotate = function(pos, node, user, mode, new_param2)
315                 return false
316         end
317
318         if def.protected then
319                 def.on_blast = function() end
320         else
321                 def.on_blast = function(pos, intensity)
322                         minetest.remove_node(pos)
323                         -- hidden node doesn't get blasted away.
324                         minetest.remove_node({ x = pos.x, y = pos.y + 1, z = pos.z})
325                         return { "doors:" .. name }
326                 end
327         end
328
329         minetest.register_node(":doors:" .. name .. "_a", {
330                 description = def.description,
331                 visual = "mesh",
332                 mesh = "door_a.obj",
333                 tiles = def.tiles,
334                 drawtype = "mesh",
335                 paramtype = "light",
336                 paramtype2 = "facedir",
337                 sunlight_propagates = true,
338                 use_texture_alpha = true,
339                 walkable = true,
340                 is_ground_content = false,
341                 buildable_to = false,
342                 drop = def.drop,
343                 groups = def.groups,
344                 sounds = def.sounds,
345                 door = def.door,
346                 on_rightclick = def.on_rightclick,
347                 after_dig_node = def.after_dig_node,
348                 can_dig = def.can_dig,
349                 on_rotate = def.on_rotate,
350                 on_blast = def.on_blast,
351                 selection_box = {
352                         type = "fixed",
353                         fixed = { -1/2,-1/2,-1/2,1/2,3/2,-6/16}
354                 },
355                 collision_box = {
356                         type = "fixed",
357                         fixed = { -1/2,-1/2,-1/2,1/2,3/2,-6/16}
358                 },
359         })
360
361         minetest.register_node(":doors:" .. name .. "_b", {
362                 description = def.description,
363                 visual = "mesh",
364                 mesh = "door_b.obj",
365                 tiles = def.tiles,
366                 drawtype = "mesh",
367                 paramtype = "light",
368                 paramtype2 = "facedir",
369                 sunlight_propagates = true,
370                 use_texture_alpha = true,
371                 walkable = true,
372                 is_ground_content = false,
373                 buildable_to = false,
374                 drop = def.drop,
375                 groups = def.groups,
376                 sounds = def.sounds,
377                 door = def.door,
378                 on_rightclick = def.on_rightclick,
379                 after_dig_node = def.after_dig_node,
380                 can_dig = def.can_dig,
381                 on_rotate = def.on_rotate,
382                 on_blast = def.on_blast,
383                 selection_box = {
384                         type = "fixed",
385                         fixed = { -1/2,-1/2,-1/2,1/2,3/2,-6/16}
386                 },
387                 collision_box = {
388                         type = "fixed",
389                         fixed = { -1/2,-1/2,-1/2,1/2,3/2,-6/16}
390                 },
391         })
392
393         if def.recipe then
394                 minetest.register_craft({
395                         output = "doors:" .. name,
396                         recipe = def.recipe,
397                 })
398         end
399
400         _doors.registered_doors["doors:" .. name .. "_a"] = true
401         _doors.registered_doors["doors:" .. name .. "_b"] = true
402 end
403
404 doors.register("door_wood", {
405                 tiles = {{ name = "doors_door_wood.png", backface_culling = true }},
406                 description = "Wooden Door",
407                 inventory_image = "doors_item_wood.png",
408                 groups = { snappy = 1, choppy = 2, oddly_breakable_by_hand = 2, flammable = 2 },
409                 recipe = {
410                         {"group:wood", "group:wood"},
411                         {"group:wood", "group:wood"},
412                         {"group:wood", "group:wood"},
413                 }
414 })
415
416 doors.register("door_steel", {
417                 tiles = {{ name = "doors_door_steel.png", backface_culling = true }},
418                 description = "Steel Door",
419                 inventory_image = "doors_item_steel.png",
420                 protected = true,
421                 groups = { snappy = 1, bendy = 2, cracky = 1, melty = 2, level = 2 },
422                 recipe = {
423                         {"default:steel_ingot", "default:steel_ingot"},
424                         {"default:steel_ingot", "default:steel_ingot"},
425                         {"default:steel_ingot", "default:steel_ingot"},
426                 }
427 })
428
429 doors.register("door_glass", {
430                 tiles = { "doors_door_glass.png"},
431                 description = "Glass Door",
432                 inventory_image = "doors_item_glass.png",
433                 groups = { snappy=1, cracky=1, oddly_breakable_by_hand=3 },
434                 sounds = default.node_sound_glass_defaults(),
435                 recipe = {
436                         {"default:glass", "default:glass"},
437                         {"default:glass", "default:glass"},
438                         {"default:glass", "default:glass"},
439                 }
440 })
441
442 doors.register("door_obsidian_glass", {
443                 tiles = { "doors_door_obsidian_glass.png" },
444                 description = "Glass Door",
445                 inventory_image = "doors_item_obsidian_glass.png",
446                 groups = { snappy=1, cracky=1, oddly_breakable_by_hand=3 },
447                 sounds = default.node_sound_glass_defaults(),
448                 recipe = {
449                         {"default:obsidian_glass", "default:obsidian_glass"},
450                         {"default:obsidian_glass", "default:obsidian_glass"},
451                         {"default:obsidian_glass", "default:obsidian_glass"},
452                 },
453 })
454
455 ----trapdoor----
456
457 function _doors.trapdoor_toggle(pos, clicker)
458         if clicker then
459                 local meta = minetest.get_meta(pos)
460                 local owner = meta:get_string("doors_owner")
461                 if owner ~= "" then
462                         if clicker:get_player_name() ~= owner then
463                                 return false
464                         end
465                 end
466         end
467
468         local node = minetest.get_node(pos)
469         local def = minetest.registered_nodes[node.name]
470
471         if string.sub(node.name, -5) == "_open" then
472                 minetest.sound_play(def.sound_close, {pos = pos, gain = 0.3, max_hear_distance = 10})
473                 minetest.swap_node(pos, {name = string.sub(node.name, 1, string.len(node.name) - 5), param1 = node.param1, param2 = node.param2})
474         else
475                 minetest.sound_play(def.sound_open, {pos = pos, gain = 0.3, max_hear_distance = 10})
476                 minetest.swap_node(pos, {name = node.name .. "_open", param1 = node.param1, param2 = node.param2})
477         end
478 end
479
480 function doors.register_trapdoor(name, def)
481         local name_closed = name
482         local name_opened = name.."_open"
483
484         local function check_player_priv(pos, player)
485                 if not def.protected then
486                         return true
487                 end
488                 local meta = minetest.get_meta(pos)
489                 local pn = player:get_player_name()
490                 return meta:get_string("doors_owner") == pn
491         end
492
493         def.on_rightclick = function(pos, node, clicker)
494                 _doors.trapdoor_toggle(pos, clicker)
495         end
496
497         -- Common trapdoor configuration
498         def.drawtype = "nodebox"
499         def.paramtype = "light"
500         def.paramtype2 = "facedir"
501         def.is_ground_content = false
502         def.can_dig = check_player_priv
503
504         if def.protected then
505                 def.after_place_node = function(pos, placer, itemstack, pointed_thing)
506                         local pn = placer:get_player_name()
507                         local meta = minetest.get_meta(pos)
508                         meta:set_string("doors_owner", pn)
509                         meta:set_string("infotext", "Owned by "..pn)
510
511                         return minetest.setting_getbool("creative_mode")
512                 end
513
514                 def.on_blast = function() end
515         else
516                 def.on_blast = function(pos, intensity)
517                         minetest.remove_node(pos)
518                         minetest.remove_node({ x = pos.x, y = pos.y + 1, z = pos.z})
519                         return { name }
520                 end
521         end
522
523         if not def.sounds then
524                 def.sounds = default.node_sound_wood_defaults()
525         end
526
527         if not def.sound_open then
528                 def.sound_open = "doors_door_open"
529         end
530
531         if not def.sound_close then
532                 def.sound_close = "doors_door_close"
533         end
534
535         local def_opened = table.copy(def)
536         local def_closed = table.copy(def)
537
538         def_closed.node_box = {
539                 type = "fixed",
540                 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
541         }
542         def_closed.selection_box = {
543                 type = "fixed",
544                 fixed = {-0.5, -0.5, -0.5, 0.5, -6/16, 0.5}
545         }
546         def_closed.tiles = { def.tile_front, def.tile_front, def.tile_side, def.tile_side,
547                 def.tile_side, def.tile_side }
548
549         def_opened.node_box = {
550                 type = "fixed",
551                 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
552         }
553         def_opened.selection_box = {
554                 type = "fixed",
555                 fixed = {-0.5, -0.5, 6/16, 0.5, 0.5, 0.5}
556         }
557         def_opened.tiles = { def.tile_side, def.tile_side,
558                         def.tile_side .. '^[transform3',
559                         def.tile_side .. '^[transform1',
560                         def.tile_front, def.tile_front }
561
562         def_opened.drop = name_closed
563         def_opened.groups.not_in_creative_inventory = 1
564
565         minetest.register_node(name_opened, def_opened)
566         minetest.register_node(name_closed, def_closed)
567
568         _doors.registered_trapdoors[name_opened] = true
569         _doors.registered_trapdoors[name_closed] = true
570 end
571
572 doors.register_trapdoor("doors:trapdoor", {
573         description = "Trapdoor",
574         inventory_image = "doors_trapdoor.png",
575         wield_image = "doors_trapdoor.png",
576         tile_front = "doors_trapdoor.png",
577         tile_side = "doors_trapdoor_side.png",
578         groups = {snappy=1, choppy=2, oddly_breakable_by_hand=2, flammable=2, door=1},
579 })
580
581 doors.register_trapdoor("doors:trapdoor_steel", {
582         description = "Steel Trapdoor",
583         inventory_image = "doors_trapdoor_steel.png",
584         wield_image = "doors_trapdoor_steel.png",
585         tile_front = "doors_trapdoor_steel.png",
586         tile_side = "doors_trapdoor_steel_side.png",
587         protected = true,
588         groups = {snappy=1, bendy=2, cracky=1, melty=2, level=2, door=1},
589 })
590
591 minetest.register_craft({
592         output = 'doors:trapdoor 2',
593         recipe = {
594                 {'group:wood', 'group:wood', 'group:wood'},
595                 {'group:wood', 'group:wood', 'group:wood'},
596                 {'', '', ''},
597         }
598 })
599
600 minetest.register_craft({
601         output = 'doors:trapdoor_steel',
602         recipe = {
603                 {'default:steel_ingot', 'default:steel_ingot'},
604                 {'default:steel_ingot', 'default:steel_ingot'},
605         }
606 })
607