]> git.lizzy.rs Git - dragonfireclient.git/blob - src/script/common/c_content.cpp
af54a8b315610a981435b6edee2828a0f4cd127b
[dragonfireclient.git] / src / script / common / c_content.cpp
1 /*
2 Minetest
3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
4
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 GNU Lesser General Public License for more details.
14
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19 #include "common/c_content.h"
20 #include "common/c_converter.h"
21 #include "common/c_types.h"
22 #include "nodedef.h"
23 #include "object_properties.h"
24 #include "cpp_api/s_node.h"
25 #include "lua_api/l_object.h"
26 #include "lua_api/l_item.h"
27 #include "common/c_internal.h"
28 #include "server.h"
29 #include "log.h"
30 #include "tool.h"
31 #include "serverobject.h"
32 #include "porting.h"
33 #include "mapgen/mg_schematic.h"
34 #include "noise.h"
35 #include "util/pointedthing.h"
36 #include "debug.h" // For FATAL_ERROR
37 #include <json/json.h>
38
39 struct EnumString es_TileAnimationType[] =
40 {
41         {TAT_NONE, "none"},
42         {TAT_VERTICAL_FRAMES, "vertical_frames"},
43         {TAT_SHEET_2D, "sheet_2d"},
44         {0, NULL},
45 };
46
47 /******************************************************************************/
48 void read_item_definition(lua_State* L, int index,
49                 const ItemDefinition &default_def, ItemDefinition &def)
50 {
51         if (index < 0)
52                 index = lua_gettop(L) + 1 + index;
53
54         def.type = (ItemType)getenumfield(L, index, "type",
55                         es_ItemType, ITEM_NONE);
56         getstringfield(L, index, "name", def.name);
57         getstringfield(L, index, "description", def.description);
58         getstringfield(L, index, "inventory_image", def.inventory_image);
59         getstringfield(L, index, "inventory_overlay", def.inventory_overlay);
60         getstringfield(L, index, "wield_image", def.wield_image);
61         getstringfield(L, index, "wield_overlay", def.wield_overlay);
62         getstringfield(L, index, "palette", def.palette_image);
63
64         // Read item color.
65         lua_getfield(L, index, "color");
66         read_color(L, -1, &def.color);
67         lua_pop(L, 1);
68
69         lua_getfield(L, index, "wield_scale");
70         if(lua_istable(L, -1)){
71                 def.wield_scale = check_v3f(L, -1);
72         }
73         lua_pop(L, 1);
74
75         int stack_max = getintfield_default(L, index, "stack_max", def.stack_max);
76         def.stack_max = rangelim(stack_max, 1, U16_MAX);
77
78         lua_getfield(L, index, "on_use");
79         def.usable = lua_isfunction(L, -1);
80         lua_pop(L, 1);
81
82         getboolfield(L, index, "liquids_pointable", def.liquids_pointable);
83
84         warn_if_field_exists(L, index, "tool_digging_properties",
85                         "Deprecated; use tool_capabilities");
86
87         lua_getfield(L, index, "tool_capabilities");
88         if(lua_istable(L, -1)){
89                 def.tool_capabilities = new ToolCapabilities(
90                                 read_tool_capabilities(L, -1));
91         }
92
93         // If name is "" (hand), ensure there are ToolCapabilities
94         // because it will be looked up there whenever any other item has
95         // no ToolCapabilities
96         if (def.name.empty() && def.tool_capabilities == NULL){
97                 def.tool_capabilities = new ToolCapabilities();
98         }
99
100         lua_getfield(L, index, "groups");
101         read_groups(L, -1, def.groups);
102         lua_pop(L, 1);
103
104         lua_getfield(L, index, "sounds");
105         if(lua_istable(L, -1)){
106                 lua_getfield(L, -1, "place");
107                 read_soundspec(L, -1, def.sound_place);
108                 lua_pop(L, 1);
109                 lua_getfield(L, -1, "place_failed");
110                 read_soundspec(L, -1, def.sound_place_failed);
111                 lua_pop(L, 1);
112         }
113         lua_pop(L, 1);
114
115         def.range = getfloatfield_default(L, index, "range", def.range);
116
117         // Client shall immediately place this node when player places the item.
118         // Server will update the precise end result a moment later.
119         // "" = no prediction
120         getstringfield(L, index, "node_placement_prediction",
121                         def.node_placement_prediction);
122 }
123
124 /******************************************************************************/
125 void push_item_definition(lua_State *L, const ItemDefinition &i)
126 {
127         lua_newtable(L);
128         lua_pushstring(L, i.name.c_str());
129         lua_setfield(L, -2, "name");
130         lua_pushstring(L, i.description.c_str());
131         lua_setfield(L, -2, "description");
132 }
133
134 void push_item_definition_full(lua_State *L, const ItemDefinition &i)
135 {
136         std::string type(es_ItemType[(int)i.type].str);
137
138         lua_newtable(L);
139         lua_pushstring(L, i.name.c_str());
140         lua_setfield(L, -2, "name");
141         lua_pushstring(L, i.description.c_str());
142         lua_setfield(L, -2, "description");
143         lua_pushstring(L, type.c_str());
144         lua_setfield(L, -2, "type");
145         lua_pushstring(L, i.inventory_image.c_str());
146         lua_setfield(L, -2, "inventory_image");
147         lua_pushstring(L, i.inventory_overlay.c_str());
148         lua_setfield(L, -2, "inventory_overlay");
149         lua_pushstring(L, i.wield_image.c_str());
150         lua_setfield(L, -2, "wield_image");
151         lua_pushstring(L, i.wield_overlay.c_str());
152         lua_setfield(L, -2, "wield_overlay");
153         lua_pushstring(L, i.palette_image.c_str());
154         lua_setfield(L, -2, "palette_image");
155         push_ARGB8(L, i.color);
156         lua_setfield(L, -2, "color");
157         push_v3f(L, i.wield_scale);
158         lua_setfield(L, -2, "wield_scale");
159         lua_pushinteger(L, i.stack_max);
160         lua_setfield(L, -2, "stack_max");
161         lua_pushboolean(L, i.usable);
162         lua_setfield(L, -2, "usable");
163         lua_pushboolean(L, i.liquids_pointable);
164         lua_setfield(L, -2, "liquids_pointable");
165         if (i.type == ITEM_TOOL) {
166                 push_tool_capabilities(L, ToolCapabilities(
167                         i.tool_capabilities->full_punch_interval,
168                         i.tool_capabilities->max_drop_level,
169                         i.tool_capabilities->groupcaps,
170                         i.tool_capabilities->damageGroups));
171                 lua_setfield(L, -2, "tool_capabilities");
172         }
173         push_groups(L, i.groups);
174         lua_setfield(L, -2, "groups");
175         push_soundspec(L, i.sound_place);
176         lua_setfield(L, -2, "sound_place");
177         push_soundspec(L, i.sound_place_failed);
178         lua_setfield(L, -2, "sound_place_failed");
179         lua_pushstring(L, i.node_placement_prediction.c_str());
180         lua_setfield(L, -2, "node_placement_prediction");
181 }
182
183 /******************************************************************************/
184 void read_object_properties(lua_State *L, int index,
185                 ObjectProperties *prop, IItemDefManager *idef)
186 {
187         if(index < 0)
188                 index = lua_gettop(L) + 1 + index;
189         if(!lua_istable(L, index))
190                 return;
191
192         int hp_max = 0;
193         if (getintfield(L, -1, "hp_max", hp_max))
194                 prop->hp_max = (s16)rangelim(hp_max, 0, S16_MAX);
195
196         getintfield(L, -1, "breath_max", prop->breath_max);
197         getboolfield(L, -1, "physical", prop->physical);
198         getboolfield(L, -1, "collide_with_objects", prop->collideWithObjects);
199
200         getfloatfield(L, -1, "weight", prop->weight);
201
202         lua_getfield(L, -1, "collisionbox");
203         bool collisionbox_defined = lua_istable(L, -1);
204         if (collisionbox_defined)
205                 prop->collisionbox = read_aabb3f(L, -1, 1.0);
206         lua_pop(L, 1);
207
208         lua_getfield(L, -1, "selectionbox");
209         if (lua_istable(L, -1))
210                 prop->selectionbox = read_aabb3f(L, -1, 1.0);
211         else if (collisionbox_defined)
212                 prop->selectionbox = prop->collisionbox;
213         lua_pop(L, 1);
214
215         getboolfield(L, -1, "pointable", prop->pointable);
216         getstringfield(L, -1, "visual", prop->visual);
217
218         getstringfield(L, -1, "mesh", prop->mesh);
219
220         lua_getfield(L, -1, "visual_size");
221         if(lua_istable(L, -1))
222                 prop->visual_size = read_v2f(L, -1);
223         lua_pop(L, 1);
224
225         lua_getfield(L, -1, "textures");
226         if(lua_istable(L, -1)){
227                 prop->textures.clear();
228                 int table = lua_gettop(L);
229                 lua_pushnil(L);
230                 while(lua_next(L, table) != 0){
231                         // key at index -2 and value at index -1
232                         if(lua_isstring(L, -1))
233                                 prop->textures.emplace_back(lua_tostring(L, -1));
234                         else
235                                 prop->textures.emplace_back("");
236                         // removes value, keeps key for next iteration
237                         lua_pop(L, 1);
238                 }
239         }
240         lua_pop(L, 1);
241
242         lua_getfield(L, -1, "colors");
243         if (lua_istable(L, -1)) {
244                 int table = lua_gettop(L);
245                 prop->colors.clear();
246                 for (lua_pushnil(L); lua_next(L, table); lua_pop(L, 1)) {
247                         video::SColor color(255, 255, 255, 255);
248                         read_color(L, -1, &color);
249                         prop->colors.push_back(color);
250                 }
251         }
252         lua_pop(L, 1);
253
254         lua_getfield(L, -1, "spritediv");
255         if(lua_istable(L, -1))
256                 prop->spritediv = read_v2s16(L, -1);
257         lua_pop(L, 1);
258
259         lua_getfield(L, -1, "initial_sprite_basepos");
260         if(lua_istable(L, -1))
261                 prop->initial_sprite_basepos = read_v2s16(L, -1);
262         lua_pop(L, 1);
263
264         getboolfield(L, -1, "is_visible", prop->is_visible);
265         getboolfield(L, -1, "makes_footstep_sound", prop->makes_footstep_sound);
266         if (getfloatfield(L, -1, "stepheight", prop->stepheight))
267                 prop->stepheight *= BS;
268         getfloatfield(L, -1, "eye_height", prop->eye_height);
269
270         getfloatfield(L, -1, "automatic_rotate", prop->automatic_rotate);
271         lua_getfield(L, -1, "automatic_face_movement_dir");
272         if (lua_isnumber(L, -1)) {
273                 prop->automatic_face_movement_dir = true;
274                 prop->automatic_face_movement_dir_offset = luaL_checknumber(L, -1);
275         } else if (lua_isboolean(L, -1)) {
276                 prop->automatic_face_movement_dir = lua_toboolean(L, -1);
277                 prop->automatic_face_movement_dir_offset = 0.0;
278         }
279         lua_pop(L, 1);
280         getboolfield(L, -1, "backface_culling", prop->backface_culling);
281         getintfield(L, -1, "glow", prop->glow);
282
283         getstringfield(L, -1, "nametag", prop->nametag);
284         lua_getfield(L, -1, "nametag_color");
285         if (!lua_isnil(L, -1)) {
286                 video::SColor color = prop->nametag_color;
287                 if (read_color(L, -1, &color))
288                         prop->nametag_color = color;
289         }
290         lua_pop(L, 1);
291
292         lua_getfield(L, -1, "automatic_face_movement_max_rotation_per_sec");
293         if (lua_isnumber(L, -1)) {
294                 prop->automatic_face_movement_max_rotation_per_sec = luaL_checknumber(L, -1);
295         }
296         lua_pop(L, 1);
297
298         getstringfield(L, -1, "infotext", prop->infotext);
299         getboolfield(L, -1, "static_save", prop->static_save);
300
301         lua_getfield(L, -1, "wield_item");
302         if (!lua_isnil(L, -1))
303                 prop->wield_item = read_item(L, -1, idef).getItemString();
304         lua_pop(L, 1);
305
306         getfloatfield(L, -1, "zoom_fov", prop->zoom_fov);
307 }
308
309 /******************************************************************************/
310 void push_object_properties(lua_State *L, ObjectProperties *prop)
311 {
312         lua_newtable(L);
313         lua_pushnumber(L, prop->hp_max);
314         lua_setfield(L, -2, "hp_max");
315         lua_pushnumber(L, prop->breath_max);
316         lua_setfield(L, -2, "breath_max");
317         lua_pushboolean(L, prop->physical);
318         lua_setfield(L, -2, "physical");
319         lua_pushboolean(L, prop->collideWithObjects);
320         lua_setfield(L, -2, "collide_with_objects");
321         lua_pushnumber(L, prop->weight);
322         lua_setfield(L, -2, "weight");
323         push_aabb3f(L, prop->collisionbox);
324         lua_setfield(L, -2, "collisionbox");
325         push_aabb3f(L, prop->selectionbox);
326         lua_setfield(L, -2, "selectionbox");
327         lua_pushboolean(L, prop->pointable);
328         lua_setfield(L, -2, "pointable");
329         lua_pushlstring(L, prop->visual.c_str(), prop->visual.size());
330         lua_setfield(L, -2, "visual");
331         lua_pushlstring(L, prop->mesh.c_str(), prop->mesh.size());
332         lua_setfield(L, -2, "mesh");
333         push_v2f(L, prop->visual_size);
334         lua_setfield(L, -2, "visual_size");
335
336         lua_newtable(L);
337         u16 i = 1;
338         for (const std::string &texture : prop->textures) {
339                 lua_pushlstring(L, texture.c_str(), texture.size());
340                 lua_rawseti(L, -2, i);
341         }
342         lua_setfield(L, -2, "textures");
343
344         lua_newtable(L);
345         i = 1;
346         for (const video::SColor &color : prop->colors) {
347                 push_ARGB8(L, color);
348                 lua_rawseti(L, -2, i);
349         }
350         lua_setfield(L, -2, "colors");
351
352         push_v2s16(L, prop->spritediv);
353         lua_setfield(L, -2, "spritediv");
354         push_v2s16(L, prop->initial_sprite_basepos);
355         lua_setfield(L, -2, "initial_sprite_basepos");
356         lua_pushboolean(L, prop->is_visible);
357         lua_setfield(L, -2, "is_visible");
358         lua_pushboolean(L, prop->makes_footstep_sound);
359         lua_setfield(L, -2, "makes_footstep_sound");
360         lua_pushnumber(L, prop->stepheight / BS);
361         lua_setfield(L, -2, "stepheight");
362         lua_pushnumber(L, prop->eye_height);
363         lua_setfield(L, -2, "eye_height");
364         lua_pushnumber(L, prop->automatic_rotate);
365         lua_setfield(L, -2, "automatic_rotate");
366         if (prop->automatic_face_movement_dir)
367                 lua_pushnumber(L, prop->automatic_face_movement_dir_offset);
368         else
369                 lua_pushboolean(L, false);
370         lua_setfield(L, -2, "automatic_face_movement_dir");
371         lua_pushboolean(L, prop->backface_culling);
372         lua_setfield(L, -2, "backface_culling");
373         lua_pushnumber(L, prop->glow);
374         lua_setfield(L, -2, "glow");
375         lua_pushlstring(L, prop->nametag.c_str(), prop->nametag.size());
376         lua_setfield(L, -2, "nametag");
377         push_ARGB8(L, prop->nametag_color);
378         lua_setfield(L, -2, "nametag_color");
379         lua_pushnumber(L, prop->automatic_face_movement_max_rotation_per_sec);
380         lua_setfield(L, -2, "automatic_face_movement_max_rotation_per_sec");
381         lua_pushlstring(L, prop->infotext.c_str(), prop->infotext.size());
382         lua_setfield(L, -2, "infotext");
383         lua_pushboolean(L, prop->static_save);
384         lua_setfield(L, -2, "static_save");
385         lua_pushlstring(L, prop->wield_item.c_str(), prop->wield_item.size());
386         lua_setfield(L, -2, "wield_item");
387         lua_pushnumber(L, prop->zoom_fov);
388         lua_setfield(L, -2, "zoom_fov");
389 }
390
391 /******************************************************************************/
392 TileDef read_tiledef(lua_State *L, int index, u8 drawtype)
393 {
394         if(index < 0)
395                 index = lua_gettop(L) + 1 + index;
396
397         TileDef tiledef;
398
399         bool default_tiling = true;
400         bool default_culling = true;
401         switch (drawtype) {
402                 case NDT_PLANTLIKE:
403                 case NDT_PLANTLIKE_ROOTED:
404                 case NDT_FIRELIKE:
405                         default_tiling = false;
406                         // "break" is omitted here intentionaly, as PLANTLIKE
407                         // FIRELIKE drawtype both should default to having
408                         // backface_culling to false.
409                 case NDT_MESH:
410                 case NDT_LIQUID:
411                         default_culling = false;
412                         break;
413                 default:
414                         break;
415         }
416
417         // key at index -2 and value at index
418         if(lua_isstring(L, index)){
419                 // "default_lava.png"
420                 tiledef.name = lua_tostring(L, index);
421                 tiledef.tileable_vertical = default_tiling;
422                 tiledef.tileable_horizontal = default_tiling;
423                 tiledef.backface_culling = default_culling;
424         }
425         else if(lua_istable(L, index))
426         {
427                 // name="default_lava.png"
428                 tiledef.name = "";
429                 getstringfield(L, index, "name", tiledef.name);
430                 getstringfield(L, index, "image", tiledef.name); // MaterialSpec compat.
431                 tiledef.backface_culling = getboolfield_default(
432                         L, index, "backface_culling", default_culling);
433                 tiledef.tileable_horizontal = getboolfield_default(
434                         L, index, "tileable_horizontal", default_tiling);
435                 tiledef.tileable_vertical = getboolfield_default(
436                         L, index, "tileable_vertical", default_tiling);
437                 std::string align_style;
438                 if (getstringfield(L, index, "align_style", align_style)) {
439                         if (align_style == "user")
440                                 tiledef.align_style = ALIGN_STYLE_USER_DEFINED;
441                         else if (align_style == "world")
442                                 tiledef.align_style = ALIGN_STYLE_WORLD;
443                         else
444                                 tiledef.align_style = ALIGN_STYLE_NODE;
445                 }
446                 tiledef.scale = getintfield_default(L, index, "scale", 0);
447                 // color = ...
448                 lua_getfield(L, index, "color");
449                 tiledef.has_color = read_color(L, -1, &tiledef.color);
450                 lua_pop(L, 1);
451                 // animation = {}
452                 lua_getfield(L, index, "animation");
453                 tiledef.animation = read_animation_definition(L, -1);
454                 lua_pop(L, 1);
455         }
456
457         return tiledef;
458 }
459
460 /******************************************************************************/
461 ContentFeatures read_content_features(lua_State *L, int index)
462 {
463         if(index < 0)
464                 index = lua_gettop(L) + 1 + index;
465
466         ContentFeatures f;
467
468         /* Cache existence of some callbacks */
469         lua_getfield(L, index, "on_construct");
470         if(!lua_isnil(L, -1)) f.has_on_construct = true;
471         lua_pop(L, 1);
472         lua_getfield(L, index, "on_destruct");
473         if(!lua_isnil(L, -1)) f.has_on_destruct = true;
474         lua_pop(L, 1);
475         lua_getfield(L, index, "after_destruct");
476         if(!lua_isnil(L, -1)) f.has_after_destruct = true;
477         lua_pop(L, 1);
478
479         lua_getfield(L, index, "on_rightclick");
480         f.rightclickable = lua_isfunction(L, -1);
481         lua_pop(L, 1);
482
483         /* Name */
484         getstringfield(L, index, "name", f.name);
485
486         /* Groups */
487         lua_getfield(L, index, "groups");
488         read_groups(L, -1, f.groups);
489         lua_pop(L, 1);
490
491         /* Visual definition */
492
493         f.drawtype = (NodeDrawType)getenumfield(L, index, "drawtype",
494                         ScriptApiNode::es_DrawType,NDT_NORMAL);
495         getfloatfield(L, index, "visual_scale", f.visual_scale);
496
497         /* Meshnode model filename */
498         getstringfield(L, index, "mesh", f.mesh);
499
500         // tiles = {}
501         lua_getfield(L, index, "tiles");
502         // If nil, try the deprecated name "tile_images" instead
503         if(lua_isnil(L, -1)){
504                 lua_pop(L, 1);
505                 warn_if_field_exists(L, index, "tile_images",
506                                 "Deprecated; new name is \"tiles\".");
507                 lua_getfield(L, index, "tile_images");
508         }
509         if(lua_istable(L, -1)){
510                 int table = lua_gettop(L);
511                 lua_pushnil(L);
512                 int i = 0;
513                 while(lua_next(L, table) != 0){
514                         // Read tiledef from value
515                         f.tiledef[i] = read_tiledef(L, -1, f.drawtype);
516                         // removes value, keeps key for next iteration
517                         lua_pop(L, 1);
518                         i++;
519                         if(i==6){
520                                 lua_pop(L, 1);
521                                 break;
522                         }
523                 }
524                 // Copy last value to all remaining textures
525                 if(i >= 1){
526                         TileDef lasttile = f.tiledef[i-1];
527                         while(i < 6){
528                                 f.tiledef[i] = lasttile;
529                                 i++;
530                         }
531                 }
532         }
533         lua_pop(L, 1);
534
535         // overlay_tiles = {}
536         lua_getfield(L, index, "overlay_tiles");
537         if (lua_istable(L, -1)) {
538                 int table = lua_gettop(L);
539                 lua_pushnil(L);
540                 int i = 0;
541                 while (lua_next(L, table) != 0) {
542                         // Read tiledef from value
543                         f.tiledef_overlay[i] = read_tiledef(L, -1, f.drawtype);
544                         // removes value, keeps key for next iteration
545                         lua_pop(L, 1);
546                         i++;
547                         if (i == 6) {
548                                 lua_pop(L, 1);
549                                 break;
550                         }
551                 }
552                 // Copy last value to all remaining textures
553                 if (i >= 1) {
554                         TileDef lasttile = f.tiledef_overlay[i - 1];
555                         while (i < 6) {
556                                 f.tiledef_overlay[i] = lasttile;
557                                 i++;
558                         }
559                 }
560         }
561         lua_pop(L, 1);
562
563         // special_tiles = {}
564         lua_getfield(L, index, "special_tiles");
565         // If nil, try the deprecated name "special_materials" instead
566         if(lua_isnil(L, -1)){
567                 lua_pop(L, 1);
568                 warn_if_field_exists(L, index, "special_materials",
569                                 "Deprecated; new name is \"special_tiles\".");
570                 lua_getfield(L, index, "special_materials");
571         }
572         if(lua_istable(L, -1)){
573                 int table = lua_gettop(L);
574                 lua_pushnil(L);
575                 int i = 0;
576                 while(lua_next(L, table) != 0){
577                         // Read tiledef from value
578                         f.tiledef_special[i] = read_tiledef(L, -1, f.drawtype);
579                         // removes value, keeps key for next iteration
580                         lua_pop(L, 1);
581                         i++;
582                         if(i==CF_SPECIAL_COUNT){
583                                 lua_pop(L, 1);
584                                 break;
585                         }
586                 }
587         }
588         lua_pop(L, 1);
589
590         f.alpha = getintfield_default(L, index, "alpha", 255);
591
592         bool usealpha = getboolfield_default(L, index,
593                         "use_texture_alpha", false);
594         if (usealpha)
595                 f.alpha = 0;
596
597         // Read node color.
598         lua_getfield(L, index, "color");
599         read_color(L, -1, &f.color);
600         lua_pop(L, 1);
601
602         getstringfield(L, index, "palette", f.palette_name);
603
604         /* Other stuff */
605
606         lua_getfield(L, index, "post_effect_color");
607         read_color(L, -1, &f.post_effect_color);
608         lua_pop(L, 1);
609
610         f.param_type = (ContentParamType)getenumfield(L, index, "paramtype",
611                         ScriptApiNode::es_ContentParamType, CPT_NONE);
612         f.param_type_2 = (ContentParamType2)getenumfield(L, index, "paramtype2",
613                         ScriptApiNode::es_ContentParamType2, CPT2_NONE);
614
615         if (!f.palette_name.empty() &&
616                         !(f.param_type_2 == CPT2_COLOR ||
617                         f.param_type_2 == CPT2_COLORED_FACEDIR ||
618                         f.param_type_2 == CPT2_COLORED_WALLMOUNTED))
619                 warningstream << "Node " << f.name.c_str()
620                         << " has a palette, but not a suitable paramtype2." << std::endl;
621
622         // Warn about some deprecated fields
623         warn_if_field_exists(L, index, "wall_mounted",
624                         "Deprecated; use paramtype2 = 'wallmounted'");
625         warn_if_field_exists(L, index, "light_propagates",
626                         "Deprecated; determined from paramtype");
627         warn_if_field_exists(L, index, "dug_item",
628                         "Deprecated; use 'drop' field");
629         warn_if_field_exists(L, index, "extra_dug_item",
630                         "Deprecated; use 'drop' field");
631         warn_if_field_exists(L, index, "extra_dug_item_rarity",
632                         "Deprecated; use 'drop' field");
633         warn_if_field_exists(L, index, "metadata_name",
634                         "Deprecated; use on_add and metadata callbacks");
635
636         // True for all ground-like things like stone and mud, false for eg. trees
637         getboolfield(L, index, "is_ground_content", f.is_ground_content);
638         f.light_propagates = (f.param_type == CPT_LIGHT);
639         getboolfield(L, index, "sunlight_propagates", f.sunlight_propagates);
640         // This is used for collision detection.
641         // Also for general solidness queries.
642         getboolfield(L, index, "walkable", f.walkable);
643         // Player can point to these
644         getboolfield(L, index, "pointable", f.pointable);
645         // Player can dig these
646         getboolfield(L, index, "diggable", f.diggable);
647         // Player can climb these
648         getboolfield(L, index, "climbable", f.climbable);
649         // Player can build on these
650         getboolfield(L, index, "buildable_to", f.buildable_to);
651         // Liquids flow into and replace node
652         getboolfield(L, index, "floodable", f.floodable);
653         // Whether the node is non-liquid, source liquid or flowing liquid
654         f.liquid_type = (LiquidType)getenumfield(L, index, "liquidtype",
655                         ScriptApiNode::es_LiquidType, LIQUID_NONE);
656         // If the content is liquid, this is the flowing version of the liquid.
657         getstringfield(L, index, "liquid_alternative_flowing",
658                         f.liquid_alternative_flowing);
659         // If the content is liquid, this is the source version of the liquid.
660         getstringfield(L, index, "liquid_alternative_source",
661                         f.liquid_alternative_source);
662         // Viscosity for fluid flow, ranging from 1 to 7, with
663         // 1 giving almost instantaneous propagation and 7 being
664         // the slowest possible
665         f.liquid_viscosity = getintfield_default(L, index,
666                         "liquid_viscosity", f.liquid_viscosity);
667         f.liquid_range = getintfield_default(L, index,
668                         "liquid_range", f.liquid_range);
669         f.leveled = getintfield_default(L, index, "leveled", f.leveled);
670
671         getboolfield(L, index, "liquid_renewable", f.liquid_renewable);
672         f.drowning = getintfield_default(L, index,
673                         "drowning", f.drowning);
674         // Amount of light the node emits
675         f.light_source = getintfield_default(L, index,
676                         "light_source", f.light_source);
677         if (f.light_source > LIGHT_MAX) {
678                 warningstream << "Node " << f.name.c_str()
679                         << " had greater light_source than " << LIGHT_MAX
680                         << ", it was reduced." << std::endl;
681                 f.light_source = LIGHT_MAX;
682         }
683         f.damage_per_second = getintfield_default(L, index,
684                         "damage_per_second", f.damage_per_second);
685
686         lua_getfield(L, index, "node_box");
687         if(lua_istable(L, -1))
688                 f.node_box = read_nodebox(L, -1);
689         lua_pop(L, 1);
690
691         lua_getfield(L, index, "connects_to");
692         if (lua_istable(L, -1)) {
693                 int table = lua_gettop(L);
694                 lua_pushnil(L);
695                 while (lua_next(L, table) != 0) {
696                         // Value at -1
697                         f.connects_to.emplace_back(lua_tostring(L, -1));
698                         lua_pop(L, 1);
699                 }
700         }
701         lua_pop(L, 1);
702
703         lua_getfield(L, index, "connect_sides");
704         if (lua_istable(L, -1)) {
705                 int table = lua_gettop(L);
706                 lua_pushnil(L);
707                 while (lua_next(L, table) != 0) {
708                         // Value at -1
709                         std::string side(lua_tostring(L, -1));
710                         // Note faces are flipped to make checking easier
711                         if (side == "top")
712                                 f.connect_sides |= 2;
713                         else if (side == "bottom")
714                                 f.connect_sides |= 1;
715                         else if (side == "front")
716                                 f.connect_sides |= 16;
717                         else if (side == "left")
718                                 f.connect_sides |= 32;
719                         else if (side == "back")
720                                 f.connect_sides |= 4;
721                         else if (side == "right")
722                                 f.connect_sides |= 8;
723                         else
724                                 warningstream << "Unknown value for \"connect_sides\": "
725                                         << side << std::endl;
726                         lua_pop(L, 1);
727                 }
728         }
729         lua_pop(L, 1);
730
731         lua_getfield(L, index, "selection_box");
732         if(lua_istable(L, -1))
733                 f.selection_box = read_nodebox(L, -1);
734         lua_pop(L, 1);
735
736         lua_getfield(L, index, "collision_box");
737         if(lua_istable(L, -1))
738                 f.collision_box = read_nodebox(L, -1);
739         lua_pop(L, 1);
740
741         f.waving = getintfield_default(L, index,
742                         "waving", f.waving);
743
744         // Set to true if paramtype used to be 'facedir_simple'
745         getboolfield(L, index, "legacy_facedir_simple", f.legacy_facedir_simple);
746         // Set to true if wall_mounted used to be set to true
747         getboolfield(L, index, "legacy_wallmounted", f.legacy_wallmounted);
748
749         // Sound table
750         lua_getfield(L, index, "sounds");
751         if(lua_istable(L, -1)){
752                 lua_getfield(L, -1, "footstep");
753                 read_soundspec(L, -1, f.sound_footstep);
754                 lua_pop(L, 1);
755                 lua_getfield(L, -1, "dig");
756                 read_soundspec(L, -1, f.sound_dig);
757                 lua_pop(L, 1);
758                 lua_getfield(L, -1, "dug");
759                 read_soundspec(L, -1, f.sound_dug);
760                 lua_pop(L, 1);
761         }
762         lua_pop(L, 1);
763
764         // Node immediately placed by client when node is dug
765         getstringfield(L, index, "node_dig_prediction",
766                 f.node_dig_prediction);
767
768         return f;
769 }
770
771 void push_content_features(lua_State *L, const ContentFeatures &c)
772 {
773         std::string paramtype(ScriptApiNode::es_ContentParamType[(int)c.param_type].str);
774         std::string paramtype2(ScriptApiNode::es_ContentParamType2[(int)c.param_type_2].str);
775         std::string drawtype(ScriptApiNode::es_DrawType[(int)c.drawtype].str);
776         std::string liquid_type(ScriptApiNode::es_LiquidType[(int)c.liquid_type].str);
777
778         /* Missing "tiles" because I don't see a usecase (at least not yet). */
779
780         lua_newtable(L);
781         lua_pushboolean(L, c.has_on_construct);
782         lua_setfield(L, -2, "has_on_construct");
783         lua_pushboolean(L, c.has_on_destruct);
784         lua_setfield(L, -2, "has_on_destruct");
785         lua_pushboolean(L, c.has_after_destruct);
786         lua_setfield(L, -2, "has_after_destruct");
787         lua_pushstring(L, c.name.c_str());
788         lua_setfield(L, -2, "name");
789         push_groups(L, c.groups);
790         lua_setfield(L, -2, "groups");
791         lua_pushstring(L, paramtype.c_str());
792         lua_setfield(L, -2, "paramtype");
793         lua_pushstring(L, paramtype2.c_str());
794         lua_setfield(L, -2, "paramtype2");
795         lua_pushstring(L, drawtype.c_str());
796         lua_setfield(L, -2, "drawtype");
797         if (!c.mesh.empty()) {
798                 lua_pushstring(L, c.mesh.c_str());
799                 lua_setfield(L, -2, "mesh");
800         }
801 #ifndef SERVER
802         push_ARGB8(L, c.minimap_color);       // I know this is not set-able w/ register_node,
803         lua_setfield(L, -2, "minimap_color"); // but the people need to know!
804 #endif
805         lua_pushnumber(L, c.visual_scale);
806         lua_setfield(L, -2, "visual_scale");
807         lua_pushnumber(L, c.alpha);
808         lua_setfield(L, -2, "alpha");
809         if (!c.palette_name.empty()) {
810                 push_ARGB8(L, c.color);
811                 lua_setfield(L, -2, "color");
812
813                 lua_pushstring(L, c.palette_name.c_str());
814                 lua_setfield(L, -2, "palette_name");
815
816                 push_palette(L, c.palette);
817                 lua_setfield(L, -2, "palette");
818         }
819         lua_pushnumber(L, c.waving);
820         lua_setfield(L, -2, "waving");
821         lua_pushnumber(L, c.connect_sides);
822         lua_setfield(L, -2, "connect_sides");
823
824         lua_newtable(L);
825         u16 i = 1;
826         for (const std::string &it : c.connects_to) {
827                 lua_pushlstring(L, it.c_str(), it.size());
828                 lua_rawseti(L, -2, i);
829         }
830         lua_setfield(L, -2, "connects_to");
831
832         push_ARGB8(L, c.post_effect_color);
833         lua_setfield(L, -2, "post_effect_color");
834         lua_pushnumber(L, c.leveled);
835         lua_setfield(L, -2, "leveled");
836         lua_pushboolean(L, c.sunlight_propagates);
837         lua_setfield(L, -2, "sunlight_propagates");
838         lua_pushnumber(L, c.light_source);
839         lua_setfield(L, -2, "light_source");
840         lua_pushboolean(L, c.is_ground_content);
841         lua_setfield(L, -2, "is_ground_content");
842         lua_pushboolean(L, c.walkable);
843         lua_setfield(L, -2, "walkable");
844         lua_pushboolean(L, c.pointable);
845         lua_setfield(L, -2, "pointable");
846         lua_pushboolean(L, c.diggable);
847         lua_setfield(L, -2, "diggable");
848         lua_pushboolean(L, c.climbable);
849         lua_setfield(L, -2, "climbable");
850         lua_pushboolean(L, c.buildable_to);
851         lua_setfield(L, -2, "buildable_to");
852         lua_pushboolean(L, c.rightclickable);
853         lua_setfield(L, -2, "rightclickable");
854         lua_pushnumber(L, c.damage_per_second);
855         lua_setfield(L, -2, "damage_per_second");
856         if (c.isLiquid()) {
857                 lua_pushstring(L, liquid_type.c_str());
858                 lua_setfield(L, -2, "liquid_type");
859                 lua_pushstring(L, c.liquid_alternative_flowing.c_str());
860                 lua_setfield(L, -2, "liquid_alternative_flowing");
861                 lua_pushstring(L, c.liquid_alternative_source.c_str());
862                 lua_setfield(L, -2, "liquid_alternative_source");
863                 lua_pushnumber(L, c.liquid_viscosity);
864                 lua_setfield(L, -2, "liquid_viscosity");
865                 lua_pushboolean(L, c.liquid_renewable);
866                 lua_setfield(L, -2, "liquid_renewable");
867                 lua_pushnumber(L, c.liquid_range);
868                 lua_setfield(L, -2, "liquid_range");
869         }
870         lua_pushnumber(L, c.drowning);
871         lua_setfield(L, -2, "drowning");
872         lua_pushboolean(L, c.floodable);
873         lua_setfield(L, -2, "floodable");
874         push_nodebox(L, c.node_box);
875         lua_setfield(L, -2, "node_box");
876         push_nodebox(L, c.selection_box);
877         lua_setfield(L, -2, "selection_box");
878         push_nodebox(L, c.collision_box);
879         lua_setfield(L, -2, "collision_box");
880         lua_newtable(L);
881         push_soundspec(L, c.sound_footstep);
882         lua_setfield(L, -2, "sound_footstep");
883         push_soundspec(L, c.sound_dig);
884         lua_setfield(L, -2, "sound_dig");
885         push_soundspec(L, c.sound_dug);
886         lua_setfield(L, -2, "sound_dug");
887         lua_setfield(L, -2, "sounds");
888         lua_pushboolean(L, c.legacy_facedir_simple);
889         lua_setfield(L, -2, "legacy_facedir_simple");
890         lua_pushboolean(L, c.legacy_wallmounted);
891         lua_setfield(L, -2, "legacy_wallmounted");
892         lua_pushstring(L, c.node_dig_prediction.c_str());
893         lua_setfield(L, -2, "node_dig_prediction");
894 }
895
896 /******************************************************************************/
897 void push_nodebox(lua_State *L, const NodeBox &box)
898 {
899         lua_newtable(L);
900         switch (box.type)
901         {
902                 case NODEBOX_REGULAR:
903                         lua_pushstring(L, "regular");
904                         lua_setfield(L, -2, "type");
905                         break;
906                 case NODEBOX_LEVELED:
907                 case NODEBOX_FIXED:
908                         lua_pushstring(L, "fixed");
909                         lua_setfield(L, -2, "type");
910                         push_box(L, box.fixed);
911                         lua_setfield(L, -2, "fixed");
912                         break;
913                 case NODEBOX_WALLMOUNTED:
914                         lua_pushstring(L, "wallmounted");
915                         lua_setfield(L, -2, "type");
916                         push_aabb3f(L, box.wall_top);
917                         lua_setfield(L, -2, "wall_top");
918                         push_aabb3f(L, box.wall_bottom);
919                         lua_setfield(L, -2, "wall_bottom");
920                         push_aabb3f(L, box.wall_side);
921                         lua_setfield(L, -2, "wall_side");
922                         break;
923                 case NODEBOX_CONNECTED:
924                         lua_pushstring(L, "connected");
925                         lua_setfield(L, -2, "type");
926                         push_box(L, box.connect_top);
927                         lua_setfield(L, -2, "connect_top");
928                         push_box(L, box.connect_bottom);
929                         lua_setfield(L, -2, "connect_bottom");
930                         push_box(L, box.connect_front);
931                         lua_setfield(L, -2, "connect_front");
932                         push_box(L, box.connect_back);
933                         lua_setfield(L, -2, "connect_back");
934                         push_box(L, box.connect_left);
935                         lua_setfield(L, -2, "connect_left");
936                         push_box(L, box.connect_right);
937                         lua_setfield(L, -2, "connect_right");
938                         break;
939                 default:
940                         FATAL_ERROR("Invalid box.type");
941                         break;
942         }
943 }
944
945 void push_box(lua_State *L, const std::vector<aabb3f> &box)
946 {
947         lua_newtable(L);
948         u8 i = 1;
949         for (const aabb3f &it : box) {
950                 push_aabb3f(L, it);
951                 lua_rawseti(L, -2, i);
952         }
953 }
954
955 /******************************************************************************/
956 void push_palette(lua_State *L, const std::vector<video::SColor> *palette)
957 {
958         lua_createtable(L, palette->size(), 0);
959         int newTable = lua_gettop(L);
960         int index = 1;
961         std::vector<video::SColor>::const_iterator iter;
962         for (iter = palette->begin(); iter != palette->end(); ++iter) {
963                 push_ARGB8(L, (*iter));
964                 lua_rawseti(L, newTable, index);
965                 index++;
966         }
967 }
968
969 /******************************************************************************/
970 void read_server_sound_params(lua_State *L, int index,
971                 ServerSoundParams &params)
972 {
973         if(index < 0)
974                 index = lua_gettop(L) + 1 + index;
975         // Clear
976         params = ServerSoundParams();
977         if(lua_istable(L, index)){
978                 getfloatfield(L, index, "gain", params.gain);
979                 getstringfield(L, index, "to_player", params.to_player);
980                 getfloatfield(L, index, "fade", params.fade);
981                 getfloatfield(L, index, "pitch", params.pitch);
982                 lua_getfield(L, index, "pos");
983                 if(!lua_isnil(L, -1)){
984                         v3f p = read_v3f(L, -1)*BS;
985                         params.pos = p;
986                         params.type = ServerSoundParams::SSP_POSITIONAL;
987                 }
988                 lua_pop(L, 1);
989                 lua_getfield(L, index, "object");
990                 if(!lua_isnil(L, -1)){
991                         ObjectRef *ref = ObjectRef::checkobject(L, -1);
992                         ServerActiveObject *sao = ObjectRef::getobject(ref);
993                         if(sao){
994                                 params.object = sao->getId();
995                                 params.type = ServerSoundParams::SSP_OBJECT;
996                         }
997                 }
998                 lua_pop(L, 1);
999                 params.max_hear_distance = BS*getfloatfield_default(L, index,
1000                                 "max_hear_distance", params.max_hear_distance/BS);
1001                 getboolfield(L, index, "loop", params.loop);
1002         }
1003 }
1004
1005 /******************************************************************************/
1006 void read_soundspec(lua_State *L, int index, SimpleSoundSpec &spec)
1007 {
1008         if(index < 0)
1009                 index = lua_gettop(L) + 1 + index;
1010         if(lua_isnil(L, index)){
1011         } else if(lua_istable(L, index)){
1012                 getstringfield(L, index, "name", spec.name);
1013                 getfloatfield(L, index, "gain", spec.gain);
1014                 getfloatfield(L, index, "fade", spec.fade);
1015                 getfloatfield(L, index, "pitch", spec.pitch);
1016         } else if(lua_isstring(L, index)){
1017                 spec.name = lua_tostring(L, index);
1018         }
1019 }
1020
1021 void push_soundspec(lua_State *L, const SimpleSoundSpec &spec)
1022 {
1023         lua_newtable(L);
1024         lua_pushstring(L, spec.name.c_str());
1025         lua_setfield(L, -2, "name");
1026         lua_pushnumber(L, spec.gain);
1027         lua_setfield(L, -2, "gain");
1028         lua_pushnumber(L, spec.fade);
1029         lua_setfield(L, -2, "fade");
1030         lua_pushnumber(L, spec.pitch);
1031         lua_setfield(L, -2, "pitch");
1032 }
1033
1034 /******************************************************************************/
1035 NodeBox read_nodebox(lua_State *L, int index)
1036 {
1037         NodeBox nodebox;
1038         if(lua_istable(L, -1)){
1039                 nodebox.type = (NodeBoxType)getenumfield(L, index, "type",
1040                                 ScriptApiNode::es_NodeBoxType, NODEBOX_REGULAR);
1041
1042 #define NODEBOXREAD(n, s){ \
1043                 lua_getfield(L, index, (s)); \
1044                 if (lua_istable(L, -1)) \
1045                         (n) = read_aabb3f(L, -1, BS); \
1046                 lua_pop(L, 1); \
1047         }
1048
1049 #define NODEBOXREADVEC(n, s) \
1050                 lua_getfield(L, index, (s)); \
1051                 if (lua_istable(L, -1)) \
1052                         (n) = read_aabb3f_vector(L, -1, BS); \
1053                 lua_pop(L, 1);
1054
1055                 NODEBOXREADVEC(nodebox.fixed, "fixed");
1056                 NODEBOXREAD(nodebox.wall_top, "wall_top");
1057                 NODEBOXREAD(nodebox.wall_bottom, "wall_bottom");
1058                 NODEBOXREAD(nodebox.wall_side, "wall_side");
1059                 NODEBOXREADVEC(nodebox.connect_top, "connect_top");
1060                 NODEBOXREADVEC(nodebox.connect_bottom, "connect_bottom");
1061                 NODEBOXREADVEC(nodebox.connect_front, "connect_front");
1062                 NODEBOXREADVEC(nodebox.connect_left, "connect_left");
1063                 NODEBOXREADVEC(nodebox.connect_back, "connect_back");
1064                 NODEBOXREADVEC(nodebox.connect_right, "connect_right");
1065         }
1066         return nodebox;
1067 }
1068
1069 /******************************************************************************/
1070 MapNode readnode(lua_State *L, int index, INodeDefManager *ndef)
1071 {
1072         lua_getfield(L, index, "name");
1073         if (!lua_isstring(L, -1))
1074                 throw LuaError("Node name is not set or is not a string!");
1075         const char *name = lua_tostring(L, -1);
1076         lua_pop(L, 1);
1077
1078         u8 param1 = 0;
1079         lua_getfield(L, index, "param1");
1080         if (!lua_isnil(L, -1))
1081                 param1 = lua_tonumber(L, -1);
1082         lua_pop(L, 1);
1083
1084         u8 param2 = 0;
1085         lua_getfield(L, index, "param2");
1086         if (!lua_isnil(L, -1))
1087                 param2 = lua_tonumber(L, -1);
1088         lua_pop(L, 1);
1089
1090         return {ndef, name, param1, param2};
1091 }
1092
1093 /******************************************************************************/
1094 void pushnode(lua_State *L, const MapNode &n, INodeDefManager *ndef)
1095 {
1096         lua_newtable(L);
1097         lua_pushstring(L, ndef->get(n).name.c_str());
1098         lua_setfield(L, -2, "name");
1099         lua_pushnumber(L, n.getParam1());
1100         lua_setfield(L, -2, "param1");
1101         lua_pushnumber(L, n.getParam2());
1102         lua_setfield(L, -2, "param2");
1103 }
1104
1105 /******************************************************************************/
1106 void warn_if_field_exists(lua_State *L, int table,
1107                 const char *name, const std::string &message)
1108 {
1109         lua_getfield(L, table, name);
1110         if (!lua_isnil(L, -1)) {
1111                 warningstream << "Field \"" << name << "\": "
1112                                 << message << std::endl;
1113                 infostream << script_get_backtrace(L) << std::endl;
1114         }
1115         lua_pop(L, 1);
1116 }
1117
1118 /******************************************************************************/
1119 int getenumfield(lua_State *L, int table,
1120                 const char *fieldname, const EnumString *spec, int default_)
1121 {
1122         int result = default_;
1123         string_to_enum(spec, result,
1124                         getstringfield_default(L, table, fieldname, ""));
1125         return result;
1126 }
1127
1128 /******************************************************************************/
1129 bool string_to_enum(const EnumString *spec, int &result,
1130                 const std::string &str)
1131 {
1132         const EnumString *esp = spec;
1133         while(esp->str){
1134                 if(str == std::string(esp->str)){
1135                         result = esp->num;
1136                         return true;
1137                 }
1138                 esp++;
1139         }
1140         return false;
1141 }
1142
1143 /******************************************************************************/
1144 ItemStack read_item(lua_State* L, int index, IItemDefManager *idef)
1145 {
1146         if(index < 0)
1147                 index = lua_gettop(L) + 1 + index;
1148
1149         if (lua_isnil(L, index)) {
1150                 return ItemStack();
1151         }
1152
1153         if (lua_isuserdata(L, index)) {
1154                 // Convert from LuaItemStack
1155                 LuaItemStack *o = LuaItemStack::checkobject(L, index);
1156                 return o->getItem();
1157         }
1158
1159         if (lua_isstring(L, index)) {
1160                 // Convert from itemstring
1161                 std::string itemstring = lua_tostring(L, index);
1162                 try
1163                 {
1164                         ItemStack item;
1165                         item.deSerialize(itemstring, idef);
1166                         return item;
1167                 }
1168                 catch(SerializationError &e)
1169                 {
1170                         warningstream<<"unable to create item from itemstring"
1171                                         <<": "<<itemstring<<std::endl;
1172                         return ItemStack();
1173                 }
1174         }
1175         else if(lua_istable(L, index))
1176         {
1177                 // Convert from table
1178                 std::string name = getstringfield_default(L, index, "name", "");
1179                 int count = getintfield_default(L, index, "count", 1);
1180                 int wear = getintfield_default(L, index, "wear", 0);
1181
1182                 ItemStack istack(name, count, wear, idef);
1183
1184                 // BACKWARDS COMPATIBLITY
1185                 std::string value = getstringfield_default(L, index, "metadata", "");
1186                 istack.metadata.setString("", value);
1187
1188                 // Get meta
1189                 lua_getfield(L, index, "meta");
1190                 int fieldstable = lua_gettop(L);
1191                 if (lua_istable(L, fieldstable)) {
1192                         lua_pushnil(L);
1193                         while (lua_next(L, fieldstable) != 0) {
1194                                 // key at index -2 and value at index -1
1195                                 std::string key = lua_tostring(L, -2);
1196                                 size_t value_len;
1197                                 const char *value_cs = lua_tolstring(L, -1, &value_len);
1198                                 std::string value(value_cs, value_len);
1199                                 istack.metadata.setString(key, value);
1200                                 lua_pop(L, 1); // removes value, keeps key for next iteration
1201                         }
1202                 }
1203
1204                 return istack;
1205         } else {
1206                 throw LuaError("Expecting itemstack, itemstring, table or nil");
1207         }
1208 }
1209
1210 /******************************************************************************/
1211 void push_tool_capabilities(lua_State *L,
1212                 const ToolCapabilities &toolcap)
1213 {
1214         lua_newtable(L);
1215         setfloatfield(L, -1, "full_punch_interval", toolcap.full_punch_interval);
1216                 setintfield(L, -1, "max_drop_level", toolcap.max_drop_level);
1217                 // Create groupcaps table
1218                 lua_newtable(L);
1219                 // For each groupcap
1220                 for (const auto &gc_it : toolcap.groupcaps) {
1221                         // Create groupcap table
1222                         lua_newtable(L);
1223                         const std::string &name = gc_it.first;
1224                         const ToolGroupCap &groupcap = gc_it.second;
1225                         // Create subtable "times"
1226                         lua_newtable(L);
1227                         for (auto time : groupcap.times) {
1228                                 lua_pushinteger(L, time.first);
1229                                 lua_pushnumber(L, time.second);
1230                                 lua_settable(L, -3);
1231                         }
1232                         // Set subtable "times"
1233                         lua_setfield(L, -2, "times");
1234                         // Set simple parameters
1235                         setintfield(L, -1, "maxlevel", groupcap.maxlevel);
1236                         setintfield(L, -1, "uses", groupcap.uses);
1237                         // Insert groupcap table into groupcaps table
1238                         lua_setfield(L, -2, name.c_str());
1239                 }
1240                 // Set groupcaps table
1241                 lua_setfield(L, -2, "groupcaps");
1242                 //Create damage_groups table
1243                 lua_newtable(L);
1244                 // For each damage group
1245                 for (const auto &damageGroup : toolcap.damageGroups) {
1246                         // Create damage group table
1247                         lua_pushinteger(L, damageGroup.second);
1248                         lua_setfield(L, -2, damageGroup.first.c_str());
1249                 }
1250                 lua_setfield(L, -2, "damage_groups");
1251 }
1252
1253 /******************************************************************************/
1254 void push_inventory_list(lua_State *L, Inventory *inv, const char *name)
1255 {
1256         InventoryList *invlist = inv->getList(name);
1257         if(invlist == NULL){
1258                 lua_pushnil(L);
1259                 return;
1260         }
1261         std::vector<ItemStack> items;
1262         for(u32 i=0; i<invlist->getSize(); i++)
1263                 items.push_back(invlist->getItem(i));
1264         push_items(L, items);
1265 }
1266
1267 /******************************************************************************/
1268 void read_inventory_list(lua_State *L, int tableindex,
1269                 Inventory *inv, const char *name, Server* srv, int forcesize)
1270 {
1271         if(tableindex < 0)
1272                 tableindex = lua_gettop(L) + 1 + tableindex;
1273         // If nil, delete list
1274         if(lua_isnil(L, tableindex)){
1275                 inv->deleteList(name);
1276                 return;
1277         }
1278         // Otherwise set list
1279         std::vector<ItemStack> items = read_items(L, tableindex,srv);
1280         int listsize = (forcesize != -1) ? forcesize : items.size();
1281         InventoryList *invlist = inv->addList(name, listsize);
1282         int index = 0;
1283         for(std::vector<ItemStack>::const_iterator
1284                         i = items.begin(); i != items.end(); ++i){
1285                 if(forcesize != -1 && index == forcesize)
1286                         break;
1287                 invlist->changeItem(index, *i);
1288                 index++;
1289         }
1290         while(forcesize != -1 && index < forcesize){
1291                 invlist->deleteItem(index);
1292                 index++;
1293         }
1294 }
1295
1296 /******************************************************************************/
1297 struct TileAnimationParams read_animation_definition(lua_State *L, int index)
1298 {
1299         if(index < 0)
1300                 index = lua_gettop(L) + 1 + index;
1301
1302         struct TileAnimationParams anim;
1303         anim.type = TAT_NONE;
1304         if (!lua_istable(L, index))
1305                 return anim;
1306
1307         anim.type = (TileAnimationType)
1308                 getenumfield(L, index, "type", es_TileAnimationType,
1309                 TAT_NONE);
1310         if (anim.type == TAT_VERTICAL_FRAMES) {
1311                 // {type="vertical_frames", aspect_w=16, aspect_h=16, length=2.0}
1312                 anim.vertical_frames.aspect_w =
1313                         getintfield_default(L, index, "aspect_w", 16);
1314                 anim.vertical_frames.aspect_h =
1315                         getintfield_default(L, index, "aspect_h", 16);
1316                 anim.vertical_frames.length =
1317                         getfloatfield_default(L, index, "length", 1.0);
1318         } else if (anim.type == TAT_SHEET_2D) {
1319                 // {type="sheet_2d", frames_w=5, frames_h=3, frame_length=0.5}
1320                 getintfield(L, index, "frames_w",
1321                         anim.sheet_2d.frames_w);
1322                 getintfield(L, index, "frames_h",
1323                         anim.sheet_2d.frames_h);
1324                 getfloatfield(L, index, "frame_length",
1325                         anim.sheet_2d.frame_length);
1326         }
1327
1328         return anim;
1329 }
1330
1331 /******************************************************************************/
1332 ToolCapabilities read_tool_capabilities(
1333                 lua_State *L, int table)
1334 {
1335         ToolCapabilities toolcap;
1336         getfloatfield(L, table, "full_punch_interval", toolcap.full_punch_interval);
1337         getintfield(L, table, "max_drop_level", toolcap.max_drop_level);
1338         lua_getfield(L, table, "groupcaps");
1339         if(lua_istable(L, -1)){
1340                 int table_groupcaps = lua_gettop(L);
1341                 lua_pushnil(L);
1342                 while(lua_next(L, table_groupcaps) != 0){
1343                         // key at index -2 and value at index -1
1344                         std::string groupname = luaL_checkstring(L, -2);
1345                         if(lua_istable(L, -1)){
1346                                 int table_groupcap = lua_gettop(L);
1347                                 // This will be created
1348                                 ToolGroupCap groupcap;
1349                                 // Read simple parameters
1350                                 getintfield(L, table_groupcap, "maxlevel", groupcap.maxlevel);
1351                                 getintfield(L, table_groupcap, "uses", groupcap.uses);
1352                                 // DEPRECATED: maxwear
1353                                 float maxwear = 0;
1354                                 if (getfloatfield(L, table_groupcap, "maxwear", maxwear)){
1355                                         if (maxwear != 0)
1356                                                 groupcap.uses = 1.0/maxwear;
1357                                         else
1358                                                 groupcap.uses = 0;
1359                                         warningstream << "Field \"maxwear\" is deprecated; "
1360                                                         << "replace with uses=1/maxwear" << std::endl;
1361                                         infostream << script_get_backtrace(L) << std::endl;
1362                                 }
1363                                 // Read "times" table
1364                                 lua_getfield(L, table_groupcap, "times");
1365                                 if(lua_istable(L, -1)){
1366                                         int table_times = lua_gettop(L);
1367                                         lua_pushnil(L);
1368                                         while(lua_next(L, table_times) != 0){
1369                                                 // key at index -2 and value at index -1
1370                                                 int rating = luaL_checkinteger(L, -2);
1371                                                 float time = luaL_checknumber(L, -1);
1372                                                 groupcap.times[rating] = time;
1373                                                 // removes value, keeps key for next iteration
1374                                                 lua_pop(L, 1);
1375                                         }
1376                                 }
1377                                 lua_pop(L, 1);
1378                                 // Insert groupcap into toolcap
1379                                 toolcap.groupcaps[groupname] = groupcap;
1380                         }
1381                         // removes value, keeps key for next iteration
1382                         lua_pop(L, 1);
1383                 }
1384         }
1385         lua_pop(L, 1);
1386
1387         lua_getfield(L, table, "damage_groups");
1388         if(lua_istable(L, -1)){
1389                 int table_damage_groups = lua_gettop(L);
1390                 lua_pushnil(L);
1391                 while(lua_next(L, table_damage_groups) != 0){
1392                         // key at index -2 and value at index -1
1393                         std::string groupname = luaL_checkstring(L, -2);
1394                         u16 value = luaL_checkinteger(L, -1);
1395                         toolcap.damageGroups[groupname] = value;
1396                         // removes value, keeps key for next iteration
1397                         lua_pop(L, 1);
1398                 }
1399         }
1400         lua_pop(L, 1);
1401         return toolcap;
1402 }
1403
1404 /******************************************************************************/
1405 void push_dig_params(lua_State *L,const DigParams &params)
1406 {
1407         lua_newtable(L);
1408         setboolfield(L, -1, "diggable", params.diggable);
1409         setfloatfield(L, -1, "time", params.time);
1410         setintfield(L, -1, "wear", params.wear);
1411 }
1412
1413 /******************************************************************************/
1414 void push_hit_params(lua_State *L,const HitParams &params)
1415 {
1416         lua_newtable(L);
1417         setintfield(L, -1, "hp", params.hp);
1418         setintfield(L, -1, "wear", params.wear);
1419 }
1420
1421 /******************************************************************************/
1422
1423 bool getflagsfield(lua_State *L, int table, const char *fieldname,
1424         FlagDesc *flagdesc, u32 *flags, u32 *flagmask)
1425 {
1426         lua_getfield(L, table, fieldname);
1427
1428         bool success = read_flags(L, -1, flagdesc, flags, flagmask);
1429
1430         lua_pop(L, 1);
1431
1432         return success;
1433 }
1434
1435 bool read_flags(lua_State *L, int index, FlagDesc *flagdesc,
1436         u32 *flags, u32 *flagmask)
1437 {
1438         if (lua_isstring(L, index)) {
1439                 std::string flagstr = lua_tostring(L, index);
1440                 *flags = readFlagString(flagstr, flagdesc, flagmask);
1441         } else if (lua_istable(L, index)) {
1442                 *flags = read_flags_table(L, index, flagdesc, flagmask);
1443         } else {
1444                 return false;
1445         }
1446
1447         return true;
1448 }
1449
1450 u32 read_flags_table(lua_State *L, int table, FlagDesc *flagdesc, u32 *flagmask)
1451 {
1452         u32 flags = 0, mask = 0;
1453         char fnamebuf[64] = "no";
1454
1455         for (int i = 0; flagdesc[i].name; i++) {
1456                 bool result;
1457
1458                 if (getboolfield(L, table, flagdesc[i].name, result)) {
1459                         mask |= flagdesc[i].flag;
1460                         if (result)
1461                                 flags |= flagdesc[i].flag;
1462                 }
1463
1464                 strlcpy(fnamebuf + 2, flagdesc[i].name, sizeof(fnamebuf) - 2);
1465                 if (getboolfield(L, table, fnamebuf, result))
1466                         mask |= flagdesc[i].flag;
1467         }
1468
1469         if (flagmask)
1470                 *flagmask = mask;
1471
1472         return flags;
1473 }
1474
1475 void push_flags_string(lua_State *L, FlagDesc *flagdesc, u32 flags, u32 flagmask)
1476 {
1477         std::string flagstring = writeFlagString(flags, flagdesc, flagmask);
1478         lua_pushlstring(L, flagstring.c_str(), flagstring.size());
1479 }
1480
1481 /******************************************************************************/
1482 /* Lua Stored data!                                                           */
1483 /******************************************************************************/
1484
1485 /******************************************************************************/
1486 void read_groups(lua_State *L, int index, ItemGroupList &result)
1487 {
1488         if (!lua_istable(L,index))
1489                 return;
1490         result.clear();
1491         lua_pushnil(L);
1492         if(index < 0)
1493                 index -= 1;
1494         while(lua_next(L, index) != 0){
1495                 // key at index -2 and value at index -1
1496                 std::string name = luaL_checkstring(L, -2);
1497                 int rating = luaL_checkinteger(L, -1);
1498                 result[name] = rating;
1499                 // removes value, keeps key for next iteration
1500                 lua_pop(L, 1);
1501         }
1502 }
1503
1504 /******************************************************************************/
1505 void push_groups(lua_State *L, const ItemGroupList &groups)
1506 {
1507         lua_newtable(L);
1508         for (const auto &group : groups) {
1509                 lua_pushnumber(L, group.second);
1510                 lua_setfield(L, -2, group.first.c_str());
1511         }
1512 }
1513
1514 /******************************************************************************/
1515 void push_items(lua_State *L, const std::vector<ItemStack> &items)
1516 {
1517         lua_createtable(L, items.size(), 0);
1518         for (u32 i = 0; i != items.size(); i++) {
1519                 LuaItemStack::create(L, items[i]);
1520                 lua_rawseti(L, -2, i + 1);
1521         }
1522 }
1523
1524 /******************************************************************************/
1525 std::vector<ItemStack> read_items(lua_State *L, int index, Server *srv)
1526 {
1527         if(index < 0)
1528                 index = lua_gettop(L) + 1 + index;
1529
1530         std::vector<ItemStack> items;
1531         luaL_checktype(L, index, LUA_TTABLE);
1532         lua_pushnil(L);
1533         while (lua_next(L, index)) {
1534                 s32 key = luaL_checkinteger(L, -2);
1535                 if (key < 1) {
1536                         throw LuaError("Invalid inventory list index");
1537                 }
1538                 if (items.size() < (u32) key) {
1539                         items.resize(key);
1540                 }
1541                 items[key - 1] = read_item(L, -1, srv->idef());
1542                 lua_pop(L, 1);
1543         }
1544         return items;
1545 }
1546
1547 /******************************************************************************/
1548 void luaentity_get(lua_State *L, u16 id)
1549 {
1550         // Get luaentities[i]
1551         lua_getglobal(L, "core");
1552         lua_getfield(L, -1, "luaentities");
1553         luaL_checktype(L, -1, LUA_TTABLE);
1554         lua_pushnumber(L, id);
1555         lua_gettable(L, -2);
1556         lua_remove(L, -2); // Remove luaentities
1557         lua_remove(L, -2); // Remove core
1558 }
1559
1560 /******************************************************************************/
1561 bool read_noiseparams(lua_State *L, int index, NoiseParams *np)
1562 {
1563         if (index < 0)
1564                 index = lua_gettop(L) + 1 + index;
1565
1566         if (!lua_istable(L, index))
1567                 return false;
1568
1569         getfloatfield(L, index, "offset",      np->offset);
1570         getfloatfield(L, index, "scale",       np->scale);
1571         getfloatfield(L, index, "persist",     np->persist);
1572         getfloatfield(L, index, "persistence", np->persist);
1573         getfloatfield(L, index, "lacunarity",  np->lacunarity);
1574         getintfield(L,   index, "seed",        np->seed);
1575         getintfield(L,   index, "octaves",     np->octaves);
1576
1577         u32 flags    = 0;
1578         u32 flagmask = 0;
1579         np->flags = getflagsfield(L, index, "flags", flagdesc_noiseparams,
1580                 &flags, &flagmask) ? flags : NOISE_FLAG_DEFAULTS;
1581
1582         lua_getfield(L, index, "spread");
1583         np->spread  = read_v3f(L, -1);
1584         lua_pop(L, 1);
1585
1586         return true;
1587 }
1588
1589 void push_noiseparams(lua_State *L, NoiseParams *np)
1590 {
1591         lua_newtable(L);
1592         push_float_string(L, np->offset);
1593         lua_setfield(L, -2, "offset");
1594         push_float_string(L, np->scale);
1595         lua_setfield(L, -2, "scale");
1596         push_float_string(L, np->persist);
1597         lua_setfield(L, -2, "persistence");
1598         push_float_string(L, np->lacunarity);
1599         lua_setfield(L, -2, "lacunarity");
1600         lua_pushnumber(L, np->seed);
1601         lua_setfield(L, -2, "seed");
1602         lua_pushnumber(L, np->octaves);
1603         lua_setfield(L, -2, "octaves");
1604
1605         push_flags_string(L, flagdesc_noiseparams, np->flags,
1606                 np->flags);
1607         lua_setfield(L, -2, "flags");
1608
1609         push_v3_float_string(L, np->spread);
1610         lua_setfield(L, -2, "spread");
1611 }
1612
1613 /******************************************************************************/
1614 // Returns depth of json value tree
1615 static int push_json_value_getdepth(const Json::Value &value)
1616 {
1617         if (!value.isArray() && !value.isObject())
1618                 return 1;
1619
1620         int maxdepth = 0;
1621         for (const auto &it : value) {
1622                 int elemdepth = push_json_value_getdepth(it);
1623                 if (elemdepth > maxdepth)
1624                         maxdepth = elemdepth;
1625         }
1626         return maxdepth + 1;
1627 }
1628 // Recursive function to convert JSON --> Lua table
1629 static bool push_json_value_helper(lua_State *L, const Json::Value &value,
1630                 int nullindex)
1631 {
1632         switch(value.type()) {
1633                 case Json::nullValue:
1634                 default:
1635                         lua_pushvalue(L, nullindex);
1636                         break;
1637                 case Json::intValue:
1638                         lua_pushinteger(L, value.asInt());
1639                         break;
1640                 case Json::uintValue:
1641                         lua_pushinteger(L, value.asUInt());
1642                         break;
1643                 case Json::realValue:
1644                         lua_pushnumber(L, value.asDouble());
1645                         break;
1646                 case Json::stringValue:
1647                         {
1648                                 const char *str = value.asCString();
1649                                 lua_pushstring(L, str ? str : "");
1650                         }
1651                         break;
1652                 case Json::booleanValue:
1653                         lua_pushboolean(L, value.asInt());
1654                         break;
1655                 case Json::arrayValue:
1656                         lua_newtable(L);
1657                         for (Json::Value::const_iterator it = value.begin();
1658                                         it != value.end(); ++it) {
1659                                 push_json_value_helper(L, *it, nullindex);
1660                                 lua_rawseti(L, -2, it.index() + 1);
1661                         }
1662                         break;
1663                 case Json::objectValue:
1664                         lua_newtable(L);
1665                         for (Json::Value::const_iterator it = value.begin();
1666                                         it != value.end(); ++it) {
1667 #ifndef JSONCPP_STRING
1668                                 const char *str = it.memberName();
1669                                 lua_pushstring(L, str ? str : "");
1670 #else
1671                                 std::string str = it.name();
1672                                 lua_pushstring(L, str.c_str());
1673 #endif
1674                                 push_json_value_helper(L, *it, nullindex);
1675                                 lua_rawset(L, -3);
1676                         }
1677                         break;
1678         }
1679         return true;
1680 }
1681 // converts JSON --> Lua table; returns false if lua stack limit exceeded
1682 // nullindex: Lua stack index of value to use in place of JSON null
1683 bool push_json_value(lua_State *L, const Json::Value &value, int nullindex)
1684 {
1685         if(nullindex < 0)
1686                 nullindex = lua_gettop(L) + 1 + nullindex;
1687
1688         int depth = push_json_value_getdepth(value);
1689
1690         // The maximum number of Lua stack slots used at each recursion level
1691         // of push_json_value_helper is 2, so make sure there a depth * 2 slots
1692         if (lua_checkstack(L, depth * 2))
1693                 return push_json_value_helper(L, value, nullindex);
1694
1695         return false;
1696 }
1697
1698 // Converts Lua table --> JSON
1699 void read_json_value(lua_State *L, Json::Value &root, int index, u8 recursion)
1700 {
1701         if (recursion > 16) {
1702                 throw SerializationError("Maximum recursion depth exceeded");
1703         }
1704         int type = lua_type(L, index);
1705         if (type == LUA_TBOOLEAN) {
1706                 root = (bool) lua_toboolean(L, index);
1707         } else if (type == LUA_TNUMBER) {
1708                 root = lua_tonumber(L, index);
1709         } else if (type == LUA_TSTRING) {
1710                 size_t len;
1711                 const char *str = lua_tolstring(L, index, &len);
1712                 root = std::string(str, len);
1713         } else if (type == LUA_TTABLE) {
1714                 lua_pushnil(L);
1715                 while (lua_next(L, index)) {
1716                         // Key is at -2 and value is at -1
1717                         Json::Value value;
1718                         read_json_value(L, value, lua_gettop(L), recursion + 1);
1719
1720                         Json::ValueType roottype = root.type();
1721                         int keytype = lua_type(L, -1);
1722                         if (keytype == LUA_TNUMBER) {
1723                                 lua_Number key = lua_tonumber(L, -1);
1724                                 if (roottype != Json::nullValue && roottype != Json::arrayValue) {
1725                                         throw SerializationError("Can't mix array and object values in JSON");
1726                                 } else if (key < 1) {
1727                                         throw SerializationError("Can't use zero-based or negative indexes in JSON");
1728                                 } else if (floor(key) != key) {
1729                                         throw SerializationError("Can't use indexes with a fractional part in JSON");
1730                                 }
1731                                 root[(Json::ArrayIndex) key - 1] = value;
1732                         } else if (keytype == LUA_TSTRING) {
1733                                 if (roottype != Json::nullValue && roottype != Json::objectValue) {
1734                                         throw SerializationError("Can't mix array and object values in JSON");
1735                                 }
1736                                 root[lua_tostring(L, -1)] = value;
1737                         } else {
1738                                 throw SerializationError("Lua key to convert to JSON is not a string or number");
1739                         }
1740                 }
1741         } else if (type == LUA_TNIL) {
1742                 root = Json::nullValue;
1743         } else {
1744                 throw SerializationError("Can only store booleans, numbers, strings, objects, arrays, and null in JSON");
1745         }
1746         lua_pop(L, 1); // Pop value
1747 }
1748
1749 void push_pointed_thing(lua_State *L, const PointedThing &pointed, bool csm)
1750 {
1751         lua_newtable(L);
1752         if (pointed.type == POINTEDTHING_NODE) {
1753                 lua_pushstring(L, "node");
1754                 lua_setfield(L, -2, "type");
1755                 push_v3s16(L, pointed.node_undersurface);
1756                 lua_setfield(L, -2, "under");
1757                 push_v3s16(L, pointed.node_abovesurface);
1758                 lua_setfield(L, -2, "above");
1759         } else if (pointed.type == POINTEDTHING_OBJECT) {
1760                 lua_pushstring(L, "object");
1761                 lua_setfield(L, -2, "type");
1762
1763                 if (csm) {
1764                         lua_pushinteger(L, pointed.object_id);
1765                         lua_setfield(L, -2, "id");
1766                 } else {
1767                         push_objectRef(L, pointed.object_id);
1768                         lua_setfield(L, -2, "ref");
1769                 }
1770         } else {
1771                 lua_pushstring(L, "nothing");
1772                 lua_setfield(L, -2, "type");
1773         }
1774 }
1775
1776 void push_objectRef(lua_State *L, const u16 id)
1777 {
1778         // Get core.object_refs[i]
1779         lua_getglobal(L, "core");
1780         lua_getfield(L, -1, "object_refs");
1781         luaL_checktype(L, -1, LUA_TTABLE);
1782         lua_pushnumber(L, id);
1783         lua_gettable(L, -2);
1784         lua_remove(L, -2); // object_refs
1785         lua_remove(L, -2); // core
1786 }