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 "collision.h"
25 #include "cpp_api/s_node.h"
26 #include "lua_api/l_object.h"
27 #include "lua_api/l_item.h"
28 #include "common/c_internal.h"
33 #include "mapgen/mg_schematic.h"
35 #include "server/player_sao.h"
36 #include "util/pointedthing.h"
37 #include "debug.h" // For FATAL_ERROR
38 #include <json/json.h>
40 struct EnumString es_TileAnimationType[] =
43 {TAT_VERTICAL_FRAMES, "vertical_frames"},
44 {TAT_SHEET_2D, "sheet_2d"},
48 /******************************************************************************/
49 void read_item_definition(lua_State* L, int index,
50 const ItemDefinition &default_def, ItemDefinition &def)
53 index = lua_gettop(L) + 1 + index;
55 def.type = (ItemType)getenumfield(L, index, "type",
56 es_ItemType, ITEM_NONE);
57 getstringfield(L, index, "name", def.name);
58 getstringfield(L, index, "description", def.description);
59 getstringfield(L, index, "short_description", def.short_description);
60 getstringfield(L, index, "inventory_image", def.inventory_image);
61 getstringfield(L, index, "inventory_overlay", def.inventory_overlay);
62 getstringfield(L, index, "wield_image", def.wield_image);
63 getstringfield(L, index, "wield_overlay", def.wield_overlay);
64 getstringfield(L, index, "palette", def.palette_image);
67 lua_getfield(L, index, "color");
68 read_color(L, -1, &def.color);
71 lua_getfield(L, index, "wield_scale");
72 if(lua_istable(L, -1)){
73 def.wield_scale = check_v3f(L, -1);
77 int stack_max = getintfield_default(L, index, "stack_max", def.stack_max);
78 def.stack_max = rangelim(stack_max, 1, U16_MAX);
80 lua_getfield(L, index, "on_use");
81 def.usable = lua_isfunction(L, -1);
84 getboolfield(L, index, "liquids_pointable", def.liquids_pointable);
86 lua_getfield(L, index, "tool_capabilities");
87 if(lua_istable(L, -1)){
88 def.tool_capabilities = new ToolCapabilities(
89 read_tool_capabilities(L, -1));
92 // If name is "" (hand), ensure there are ToolCapabilities
93 // because it will be looked up there whenever any other item has
94 // no ToolCapabilities
95 if (def.name.empty() && def.tool_capabilities == NULL){
96 def.tool_capabilities = new ToolCapabilities();
99 lua_getfield(L, index, "groups");
100 read_groups(L, -1, def.groups);
103 lua_getfield(L, index, "sounds");
104 if (!lua_isnil(L, -1)) {
105 luaL_checktype(L, -1, LUA_TTABLE);
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, i.short_description.c_str());
144 lua_setfield(L, -2, "short_description");
145 lua_pushstring(L, type.c_str());
146 lua_setfield(L, -2, "type");
147 lua_pushstring(L, i.inventory_image.c_str());
148 lua_setfield(L, -2, "inventory_image");
149 lua_pushstring(L, i.inventory_overlay.c_str());
150 lua_setfield(L, -2, "inventory_overlay");
151 lua_pushstring(L, i.wield_image.c_str());
152 lua_setfield(L, -2, "wield_image");
153 lua_pushstring(L, i.wield_overlay.c_str());
154 lua_setfield(L, -2, "wield_overlay");
155 lua_pushstring(L, i.palette_image.c_str());
156 lua_setfield(L, -2, "palette_image");
157 push_ARGB8(L, i.color);
158 lua_setfield(L, -2, "color");
159 push_v3f(L, i.wield_scale);
160 lua_setfield(L, -2, "wield_scale");
161 lua_pushinteger(L, i.stack_max);
162 lua_setfield(L, -2, "stack_max");
163 lua_pushboolean(L, i.usable);
164 lua_setfield(L, -2, "usable");
165 lua_pushboolean(L, i.liquids_pointable);
166 lua_setfield(L, -2, "liquids_pointable");
167 if (i.tool_capabilities) {
168 push_tool_capabilities(L, *i.tool_capabilities);
169 lua_setfield(L, -2, "tool_capabilities");
171 push_groups(L, i.groups);
172 lua_setfield(L, -2, "groups");
173 push_soundspec(L, i.sound_place);
174 lua_setfield(L, -2, "sound_place");
175 push_soundspec(L, i.sound_place_failed);
176 lua_setfield(L, -2, "sound_place_failed");
177 lua_pushstring(L, i.node_placement_prediction.c_str());
178 lua_setfield(L, -2, "node_placement_prediction");
181 /******************************************************************************/
182 void read_object_properties(lua_State *L, int index,
183 ServerActiveObject *sao, ObjectProperties *prop, IItemDefManager *idef)
186 index = lua_gettop(L) + 1 + index;
187 if (lua_isnil(L, index))
190 luaL_checktype(L, -1, LUA_TTABLE);
193 if (getintfield(L, -1, "hp_max", hp_max)) {
194 prop->hp_max = (u16)rangelim(hp_max, 0, U16_MAX);
196 if (prop->hp_max < sao->getHP()) {
197 PlayerHPChangeReason reason(PlayerHPChangeReason::SET_HP);
198 sao->setHP(prop->hp_max, reason);
199 if (sao->getType() == ACTIVEOBJECT_TYPE_PLAYER)
200 sao->getEnv()->getGameDef()->SendPlayerHPOrDie((PlayerSAO *)sao, reason);
204 if (getintfield(L, -1, "breath_max", prop->breath_max)) {
205 if (sao->getType() == ACTIVEOBJECT_TYPE_PLAYER) {
206 PlayerSAO *player = (PlayerSAO *)sao;
207 if (prop->breath_max < player->getBreath())
208 player->setBreath(prop->breath_max);
211 getboolfield(L, -1, "physical", prop->physical);
212 getboolfield(L, -1, "collide_with_objects", prop->collideWithObjects);
214 lua_getfield(L, -1, "collisionbox");
215 bool collisionbox_defined = lua_istable(L, -1);
216 if (collisionbox_defined)
217 prop->collisionbox = read_aabb3f(L, -1, 1.0);
220 lua_getfield(L, -1, "selectionbox");
221 if (lua_istable(L, -1))
222 prop->selectionbox = read_aabb3f(L, -1, 1.0);
223 else if (collisionbox_defined)
224 prop->selectionbox = prop->collisionbox;
227 getboolfield(L, -1, "pointable", prop->pointable);
228 getstringfield(L, -1, "visual", prop->visual);
230 getstringfield(L, -1, "mesh", prop->mesh);
232 lua_getfield(L, -1, "visual_size");
233 if (lua_istable(L, -1)) {
234 // Backwards compatibility: Also accept { x = ?, y = ? }
235 v2f scale_xy = read_v2f(L, -1);
237 f32 scale_z = scale_xy.X;
238 lua_getfield(L, -1, "z");
239 if (lua_isnumber(L, -1))
240 scale_z = lua_tonumber(L, -1);
243 prop->visual_size = v3f(scale_xy.X, scale_xy.Y, scale_z);
247 lua_getfield(L, -1, "textures");
248 if(lua_istable(L, -1)){
249 prop->textures.clear();
250 int table = lua_gettop(L);
252 while(lua_next(L, table) != 0){
253 // key at index -2 and value at index -1
254 if(lua_isstring(L, -1))
255 prop->textures.emplace_back(lua_tostring(L, -1));
257 prop->textures.emplace_back("");
258 // removes value, keeps key for next iteration
264 lua_getfield(L, -1, "colors");
265 if (lua_istable(L, -1)) {
266 int table = lua_gettop(L);
267 prop->colors.clear();
268 for (lua_pushnil(L); lua_next(L, table); lua_pop(L, 1)) {
269 video::SColor color(255, 255, 255, 255);
270 read_color(L, -1, &color);
271 prop->colors.push_back(color);
276 lua_getfield(L, -1, "spritediv");
277 if(lua_istable(L, -1))
278 prop->spritediv = read_v2s16(L, -1);
281 lua_getfield(L, -1, "initial_sprite_basepos");
282 if(lua_istable(L, -1))
283 prop->initial_sprite_basepos = read_v2s16(L, -1);
286 getboolfield(L, -1, "is_visible", prop->is_visible);
287 getboolfield(L, -1, "makes_footstep_sound", prop->makes_footstep_sound);
288 if (getfloatfield(L, -1, "stepheight", prop->stepheight))
289 prop->stepheight *= BS;
290 getfloatfield(L, -1, "eye_height", prop->eye_height);
292 getfloatfield(L, -1, "automatic_rotate", prop->automatic_rotate);
293 lua_getfield(L, -1, "automatic_face_movement_dir");
294 if (lua_isnumber(L, -1)) {
295 prop->automatic_face_movement_dir = true;
296 prop->automatic_face_movement_dir_offset = luaL_checknumber(L, -1);
297 } else if (lua_isboolean(L, -1)) {
298 prop->automatic_face_movement_dir = lua_toboolean(L, -1);
299 prop->automatic_face_movement_dir_offset = 0.0;
302 getboolfield(L, -1, "backface_culling", prop->backface_culling);
303 getintfield(L, -1, "glow", prop->glow);
305 getstringfield(L, -1, "nametag", prop->nametag);
306 lua_getfield(L, -1, "nametag_color");
307 if (!lua_isnil(L, -1)) {
308 video::SColor color = prop->nametag_color;
309 if (read_color(L, -1, &color))
310 prop->nametag_color = color;
314 lua_getfield(L, -1, "automatic_face_movement_max_rotation_per_sec");
315 if (lua_isnumber(L, -1)) {
316 prop->automatic_face_movement_max_rotation_per_sec = luaL_checknumber(L, -1);
320 getstringfield(L, -1, "infotext", prop->infotext);
321 getboolfield(L, -1, "static_save", prop->static_save);
323 lua_getfield(L, -1, "wield_item");
324 if (!lua_isnil(L, -1))
325 prop->wield_item = read_item(L, -1, idef).getItemString();
328 getfloatfield(L, -1, "zoom_fov", prop->zoom_fov);
329 getboolfield(L, -1, "use_texture_alpha", prop->use_texture_alpha);
330 getboolfield(L, -1, "shaded", prop->shaded);
331 getboolfield(L, -1, "show_on_minimap", prop->show_on_minimap);
333 getstringfield(L, -1, "damage_texture_modifier", prop->damage_texture_modifier);
336 /******************************************************************************/
337 void push_object_properties(lua_State *L, ObjectProperties *prop)
340 lua_pushnumber(L, prop->hp_max);
341 lua_setfield(L, -2, "hp_max");
342 lua_pushnumber(L, prop->breath_max);
343 lua_setfield(L, -2, "breath_max");
344 lua_pushboolean(L, prop->physical);
345 lua_setfield(L, -2, "physical");
346 lua_pushboolean(L, prop->collideWithObjects);
347 lua_setfield(L, -2, "collide_with_objects");
348 push_aabb3f(L, prop->collisionbox);
349 lua_setfield(L, -2, "collisionbox");
350 push_aabb3f(L, prop->selectionbox);
351 lua_setfield(L, -2, "selectionbox");
352 lua_pushboolean(L, prop->pointable);
353 lua_setfield(L, -2, "pointable");
354 lua_pushlstring(L, prop->visual.c_str(), prop->visual.size());
355 lua_setfield(L, -2, "visual");
356 lua_pushlstring(L, prop->mesh.c_str(), prop->mesh.size());
357 lua_setfield(L, -2, "mesh");
358 push_v3f(L, prop->visual_size);
359 lua_setfield(L, -2, "visual_size");
361 lua_createtable(L, prop->textures.size(), 0);
363 for (const std::string &texture : prop->textures) {
364 lua_pushlstring(L, texture.c_str(), texture.size());
365 lua_rawseti(L, -2, i++);
367 lua_setfield(L, -2, "textures");
369 lua_createtable(L, prop->colors.size(), 0);
371 for (const video::SColor &color : prop->colors) {
372 push_ARGB8(L, color);
373 lua_rawseti(L, -2, i++);
375 lua_setfield(L, -2, "colors");
377 push_v2s16(L, prop->spritediv);
378 lua_setfield(L, -2, "spritediv");
379 push_v2s16(L, prop->initial_sprite_basepos);
380 lua_setfield(L, -2, "initial_sprite_basepos");
381 lua_pushboolean(L, prop->is_visible);
382 lua_setfield(L, -2, "is_visible");
383 lua_pushboolean(L, prop->makes_footstep_sound);
384 lua_setfield(L, -2, "makes_footstep_sound");
385 lua_pushnumber(L, prop->stepheight / BS);
386 lua_setfield(L, -2, "stepheight");
387 lua_pushnumber(L, prop->eye_height);
388 lua_setfield(L, -2, "eye_height");
389 lua_pushnumber(L, prop->automatic_rotate);
390 lua_setfield(L, -2, "automatic_rotate");
391 if (prop->automatic_face_movement_dir)
392 lua_pushnumber(L, prop->automatic_face_movement_dir_offset);
394 lua_pushboolean(L, false);
395 lua_setfield(L, -2, "automatic_face_movement_dir");
396 lua_pushboolean(L, prop->backface_culling);
397 lua_setfield(L, -2, "backface_culling");
398 lua_pushnumber(L, prop->glow);
399 lua_setfield(L, -2, "glow");
400 lua_pushlstring(L, prop->nametag.c_str(), prop->nametag.size());
401 lua_setfield(L, -2, "nametag");
402 push_ARGB8(L, prop->nametag_color);
403 lua_setfield(L, -2, "nametag_color");
404 lua_pushnumber(L, prop->automatic_face_movement_max_rotation_per_sec);
405 lua_setfield(L, -2, "automatic_face_movement_max_rotation_per_sec");
406 lua_pushlstring(L, prop->infotext.c_str(), prop->infotext.size());
407 lua_setfield(L, -2, "infotext");
408 lua_pushboolean(L, prop->static_save);
409 lua_setfield(L, -2, "static_save");
410 lua_pushlstring(L, prop->wield_item.c_str(), prop->wield_item.size());
411 lua_setfield(L, -2, "wield_item");
412 lua_pushnumber(L, prop->zoom_fov);
413 lua_setfield(L, -2, "zoom_fov");
414 lua_pushboolean(L, prop->use_texture_alpha);
415 lua_setfield(L, -2, "use_texture_alpha");
416 lua_pushboolean(L, prop->shaded);
417 lua_setfield(L, -2, "shaded");
418 lua_pushlstring(L, prop->damage_texture_modifier.c_str(), prop->damage_texture_modifier.size());
419 lua_setfield(L, -2, "damage_texture_modifier");
420 lua_pushboolean(L, prop->show_on_minimap);
421 lua_setfield(L, -2, "show_on_minimap");
424 /******************************************************************************/
425 TileDef read_tiledef(lua_State *L, int index, u8 drawtype)
428 index = lua_gettop(L) + 1 + index;
432 bool default_tiling = true;
433 bool default_culling = true;
436 case NDT_PLANTLIKE_ROOTED:
438 default_tiling = false;
439 // "break" is omitted here intentionaly, as PLANTLIKE
440 // FIRELIKE drawtype both should default to having
441 // backface_culling to false.
444 default_culling = false;
450 // key at index -2 and value at index
451 if(lua_isstring(L, index)){
452 // "default_lava.png"
453 tiledef.name = lua_tostring(L, index);
454 tiledef.tileable_vertical = default_tiling;
455 tiledef.tileable_horizontal = default_tiling;
456 tiledef.backface_culling = default_culling;
458 else if(lua_istable(L, index))
460 // name="default_lava.png"
462 getstringfield(L, index, "name", tiledef.name);
463 getstringfield(L, index, "image", tiledef.name); // MaterialSpec compat.
464 tiledef.backface_culling = getboolfield_default(
465 L, index, "backface_culling", default_culling);
466 tiledef.tileable_horizontal = getboolfield_default(
467 L, index, "tileable_horizontal", default_tiling);
468 tiledef.tileable_vertical = getboolfield_default(
469 L, index, "tileable_vertical", default_tiling);
470 std::string align_style;
471 if (getstringfield(L, index, "align_style", align_style)) {
472 if (align_style == "user")
473 tiledef.align_style = ALIGN_STYLE_USER_DEFINED;
474 else if (align_style == "world")
475 tiledef.align_style = ALIGN_STYLE_WORLD;
477 tiledef.align_style = ALIGN_STYLE_NODE;
479 tiledef.scale = getintfield_default(L, index, "scale", 0);
481 lua_getfield(L, index, "color");
482 tiledef.has_color = read_color(L, -1, &tiledef.color);
485 lua_getfield(L, index, "animation");
486 tiledef.animation = read_animation_definition(L, -1);
493 /******************************************************************************/
494 void read_content_features(lua_State *L, ContentFeatures &f, int index)
497 index = lua_gettop(L) + 1 + index;
499 /* Cache existence of some callbacks */
500 lua_getfield(L, index, "on_construct");
501 if(!lua_isnil(L, -1)) f.has_on_construct = true;
503 lua_getfield(L, index, "on_destruct");
504 if(!lua_isnil(L, -1)) f.has_on_destruct = true;
506 lua_getfield(L, index, "after_destruct");
507 if(!lua_isnil(L, -1)) f.has_after_destruct = true;
510 lua_getfield(L, index, "on_rightclick");
511 f.rightclickable = lua_isfunction(L, -1);
515 getstringfield(L, index, "name", f.name);
518 lua_getfield(L, index, "groups");
519 read_groups(L, -1, f.groups);
522 /* Visual definition */
524 f.drawtype = (NodeDrawType)getenumfield(L, index, "drawtype",
525 ScriptApiNode::es_DrawType,NDT_NORMAL);
526 getfloatfield(L, index, "visual_scale", f.visual_scale);
528 /* Meshnode model filename */
529 getstringfield(L, index, "mesh", f.mesh);
532 lua_getfield(L, index, "tiles");
533 // If nil, try the deprecated name "tile_images" instead
534 if(lua_isnil(L, -1)){
536 warn_if_field_exists(L, index, "tile_images",
537 "Deprecated; new name is \"tiles\".");
538 lua_getfield(L, index, "tile_images");
540 if(lua_istable(L, -1)){
541 int table = lua_gettop(L);
544 while(lua_next(L, table) != 0){
545 // Read tiledef from value
546 f.tiledef[i] = read_tiledef(L, -1, f.drawtype);
547 // removes value, keeps key for next iteration
555 // Copy last value to all remaining textures
557 TileDef lasttile = f.tiledef[i-1];
559 f.tiledef[i] = lasttile;
566 // overlay_tiles = {}
567 lua_getfield(L, index, "overlay_tiles");
568 if (lua_istable(L, -1)) {
569 int table = lua_gettop(L);
572 while (lua_next(L, table) != 0) {
573 // Read tiledef from value
574 f.tiledef_overlay[i] = read_tiledef(L, -1, f.drawtype);
575 // removes value, keeps key for next iteration
583 // Copy last value to all remaining textures
585 TileDef lasttile = f.tiledef_overlay[i - 1];
587 f.tiledef_overlay[i] = lasttile;
594 // special_tiles = {}
595 lua_getfield(L, index, "special_tiles");
596 // If nil, try the deprecated name "special_materials" instead
597 if(lua_isnil(L, -1)){
599 warn_if_field_exists(L, index, "special_materials",
600 "Deprecated; new name is \"special_tiles\".");
601 lua_getfield(L, index, "special_materials");
603 if(lua_istable(L, -1)){
604 int table = lua_gettop(L);
607 while(lua_next(L, table) != 0){
608 // Read tiledef from value
609 f.tiledef_special[i] = read_tiledef(L, -1, f.drawtype);
610 // removes value, keeps key for next iteration
613 if(i==CF_SPECIAL_COUNT){
621 /* alpha & use_texture_alpha */
622 // This is a bit complicated due to compatibility
624 f.setDefaultAlphaMode();
626 warn_if_field_exists(L, index, "alpha",
627 "Obsolete, only limited compatibility provided; "
628 "replaced by \"use_texture_alpha\"");
629 if (getintfield_default(L, index, "alpha", 255) != 255)
630 f.alpha = ALPHAMODE_BLEND;
632 lua_getfield(L, index, "use_texture_alpha");
633 if (lua_isboolean(L, -1)) {
634 warn_if_field_exists(L, index, "use_texture_alpha",
635 "Boolean values are deprecated; use the new choices");
636 if (lua_toboolean(L, -1))
637 f.alpha = (f.drawtype == NDT_NORMAL) ? ALPHAMODE_CLIP : ALPHAMODE_BLEND;
638 } else if (check_field_or_nil(L, -1, LUA_TSTRING, "use_texture_alpha")) {
639 int result = f.alpha;
640 string_to_enum(ScriptApiNode::es_TextureAlphaMode, result,
641 std::string(lua_tostring(L, -1)));
642 f.alpha = static_cast<enum AlphaMode>(result);
648 lua_getfield(L, index, "color");
649 read_color(L, -1, &f.color);
652 getstringfield(L, index, "palette", f.palette_name);
654 lua_getfield(L, index, "post_effect_color");
655 read_color(L, -1, &f.post_effect_color);
658 f.param_type = (ContentParamType)getenumfield(L, index, "paramtype",
659 ScriptApiNode::es_ContentParamType, CPT_NONE);
660 f.param_type_2 = (ContentParamType2)getenumfield(L, index, "paramtype2",
661 ScriptApiNode::es_ContentParamType2, CPT2_NONE);
663 if (!f.palette_name.empty() &&
664 !(f.param_type_2 == CPT2_COLOR ||
665 f.param_type_2 == CPT2_COLORED_FACEDIR ||
666 f.param_type_2 == CPT2_COLORED_WALLMOUNTED))
667 warningstream << "Node " << f.name.c_str()
668 << " has a palette, but not a suitable paramtype2." << std::endl;
670 // True for all ground-like things like stone and mud, false for eg. trees
671 getboolfield(L, index, "is_ground_content", f.is_ground_content);
672 f.light_propagates = (f.param_type == CPT_LIGHT);
673 getboolfield(L, index, "sunlight_propagates", f.sunlight_propagates);
674 // This is used for collision detection.
675 // Also for general solidness queries.
676 getboolfield(L, index, "walkable", f.walkable);
677 // Player can point to these
678 getboolfield(L, index, "pointable", f.pointable);
679 // Player can dig these
680 getboolfield(L, index, "diggable", f.diggable);
681 // Player can climb these
682 getboolfield(L, index, "climbable", f.climbable);
683 // Player can build on these
684 getboolfield(L, index, "buildable_to", f.buildable_to);
685 // Liquids flow into and replace node
686 getboolfield(L, index, "floodable", f.floodable);
687 // Whether the node is non-liquid, source liquid or flowing liquid
688 f.liquid_type = (LiquidType)getenumfield(L, index, "liquidtype",
689 ScriptApiNode::es_LiquidType, LIQUID_NONE);
690 // If the content is liquid, this is the flowing version of the liquid.
691 getstringfield(L, index, "liquid_alternative_flowing",
692 f.liquid_alternative_flowing);
693 // If the content is liquid, this is the source version of the liquid.
694 getstringfield(L, index, "liquid_alternative_source",
695 f.liquid_alternative_source);
696 // Viscosity for fluid flow, ranging from 1 to 7, with
697 // 1 giving almost instantaneous propagation and 7 being
698 // the slowest possible
699 f.liquid_viscosity = getintfield_default(L, index,
700 "liquid_viscosity", f.liquid_viscosity);
701 f.liquid_range = getintfield_default(L, index,
702 "liquid_range", f.liquid_range);
703 f.leveled = getintfield_default(L, index, "leveled", f.leveled);
704 f.leveled_max = getintfield_default(L, index,
705 "leveled_max", f.leveled_max);
707 getboolfield(L, index, "liquid_renewable", f.liquid_renewable);
708 f.drowning = getintfield_default(L, index,
709 "drowning", f.drowning);
710 // Amount of light the node emits
711 f.light_source = getintfield_default(L, index,
712 "light_source", f.light_source);
713 if (f.light_source > LIGHT_MAX) {
714 warningstream << "Node " << f.name.c_str()
715 << " had greater light_source than " << LIGHT_MAX
716 << ", it was reduced." << std::endl;
717 f.light_source = LIGHT_MAX;
719 f.damage_per_second = getintfield_default(L, index,
720 "damage_per_second", f.damage_per_second);
722 lua_getfield(L, index, "node_box");
723 if(lua_istable(L, -1))
724 f.node_box = read_nodebox(L, -1);
727 lua_getfield(L, index, "connects_to");
728 if (lua_istable(L, -1)) {
729 int table = lua_gettop(L);
731 while (lua_next(L, table) != 0) {
733 f.connects_to.emplace_back(lua_tostring(L, -1));
739 lua_getfield(L, index, "connect_sides");
740 if (lua_istable(L, -1)) {
741 int table = lua_gettop(L);
743 while (lua_next(L, table) != 0) {
745 std::string side(lua_tostring(L, -1));
746 // Note faces are flipped to make checking easier
748 f.connect_sides |= 2;
749 else if (side == "bottom")
750 f.connect_sides |= 1;
751 else if (side == "front")
752 f.connect_sides |= 16;
753 else if (side == "left")
754 f.connect_sides |= 32;
755 else if (side == "back")
756 f.connect_sides |= 4;
757 else if (side == "right")
758 f.connect_sides |= 8;
760 warningstream << "Unknown value for \"connect_sides\": "
761 << side << std::endl;
767 lua_getfield(L, index, "selection_box");
768 if(lua_istable(L, -1))
769 f.selection_box = read_nodebox(L, -1);
772 lua_getfield(L, index, "collision_box");
773 if(lua_istable(L, -1))
774 f.collision_box = read_nodebox(L, -1);
777 f.waving = getintfield_default(L, index,
780 // Set to true if paramtype used to be 'facedir_simple'
781 getboolfield(L, index, "legacy_facedir_simple", f.legacy_facedir_simple);
782 // Set to true if wall_mounted used to be set to true
783 getboolfield(L, index, "legacy_wallmounted", f.legacy_wallmounted);
786 lua_getfield(L, index, "sounds");
787 if(lua_istable(L, -1)){
788 lua_getfield(L, -1, "footstep");
789 read_soundspec(L, -1, f.sound_footstep);
791 lua_getfield(L, -1, "dig");
792 read_soundspec(L, -1, f.sound_dig);
794 lua_getfield(L, -1, "dug");
795 read_soundspec(L, -1, f.sound_dug);
800 // Node immediately placed by client when node is dug
801 getstringfield(L, index, "node_dig_prediction",
802 f.node_dig_prediction);
806 void push_content_features(lua_State *L, const ContentFeatures &c)
808 std::string paramtype(ScriptApiNode::es_ContentParamType[(int)c.param_type].str);
809 std::string paramtype2(ScriptApiNode::es_ContentParamType2[(int)c.param_type_2].str);
810 std::string drawtype(ScriptApiNode::es_DrawType[(int)c.drawtype].str);
811 std::string liquid_type(ScriptApiNode::es_LiquidType[(int)c.liquid_type].str);
813 /* Missing "tiles" because I don't see a usecase (at least not yet). */
816 lua_pushboolean(L, c.has_on_construct);
817 lua_setfield(L, -2, "has_on_construct");
818 lua_pushboolean(L, c.has_on_destruct);
819 lua_setfield(L, -2, "has_on_destruct");
820 lua_pushboolean(L, c.has_after_destruct);
821 lua_setfield(L, -2, "has_after_destruct");
822 lua_pushstring(L, c.name.c_str());
823 lua_setfield(L, -2, "name");
824 push_groups(L, c.groups);
825 lua_setfield(L, -2, "groups");
826 lua_pushstring(L, paramtype.c_str());
827 lua_setfield(L, -2, "paramtype");
828 lua_pushstring(L, paramtype2.c_str());
829 lua_setfield(L, -2, "paramtype2");
830 lua_pushstring(L, drawtype.c_str());
831 lua_setfield(L, -2, "drawtype");
832 if (!c.mesh.empty()) {
833 lua_pushstring(L, c.mesh.c_str());
834 lua_setfield(L, -2, "mesh");
837 push_ARGB8(L, c.minimap_color); // I know this is not set-able w/ register_node,
838 lua_setfield(L, -2, "minimap_color"); // but the people need to know!
840 lua_pushnumber(L, c.visual_scale);
841 lua_setfield(L, -2, "visual_scale");
842 lua_pushnumber(L, c.alpha);
843 lua_setfield(L, -2, "alpha");
844 if (!c.palette_name.empty()) {
845 push_ARGB8(L, c.color);
846 lua_setfield(L, -2, "color");
848 lua_pushstring(L, c.palette_name.c_str());
849 lua_setfield(L, -2, "palette_name");
851 push_palette(L, c.palette);
852 lua_setfield(L, -2, "palette");
854 lua_pushnumber(L, c.waving);
855 lua_setfield(L, -2, "waving");
856 lua_pushnumber(L, c.connect_sides);
857 lua_setfield(L, -2, "connect_sides");
859 lua_createtable(L, c.connects_to.size(), 0);
861 for (const std::string &it : c.connects_to) {
862 lua_pushlstring(L, it.c_str(), it.size());
863 lua_rawseti(L, -2, i++);
865 lua_setfield(L, -2, "connects_to");
867 push_ARGB8(L, c.post_effect_color);
868 lua_setfield(L, -2, "post_effect_color");
869 lua_pushnumber(L, c.leveled);
870 lua_setfield(L, -2, "leveled");
871 lua_pushnumber(L, c.leveled_max);
872 lua_setfield(L, -2, "leveled_max");
873 lua_pushboolean(L, c.sunlight_propagates);
874 lua_setfield(L, -2, "sunlight_propagates");
875 lua_pushnumber(L, c.light_source);
876 lua_setfield(L, -2, "light_source");
877 lua_pushboolean(L, c.is_ground_content);
878 lua_setfield(L, -2, "is_ground_content");
879 lua_pushboolean(L, c.walkable);
880 lua_setfield(L, -2, "walkable");
881 lua_pushboolean(L, c.pointable);
882 lua_setfield(L, -2, "pointable");
883 lua_pushboolean(L, c.diggable);
884 lua_setfield(L, -2, "diggable");
885 lua_pushboolean(L, c.climbable);
886 lua_setfield(L, -2, "climbable");
887 lua_pushboolean(L, c.buildable_to);
888 lua_setfield(L, -2, "buildable_to");
889 lua_pushboolean(L, c.rightclickable);
890 lua_setfield(L, -2, "rightclickable");
891 lua_pushnumber(L, c.damage_per_second);
892 lua_setfield(L, -2, "damage_per_second");
894 lua_pushstring(L, liquid_type.c_str());
895 lua_setfield(L, -2, "liquid_type");
896 lua_pushstring(L, c.liquid_alternative_flowing.c_str());
897 lua_setfield(L, -2, "liquid_alternative_flowing");
898 lua_pushstring(L, c.liquid_alternative_source.c_str());
899 lua_setfield(L, -2, "liquid_alternative_source");
900 lua_pushnumber(L, c.liquid_viscosity);
901 lua_setfield(L, -2, "liquid_viscosity");
902 lua_pushboolean(L, c.liquid_renewable);
903 lua_setfield(L, -2, "liquid_renewable");
904 lua_pushnumber(L, c.liquid_range);
905 lua_setfield(L, -2, "liquid_range");
907 lua_pushnumber(L, c.drowning);
908 lua_setfield(L, -2, "drowning");
909 lua_pushboolean(L, c.floodable);
910 lua_setfield(L, -2, "floodable");
911 push_nodebox(L, c.node_box);
912 lua_setfield(L, -2, "node_box");
913 push_nodebox(L, c.selection_box);
914 lua_setfield(L, -2, "selection_box");
915 push_nodebox(L, c.collision_box);
916 lua_setfield(L, -2, "collision_box");
918 push_soundspec(L, c.sound_footstep);
919 lua_setfield(L, -2, "sound_footstep");
920 push_soundspec(L, c.sound_dig);
921 lua_setfield(L, -2, "sound_dig");
922 push_soundspec(L, c.sound_dug);
923 lua_setfield(L, -2, "sound_dug");
924 lua_setfield(L, -2, "sounds");
925 lua_pushboolean(L, c.legacy_facedir_simple);
926 lua_setfield(L, -2, "legacy_facedir_simple");
927 lua_pushboolean(L, c.legacy_wallmounted);
928 lua_setfield(L, -2, "legacy_wallmounted");
929 lua_pushstring(L, c.node_dig_prediction.c_str());
930 lua_setfield(L, -2, "node_dig_prediction");
933 /******************************************************************************/
934 void push_nodebox(lua_State *L, const NodeBox &box)
939 case NODEBOX_REGULAR:
940 lua_pushstring(L, "regular");
941 lua_setfield(L, -2, "type");
943 case NODEBOX_LEVELED:
945 lua_pushstring(L, "fixed");
946 lua_setfield(L, -2, "type");
947 push_box(L, box.fixed);
948 lua_setfield(L, -2, "fixed");
950 case NODEBOX_WALLMOUNTED:
951 lua_pushstring(L, "wallmounted");
952 lua_setfield(L, -2, "type");
953 push_aabb3f(L, box.wall_top);
954 lua_setfield(L, -2, "wall_top");
955 push_aabb3f(L, box.wall_bottom);
956 lua_setfield(L, -2, "wall_bottom");
957 push_aabb3f(L, box.wall_side);
958 lua_setfield(L, -2, "wall_side");
960 case NODEBOX_CONNECTED:
961 lua_pushstring(L, "connected");
962 lua_setfield(L, -2, "type");
963 push_box(L, box.connect_top);
964 lua_setfield(L, -2, "connect_top");
965 push_box(L, box.connect_bottom);
966 lua_setfield(L, -2, "connect_bottom");
967 push_box(L, box.connect_front);
968 lua_setfield(L, -2, "connect_front");
969 push_box(L, box.connect_back);
970 lua_setfield(L, -2, "connect_back");
971 push_box(L, box.connect_left);
972 lua_setfield(L, -2, "connect_left");
973 push_box(L, box.connect_right);
974 lua_setfield(L, -2, "connect_right");
977 FATAL_ERROR("Invalid box.type");
982 void push_box(lua_State *L, const std::vector<aabb3f> &box)
984 lua_createtable(L, box.size(), 0);
986 for (const aabb3f &it : box) {
988 lua_rawseti(L, -2, i++);
992 /******************************************************************************/
993 void push_palette(lua_State *L, const std::vector<video::SColor> *palette)
995 lua_createtable(L, palette->size(), 0);
996 int newTable = lua_gettop(L);
998 std::vector<video::SColor>::const_iterator iter;
999 for (iter = palette->begin(); iter != palette->end(); ++iter) {
1000 push_ARGB8(L, (*iter));
1001 lua_rawseti(L, newTable, index);
1006 /******************************************************************************/
1007 void read_server_sound_params(lua_State *L, int index,
1008 ServerSoundParams ¶ms)
1011 index = lua_gettop(L) + 1 + index;
1013 params = ServerSoundParams();
1014 if(lua_istable(L, index)){
1015 getfloatfield(L, index, "gain", params.gain);
1016 getstringfield(L, index, "to_player", params.to_player);
1017 getfloatfield(L, index, "fade", params.fade);
1018 getfloatfield(L, index, "pitch", params.pitch);
1019 lua_getfield(L, index, "pos");
1020 if(!lua_isnil(L, -1)){
1021 v3f p = read_v3f(L, -1)*BS;
1023 params.type = ServerSoundParams::SSP_POSITIONAL;
1026 lua_getfield(L, index, "object");
1027 if(!lua_isnil(L, -1)){
1028 ObjectRef *ref = ObjectRef::checkobject(L, -1);
1029 ServerActiveObject *sao = ObjectRef::getobject(ref);
1031 params.object = sao->getId();
1032 params.type = ServerSoundParams::SSP_OBJECT;
1036 params.max_hear_distance = BS*getfloatfield_default(L, index,
1037 "max_hear_distance", params.max_hear_distance/BS);
1038 getboolfield(L, index, "loop", params.loop);
1039 getstringfield(L, index, "exclude_player", params.exclude_player);
1043 /******************************************************************************/
1044 void read_soundspec(lua_State *L, int index, SimpleSoundSpec &spec)
1047 index = lua_gettop(L) + 1 + index;
1048 if (lua_isnil(L, index))
1051 if (lua_istable(L, index)) {
1052 getstringfield(L, index, "name", spec.name);
1053 getfloatfield(L, index, "gain", spec.gain);
1054 getfloatfield(L, index, "fade", spec.fade);
1055 getfloatfield(L, index, "pitch", spec.pitch);
1056 } else if (lua_isstring(L, index)) {
1057 spec.name = lua_tostring(L, index);
1061 void push_soundspec(lua_State *L, const SimpleSoundSpec &spec)
1063 lua_createtable(L, 0, 3);
1064 lua_pushstring(L, spec.name.c_str());
1065 lua_setfield(L, -2, "name");
1066 lua_pushnumber(L, spec.gain);
1067 lua_setfield(L, -2, "gain");
1068 lua_pushnumber(L, spec.fade);
1069 lua_setfield(L, -2, "fade");
1070 lua_pushnumber(L, spec.pitch);
1071 lua_setfield(L, -2, "pitch");
1074 /******************************************************************************/
1075 NodeBox read_nodebox(lua_State *L, int index)
1078 if (lua_isnil(L, -1))
1081 luaL_checktype(L, -1, LUA_TTABLE);
1083 nodebox.type = (NodeBoxType)getenumfield(L, index, "type",
1084 ScriptApiNode::es_NodeBoxType, NODEBOX_REGULAR);
1086 #define NODEBOXREAD(n, s){ \
1087 lua_getfield(L, index, (s)); \
1088 if (lua_istable(L, -1)) \
1089 (n) = read_aabb3f(L, -1, BS); \
1093 #define NODEBOXREADVEC(n, s) \
1094 lua_getfield(L, index, (s)); \
1095 if (lua_istable(L, -1)) \
1096 (n) = read_aabb3f_vector(L, -1, BS); \
1099 NODEBOXREADVEC(nodebox.fixed, "fixed");
1100 NODEBOXREAD(nodebox.wall_top, "wall_top");
1101 NODEBOXREAD(nodebox.wall_bottom, "wall_bottom");
1102 NODEBOXREAD(nodebox.wall_side, "wall_side");
1103 NODEBOXREADVEC(nodebox.connect_top, "connect_top");
1104 NODEBOXREADVEC(nodebox.connect_bottom, "connect_bottom");
1105 NODEBOXREADVEC(nodebox.connect_front, "connect_front");
1106 NODEBOXREADVEC(nodebox.connect_left, "connect_left");
1107 NODEBOXREADVEC(nodebox.connect_back, "connect_back");
1108 NODEBOXREADVEC(nodebox.connect_right, "connect_right");
1109 NODEBOXREADVEC(nodebox.disconnected_top, "disconnected_top");
1110 NODEBOXREADVEC(nodebox.disconnected_bottom, "disconnected_bottom");
1111 NODEBOXREADVEC(nodebox.disconnected_front, "disconnected_front");
1112 NODEBOXREADVEC(nodebox.disconnected_left, "disconnected_left");
1113 NODEBOXREADVEC(nodebox.disconnected_back, "disconnected_back");
1114 NODEBOXREADVEC(nodebox.disconnected_right, "disconnected_right");
1115 NODEBOXREADVEC(nodebox.disconnected, "disconnected");
1116 NODEBOXREADVEC(nodebox.disconnected_sides, "disconnected_sides");
1121 /******************************************************************************/
1122 MapNode readnode(lua_State *L, int index, const NodeDefManager *ndef)
1124 lua_getfield(L, index, "name");
1125 if (!lua_isstring(L, -1))
1126 throw LuaError("Node name is not set or is not a string!");
1127 std::string name = lua_tostring(L, -1);
1131 lua_getfield(L, index, "param1");
1132 if (!lua_isnil(L, -1))
1133 param1 = lua_tonumber(L, -1);
1137 lua_getfield(L, index, "param2");
1138 if (!lua_isnil(L, -1))
1139 param2 = lua_tonumber(L, -1);
1142 content_t id = CONTENT_IGNORE;
1143 if (!ndef->getId(name, id))
1144 throw LuaError("\"" + name + "\" is not a registered node!");
1146 return {id, param1, param2};
1149 /******************************************************************************/
1150 void pushnode(lua_State *L, const MapNode &n, const NodeDefManager *ndef)
1152 lua_createtable(L, 0, 3);
1153 lua_pushstring(L, ndef->get(n).name.c_str());
1154 lua_setfield(L, -2, "name");
1155 lua_pushinteger(L, n.getParam1());
1156 lua_setfield(L, -2, "param1");
1157 lua_pushinteger(L, n.getParam2());
1158 lua_setfield(L, -2, "param2");
1161 /******************************************************************************/
1162 void warn_if_field_exists(lua_State *L, int table,
1163 const char *name, const std::string &message)
1165 lua_getfield(L, table, name);
1166 if (!lua_isnil(L, -1)) {
1167 warningstream << "Field \"" << name << "\": "
1168 << message << std::endl;
1169 infostream << script_get_backtrace(L) << std::endl;
1174 /******************************************************************************/
1175 int getenumfield(lua_State *L, int table,
1176 const char *fieldname, const EnumString *spec, int default_)
1178 int result = default_;
1179 string_to_enum(spec, result,
1180 getstringfield_default(L, table, fieldname, ""));
1184 /******************************************************************************/
1185 bool string_to_enum(const EnumString *spec, int &result,
1186 const std::string &str)
1188 const EnumString *esp = spec;
1190 if (!strcmp(str.c_str(), esp->str)) {
1199 /******************************************************************************/
1200 ItemStack read_item(lua_State* L, int index, IItemDefManager *idef)
1203 index = lua_gettop(L) + 1 + index;
1205 if (lua_isnil(L, index)) {
1209 if (lua_isuserdata(L, index)) {
1210 // Convert from LuaItemStack
1211 LuaItemStack *o = LuaItemStack::checkobject(L, index);
1212 return o->getItem();
1215 if (lua_isstring(L, index)) {
1216 // Convert from itemstring
1217 std::string itemstring = lua_tostring(L, index);
1221 item.deSerialize(itemstring, idef);
1224 catch(SerializationError &e)
1226 warningstream<<"unable to create item from itemstring"
1227 <<": "<<itemstring<<std::endl;
1231 else if(lua_istable(L, index))
1233 // Convert from table
1234 std::string name = getstringfield_default(L, index, "name", "");
1235 int count = getintfield_default(L, index, "count", 1);
1236 int wear = getintfield_default(L, index, "wear", 0);
1238 ItemStack istack(name, count, wear, idef);
1240 // BACKWARDS COMPATIBLITY
1241 std::string value = getstringfield_default(L, index, "metadata", "");
1242 istack.metadata.setString("", value);
1245 lua_getfield(L, index, "meta");
1246 int fieldstable = lua_gettop(L);
1247 if (lua_istable(L, fieldstable)) {
1249 while (lua_next(L, fieldstable) != 0) {
1250 // key at index -2 and value at index -1
1251 std::string key = lua_tostring(L, -2);
1253 const char *value_cs = lua_tolstring(L, -1, &value_len);
1254 std::string value(value_cs, value_len);
1255 istack.metadata.setString(key, value);
1256 lua_pop(L, 1); // removes value, keeps key for next iteration
1262 throw LuaError("Expecting itemstack, itemstring, table or nil");
1266 /******************************************************************************/
1267 void push_tool_capabilities(lua_State *L,
1268 const ToolCapabilities &toolcap)
1271 setfloatfield(L, -1, "full_punch_interval", toolcap.full_punch_interval);
1272 setintfield(L, -1, "max_drop_level", toolcap.max_drop_level);
1273 setintfield(L, -1, "punch_attack_uses", toolcap.punch_attack_uses);
1274 // Create groupcaps table
1276 // For each groupcap
1277 for (const auto &gc_it : toolcap.groupcaps) {
1278 // Create groupcap table
1280 const std::string &name = gc_it.first;
1281 const ToolGroupCap &groupcap = gc_it.second;
1282 // Create subtable "times"
1284 for (auto time : groupcap.times) {
1285 lua_pushinteger(L, time.first);
1286 lua_pushnumber(L, time.second);
1287 lua_settable(L, -3);
1289 // Set subtable "times"
1290 lua_setfield(L, -2, "times");
1291 // Set simple parameters
1292 setintfield(L, -1, "maxlevel", groupcap.maxlevel);
1293 setintfield(L, -1, "uses", groupcap.uses);
1294 // Insert groupcap table into groupcaps table
1295 lua_setfield(L, -2, name.c_str());
1297 // Set groupcaps table
1298 lua_setfield(L, -2, "groupcaps");
1299 //Create damage_groups table
1301 // For each damage group
1302 for (const auto &damageGroup : toolcap.damageGroups) {
1303 // Create damage group table
1304 lua_pushinteger(L, damageGroup.second);
1305 lua_setfield(L, -2, damageGroup.first.c_str());
1307 lua_setfield(L, -2, "damage_groups");
1310 /******************************************************************************/
1311 void push_inventory_list(lua_State *L, Inventory *inv, const char *name)
1313 InventoryList *invlist = inv->getList(name);
1314 if(invlist == NULL){
1318 std::vector<ItemStack> items;
1319 for(u32 i=0; i<invlist->getSize(); i++)
1320 items.push_back(invlist->getItem(i));
1321 push_items(L, items);
1324 /******************************************************************************/
1325 void read_inventory_list(lua_State *L, int tableindex,
1326 Inventory *inv, const char *name, Server* srv, int forcesize)
1329 tableindex = lua_gettop(L) + 1 + tableindex;
1330 // If nil, delete list
1331 if(lua_isnil(L, tableindex)){
1332 inv->deleteList(name);
1335 // Otherwise set list
1336 std::vector<ItemStack> items = read_items(L, tableindex,srv);
1337 int listsize = (forcesize != -1) ? forcesize : items.size();
1338 InventoryList *invlist = inv->addList(name, listsize);
1340 for(std::vector<ItemStack>::const_iterator
1341 i = items.begin(); i != items.end(); ++i){
1342 if(forcesize != -1 && index == forcesize)
1344 invlist->changeItem(index, *i);
1347 while(forcesize != -1 && index < forcesize){
1348 invlist->deleteItem(index);
1353 /******************************************************************************/
1354 struct TileAnimationParams read_animation_definition(lua_State *L, int index)
1357 index = lua_gettop(L) + 1 + index;
1359 struct TileAnimationParams anim;
1360 anim.type = TAT_NONE;
1361 if (!lua_istable(L, index))
1364 anim.type = (TileAnimationType)
1365 getenumfield(L, index, "type", es_TileAnimationType,
1367 if (anim.type == TAT_VERTICAL_FRAMES) {
1368 // {type="vertical_frames", aspect_w=16, aspect_h=16, length=2.0}
1369 anim.vertical_frames.aspect_w =
1370 getintfield_default(L, index, "aspect_w", 16);
1371 anim.vertical_frames.aspect_h =
1372 getintfield_default(L, index, "aspect_h", 16);
1373 anim.vertical_frames.length =
1374 getfloatfield_default(L, index, "length", 1.0);
1375 } else if (anim.type == TAT_SHEET_2D) {
1376 // {type="sheet_2d", frames_w=5, frames_h=3, frame_length=0.5}
1377 getintfield(L, index, "frames_w",
1378 anim.sheet_2d.frames_w);
1379 getintfield(L, index, "frames_h",
1380 anim.sheet_2d.frames_h);
1381 getfloatfield(L, index, "frame_length",
1382 anim.sheet_2d.frame_length);
1388 /******************************************************************************/
1389 ToolCapabilities read_tool_capabilities(
1390 lua_State *L, int table)
1392 ToolCapabilities toolcap;
1393 getfloatfield(L, table, "full_punch_interval", toolcap.full_punch_interval);
1394 getintfield(L, table, "max_drop_level", toolcap.max_drop_level);
1395 getintfield(L, table, "punch_attack_uses", toolcap.punch_attack_uses);
1396 lua_getfield(L, table, "groupcaps");
1397 if(lua_istable(L, -1)){
1398 int table_groupcaps = lua_gettop(L);
1400 while(lua_next(L, table_groupcaps) != 0){
1401 // key at index -2 and value at index -1
1402 std::string groupname = luaL_checkstring(L, -2);
1403 if(lua_istable(L, -1)){
1404 int table_groupcap = lua_gettop(L);
1405 // This will be created
1406 ToolGroupCap groupcap;
1407 // Read simple parameters
1408 getintfield(L, table_groupcap, "maxlevel", groupcap.maxlevel);
1409 getintfield(L, table_groupcap, "uses", groupcap.uses);
1410 // DEPRECATED: maxwear
1412 if (getfloatfield(L, table_groupcap, "maxwear", maxwear)){
1414 groupcap.uses = 1.0/maxwear;
1417 warningstream << "Field \"maxwear\" is deprecated; "
1418 << "replace with uses=1/maxwear" << std::endl;
1419 infostream << script_get_backtrace(L) << std::endl;
1421 // Read "times" table
1422 lua_getfield(L, table_groupcap, "times");
1423 if(lua_istable(L, -1)){
1424 int table_times = lua_gettop(L);
1426 while(lua_next(L, table_times) != 0){
1427 // key at index -2 and value at index -1
1428 int rating = luaL_checkinteger(L, -2);
1429 float time = luaL_checknumber(L, -1);
1430 groupcap.times[rating] = time;
1431 // removes value, keeps key for next iteration
1436 // Insert groupcap into toolcap
1437 toolcap.groupcaps[groupname] = groupcap;
1439 // removes value, keeps key for next iteration
1445 lua_getfield(L, table, "damage_groups");
1446 if(lua_istable(L, -1)){
1447 int table_damage_groups = lua_gettop(L);
1449 while(lua_next(L, table_damage_groups) != 0){
1450 // key at index -2 and value at index -1
1451 std::string groupname = luaL_checkstring(L, -2);
1452 u16 value = luaL_checkinteger(L, -1);
1453 toolcap.damageGroups[groupname] = value;
1454 // removes value, keeps key for next iteration
1462 /******************************************************************************/
1463 void push_dig_params(lua_State *L,const DigParams ¶ms)
1465 lua_createtable(L, 0, 3);
1466 setboolfield(L, -1, "diggable", params.diggable);
1467 setfloatfield(L, -1, "time", params.time);
1468 setintfield(L, -1, "wear", params.wear);
1471 /******************************************************************************/
1472 void push_hit_params(lua_State *L,const HitParams ¶ms)
1474 lua_createtable(L, 0, 3);
1475 setintfield(L, -1, "hp", params.hp);
1476 setintfield(L, -1, "wear", params.wear);
1479 /******************************************************************************/
1481 bool getflagsfield(lua_State *L, int table, const char *fieldname,
1482 FlagDesc *flagdesc, u32 *flags, u32 *flagmask)
1484 lua_getfield(L, table, fieldname);
1486 bool success = read_flags(L, -1, flagdesc, flags, flagmask);
1493 bool read_flags(lua_State *L, int index, FlagDesc *flagdesc,
1494 u32 *flags, u32 *flagmask)
1496 if (lua_isstring(L, index)) {
1497 std::string flagstr = lua_tostring(L, index);
1498 *flags = readFlagString(flagstr, flagdesc, flagmask);
1499 } else if (lua_istable(L, index)) {
1500 *flags = read_flags_table(L, index, flagdesc, flagmask);
1508 u32 read_flags_table(lua_State *L, int table, FlagDesc *flagdesc, u32 *flagmask)
1510 u32 flags = 0, mask = 0;
1511 char fnamebuf[64] = "no";
1513 for (int i = 0; flagdesc[i].name; i++) {
1516 if (getboolfield(L, table, flagdesc[i].name, result)) {
1517 mask |= flagdesc[i].flag;
1519 flags |= flagdesc[i].flag;
1522 strlcpy(fnamebuf + 2, flagdesc[i].name, sizeof(fnamebuf) - 2);
1523 if (getboolfield(L, table, fnamebuf, result))
1524 mask |= flagdesc[i].flag;
1533 void push_flags_string(lua_State *L, FlagDesc *flagdesc, u32 flags, u32 flagmask)
1535 std::string flagstring = writeFlagString(flags, flagdesc, flagmask);
1536 lua_pushlstring(L, flagstring.c_str(), flagstring.size());
1539 /******************************************************************************/
1540 /* Lua Stored data! */
1541 /******************************************************************************/
1543 /******************************************************************************/
1544 void read_groups(lua_State *L, int index, ItemGroupList &result)
1546 if (lua_isnil(L, index))
1549 luaL_checktype(L, index, LUA_TTABLE);
1555 while (lua_next(L, index) != 0) {
1556 // key at index -2 and value at index -1
1557 std::string name = luaL_checkstring(L, -2);
1558 int rating = luaL_checkinteger(L, -1);
1559 // zero rating indicates not in the group
1561 result[name] = rating;
1562 // removes value, keeps key for next iteration
1567 /******************************************************************************/
1568 void push_groups(lua_State *L, const ItemGroupList &groups)
1570 lua_createtable(L, 0, groups.size());
1571 for (const auto &group : groups) {
1572 lua_pushinteger(L, group.second);
1573 lua_setfield(L, -2, group.first.c_str());
1577 /******************************************************************************/
1578 void push_items(lua_State *L, const std::vector<ItemStack> &items)
1580 lua_createtable(L, items.size(), 0);
1581 for (u32 i = 0; i != items.size(); i++) {
1582 LuaItemStack::create(L, items[i]);
1583 lua_rawseti(L, -2, i + 1);
1587 /******************************************************************************/
1588 std::vector<ItemStack> read_items(lua_State *L, int index, Server *srv)
1591 index = lua_gettop(L) + 1 + index;
1593 std::vector<ItemStack> items;
1594 luaL_checktype(L, index, LUA_TTABLE);
1596 while (lua_next(L, index)) {
1597 s32 key = luaL_checkinteger(L, -2);
1599 throw LuaError("Invalid inventory list index");
1601 if (items.size() < (u32) key) {
1604 items[key - 1] = read_item(L, -1, srv->idef());
1610 /******************************************************************************/
1611 void luaentity_get(lua_State *L, u16 id)
1613 // Get luaentities[i]
1614 lua_getglobal(L, "core");
1615 lua_getfield(L, -1, "luaentities");
1616 luaL_checktype(L, -1, LUA_TTABLE);
1617 lua_pushinteger(L, id);
1618 lua_gettable(L, -2);
1619 lua_remove(L, -2); // Remove luaentities
1620 lua_remove(L, -2); // Remove core
1623 /******************************************************************************/
1624 bool read_noiseparams(lua_State *L, int index, NoiseParams *np)
1627 index = lua_gettop(L) + 1 + index;
1629 if (!lua_istable(L, index))
1632 getfloatfield(L, index, "offset", np->offset);
1633 getfloatfield(L, index, "scale", np->scale);
1634 getfloatfield(L, index, "persist", np->persist);
1635 getfloatfield(L, index, "persistence", np->persist);
1636 getfloatfield(L, index, "lacunarity", np->lacunarity);
1637 getintfield(L, index, "seed", np->seed);
1638 getintfield(L, index, "octaves", np->octaves);
1642 np->flags = getflagsfield(L, index, "flags", flagdesc_noiseparams,
1643 &flags, &flagmask) ? flags : NOISE_FLAG_DEFAULTS;
1645 lua_getfield(L, index, "spread");
1646 np->spread = read_v3f(L, -1);
1652 void push_noiseparams(lua_State *L, NoiseParams *np)
1655 push_float_string(L, np->offset);
1656 lua_setfield(L, -2, "offset");
1657 push_float_string(L, np->scale);
1658 lua_setfield(L, -2, "scale");
1659 push_float_string(L, np->persist);
1660 lua_setfield(L, -2, "persistence");
1661 push_float_string(L, np->lacunarity);
1662 lua_setfield(L, -2, "lacunarity");
1663 lua_pushnumber(L, np->seed);
1664 lua_setfield(L, -2, "seed");
1665 lua_pushnumber(L, np->octaves);
1666 lua_setfield(L, -2, "octaves");
1668 push_flags_string(L, flagdesc_noiseparams, np->flags,
1670 lua_setfield(L, -2, "flags");
1672 push_v3_float_string(L, np->spread);
1673 lua_setfield(L, -2, "spread");
1676 /******************************************************************************/
1677 // Returns depth of json value tree
1678 static int push_json_value_getdepth(const Json::Value &value)
1680 if (!value.isArray() && !value.isObject())
1684 for (const auto &it : value) {
1685 int elemdepth = push_json_value_getdepth(it);
1686 if (elemdepth > maxdepth)
1687 maxdepth = elemdepth;
1689 return maxdepth + 1;
1691 // Recursive function to convert JSON --> Lua table
1692 static bool push_json_value_helper(lua_State *L, const Json::Value &value,
1695 switch(value.type()) {
1696 case Json::nullValue:
1698 lua_pushvalue(L, nullindex);
1700 case Json::intValue:
1701 lua_pushinteger(L, value.asLargestInt());
1703 case Json::uintValue:
1704 lua_pushinteger(L, value.asLargestUInt());
1706 case Json::realValue:
1707 lua_pushnumber(L, value.asDouble());
1709 case Json::stringValue:
1711 const char *str = value.asCString();
1712 lua_pushstring(L, str ? str : "");
1715 case Json::booleanValue:
1716 lua_pushboolean(L, value.asInt());
1718 case Json::arrayValue:
1719 lua_createtable(L, value.size(), 0);
1720 for (Json::Value::const_iterator it = value.begin();
1721 it != value.end(); ++it) {
1722 push_json_value_helper(L, *it, nullindex);
1723 lua_rawseti(L, -2, it.index() + 1);
1726 case Json::objectValue:
1727 lua_createtable(L, 0, value.size());
1728 for (Json::Value::const_iterator it = value.begin();
1729 it != value.end(); ++it) {
1730 #if !defined(JSONCPP_STRING) && (JSONCPP_VERSION_MAJOR < 1 || JSONCPP_VERSION_MINOR < 9)
1731 const char *str = it.memberName();
1732 lua_pushstring(L, str ? str : "");
1734 std::string str = it.name();
1735 lua_pushstring(L, str.c_str());
1737 push_json_value_helper(L, *it, nullindex);
1744 // converts JSON --> Lua table; returns false if lua stack limit exceeded
1745 // nullindex: Lua stack index of value to use in place of JSON null
1746 bool push_json_value(lua_State *L, const Json::Value &value, int nullindex)
1749 nullindex = lua_gettop(L) + 1 + nullindex;
1751 int depth = push_json_value_getdepth(value);
1753 // The maximum number of Lua stack slots used at each recursion level
1754 // of push_json_value_helper is 2, so make sure there a depth * 2 slots
1755 if (lua_checkstack(L, depth * 2))
1756 return push_json_value_helper(L, value, nullindex);
1761 // Converts Lua table --> JSON
1762 void read_json_value(lua_State *L, Json::Value &root, int index, u8 recursion)
1764 if (recursion > 16) {
1765 throw SerializationError("Maximum recursion depth exceeded");
1767 int type = lua_type(L, index);
1768 if (type == LUA_TBOOLEAN) {
1769 root = (bool) lua_toboolean(L, index);
1770 } else if (type == LUA_TNUMBER) {
1771 root = lua_tonumber(L, index);
1772 } else if (type == LUA_TSTRING) {
1774 const char *str = lua_tolstring(L, index, &len);
1775 root = std::string(str, len);
1776 } else if (type == LUA_TTABLE) {
1778 while (lua_next(L, index)) {
1779 // Key is at -2 and value is at -1
1781 read_json_value(L, value, lua_gettop(L), recursion + 1);
1783 Json::ValueType roottype = root.type();
1784 int keytype = lua_type(L, -1);
1785 if (keytype == LUA_TNUMBER) {
1786 lua_Number key = lua_tonumber(L, -1);
1787 if (roottype != Json::nullValue && roottype != Json::arrayValue) {
1788 throw SerializationError("Can't mix array and object values in JSON");
1789 } else if (key < 1) {
1790 throw SerializationError("Can't use zero-based or negative indexes in JSON");
1791 } else if (floor(key) != key) {
1792 throw SerializationError("Can't use indexes with a fractional part in JSON");
1794 root[(Json::ArrayIndex) key - 1] = value;
1795 } else if (keytype == LUA_TSTRING) {
1796 if (roottype != Json::nullValue && roottype != Json::objectValue) {
1797 throw SerializationError("Can't mix array and object values in JSON");
1799 root[lua_tostring(L, -1)] = value;
1801 throw SerializationError("Lua key to convert to JSON is not a string or number");
1804 } else if (type == LUA_TNIL) {
1805 root = Json::nullValue;
1807 throw SerializationError("Can only store booleans, numbers, strings, objects, arrays, and null in JSON");
1809 lua_pop(L, 1); // Pop value
1812 void push_pointed_thing(lua_State *L, const PointedThing &pointed, bool csm,
1816 if (pointed.type == POINTEDTHING_NODE) {
1817 lua_pushstring(L, "node");
1818 lua_setfield(L, -2, "type");
1819 push_v3s16(L, pointed.node_undersurface);
1820 lua_setfield(L, -2, "under");
1821 push_v3s16(L, pointed.node_abovesurface);
1822 lua_setfield(L, -2, "above");
1823 } else if (pointed.type == POINTEDTHING_OBJECT) {
1824 lua_pushstring(L, "object");
1825 lua_setfield(L, -2, "type");
1828 lua_pushinteger(L, pointed.object_id);
1829 lua_setfield(L, -2, "id");
1831 push_objectRef(L, pointed.object_id);
1832 lua_setfield(L, -2, "ref");
1835 lua_pushstring(L, "nothing");
1836 lua_setfield(L, -2, "type");
1838 if (hitpoint && (pointed.type != POINTEDTHING_NOTHING)) {
1839 push_v3f(L, pointed.intersection_point / BS); // convert to node coords
1840 lua_setfield(L, -2, "intersection_point");
1841 push_v3s16(L, pointed.intersection_normal);
1842 lua_setfield(L, -2, "intersection_normal");
1843 lua_pushinteger(L, pointed.box_id + 1); // change to Lua array index
1844 lua_setfield(L, -2, "box_id");
1848 void push_objectRef(lua_State *L, const u16 id)
1850 // Get core.object_refs[i]
1851 lua_getglobal(L, "core");
1852 lua_getfield(L, -1, "object_refs");
1853 luaL_checktype(L, -1, LUA_TTABLE);
1854 lua_pushinteger(L, id);
1855 lua_gettable(L, -2);
1856 lua_remove(L, -2); // object_refs
1857 lua_remove(L, -2); // core
1860 void read_hud_element(lua_State *L, HudElement *elem)
1862 elem->type = (HudElementType)getenumfield(L, 2, "hud_elem_type",
1863 es_HudElementType, HUD_ELEM_TEXT);
1865 lua_getfield(L, 2, "position");
1866 elem->pos = lua_istable(L, -1) ? read_v2f(L, -1) : v2f();
1869 lua_getfield(L, 2, "scale");
1870 elem->scale = lua_istable(L, -1) ? read_v2f(L, -1) : v2f();
1873 lua_getfield(L, 2, "size");
1874 elem->size = lua_istable(L, -1) ? read_v2s32(L, -1) : v2s32();
1877 elem->name = getstringfield_default(L, 2, "name", "");
1878 elem->text = getstringfield_default(L, 2, "text", "");
1879 elem->number = getintfield_default(L, 2, "number", 0);
1880 if (elem->type == HUD_ELEM_WAYPOINT)
1881 // waypoints reuse the item field to store precision, item = precision + 1
1882 elem->item = getintfield_default(L, 2, "precision", -1) + 1;
1884 elem->item = getintfield_default(L, 2, "item", 0);
1885 elem->dir = getintfield_default(L, 2, "direction", 0);
1886 elem->z_index = MYMAX(S16_MIN, MYMIN(S16_MAX,
1887 getintfield_default(L, 2, "z_index", 0)));
1888 elem->text2 = getstringfield_default(L, 2, "text2", "");
1890 // Deprecated, only for compatibility's sake
1892 elem->dir = getintfield_default(L, 2, "dir", 0);
1894 lua_getfield(L, 2, "alignment");
1895 elem->align = lua_istable(L, -1) ? read_v2f(L, -1) : v2f();
1898 lua_getfield(L, 2, "offset");
1899 elem->offset = lua_istable(L, -1) ? read_v2f(L, -1) : v2f();
1902 lua_getfield(L, 2, "world_pos");
1903 elem->world_pos = lua_istable(L, -1) ? read_v3f(L, -1) : v3f();
1906 /* check for known deprecated element usage */
1907 if ((elem->type == HUD_ELEM_STATBAR) && (elem->size == v2s32()))
1908 log_deprecated(L,"Deprecated usage of statbar without size!");
1911 void push_hud_element(lua_State *L, HudElement *elem)
1915 lua_pushstring(L, es_HudElementType[(u8)elem->type].str);
1916 lua_setfield(L, -2, "type");
1918 push_v2f(L, elem->pos);
1919 lua_setfield(L, -2, "position");
1921 lua_pushstring(L, elem->name.c_str());
1922 lua_setfield(L, -2, "name");
1924 push_v2f(L, elem->scale);
1925 lua_setfield(L, -2, "scale");
1927 lua_pushstring(L, elem->text.c_str());
1928 lua_setfield(L, -2, "text");
1930 lua_pushnumber(L, elem->number);
1931 lua_setfield(L, -2, "number");
1933 lua_pushnumber(L, elem->item);
1934 lua_setfield(L, -2, "item");
1936 lua_pushnumber(L, elem->dir);
1937 lua_setfield(L, -2, "direction");
1939 push_v2f(L, elem->offset);
1940 lua_setfield(L, -2, "offset");
1942 push_v2f(L, elem->align);
1943 lua_setfield(L, -2, "alignment");
1945 push_v2s32(L, elem->size);
1946 lua_setfield(L, -2, "size");
1948 // Deprecated, only for compatibility's sake
1949 lua_pushnumber(L, elem->dir);
1950 lua_setfield(L, -2, "dir");
1952 push_v3f(L, elem->world_pos);
1953 lua_setfield(L, -2, "world_pos");
1955 lua_pushnumber(L, elem->z_index);
1956 lua_setfield(L, -2, "z_index");
1958 lua_pushstring(L, elem->text2.c_str());
1959 lua_setfield(L, -2, "text2");
1962 HudElementStat read_hud_change(lua_State *L, HudElement *elem, void **value)
1964 HudElementStat stat = HUD_STAT_NUMBER;
1965 std::string statstr;
1966 if (lua_isstring(L, 3)) {
1968 statstr = lua_tostring(L, 3);
1969 stat = string_to_enum(es_HudElementStat, statint, statstr) ?
1970 (HudElementStat)statint : stat;
1975 elem->pos = read_v2f(L, 4);
1976 *value = &elem->pos;
1979 elem->name = luaL_checkstring(L, 4);
1980 *value = &elem->name;
1982 case HUD_STAT_SCALE:
1983 elem->scale = read_v2f(L, 4);
1984 *value = &elem->scale;
1987 elem->text = luaL_checkstring(L, 4);
1988 *value = &elem->text;
1990 case HUD_STAT_NUMBER:
1991 elem->number = luaL_checknumber(L, 4);
1992 *value = &elem->number;
1995 elem->item = luaL_checknumber(L, 4);
1996 if (elem->type == HUD_ELEM_WAYPOINT && statstr == "precision")
1998 *value = &elem->item;
2001 elem->dir = luaL_checknumber(L, 4);
2002 *value = &elem->dir;
2004 case HUD_STAT_ALIGN:
2005 elem->align = read_v2f(L, 4);
2006 *value = &elem->align;
2008 case HUD_STAT_OFFSET:
2009 elem->offset = read_v2f(L, 4);
2010 *value = &elem->offset;
2012 case HUD_STAT_WORLD_POS:
2013 elem->world_pos = read_v3f(L, 4);
2014 *value = &elem->world_pos;
2017 elem->size = read_v2s32(L, 4);
2018 *value = &elem->size;
2020 case HUD_STAT_Z_INDEX:
2021 elem->z_index = MYMAX(S16_MIN, MYMIN(S16_MAX, luaL_checknumber(L, 4)));
2022 *value = &elem->z_index;
2024 case HUD_STAT_TEXT2:
2025 elem->text2 = luaL_checkstring(L, 4);
2026 *value = &elem->text2;
2032 /******************************************************************************/
2034 // Indices must match values in `enum CollisionType` exactly!!
2035 static const char *collision_type_str[] = {
2040 // Indices must match values in `enum CollisionAxis` exactly!!
2041 static const char *collision_axis_str[] = {
2047 void push_collision_move_result(lua_State *L, const collisionMoveResult &res)
2049 lua_createtable(L, 0, 4);
2051 setboolfield(L, -1, "touching_ground", res.touching_ground);
2052 setboolfield(L, -1, "collides", res.collides);
2053 setboolfield(L, -1, "standing_on_object", res.standing_on_object);
2056 lua_createtable(L, res.collisions.size(), 0);
2058 for (const auto &c : res.collisions) {
2059 lua_createtable(L, 0, 5);
2061 lua_pushstring(L, collision_type_str[c.type]);
2062 lua_setfield(L, -2, "type");
2064 assert(c.axis != COLLISION_AXIS_NONE);
2065 lua_pushstring(L, collision_axis_str[c.axis]);
2066 lua_setfield(L, -2, "axis");
2068 if (c.type == COLLISION_NODE) {
2069 push_v3s16(L, c.node_p);
2070 lua_setfield(L, -2, "node_pos");
2071 } else if (c.type == COLLISION_OBJECT) {
2072 push_objectRef(L, c.object->getId());
2073 lua_setfield(L, -2, "object");
2076 push_v3f(L, c.old_speed / BS);
2077 lua_setfield(L, -2, "old_velocity");
2079 push_v3f(L, c.new_speed / BS);
2080 lua_setfield(L, -2, "new_velocity");
2082 lua_rawseti(L, -2, i++);
2084 lua_setfield(L, -2, "collisions");