3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
19 #include "common/c_content.h"
20 #include "common/c_converter.h"
21 #include "common/c_types.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"
31 #include "serverobject.h"
33 #include "mapgen/mg_schematic.h"
35 #include "util/pointedthing.h"
36 #include "debug.h" // For FATAL_ERROR
37 #include <json/json.h>
39 struct EnumString es_TileAnimationType[] =
42 {TAT_VERTICAL_FRAMES, "vertical_frames"},
43 {TAT_SHEET_2D, "sheet_2d"},
47 /******************************************************************************/
48 void read_item_definition(lua_State* L, int index,
49 const ItemDefinition &default_def, ItemDefinition &def)
52 index = lua_gettop(L) + 1 + index;
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);
65 lua_getfield(L, index, "color");
66 read_color(L, -1, &def.color);
69 lua_getfield(L, index, "wield_scale");
70 if(lua_istable(L, -1)){
71 def.wield_scale = check_v3f(L, -1);
75 int stack_max = getintfield_default(L, index, "stack_max", def.stack_max);
76 def.stack_max = rangelim(stack_max, 1, U16_MAX);
78 lua_getfield(L, index, "on_use");
79 def.usable = lua_isfunction(L, -1);
82 getboolfield(L, index, "liquids_pointable", def.liquids_pointable);
84 warn_if_field_exists(L, index, "tool_digging_properties",
85 "Deprecated; use tool_capabilities");
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));
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();
100 lua_getfield(L, index, "groups");
101 read_groups(L, -1, def.groups);
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);
109 lua_getfield(L, -1, "place_failed");
110 read_soundspec(L, -1, def.sound_place_failed);
115 def.range = getfloatfield_default(L, index, "range", def.range);
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);
124 /******************************************************************************/
125 void push_item_definition(lua_State *L, const ItemDefinition &i)
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");
134 void push_item_definition_full(lua_State *L, const ItemDefinition &i)
136 std::string type(es_ItemType[(int)i.type].str);
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");
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");
183 /******************************************************************************/
184 void read_object_properties(lua_State *L, int index,
185 ObjectProperties *prop, IItemDefManager *idef)
188 index = lua_gettop(L) + 1 + index;
189 if(!lua_istable(L, index))
193 if (getintfield(L, -1, "hp_max", hp_max))
194 prop->hp_max = (u16)rangelim(hp_max, 0, U16_MAX);
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);
200 getfloatfield(L, -1, "weight", prop->weight);
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);
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;
215 getboolfield(L, -1, "pointable", prop->pointable);
216 getstringfield(L, -1, "visual", prop->visual);
218 getstringfield(L, -1, "mesh", prop->mesh);
220 lua_getfield(L, -1, "visual_size");
221 if (lua_istable(L, -1)) {
222 // Backwards compatibility: Also accept { x = ?, y = ? }
223 v2f scale_xy = read_v2f(L, -1);
225 f32 scale_z = scale_xy.X;
226 lua_getfield(L, -1, "z");
227 if (lua_isnumber(L, -1))
228 scale_z = lua_tonumber(L, -1);
231 prop->visual_size = v3f(scale_xy.X, scale_xy.Y, scale_z);
235 lua_getfield(L, -1, "textures");
236 if(lua_istable(L, -1)){
237 prop->textures.clear();
238 int table = lua_gettop(L);
240 while(lua_next(L, table) != 0){
241 // key at index -2 and value at index -1
242 if(lua_isstring(L, -1))
243 prop->textures.emplace_back(lua_tostring(L, -1));
245 prop->textures.emplace_back("");
246 // removes value, keeps key for next iteration
252 lua_getfield(L, -1, "colors");
253 if (lua_istable(L, -1)) {
254 int table = lua_gettop(L);
255 prop->colors.clear();
256 for (lua_pushnil(L); lua_next(L, table); lua_pop(L, 1)) {
257 video::SColor color(255, 255, 255, 255);
258 read_color(L, -1, &color);
259 prop->colors.push_back(color);
264 lua_getfield(L, -1, "spritediv");
265 if(lua_istable(L, -1))
266 prop->spritediv = read_v2s16(L, -1);
269 lua_getfield(L, -1, "initial_sprite_basepos");
270 if(lua_istable(L, -1))
271 prop->initial_sprite_basepos = read_v2s16(L, -1);
274 getboolfield(L, -1, "is_visible", prop->is_visible);
275 getboolfield(L, -1, "makes_footstep_sound", prop->makes_footstep_sound);
276 if (getfloatfield(L, -1, "stepheight", prop->stepheight))
277 prop->stepheight *= BS;
278 getfloatfield(L, -1, "eye_height", prop->eye_height);
280 getfloatfield(L, -1, "automatic_rotate", prop->automatic_rotate);
281 lua_getfield(L, -1, "automatic_face_movement_dir");
282 if (lua_isnumber(L, -1)) {
283 prop->automatic_face_movement_dir = true;
284 prop->automatic_face_movement_dir_offset = luaL_checknumber(L, -1);
285 } else if (lua_isboolean(L, -1)) {
286 prop->automatic_face_movement_dir = lua_toboolean(L, -1);
287 prop->automatic_face_movement_dir_offset = 0.0;
290 getboolfield(L, -1, "backface_culling", prop->backface_culling);
291 getintfield(L, -1, "glow", prop->glow);
293 getstringfield(L, -1, "nametag", prop->nametag);
294 lua_getfield(L, -1, "nametag_color");
295 if (!lua_isnil(L, -1)) {
296 video::SColor color = prop->nametag_color;
297 if (read_color(L, -1, &color))
298 prop->nametag_color = color;
302 lua_getfield(L, -1, "automatic_face_movement_max_rotation_per_sec");
303 if (lua_isnumber(L, -1)) {
304 prop->automatic_face_movement_max_rotation_per_sec = luaL_checknumber(L, -1);
308 getstringfield(L, -1, "infotext", prop->infotext);
309 getboolfield(L, -1, "static_save", prop->static_save);
311 lua_getfield(L, -1, "wield_item");
312 if (!lua_isnil(L, -1))
313 prop->wield_item = read_item(L, -1, idef).getItemString();
316 getfloatfield(L, -1, "zoom_fov", prop->zoom_fov);
317 getboolfield(L, -1, "use_texture_alpha", prop->use_texture_alpha);
320 /******************************************************************************/
321 void push_object_properties(lua_State *L, ObjectProperties *prop)
324 lua_pushnumber(L, prop->hp_max);
325 lua_setfield(L, -2, "hp_max");
326 lua_pushnumber(L, prop->breath_max);
327 lua_setfield(L, -2, "breath_max");
328 lua_pushboolean(L, prop->physical);
329 lua_setfield(L, -2, "physical");
330 lua_pushboolean(L, prop->collideWithObjects);
331 lua_setfield(L, -2, "collide_with_objects");
332 lua_pushnumber(L, prop->weight);
333 lua_setfield(L, -2, "weight");
334 push_aabb3f(L, prop->collisionbox);
335 lua_setfield(L, -2, "collisionbox");
336 push_aabb3f(L, prop->selectionbox);
337 lua_setfield(L, -2, "selectionbox");
338 lua_pushboolean(L, prop->pointable);
339 lua_setfield(L, -2, "pointable");
340 lua_pushlstring(L, prop->visual.c_str(), prop->visual.size());
341 lua_setfield(L, -2, "visual");
342 lua_pushlstring(L, prop->mesh.c_str(), prop->mesh.size());
343 lua_setfield(L, -2, "mesh");
344 push_v3f(L, prop->visual_size);
345 lua_setfield(L, -2, "visual_size");
349 for (const std::string &texture : prop->textures) {
350 lua_pushlstring(L, texture.c_str(), texture.size());
351 lua_rawseti(L, -2, i++);
353 lua_setfield(L, -2, "textures");
357 for (const video::SColor &color : prop->colors) {
358 push_ARGB8(L, color);
359 lua_rawseti(L, -2, i++);
361 lua_setfield(L, -2, "colors");
363 push_v2s16(L, prop->spritediv);
364 lua_setfield(L, -2, "spritediv");
365 push_v2s16(L, prop->initial_sprite_basepos);
366 lua_setfield(L, -2, "initial_sprite_basepos");
367 lua_pushboolean(L, prop->is_visible);
368 lua_setfield(L, -2, "is_visible");
369 lua_pushboolean(L, prop->makes_footstep_sound);
370 lua_setfield(L, -2, "makes_footstep_sound");
371 lua_pushnumber(L, prop->stepheight / BS);
372 lua_setfield(L, -2, "stepheight");
373 lua_pushnumber(L, prop->eye_height);
374 lua_setfield(L, -2, "eye_height");
375 lua_pushnumber(L, prop->automatic_rotate);
376 lua_setfield(L, -2, "automatic_rotate");
377 if (prop->automatic_face_movement_dir)
378 lua_pushnumber(L, prop->automatic_face_movement_dir_offset);
380 lua_pushboolean(L, false);
381 lua_setfield(L, -2, "automatic_face_movement_dir");
382 lua_pushboolean(L, prop->backface_culling);
383 lua_setfield(L, -2, "backface_culling");
384 lua_pushnumber(L, prop->glow);
385 lua_setfield(L, -2, "glow");
386 lua_pushlstring(L, prop->nametag.c_str(), prop->nametag.size());
387 lua_setfield(L, -2, "nametag");
388 push_ARGB8(L, prop->nametag_color);
389 lua_setfield(L, -2, "nametag_color");
390 lua_pushnumber(L, prop->automatic_face_movement_max_rotation_per_sec);
391 lua_setfield(L, -2, "automatic_face_movement_max_rotation_per_sec");
392 lua_pushlstring(L, prop->infotext.c_str(), prop->infotext.size());
393 lua_setfield(L, -2, "infotext");
394 lua_pushboolean(L, prop->static_save);
395 lua_setfield(L, -2, "static_save");
396 lua_pushlstring(L, prop->wield_item.c_str(), prop->wield_item.size());
397 lua_setfield(L, -2, "wield_item");
398 lua_pushnumber(L, prop->zoom_fov);
399 lua_setfield(L, -2, "zoom_fov");
400 lua_pushboolean(L, prop->use_texture_alpha);
401 lua_setfield(L, -2, "use_texture_alpha");
404 /******************************************************************************/
405 TileDef read_tiledef(lua_State *L, int index, u8 drawtype)
408 index = lua_gettop(L) + 1 + index;
412 bool default_tiling = true;
413 bool default_culling = true;
416 case NDT_PLANTLIKE_ROOTED:
418 default_tiling = false;
419 // "break" is omitted here intentionaly, as PLANTLIKE
420 // FIRELIKE drawtype both should default to having
421 // backface_culling to false.
424 default_culling = false;
430 // key at index -2 and value at index
431 if(lua_isstring(L, index)){
432 // "default_lava.png"
433 tiledef.name = lua_tostring(L, index);
434 tiledef.tileable_vertical = default_tiling;
435 tiledef.tileable_horizontal = default_tiling;
436 tiledef.backface_culling = default_culling;
438 else if(lua_istable(L, index))
440 // name="default_lava.png"
442 getstringfield(L, index, "name", tiledef.name);
443 getstringfield(L, index, "image", tiledef.name); // MaterialSpec compat.
444 tiledef.backface_culling = getboolfield_default(
445 L, index, "backface_culling", default_culling);
446 tiledef.tileable_horizontal = getboolfield_default(
447 L, index, "tileable_horizontal", default_tiling);
448 tiledef.tileable_vertical = getboolfield_default(
449 L, index, "tileable_vertical", default_tiling);
450 std::string align_style;
451 if (getstringfield(L, index, "align_style", align_style)) {
452 if (align_style == "user")
453 tiledef.align_style = ALIGN_STYLE_USER_DEFINED;
454 else if (align_style == "world")
455 tiledef.align_style = ALIGN_STYLE_WORLD;
457 tiledef.align_style = ALIGN_STYLE_NODE;
459 tiledef.scale = getintfield_default(L, index, "scale", 0);
461 lua_getfield(L, index, "color");
462 tiledef.has_color = read_color(L, -1, &tiledef.color);
465 lua_getfield(L, index, "animation");
466 tiledef.animation = read_animation_definition(L, -1);
473 /******************************************************************************/
474 ContentFeatures read_content_features(lua_State *L, int index)
477 index = lua_gettop(L) + 1 + index;
481 /* Cache existence of some callbacks */
482 lua_getfield(L, index, "on_construct");
483 if(!lua_isnil(L, -1)) f.has_on_construct = true;
485 lua_getfield(L, index, "on_destruct");
486 if(!lua_isnil(L, -1)) f.has_on_destruct = true;
488 lua_getfield(L, index, "after_destruct");
489 if(!lua_isnil(L, -1)) f.has_after_destruct = true;
492 lua_getfield(L, index, "on_rightclick");
493 f.rightclickable = lua_isfunction(L, -1);
497 getstringfield(L, index, "name", f.name);
500 lua_getfield(L, index, "groups");
501 read_groups(L, -1, f.groups);
504 /* Visual definition */
506 f.drawtype = (NodeDrawType)getenumfield(L, index, "drawtype",
507 ScriptApiNode::es_DrawType,NDT_NORMAL);
508 getfloatfield(L, index, "visual_scale", f.visual_scale);
510 /* Meshnode model filename */
511 getstringfield(L, index, "mesh", f.mesh);
514 lua_getfield(L, index, "tiles");
515 // If nil, try the deprecated name "tile_images" instead
516 if(lua_isnil(L, -1)){
518 warn_if_field_exists(L, index, "tile_images",
519 "Deprecated; new name is \"tiles\".");
520 lua_getfield(L, index, "tile_images");
522 if(lua_istable(L, -1)){
523 int table = lua_gettop(L);
526 while(lua_next(L, table) != 0){
527 // Read tiledef from value
528 f.tiledef[i] = read_tiledef(L, -1, f.drawtype);
529 // removes value, keeps key for next iteration
537 // Copy last value to all remaining textures
539 TileDef lasttile = f.tiledef[i-1];
541 f.tiledef[i] = lasttile;
548 // overlay_tiles = {}
549 lua_getfield(L, index, "overlay_tiles");
550 if (lua_istable(L, -1)) {
551 int table = lua_gettop(L);
554 while (lua_next(L, table) != 0) {
555 // Read tiledef from value
556 f.tiledef_overlay[i] = read_tiledef(L, -1, f.drawtype);
557 // removes value, keeps key for next iteration
565 // Copy last value to all remaining textures
567 TileDef lasttile = f.tiledef_overlay[i - 1];
569 f.tiledef_overlay[i] = lasttile;
576 // special_tiles = {}
577 lua_getfield(L, index, "special_tiles");
578 // If nil, try the deprecated name "special_materials" instead
579 if(lua_isnil(L, -1)){
581 warn_if_field_exists(L, index, "special_materials",
582 "Deprecated; new name is \"special_tiles\".");
583 lua_getfield(L, index, "special_materials");
585 if(lua_istable(L, -1)){
586 int table = lua_gettop(L);
589 while(lua_next(L, table) != 0){
590 // Read tiledef from value
591 f.tiledef_special[i] = read_tiledef(L, -1, f.drawtype);
592 // removes value, keeps key for next iteration
595 if(i==CF_SPECIAL_COUNT){
603 f.alpha = getintfield_default(L, index, "alpha", 255);
605 bool usealpha = getboolfield_default(L, index,
606 "use_texture_alpha", false);
611 lua_getfield(L, index, "color");
612 read_color(L, -1, &f.color);
615 getstringfield(L, index, "palette", f.palette_name);
619 lua_getfield(L, index, "post_effect_color");
620 read_color(L, -1, &f.post_effect_color);
623 f.param_type = (ContentParamType)getenumfield(L, index, "paramtype",
624 ScriptApiNode::es_ContentParamType, CPT_NONE);
625 f.param_type_2 = (ContentParamType2)getenumfield(L, index, "paramtype2",
626 ScriptApiNode::es_ContentParamType2, CPT2_NONE);
628 if (!f.palette_name.empty() &&
629 !(f.param_type_2 == CPT2_COLOR ||
630 f.param_type_2 == CPT2_COLORED_FACEDIR ||
631 f.param_type_2 == CPT2_COLORED_WALLMOUNTED))
632 warningstream << "Node " << f.name.c_str()
633 << " has a palette, but not a suitable paramtype2." << std::endl;
635 // Warn about some deprecated fields
636 warn_if_field_exists(L, index, "wall_mounted",
637 "Deprecated; use paramtype2 = 'wallmounted'");
638 warn_if_field_exists(L, index, "light_propagates",
639 "Deprecated; determined from paramtype");
640 warn_if_field_exists(L, index, "dug_item",
641 "Deprecated; use 'drop' field");
642 warn_if_field_exists(L, index, "extra_dug_item",
643 "Deprecated; use 'drop' field");
644 warn_if_field_exists(L, index, "extra_dug_item_rarity",
645 "Deprecated; use 'drop' field");
646 warn_if_field_exists(L, index, "metadata_name",
647 "Deprecated; use on_add and metadata callbacks");
649 // True for all ground-like things like stone and mud, false for eg. trees
650 getboolfield(L, index, "is_ground_content", f.is_ground_content);
651 f.light_propagates = (f.param_type == CPT_LIGHT);
652 getboolfield(L, index, "sunlight_propagates", f.sunlight_propagates);
653 // This is used for collision detection.
654 // Also for general solidness queries.
655 getboolfield(L, index, "walkable", f.walkable);
656 // Player can point to these
657 getboolfield(L, index, "pointable", f.pointable);
658 // Player can dig these
659 getboolfield(L, index, "diggable", f.diggable);
660 // Player can climb these
661 getboolfield(L, index, "climbable", f.climbable);
662 // Player can build on these
663 getboolfield(L, index, "buildable_to", f.buildable_to);
664 // Liquids flow into and replace node
665 getboolfield(L, index, "floodable", f.floodable);
666 // Whether the node is non-liquid, source liquid or flowing liquid
667 f.liquid_type = (LiquidType)getenumfield(L, index, "liquidtype",
668 ScriptApiNode::es_LiquidType, LIQUID_NONE);
669 // If the content is liquid, this is the flowing version of the liquid.
670 getstringfield(L, index, "liquid_alternative_flowing",
671 f.liquid_alternative_flowing);
672 // If the content is liquid, this is the source version of the liquid.
673 getstringfield(L, index, "liquid_alternative_source",
674 f.liquid_alternative_source);
675 // Viscosity for fluid flow, ranging from 1 to 7, with
676 // 1 giving almost instantaneous propagation and 7 being
677 // the slowest possible
678 f.liquid_viscosity = getintfield_default(L, index,
679 "liquid_viscosity", f.liquid_viscosity);
680 f.liquid_range = getintfield_default(L, index,
681 "liquid_range", f.liquid_range);
682 f.leveled = getintfield_default(L, index, "leveled", f.leveled);
684 getboolfield(L, index, "liquid_renewable", f.liquid_renewable);
685 f.drowning = getintfield_default(L, index,
686 "drowning", f.drowning);
687 // Amount of light the node emits
688 f.light_source = getintfield_default(L, index,
689 "light_source", f.light_source);
690 if (f.light_source > LIGHT_MAX) {
691 warningstream << "Node " << f.name.c_str()
692 << " had greater light_source than " << LIGHT_MAX
693 << ", it was reduced." << std::endl;
694 f.light_source = LIGHT_MAX;
696 f.damage_per_second = getintfield_default(L, index,
697 "damage_per_second", f.damage_per_second);
699 lua_getfield(L, index, "node_box");
700 if(lua_istable(L, -1))
701 f.node_box = read_nodebox(L, -1);
704 lua_getfield(L, index, "connects_to");
705 if (lua_istable(L, -1)) {
706 int table = lua_gettop(L);
708 while (lua_next(L, table) != 0) {
710 f.connects_to.emplace_back(lua_tostring(L, -1));
716 lua_getfield(L, index, "connect_sides");
717 if (lua_istable(L, -1)) {
718 int table = lua_gettop(L);
720 while (lua_next(L, table) != 0) {
722 std::string side(lua_tostring(L, -1));
723 // Note faces are flipped to make checking easier
725 f.connect_sides |= 2;
726 else if (side == "bottom")
727 f.connect_sides |= 1;
728 else if (side == "front")
729 f.connect_sides |= 16;
730 else if (side == "left")
731 f.connect_sides |= 32;
732 else if (side == "back")
733 f.connect_sides |= 4;
734 else if (side == "right")
735 f.connect_sides |= 8;
737 warningstream << "Unknown value for \"connect_sides\": "
738 << side << std::endl;
744 lua_getfield(L, index, "selection_box");
745 if(lua_istable(L, -1))
746 f.selection_box = read_nodebox(L, -1);
749 lua_getfield(L, index, "collision_box");
750 if(lua_istable(L, -1))
751 f.collision_box = read_nodebox(L, -1);
754 f.waving = getintfield_default(L, index,
757 // Set to true if paramtype used to be 'facedir_simple'
758 getboolfield(L, index, "legacy_facedir_simple", f.legacy_facedir_simple);
759 // Set to true if wall_mounted used to be set to true
760 getboolfield(L, index, "legacy_wallmounted", f.legacy_wallmounted);
763 lua_getfield(L, index, "sounds");
764 if(lua_istable(L, -1)){
765 lua_getfield(L, -1, "footstep");
766 read_soundspec(L, -1, f.sound_footstep);
768 lua_getfield(L, -1, "dig");
769 read_soundspec(L, -1, f.sound_dig);
771 lua_getfield(L, -1, "dug");
772 read_soundspec(L, -1, f.sound_dug);
777 // Node immediately placed by client when node is dug
778 getstringfield(L, index, "node_dig_prediction",
779 f.node_dig_prediction);
784 void push_content_features(lua_State *L, const ContentFeatures &c)
786 std::string paramtype(ScriptApiNode::es_ContentParamType[(int)c.param_type].str);
787 std::string paramtype2(ScriptApiNode::es_ContentParamType2[(int)c.param_type_2].str);
788 std::string drawtype(ScriptApiNode::es_DrawType[(int)c.drawtype].str);
789 std::string liquid_type(ScriptApiNode::es_LiquidType[(int)c.liquid_type].str);
791 /* Missing "tiles" because I don't see a usecase (at least not yet). */
794 lua_pushboolean(L, c.has_on_construct);
795 lua_setfield(L, -2, "has_on_construct");
796 lua_pushboolean(L, c.has_on_destruct);
797 lua_setfield(L, -2, "has_on_destruct");
798 lua_pushboolean(L, c.has_after_destruct);
799 lua_setfield(L, -2, "has_after_destruct");
800 lua_pushstring(L, c.name.c_str());
801 lua_setfield(L, -2, "name");
802 push_groups(L, c.groups);
803 lua_setfield(L, -2, "groups");
804 lua_pushstring(L, paramtype.c_str());
805 lua_setfield(L, -2, "paramtype");
806 lua_pushstring(L, paramtype2.c_str());
807 lua_setfield(L, -2, "paramtype2");
808 lua_pushstring(L, drawtype.c_str());
809 lua_setfield(L, -2, "drawtype");
810 if (!c.mesh.empty()) {
811 lua_pushstring(L, c.mesh.c_str());
812 lua_setfield(L, -2, "mesh");
815 push_ARGB8(L, c.minimap_color); // I know this is not set-able w/ register_node,
816 lua_setfield(L, -2, "minimap_color"); // but the people need to know!
818 lua_pushnumber(L, c.visual_scale);
819 lua_setfield(L, -2, "visual_scale");
820 lua_pushnumber(L, c.alpha);
821 lua_setfield(L, -2, "alpha");
822 if (!c.palette_name.empty()) {
823 push_ARGB8(L, c.color);
824 lua_setfield(L, -2, "color");
826 lua_pushstring(L, c.palette_name.c_str());
827 lua_setfield(L, -2, "palette_name");
829 push_palette(L, c.palette);
830 lua_setfield(L, -2, "palette");
832 lua_pushnumber(L, c.waving);
833 lua_setfield(L, -2, "waving");
834 lua_pushnumber(L, c.connect_sides);
835 lua_setfield(L, -2, "connect_sides");
839 for (const std::string &it : c.connects_to) {
840 lua_pushlstring(L, it.c_str(), it.size());
841 lua_rawseti(L, -2, i++);
843 lua_setfield(L, -2, "connects_to");
845 push_ARGB8(L, c.post_effect_color);
846 lua_setfield(L, -2, "post_effect_color");
847 lua_pushnumber(L, c.leveled);
848 lua_setfield(L, -2, "leveled");
849 lua_pushboolean(L, c.sunlight_propagates);
850 lua_setfield(L, -2, "sunlight_propagates");
851 lua_pushnumber(L, c.light_source);
852 lua_setfield(L, -2, "light_source");
853 lua_pushboolean(L, c.is_ground_content);
854 lua_setfield(L, -2, "is_ground_content");
855 lua_pushboolean(L, c.walkable);
856 lua_setfield(L, -2, "walkable");
857 lua_pushboolean(L, c.pointable);
858 lua_setfield(L, -2, "pointable");
859 lua_pushboolean(L, c.diggable);
860 lua_setfield(L, -2, "diggable");
861 lua_pushboolean(L, c.climbable);
862 lua_setfield(L, -2, "climbable");
863 lua_pushboolean(L, c.buildable_to);
864 lua_setfield(L, -2, "buildable_to");
865 lua_pushboolean(L, c.rightclickable);
866 lua_setfield(L, -2, "rightclickable");
867 lua_pushnumber(L, c.damage_per_second);
868 lua_setfield(L, -2, "damage_per_second");
870 lua_pushstring(L, liquid_type.c_str());
871 lua_setfield(L, -2, "liquid_type");
872 lua_pushstring(L, c.liquid_alternative_flowing.c_str());
873 lua_setfield(L, -2, "liquid_alternative_flowing");
874 lua_pushstring(L, c.liquid_alternative_source.c_str());
875 lua_setfield(L, -2, "liquid_alternative_source");
876 lua_pushnumber(L, c.liquid_viscosity);
877 lua_setfield(L, -2, "liquid_viscosity");
878 lua_pushboolean(L, c.liquid_renewable);
879 lua_setfield(L, -2, "liquid_renewable");
880 lua_pushnumber(L, c.liquid_range);
881 lua_setfield(L, -2, "liquid_range");
883 lua_pushnumber(L, c.drowning);
884 lua_setfield(L, -2, "drowning");
885 lua_pushboolean(L, c.floodable);
886 lua_setfield(L, -2, "floodable");
887 push_nodebox(L, c.node_box);
888 lua_setfield(L, -2, "node_box");
889 push_nodebox(L, c.selection_box);
890 lua_setfield(L, -2, "selection_box");
891 push_nodebox(L, c.collision_box);
892 lua_setfield(L, -2, "collision_box");
894 push_soundspec(L, c.sound_footstep);
895 lua_setfield(L, -2, "sound_footstep");
896 push_soundspec(L, c.sound_dig);
897 lua_setfield(L, -2, "sound_dig");
898 push_soundspec(L, c.sound_dug);
899 lua_setfield(L, -2, "sound_dug");
900 lua_setfield(L, -2, "sounds");
901 lua_pushboolean(L, c.legacy_facedir_simple);
902 lua_setfield(L, -2, "legacy_facedir_simple");
903 lua_pushboolean(L, c.legacy_wallmounted);
904 lua_setfield(L, -2, "legacy_wallmounted");
905 lua_pushstring(L, c.node_dig_prediction.c_str());
906 lua_setfield(L, -2, "node_dig_prediction");
909 /******************************************************************************/
910 void push_nodebox(lua_State *L, const NodeBox &box)
915 case NODEBOX_REGULAR:
916 lua_pushstring(L, "regular");
917 lua_setfield(L, -2, "type");
919 case NODEBOX_LEVELED:
921 lua_pushstring(L, "fixed");
922 lua_setfield(L, -2, "type");
923 push_box(L, box.fixed);
924 lua_setfield(L, -2, "fixed");
926 case NODEBOX_WALLMOUNTED:
927 lua_pushstring(L, "wallmounted");
928 lua_setfield(L, -2, "type");
929 push_aabb3f(L, box.wall_top);
930 lua_setfield(L, -2, "wall_top");
931 push_aabb3f(L, box.wall_bottom);
932 lua_setfield(L, -2, "wall_bottom");
933 push_aabb3f(L, box.wall_side);
934 lua_setfield(L, -2, "wall_side");
936 case NODEBOX_CONNECTED:
937 lua_pushstring(L, "connected");
938 lua_setfield(L, -2, "type");
939 push_box(L, box.connect_top);
940 lua_setfield(L, -2, "connect_top");
941 push_box(L, box.connect_bottom);
942 lua_setfield(L, -2, "connect_bottom");
943 push_box(L, box.connect_front);
944 lua_setfield(L, -2, "connect_front");
945 push_box(L, box.connect_back);
946 lua_setfield(L, -2, "connect_back");
947 push_box(L, box.connect_left);
948 lua_setfield(L, -2, "connect_left");
949 push_box(L, box.connect_right);
950 lua_setfield(L, -2, "connect_right");
953 FATAL_ERROR("Invalid box.type");
958 void push_box(lua_State *L, const std::vector<aabb3f> &box)
962 for (const aabb3f &it : box) {
964 lua_rawseti(L, -2, i++);
968 /******************************************************************************/
969 void push_palette(lua_State *L, const std::vector<video::SColor> *palette)
971 lua_createtable(L, palette->size(), 0);
972 int newTable = lua_gettop(L);
974 std::vector<video::SColor>::const_iterator iter;
975 for (iter = palette->begin(); iter != palette->end(); ++iter) {
976 push_ARGB8(L, (*iter));
977 lua_rawseti(L, newTable, index);
982 /******************************************************************************/
983 void read_server_sound_params(lua_State *L, int index,
984 ServerSoundParams ¶ms)
987 index = lua_gettop(L) + 1 + index;
989 params = ServerSoundParams();
990 if(lua_istable(L, index)){
991 getfloatfield(L, index, "gain", params.gain);
992 getstringfield(L, index, "to_player", params.to_player);
993 getfloatfield(L, index, "fade", params.fade);
994 getfloatfield(L, index, "pitch", params.pitch);
995 lua_getfield(L, index, "pos");
996 if(!lua_isnil(L, -1)){
997 v3f p = read_v3f(L, -1)*BS;
999 params.type = ServerSoundParams::SSP_POSITIONAL;
1002 lua_getfield(L, index, "object");
1003 if(!lua_isnil(L, -1)){
1004 ObjectRef *ref = ObjectRef::checkobject(L, -1);
1005 ServerActiveObject *sao = ObjectRef::getobject(ref);
1007 params.object = sao->getId();
1008 params.type = ServerSoundParams::SSP_OBJECT;
1012 params.max_hear_distance = BS*getfloatfield_default(L, index,
1013 "max_hear_distance", params.max_hear_distance/BS);
1014 getboolfield(L, index, "loop", params.loop);
1018 /******************************************************************************/
1019 void read_soundspec(lua_State *L, int index, SimpleSoundSpec &spec)
1022 index = lua_gettop(L) + 1 + index;
1023 if(lua_isnil(L, index)){
1024 } else if(lua_istable(L, index)){
1025 getstringfield(L, index, "name", spec.name);
1026 getfloatfield(L, index, "gain", spec.gain);
1027 getfloatfield(L, index, "fade", spec.fade);
1028 getfloatfield(L, index, "pitch", spec.pitch);
1029 } else if(lua_isstring(L, index)){
1030 spec.name = lua_tostring(L, index);
1034 void push_soundspec(lua_State *L, const SimpleSoundSpec &spec)
1037 lua_pushstring(L, spec.name.c_str());
1038 lua_setfield(L, -2, "name");
1039 lua_pushnumber(L, spec.gain);
1040 lua_setfield(L, -2, "gain");
1041 lua_pushnumber(L, spec.fade);
1042 lua_setfield(L, -2, "fade");
1043 lua_pushnumber(L, spec.pitch);
1044 lua_setfield(L, -2, "pitch");
1047 /******************************************************************************/
1048 NodeBox read_nodebox(lua_State *L, int index)
1051 if(lua_istable(L, -1)){
1052 nodebox.type = (NodeBoxType)getenumfield(L, index, "type",
1053 ScriptApiNode::es_NodeBoxType, NODEBOX_REGULAR);
1055 #define NODEBOXREAD(n, s){ \
1056 lua_getfield(L, index, (s)); \
1057 if (lua_istable(L, -1)) \
1058 (n) = read_aabb3f(L, -1, BS); \
1062 #define NODEBOXREADVEC(n, s) \
1063 lua_getfield(L, index, (s)); \
1064 if (lua_istable(L, -1)) \
1065 (n) = read_aabb3f_vector(L, -1, BS); \
1068 NODEBOXREADVEC(nodebox.fixed, "fixed");
1069 NODEBOXREAD(nodebox.wall_top, "wall_top");
1070 NODEBOXREAD(nodebox.wall_bottom, "wall_bottom");
1071 NODEBOXREAD(nodebox.wall_side, "wall_side");
1072 NODEBOXREADVEC(nodebox.connect_top, "connect_top");
1073 NODEBOXREADVEC(nodebox.connect_bottom, "connect_bottom");
1074 NODEBOXREADVEC(nodebox.connect_front, "connect_front");
1075 NODEBOXREADVEC(nodebox.connect_left, "connect_left");
1076 NODEBOXREADVEC(nodebox.connect_back, "connect_back");
1077 NODEBOXREADVEC(nodebox.connect_right, "connect_right");
1078 NODEBOXREADVEC(nodebox.disconnected_top, "disconnected_top");
1079 NODEBOXREADVEC(nodebox.disconnected_bottom, "disconnected_bottom");
1080 NODEBOXREADVEC(nodebox.disconnected_front, "disconnected_front");
1081 NODEBOXREADVEC(nodebox.disconnected_left, "disconnected_left");
1082 NODEBOXREADVEC(nodebox.disconnected_back, "disconnected_back");
1083 NODEBOXREADVEC(nodebox.disconnected_right, "disconnected_right");
1084 NODEBOXREADVEC(nodebox.disconnected, "disconnected");
1085 NODEBOXREADVEC(nodebox.disconnected_sides, "disconnected_sides");
1090 /******************************************************************************/
1091 MapNode readnode(lua_State *L, int index, const NodeDefManager *ndef)
1093 lua_getfield(L, index, "name");
1094 if (!lua_isstring(L, -1))
1095 throw LuaError("Node name is not set or is not a string!");
1096 const char *name = lua_tostring(L, -1);
1100 lua_getfield(L, index, "param1");
1101 if (!lua_isnil(L, -1))
1102 param1 = lua_tonumber(L, -1);
1106 lua_getfield(L, index, "param2");
1107 if (!lua_isnil(L, -1))
1108 param2 = lua_tonumber(L, -1);
1111 return {ndef, name, param1, param2};
1114 /******************************************************************************/
1115 void pushnode(lua_State *L, const MapNode &n, const NodeDefManager *ndef)
1118 lua_pushstring(L, ndef->get(n).name.c_str());
1119 lua_setfield(L, -2, "name");
1120 lua_pushnumber(L, n.getParam1());
1121 lua_setfield(L, -2, "param1");
1122 lua_pushnumber(L, n.getParam2());
1123 lua_setfield(L, -2, "param2");
1126 /******************************************************************************/
1127 void warn_if_field_exists(lua_State *L, int table,
1128 const char *name, const std::string &message)
1130 lua_getfield(L, table, name);
1131 if (!lua_isnil(L, -1)) {
1132 warningstream << "Field \"" << name << "\": "
1133 << message << std::endl;
1134 infostream << script_get_backtrace(L) << std::endl;
1139 /******************************************************************************/
1140 int getenumfield(lua_State *L, int table,
1141 const char *fieldname, const EnumString *spec, int default_)
1143 int result = default_;
1144 string_to_enum(spec, result,
1145 getstringfield_default(L, table, fieldname, ""));
1149 /******************************************************************************/
1150 bool string_to_enum(const EnumString *spec, int &result,
1151 const std::string &str)
1153 const EnumString *esp = spec;
1155 if(str == std::string(esp->str)){
1164 /******************************************************************************/
1165 ItemStack read_item(lua_State* L, int index, IItemDefManager *idef)
1168 index = lua_gettop(L) + 1 + index;
1170 if (lua_isnil(L, index)) {
1174 if (lua_isuserdata(L, index)) {
1175 // Convert from LuaItemStack
1176 LuaItemStack *o = LuaItemStack::checkobject(L, index);
1177 return o->getItem();
1180 if (lua_isstring(L, index)) {
1181 // Convert from itemstring
1182 std::string itemstring = lua_tostring(L, index);
1186 item.deSerialize(itemstring, idef);
1189 catch(SerializationError &e)
1191 warningstream<<"unable to create item from itemstring"
1192 <<": "<<itemstring<<std::endl;
1196 else if(lua_istable(L, index))
1198 // Convert from table
1199 std::string name = getstringfield_default(L, index, "name", "");
1200 int count = getintfield_default(L, index, "count", 1);
1201 int wear = getintfield_default(L, index, "wear", 0);
1203 ItemStack istack(name, count, wear, idef);
1205 // BACKWARDS COMPATIBLITY
1206 std::string value = getstringfield_default(L, index, "metadata", "");
1207 istack.metadata.setString("", value);
1210 lua_getfield(L, index, "meta");
1211 int fieldstable = lua_gettop(L);
1212 if (lua_istable(L, fieldstable)) {
1214 while (lua_next(L, fieldstable) != 0) {
1215 // key at index -2 and value at index -1
1216 std::string key = lua_tostring(L, -2);
1218 const char *value_cs = lua_tolstring(L, -1, &value_len);
1219 std::string value(value_cs, value_len);
1220 istack.metadata.setString(key, value);
1221 lua_pop(L, 1); // removes value, keeps key for next iteration
1227 throw LuaError("Expecting itemstack, itemstring, table or nil");
1231 /******************************************************************************/
1232 void push_tool_capabilities(lua_State *L,
1233 const ToolCapabilities &toolcap)
1236 setfloatfield(L, -1, "full_punch_interval", toolcap.full_punch_interval);
1237 setintfield(L, -1, "max_drop_level", toolcap.max_drop_level);
1238 // Create groupcaps table
1240 // For each groupcap
1241 for (const auto &gc_it : toolcap.groupcaps) {
1242 // Create groupcap table
1244 const std::string &name = gc_it.first;
1245 const ToolGroupCap &groupcap = gc_it.second;
1246 // Create subtable "times"
1248 for (auto time : groupcap.times) {
1249 lua_pushinteger(L, time.first);
1250 lua_pushnumber(L, time.second);
1251 lua_settable(L, -3);
1253 // Set subtable "times"
1254 lua_setfield(L, -2, "times");
1255 // Set simple parameters
1256 setintfield(L, -1, "maxlevel", groupcap.maxlevel);
1257 setintfield(L, -1, "uses", groupcap.uses);
1258 // Insert groupcap table into groupcaps table
1259 lua_setfield(L, -2, name.c_str());
1261 // Set groupcaps table
1262 lua_setfield(L, -2, "groupcaps");
1263 //Create damage_groups table
1265 // For each damage group
1266 for (const auto &damageGroup : toolcap.damageGroups) {
1267 // Create damage group table
1268 lua_pushinteger(L, damageGroup.second);
1269 lua_setfield(L, -2, damageGroup.first.c_str());
1271 lua_setfield(L, -2, "damage_groups");
1274 /******************************************************************************/
1275 void push_inventory_list(lua_State *L, Inventory *inv, const char *name)
1277 InventoryList *invlist = inv->getList(name);
1278 if(invlist == NULL){
1282 std::vector<ItemStack> items;
1283 for(u32 i=0; i<invlist->getSize(); i++)
1284 items.push_back(invlist->getItem(i));
1285 push_items(L, items);
1288 /******************************************************************************/
1289 void read_inventory_list(lua_State *L, int tableindex,
1290 Inventory *inv, const char *name, Server* srv, int forcesize)
1293 tableindex = lua_gettop(L) + 1 + tableindex;
1294 // If nil, delete list
1295 if(lua_isnil(L, tableindex)){
1296 inv->deleteList(name);
1299 // Otherwise set list
1300 std::vector<ItemStack> items = read_items(L, tableindex,srv);
1301 int listsize = (forcesize != -1) ? forcesize : items.size();
1302 InventoryList *invlist = inv->addList(name, listsize);
1304 for(std::vector<ItemStack>::const_iterator
1305 i = items.begin(); i != items.end(); ++i){
1306 if(forcesize != -1 && index == forcesize)
1308 invlist->changeItem(index, *i);
1311 while(forcesize != -1 && index < forcesize){
1312 invlist->deleteItem(index);
1317 /******************************************************************************/
1318 struct TileAnimationParams read_animation_definition(lua_State *L, int index)
1321 index = lua_gettop(L) + 1 + index;
1323 struct TileAnimationParams anim;
1324 anim.type = TAT_NONE;
1325 if (!lua_istable(L, index))
1328 anim.type = (TileAnimationType)
1329 getenumfield(L, index, "type", es_TileAnimationType,
1331 if (anim.type == TAT_VERTICAL_FRAMES) {
1332 // {type="vertical_frames", aspect_w=16, aspect_h=16, length=2.0}
1333 anim.vertical_frames.aspect_w =
1334 getintfield_default(L, index, "aspect_w", 16);
1335 anim.vertical_frames.aspect_h =
1336 getintfield_default(L, index, "aspect_h", 16);
1337 anim.vertical_frames.length =
1338 getfloatfield_default(L, index, "length", 1.0);
1339 } else if (anim.type == TAT_SHEET_2D) {
1340 // {type="sheet_2d", frames_w=5, frames_h=3, frame_length=0.5}
1341 getintfield(L, index, "frames_w",
1342 anim.sheet_2d.frames_w);
1343 getintfield(L, index, "frames_h",
1344 anim.sheet_2d.frames_h);
1345 getfloatfield(L, index, "frame_length",
1346 anim.sheet_2d.frame_length);
1352 /******************************************************************************/
1353 ToolCapabilities read_tool_capabilities(
1354 lua_State *L, int table)
1356 ToolCapabilities toolcap;
1357 getfloatfield(L, table, "full_punch_interval", toolcap.full_punch_interval);
1358 getintfield(L, table, "max_drop_level", toolcap.max_drop_level);
1359 lua_getfield(L, table, "groupcaps");
1360 if(lua_istable(L, -1)){
1361 int table_groupcaps = lua_gettop(L);
1363 while(lua_next(L, table_groupcaps) != 0){
1364 // key at index -2 and value at index -1
1365 std::string groupname = luaL_checkstring(L, -2);
1366 if(lua_istable(L, -1)){
1367 int table_groupcap = lua_gettop(L);
1368 // This will be created
1369 ToolGroupCap groupcap;
1370 // Read simple parameters
1371 getintfield(L, table_groupcap, "maxlevel", groupcap.maxlevel);
1372 getintfield(L, table_groupcap, "uses", groupcap.uses);
1373 // DEPRECATED: maxwear
1375 if (getfloatfield(L, table_groupcap, "maxwear", maxwear)){
1377 groupcap.uses = 1.0/maxwear;
1380 warningstream << "Field \"maxwear\" is deprecated; "
1381 << "replace with uses=1/maxwear" << std::endl;
1382 infostream << script_get_backtrace(L) << std::endl;
1384 // Read "times" table
1385 lua_getfield(L, table_groupcap, "times");
1386 if(lua_istable(L, -1)){
1387 int table_times = lua_gettop(L);
1389 while(lua_next(L, table_times) != 0){
1390 // key at index -2 and value at index -1
1391 int rating = luaL_checkinteger(L, -2);
1392 float time = luaL_checknumber(L, -1);
1393 groupcap.times[rating] = time;
1394 // removes value, keeps key for next iteration
1399 // Insert groupcap into toolcap
1400 toolcap.groupcaps[groupname] = groupcap;
1402 // removes value, keeps key for next iteration
1408 lua_getfield(L, table, "damage_groups");
1409 if(lua_istable(L, -1)){
1410 int table_damage_groups = lua_gettop(L);
1412 while(lua_next(L, table_damage_groups) != 0){
1413 // key at index -2 and value at index -1
1414 std::string groupname = luaL_checkstring(L, -2);
1415 u16 value = luaL_checkinteger(L, -1);
1416 toolcap.damageGroups[groupname] = value;
1417 // removes value, keeps key for next iteration
1425 /******************************************************************************/
1426 void push_dig_params(lua_State *L,const DigParams ¶ms)
1429 setboolfield(L, -1, "diggable", params.diggable);
1430 setfloatfield(L, -1, "time", params.time);
1431 setintfield(L, -1, "wear", params.wear);
1434 /******************************************************************************/
1435 void push_hit_params(lua_State *L,const HitParams ¶ms)
1438 setintfield(L, -1, "hp", params.hp);
1439 setintfield(L, -1, "wear", params.wear);
1442 /******************************************************************************/
1444 bool getflagsfield(lua_State *L, int table, const char *fieldname,
1445 FlagDesc *flagdesc, u32 *flags, u32 *flagmask)
1447 lua_getfield(L, table, fieldname);
1449 bool success = read_flags(L, -1, flagdesc, flags, flagmask);
1456 bool read_flags(lua_State *L, int index, FlagDesc *flagdesc,
1457 u32 *flags, u32 *flagmask)
1459 if (lua_isstring(L, index)) {
1460 std::string flagstr = lua_tostring(L, index);
1461 *flags = readFlagString(flagstr, flagdesc, flagmask);
1462 } else if (lua_istable(L, index)) {
1463 *flags = read_flags_table(L, index, flagdesc, flagmask);
1471 u32 read_flags_table(lua_State *L, int table, FlagDesc *flagdesc, u32 *flagmask)
1473 u32 flags = 0, mask = 0;
1474 char fnamebuf[64] = "no";
1476 for (int i = 0; flagdesc[i].name; i++) {
1479 if (getboolfield(L, table, flagdesc[i].name, result)) {
1480 mask |= flagdesc[i].flag;
1482 flags |= flagdesc[i].flag;
1485 strlcpy(fnamebuf + 2, flagdesc[i].name, sizeof(fnamebuf) - 2);
1486 if (getboolfield(L, table, fnamebuf, result))
1487 mask |= flagdesc[i].flag;
1496 void push_flags_string(lua_State *L, FlagDesc *flagdesc, u32 flags, u32 flagmask)
1498 std::string flagstring = writeFlagString(flags, flagdesc, flagmask);
1499 lua_pushlstring(L, flagstring.c_str(), flagstring.size());
1502 /******************************************************************************/
1503 /* Lua Stored data! */
1504 /******************************************************************************/
1506 /******************************************************************************/
1507 void read_groups(lua_State *L, int index, ItemGroupList &result)
1509 if (!lua_istable(L,index))
1515 while(lua_next(L, index) != 0){
1516 // key at index -2 and value at index -1
1517 std::string name = luaL_checkstring(L, -2);
1518 int rating = luaL_checkinteger(L, -1);
1519 result[name] = rating;
1520 // removes value, keeps key for next iteration
1525 /******************************************************************************/
1526 void push_groups(lua_State *L, const ItemGroupList &groups)
1529 for (const auto &group : groups) {
1530 lua_pushnumber(L, group.second);
1531 lua_setfield(L, -2, group.first.c_str());
1535 /******************************************************************************/
1536 void push_items(lua_State *L, const std::vector<ItemStack> &items)
1538 lua_createtable(L, items.size(), 0);
1539 for (u32 i = 0; i != items.size(); i++) {
1540 LuaItemStack::create(L, items[i]);
1541 lua_rawseti(L, -2, i + 1);
1545 /******************************************************************************/
1546 std::vector<ItemStack> read_items(lua_State *L, int index, Server *srv)
1549 index = lua_gettop(L) + 1 + index;
1551 std::vector<ItemStack> items;
1552 luaL_checktype(L, index, LUA_TTABLE);
1554 while (lua_next(L, index)) {
1555 s32 key = luaL_checkinteger(L, -2);
1557 throw LuaError("Invalid inventory list index");
1559 if (items.size() < (u32) key) {
1562 items[key - 1] = read_item(L, -1, srv->idef());
1568 /******************************************************************************/
1569 void luaentity_get(lua_State *L, u16 id)
1571 // Get luaentities[i]
1572 lua_getglobal(L, "core");
1573 lua_getfield(L, -1, "luaentities");
1574 luaL_checktype(L, -1, LUA_TTABLE);
1575 lua_pushnumber(L, id);
1576 lua_gettable(L, -2);
1577 lua_remove(L, -2); // Remove luaentities
1578 lua_remove(L, -2); // Remove core
1581 /******************************************************************************/
1582 bool read_noiseparams(lua_State *L, int index, NoiseParams *np)
1585 index = lua_gettop(L) + 1 + index;
1587 if (!lua_istable(L, index))
1590 getfloatfield(L, index, "offset", np->offset);
1591 getfloatfield(L, index, "scale", np->scale);
1592 getfloatfield(L, index, "persist", np->persist);
1593 getfloatfield(L, index, "persistence", np->persist);
1594 getfloatfield(L, index, "lacunarity", np->lacunarity);
1595 getintfield(L, index, "seed", np->seed);
1596 getintfield(L, index, "octaves", np->octaves);
1600 np->flags = getflagsfield(L, index, "flags", flagdesc_noiseparams,
1601 &flags, &flagmask) ? flags : NOISE_FLAG_DEFAULTS;
1603 lua_getfield(L, index, "spread");
1604 np->spread = read_v3f(L, -1);
1610 void push_noiseparams(lua_State *L, NoiseParams *np)
1613 push_float_string(L, np->offset);
1614 lua_setfield(L, -2, "offset");
1615 push_float_string(L, np->scale);
1616 lua_setfield(L, -2, "scale");
1617 push_float_string(L, np->persist);
1618 lua_setfield(L, -2, "persistence");
1619 push_float_string(L, np->lacunarity);
1620 lua_setfield(L, -2, "lacunarity");
1621 lua_pushnumber(L, np->seed);
1622 lua_setfield(L, -2, "seed");
1623 lua_pushnumber(L, np->octaves);
1624 lua_setfield(L, -2, "octaves");
1626 push_flags_string(L, flagdesc_noiseparams, np->flags,
1628 lua_setfield(L, -2, "flags");
1630 push_v3_float_string(L, np->spread);
1631 lua_setfield(L, -2, "spread");
1634 /******************************************************************************/
1635 // Returns depth of json value tree
1636 static int push_json_value_getdepth(const Json::Value &value)
1638 if (!value.isArray() && !value.isObject())
1642 for (const auto &it : value) {
1643 int elemdepth = push_json_value_getdepth(it);
1644 if (elemdepth > maxdepth)
1645 maxdepth = elemdepth;
1647 return maxdepth + 1;
1649 // Recursive function to convert JSON --> Lua table
1650 static bool push_json_value_helper(lua_State *L, const Json::Value &value,
1653 switch(value.type()) {
1654 case Json::nullValue:
1656 lua_pushvalue(L, nullindex);
1658 case Json::intValue:
1659 lua_pushinteger(L, value.asInt());
1661 case Json::uintValue:
1662 lua_pushinteger(L, value.asUInt());
1664 case Json::realValue:
1665 lua_pushnumber(L, value.asDouble());
1667 case Json::stringValue:
1669 const char *str = value.asCString();
1670 lua_pushstring(L, str ? str : "");
1673 case Json::booleanValue:
1674 lua_pushboolean(L, value.asInt());
1676 case Json::arrayValue:
1678 for (Json::Value::const_iterator it = value.begin();
1679 it != value.end(); ++it) {
1680 push_json_value_helper(L, *it, nullindex);
1681 lua_rawseti(L, -2, it.index() + 1);
1684 case Json::objectValue:
1686 for (Json::Value::const_iterator it = value.begin();
1687 it != value.end(); ++it) {
1688 #ifndef JSONCPP_STRING
1689 const char *str = it.memberName();
1690 lua_pushstring(L, str ? str : "");
1692 std::string str = it.name();
1693 lua_pushstring(L, str.c_str());
1695 push_json_value_helper(L, *it, nullindex);
1702 // converts JSON --> Lua table; returns false if lua stack limit exceeded
1703 // nullindex: Lua stack index of value to use in place of JSON null
1704 bool push_json_value(lua_State *L, const Json::Value &value, int nullindex)
1707 nullindex = lua_gettop(L) + 1 + nullindex;
1709 int depth = push_json_value_getdepth(value);
1711 // The maximum number of Lua stack slots used at each recursion level
1712 // of push_json_value_helper is 2, so make sure there a depth * 2 slots
1713 if (lua_checkstack(L, depth * 2))
1714 return push_json_value_helper(L, value, nullindex);
1719 // Converts Lua table --> JSON
1720 void read_json_value(lua_State *L, Json::Value &root, int index, u8 recursion)
1722 if (recursion > 16) {
1723 throw SerializationError("Maximum recursion depth exceeded");
1725 int type = lua_type(L, index);
1726 if (type == LUA_TBOOLEAN) {
1727 root = (bool) lua_toboolean(L, index);
1728 } else if (type == LUA_TNUMBER) {
1729 root = lua_tonumber(L, index);
1730 } else if (type == LUA_TSTRING) {
1732 const char *str = lua_tolstring(L, index, &len);
1733 root = std::string(str, len);
1734 } else if (type == LUA_TTABLE) {
1736 while (lua_next(L, index)) {
1737 // Key is at -2 and value is at -1
1739 read_json_value(L, value, lua_gettop(L), recursion + 1);
1741 Json::ValueType roottype = root.type();
1742 int keytype = lua_type(L, -1);
1743 if (keytype == LUA_TNUMBER) {
1744 lua_Number key = lua_tonumber(L, -1);
1745 if (roottype != Json::nullValue && roottype != Json::arrayValue) {
1746 throw SerializationError("Can't mix array and object values in JSON");
1747 } else if (key < 1) {
1748 throw SerializationError("Can't use zero-based or negative indexes in JSON");
1749 } else if (floor(key) != key) {
1750 throw SerializationError("Can't use indexes with a fractional part in JSON");
1752 root[(Json::ArrayIndex) key - 1] = value;
1753 } else if (keytype == LUA_TSTRING) {
1754 if (roottype != Json::nullValue && roottype != Json::objectValue) {
1755 throw SerializationError("Can't mix array and object values in JSON");
1757 root[lua_tostring(L, -1)] = value;
1759 throw SerializationError("Lua key to convert to JSON is not a string or number");
1762 } else if (type == LUA_TNIL) {
1763 root = Json::nullValue;
1765 throw SerializationError("Can only store booleans, numbers, strings, objects, arrays, and null in JSON");
1767 lua_pop(L, 1); // Pop value
1770 void push_pointed_thing(lua_State *L, const PointedThing &pointed, bool csm,
1774 if (pointed.type == POINTEDTHING_NODE) {
1775 lua_pushstring(L, "node");
1776 lua_setfield(L, -2, "type");
1777 push_v3s16(L, pointed.node_undersurface);
1778 lua_setfield(L, -2, "under");
1779 push_v3s16(L, pointed.node_abovesurface);
1780 lua_setfield(L, -2, "above");
1781 } else if (pointed.type == POINTEDTHING_OBJECT) {
1782 lua_pushstring(L, "object");
1783 lua_setfield(L, -2, "type");
1786 lua_pushinteger(L, pointed.object_id);
1787 lua_setfield(L, -2, "id");
1789 push_objectRef(L, pointed.object_id);
1790 lua_setfield(L, -2, "ref");
1793 lua_pushstring(L, "nothing");
1794 lua_setfield(L, -2, "type");
1796 if (hitpoint && (pointed.type != POINTEDTHING_NOTHING)) {
1797 push_v3f(L, pointed.intersection_point / BS); // convert to node coords
1798 lua_setfield(L, -2, "intersection_point");
1799 push_v3s16(L, pointed.intersection_normal);
1800 lua_setfield(L, -2, "intersection_normal");
1801 lua_pushinteger(L, pointed.box_id + 1); // change to Lua array index
1802 lua_setfield(L, -2, "box_id");
1806 void push_objectRef(lua_State *L, const u16 id)
1808 // Get core.object_refs[i]
1809 lua_getglobal(L, "core");
1810 lua_getfield(L, -1, "object_refs");
1811 luaL_checktype(L, -1, LUA_TTABLE);
1812 lua_pushnumber(L, id);
1813 lua_gettable(L, -2);
1814 lua_remove(L, -2); // object_refs
1815 lua_remove(L, -2); // core
1818 void read_hud_element(lua_State *L, HudElement *elem)
1820 elem->type = (HudElementType)getenumfield(L, 2, "hud_elem_type",
1821 es_HudElementType, HUD_ELEM_TEXT);
1823 lua_getfield(L, 2, "position");
1824 elem->pos = lua_istable(L, -1) ? read_v2f(L, -1) : v2f();
1827 lua_getfield(L, 2, "scale");
1828 elem->scale = lua_istable(L, -1) ? read_v2f(L, -1) : v2f();
1831 lua_getfield(L, 2, "size");
1832 elem->size = lua_istable(L, -1) ? read_v2s32(L, -1) : v2s32();
1835 elem->name = getstringfield_default(L, 2, "name", "");
1836 elem->text = getstringfield_default(L, 2, "text", "");
1837 elem->number = getintfield_default(L, 2, "number", 0);
1838 elem->item = getintfield_default(L, 2, "item", 0);
1839 elem->dir = getintfield_default(L, 2, "direction", 0);
1841 // Deprecated, only for compatibility's sake
1843 elem->dir = getintfield_default(L, 2, "dir", 0);
1845 lua_getfield(L, 2, "alignment");
1846 elem->align = lua_istable(L, -1) ? read_v2f(L, -1) : v2f();
1849 lua_getfield(L, 2, "offset");
1850 elem->offset = lua_istable(L, -1) ? read_v2f(L, -1) : v2f();
1853 lua_getfield(L, 2, "world_pos");
1854 elem->world_pos = lua_istable(L, -1) ? read_v3f(L, -1) : v3f();
1857 /* check for known deprecated element usage */
1858 if ((elem->type == HUD_ELEM_STATBAR) && (elem->size == v2s32()))
1859 log_deprecated(L,"Deprecated usage of statbar without size!");
1862 void push_hud_element(lua_State *L, HudElement *elem)
1866 lua_pushstring(L, es_HudElementType[(u8)elem->type].str);
1867 lua_setfield(L, -2, "type");
1869 push_v2f(L, elem->pos);
1870 lua_setfield(L, -2, "position");
1872 lua_pushstring(L, elem->name.c_str());
1873 lua_setfield(L, -2, "name");
1875 push_v2f(L, elem->scale);
1876 lua_setfield(L, -2, "scale");
1878 lua_pushstring(L, elem->text.c_str());
1879 lua_setfield(L, -2, "text");
1881 lua_pushnumber(L, elem->number);
1882 lua_setfield(L, -2, "number");
1884 lua_pushnumber(L, elem->item);
1885 lua_setfield(L, -2, "item");
1887 lua_pushnumber(L, elem->dir);
1888 lua_setfield(L, -2, "direction");
1890 push_v2f(L, elem->offset);
1891 lua_setfield(L, -2, "offset");
1893 push_v2f(L, elem->align);
1894 lua_setfield(L, -2, "alignment");
1896 push_v2s32(L, elem->size);
1897 lua_setfield(L, -2, "size");
1899 // Deprecated, only for compatibility's sake
1900 lua_pushnumber(L, elem->dir);
1901 lua_setfield(L, -2, "dir");
1903 push_v3f(L, elem->world_pos);
1904 lua_setfield(L, -2, "world_pos");
1907 HudElementStat read_hud_change(lua_State *L, HudElement *elem, void **value)
1909 HudElementStat stat = HUD_STAT_NUMBER;
1910 if (lua_isstring(L, 3)) {
1912 std::string statstr = lua_tostring(L, 3);
1913 stat = string_to_enum(es_HudElementStat, statint, statstr) ?
1914 (HudElementStat)statint : stat;
1919 elem->pos = read_v2f(L, 4);
1920 *value = &elem->pos;
1923 elem->name = luaL_checkstring(L, 4);
1924 *value = &elem->name;
1926 case HUD_STAT_SCALE:
1927 elem->scale = read_v2f(L, 4);
1928 *value = &elem->scale;
1931 elem->text = luaL_checkstring(L, 4);
1932 *value = &elem->text;
1934 case HUD_STAT_NUMBER:
1935 elem->number = luaL_checknumber(L, 4);
1936 *value = &elem->number;
1939 elem->item = luaL_checknumber(L, 4);
1940 *value = &elem->item;
1943 elem->dir = luaL_checknumber(L, 4);
1944 *value = &elem->dir;
1946 case HUD_STAT_ALIGN:
1947 elem->align = read_v2f(L, 4);
1948 *value = &elem->align;
1950 case HUD_STAT_OFFSET:
1951 elem->offset = read_v2f(L, 4);
1952 *value = &elem->offset;
1954 case HUD_STAT_WORLD_POS:
1955 elem->world_pos = read_v3f(L, 4);
1956 *value = &elem->world_pos;
1959 elem->size = read_v2s32(L, 4);
1960 *value = &elem->size;