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"
24 #include "object_properties.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"
32 #include "serverobject.h"
34 #include "mg_schematic.h"
36 #include "json/json.h"
38 struct EnumString es_TileAnimationType[] =
41 {TAT_VERTICAL_FRAMES, "vertical_frames"},
45 /******************************************************************************/
46 ItemDefinition read_item_definition(lua_State* L,int index,
47 ItemDefinition default_def)
50 index = lua_gettop(L) + 1 + index;
52 // Read the item definition
53 ItemDefinition def = default_def;
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, "inventory_image", def.inventory_image);
60 getstringfield(L, index, "wield_image", def.wield_image);
62 lua_getfield(L, index, "wield_scale");
63 if(lua_istable(L, -1)){
64 def.wield_scale = check_v3f(L, -1);
68 def.stack_max = getintfield_default(L, index, "stack_max", def.stack_max);
69 if(def.stack_max == 0)
72 lua_getfield(L, index, "on_use");
73 def.usable = lua_isfunction(L, -1);
76 getboolfield(L, index, "liquids_pointable", def.liquids_pointable);
78 warn_if_field_exists(L, index, "tool_digging_properties",
79 "deprecated: use tool_capabilities");
81 lua_getfield(L, index, "tool_capabilities");
82 if(lua_istable(L, -1)){
83 def.tool_capabilities = new ToolCapabilities(
84 read_tool_capabilities(L, -1));
87 // If name is "" (hand), ensure there are ToolCapabilities
88 // because it will be looked up there whenever any other item has
89 // no ToolCapabilities
90 if(def.name == "" && def.tool_capabilities == NULL){
91 def.tool_capabilities = new ToolCapabilities();
94 lua_getfield(L, index, "groups");
95 read_groups(L, -1, def.groups);
98 lua_getfield(L, index, "sounds");
99 if(lua_istable(L, -1)){
100 lua_getfield(L, -1, "place");
101 read_soundspec(L, -1, def.sound_place);
106 def.range = getfloatfield_default(L, index, "range", def.range);
108 // Client shall immediately place this node when player places the item.
109 // Server will update the precise end result a moment later.
110 // "" = no prediction
111 getstringfield(L, index, "node_placement_prediction",
112 def.node_placement_prediction);
117 /******************************************************************************/
118 void read_object_properties(lua_State *L, int index,
119 ObjectProperties *prop)
122 index = lua_gettop(L) + 1 + index;
123 if(!lua_istable(L, index))
126 prop->hp_max = getintfield_default(L, -1, "hp_max", 10);
128 getboolfield(L, -1, "physical", prop->physical);
129 getboolfield(L, -1, "collide_with_objects", prop->collideWithObjects);
131 getfloatfield(L, -1, "weight", prop->weight);
133 lua_getfield(L, -1, "collisionbox");
134 if(lua_istable(L, -1))
135 prop->collisionbox = read_aabb3f(L, -1, 1.0);
138 getstringfield(L, -1, "visual", prop->visual);
140 getstringfield(L, -1, "mesh", prop->mesh);
142 lua_getfield(L, -1, "visual_size");
143 if(lua_istable(L, -1))
144 prop->visual_size = read_v2f(L, -1);
147 lua_getfield(L, -1, "textures");
148 if(lua_istable(L, -1)){
149 prop->textures.clear();
150 int table = lua_gettop(L);
152 while(lua_next(L, table) != 0){
153 // key at index -2 and value at index -1
154 if(lua_isstring(L, -1))
155 prop->textures.push_back(lua_tostring(L, -1));
157 prop->textures.push_back("");
158 // removes value, keeps key for next iteration
164 lua_getfield(L, -1, "colors");
165 if (lua_istable(L, -1)) {
166 int table = lua_gettop(L);
167 prop->colors.clear();
168 for (lua_pushnil(L); lua_next(L, table); lua_pop(L, 1)) {
169 video::SColor color(255, 255, 255, 255);
170 read_color(L, -1, &color);
171 prop->colors.push_back(color);
176 lua_getfield(L, -1, "spritediv");
177 if(lua_istable(L, -1))
178 prop->spritediv = read_v2s16(L, -1);
181 lua_getfield(L, -1, "initial_sprite_basepos");
182 if(lua_istable(L, -1))
183 prop->initial_sprite_basepos = read_v2s16(L, -1);
186 getboolfield(L, -1, "is_visible", prop->is_visible);
187 getboolfield(L, -1, "makes_footstep_sound", prop->makes_footstep_sound);
188 getfloatfield(L, -1, "automatic_rotate", prop->automatic_rotate);
189 if (getfloatfield(L, -1, "stepheight", prop->stepheight))
190 prop->stepheight *= BS;
191 lua_getfield(L, -1, "automatic_face_movement_dir");
192 if (lua_isnumber(L, -1)) {
193 prop->automatic_face_movement_dir = true;
194 prop->automatic_face_movement_dir_offset = luaL_checknumber(L, -1);
195 } else if (lua_isboolean(L, -1)) {
196 prop->automatic_face_movement_dir = lua_toboolean(L, -1);
197 prop->automatic_face_movement_dir_offset = 0.0;
202 /******************************************************************************/
203 void push_object_properties(lua_State *L, ObjectProperties *prop)
206 lua_pushnumber(L, prop->hp_max);
207 lua_setfield(L, -2, "hp_max");
208 lua_pushboolean(L, prop->physical);
209 lua_setfield(L, -2, "physical");
210 lua_pushboolean(L, prop->collideWithObjects);
211 lua_setfield(L, -2, "collide_with_objects");
212 lua_pushnumber(L, prop->weight);
213 lua_setfield(L, -2, "weight");
214 push_aabb3f(L, prop->collisionbox);
215 lua_setfield(L, -2, "collisionbox");
216 lua_pushlstring(L, prop->visual.c_str(), prop->visual.size());
217 lua_setfield(L, -2, "visual");
218 lua_pushlstring(L, prop->mesh.c_str(), prop->mesh.size());
219 lua_setfield(L, -2, "mesh");
220 push_v2f(L, prop->visual_size);
221 lua_setfield(L, -2, "visual_size");
225 for (std::vector<std::string>::iterator it = prop->textures.begin();
226 it != prop->textures.end(); ++it) {
227 lua_pushlstring(L, it->c_str(), it->size());
228 lua_rawseti(L, -2, i);
230 lua_setfield(L, -2, "textures");
234 for (std::vector<video::SColor>::iterator it = prop->colors.begin();
235 it != prop->colors.end(); ++it) {
237 lua_rawseti(L, -2, i);
239 lua_setfield(L, -2, "colors");
241 push_v2s16(L, prop->spritediv);
242 lua_setfield(L, -2, "spritediv");
243 push_v2s16(L, prop->initial_sprite_basepos);
244 lua_setfield(L, -2, "initial_sprite_basepos");
245 lua_pushboolean(L, prop->is_visible);
246 lua_setfield(L, -2, "is_visible");
247 lua_pushboolean(L, prop->makes_footstep_sound);
248 lua_setfield(L, -2, "makes_footstep_sound");
249 lua_pushnumber(L, prop->automatic_rotate);
250 lua_setfield(L, -2, "automatic_rotate");
251 lua_pushnumber(L, prop->stepheight / BS);
252 lua_setfield(L, -2, "stepheight");
253 if (prop->automatic_face_movement_dir)
254 lua_pushnumber(L, prop->automatic_face_movement_dir_offset);
256 lua_pushboolean(L, false);
257 lua_setfield(L, -2, "automatic_face_movement_dir");
260 /******************************************************************************/
261 TileDef read_tiledef(lua_State *L, int index, u8 drawtype)
264 index = lua_gettop(L) + 1 + index;
267 bool default_tiling = (drawtype == NDT_PLANTLIKE || drawtype == NDT_FIRELIKE)
269 // key at index -2 and value at index
270 if(lua_isstring(L, index)){
271 // "default_lava.png"
272 tiledef.name = lua_tostring(L, index);
273 tiledef.tileable_vertical = default_tiling;
274 tiledef.tileable_horizontal = default_tiling;
276 else if(lua_istable(L, index))
278 // {name="default_lava.png", animation={}}
280 getstringfield(L, index, "name", tiledef.name);
281 getstringfield(L, index, "image", tiledef.name); // MaterialSpec compat.
282 tiledef.backface_culling = getboolfield_default(
283 L, index, "backface_culling", true);
284 tiledef.tileable_horizontal = getboolfield_default(
285 L, index, "tileable_horizontal", default_tiling);
286 tiledef.tileable_vertical = getboolfield_default(
287 L, index, "tileable_vertical", default_tiling);
289 lua_getfield(L, index, "animation");
290 if(lua_istable(L, -1)){
291 // {type="vertical_frames", aspect_w=16, aspect_h=16, length=2.0}
292 tiledef.animation.type = (TileAnimationType)
293 getenumfield(L, -1, "type", es_TileAnimationType,
295 tiledef.animation.aspect_w =
296 getintfield_default(L, -1, "aspect_w", 16);
297 tiledef.animation.aspect_h =
298 getintfield_default(L, -1, "aspect_h", 16);
299 tiledef.animation.length =
300 getfloatfield_default(L, -1, "length", 1.0);
308 /******************************************************************************/
309 ContentFeatures read_content_features(lua_State *L, int index)
312 index = lua_gettop(L) + 1 + index;
316 /* Cache existence of some callbacks */
317 lua_getfield(L, index, "on_construct");
318 if(!lua_isnil(L, -1)) f.has_on_construct = true;
320 lua_getfield(L, index, "on_destruct");
321 if(!lua_isnil(L, -1)) f.has_on_destruct = true;
323 lua_getfield(L, index, "after_destruct");
324 if(!lua_isnil(L, -1)) f.has_after_destruct = true;
327 lua_getfield(L, index, "on_rightclick");
328 f.rightclickable = lua_isfunction(L, -1);
332 getstringfield(L, index, "name", f.name);
335 lua_getfield(L, index, "groups");
336 read_groups(L, -1, f.groups);
339 /* Visual definition */
341 f.drawtype = (NodeDrawType)getenumfield(L, index, "drawtype",
342 ScriptApiNode::es_DrawType,NDT_NORMAL);
343 getfloatfield(L, index, "visual_scale", f.visual_scale);
345 /* Meshnode model filename */
346 getstringfield(L, index, "mesh", f.mesh);
349 lua_getfield(L, index, "tiles");
350 // If nil, try the deprecated name "tile_images" instead
351 if(lua_isnil(L, -1)){
353 warn_if_field_exists(L, index, "tile_images",
354 "Deprecated; new name is \"tiles\".");
355 lua_getfield(L, index, "tile_images");
357 if(lua_istable(L, -1)){
358 int table = lua_gettop(L);
361 while(lua_next(L, table) != 0){
362 // Read tiledef from value
363 f.tiledef[i] = read_tiledef(L, -1, f.drawtype);
364 // removes value, keeps key for next iteration
372 // Copy last value to all remaining textures
374 TileDef lasttile = f.tiledef[i-1];
376 f.tiledef[i] = lasttile;
383 // special_tiles = {}
384 lua_getfield(L, index, "special_tiles");
385 // If nil, try the deprecated name "special_materials" instead
386 if(lua_isnil(L, -1)){
388 warn_if_field_exists(L, index, "special_materials",
389 "Deprecated; new name is \"special_tiles\".");
390 lua_getfield(L, index, "special_materials");
392 if(lua_istable(L, -1)){
393 int table = lua_gettop(L);
396 while(lua_next(L, table) != 0){
397 // Read tiledef from value
398 f.tiledef_special[i] = read_tiledef(L, -1, f.drawtype);
399 // removes value, keeps key for next iteration
402 if(i==CF_SPECIAL_COUNT){
410 f.alpha = getintfield_default(L, index, "alpha", 255);
412 bool usealpha = getboolfield_default(L, index,
413 "use_texture_alpha", false);
419 lua_getfield(L, index, "post_effect_color");
420 read_color(L, -1, &f.post_effect_color);
423 f.param_type = (ContentParamType)getenumfield(L, index, "paramtype",
424 ScriptApiNode::es_ContentParamType, CPT_NONE);
425 f.param_type_2 = (ContentParamType2)getenumfield(L, index, "paramtype2",
426 ScriptApiNode::es_ContentParamType2, CPT2_NONE);
428 // Warn about some deprecated fields
429 warn_if_field_exists(L, index, "wall_mounted",
430 "deprecated: use paramtype2 = 'wallmounted'");
431 warn_if_field_exists(L, index, "light_propagates",
432 "deprecated: determined from paramtype");
433 warn_if_field_exists(L, index, "dug_item",
434 "deprecated: use 'drop' field");
435 warn_if_field_exists(L, index, "extra_dug_item",
436 "deprecated: use 'drop' field");
437 warn_if_field_exists(L, index, "extra_dug_item_rarity",
438 "deprecated: use 'drop' field");
439 warn_if_field_exists(L, index, "metadata_name",
440 "deprecated: use on_add and metadata callbacks");
442 // True for all ground-like things like stone and mud, false for eg. trees
443 getboolfield(L, index, "is_ground_content", f.is_ground_content);
444 f.light_propagates = (f.param_type == CPT_LIGHT);
445 getboolfield(L, index, "sunlight_propagates", f.sunlight_propagates);
446 // This is used for collision detection.
447 // Also for general solidness queries.
448 getboolfield(L, index, "walkable", f.walkable);
449 // Player can point to these
450 getboolfield(L, index, "pointable", f.pointable);
451 // Player can dig these
452 getboolfield(L, index, "diggable", f.diggable);
453 // Player can climb these
454 getboolfield(L, index, "climbable", f.climbable);
455 // Player can build on these
456 getboolfield(L, index, "buildable_to", f.buildable_to);
457 // Whether the node is non-liquid, source liquid or flowing liquid
458 f.liquid_type = (LiquidType)getenumfield(L, index, "liquidtype",
459 ScriptApiNode::es_LiquidType, LIQUID_NONE);
460 // If the content is liquid, this is the flowing version of the liquid.
461 getstringfield(L, index, "liquid_alternative_flowing",
462 f.liquid_alternative_flowing);
463 // If the content is liquid, this is the source version of the liquid.
464 getstringfield(L, index, "liquid_alternative_source",
465 f.liquid_alternative_source);
466 // Viscosity for fluid flow, ranging from 1 to 7, with
467 // 1 giving almost instantaneous propagation and 7 being
468 // the slowest possible
469 f.liquid_viscosity = getintfield_default(L, index,
470 "liquid_viscosity", f.liquid_viscosity);
471 f.liquid_range = getintfield_default(L, index,
472 "liquid_range", f.liquid_range);
473 f.leveled = getintfield_default(L, index, "leveled", f.leveled);
475 getboolfield(L, index, "liquid_renewable", f.liquid_renewable);
476 f.drowning = getintfield_default(L, index,
477 "drowning", f.drowning);
478 // Amount of light the node emits
479 f.light_source = getintfield_default(L, index,
480 "light_source", f.light_source);
481 f.damage_per_second = getintfield_default(L, index,
482 "damage_per_second", f.damage_per_second);
484 lua_getfield(L, index, "node_box");
485 if(lua_istable(L, -1))
486 f.node_box = read_nodebox(L, -1);
489 lua_getfield(L, index, "selection_box");
490 if(lua_istable(L, -1))
491 f.selection_box = read_nodebox(L, -1);
494 lua_getfield(L, index, "collision_box");
495 if(lua_istable(L, -1))
496 f.collision_box = read_nodebox(L, -1);
499 f.waving = getintfield_default(L, index,
502 // Set to true if paramtype used to be 'facedir_simple'
503 getboolfield(L, index, "legacy_facedir_simple", f.legacy_facedir_simple);
504 // Set to true if wall_mounted used to be set to true
505 getboolfield(L, index, "legacy_wallmounted", f.legacy_wallmounted);
508 lua_getfield(L, index, "sounds");
509 if(lua_istable(L, -1)){
510 lua_getfield(L, -1, "footstep");
511 read_soundspec(L, -1, f.sound_footstep);
513 lua_getfield(L, -1, "dig");
514 read_soundspec(L, -1, f.sound_dig);
516 lua_getfield(L, -1, "dug");
517 read_soundspec(L, -1, f.sound_dug);
525 /******************************************************************************/
526 void read_server_sound_params(lua_State *L, int index,
527 ServerSoundParams ¶ms)
530 index = lua_gettop(L) + 1 + index;
532 params = ServerSoundParams();
533 if(lua_istable(L, index)){
534 getfloatfield(L, index, "gain", params.gain);
535 getstringfield(L, index, "to_player", params.to_player);
536 lua_getfield(L, index, "pos");
537 if(!lua_isnil(L, -1)){
538 v3f p = read_v3f(L, -1)*BS;
540 params.type = ServerSoundParams::SSP_POSITIONAL;
543 lua_getfield(L, index, "object");
544 if(!lua_isnil(L, -1)){
545 ObjectRef *ref = ObjectRef::checkobject(L, -1);
546 ServerActiveObject *sao = ObjectRef::getobject(ref);
548 params.object = sao->getId();
549 params.type = ServerSoundParams::SSP_OBJECT;
553 params.max_hear_distance = BS*getfloatfield_default(L, index,
554 "max_hear_distance", params.max_hear_distance/BS);
555 getboolfield(L, index, "loop", params.loop);
559 /******************************************************************************/
560 void read_soundspec(lua_State *L, int index, SimpleSoundSpec &spec)
563 index = lua_gettop(L) + 1 + index;
564 if(lua_isnil(L, index)){
565 } else if(lua_istable(L, index)){
566 getstringfield(L, index, "name", spec.name);
567 getfloatfield(L, index, "gain", spec.gain);
568 } else if(lua_isstring(L, index)){
569 spec.name = lua_tostring(L, index);
573 /******************************************************************************/
574 NodeBox read_nodebox(lua_State *L, int index)
577 if(lua_istable(L, -1)){
578 nodebox.type = (NodeBoxType)getenumfield(L, index, "type",
579 ScriptApiNode::es_NodeBoxType, NODEBOX_REGULAR);
581 lua_getfield(L, index, "fixed");
582 if(lua_istable(L, -1))
583 nodebox.fixed = read_aabb3f_vector(L, -1, BS);
586 lua_getfield(L, index, "wall_top");
587 if(lua_istable(L, -1))
588 nodebox.wall_top = read_aabb3f(L, -1, BS);
591 lua_getfield(L, index, "wall_bottom");
592 if(lua_istable(L, -1))
593 nodebox.wall_bottom = read_aabb3f(L, -1, BS);
596 lua_getfield(L, index, "wall_side");
597 if(lua_istable(L, -1))
598 nodebox.wall_side = read_aabb3f(L, -1, BS);
604 /******************************************************************************/
605 MapNode readnode(lua_State *L, int index, INodeDefManager *ndef)
607 lua_getfield(L, index, "name");
608 if (!lua_isstring(L, -1))
609 throw LuaError("Node name is not set or is not a string!");
610 const char *name = lua_tostring(L, -1);
614 lua_getfield(L, index, "param1");
615 if (!lua_isnil(L, -1))
616 param1 = lua_tonumber(L, -1);
620 lua_getfield(L, index, "param2");
621 if (!lua_isnil(L, -1))
622 param2 = lua_tonumber(L, -1);
625 return MapNode(ndef, name, param1, param2);
628 /******************************************************************************/
629 void pushnode(lua_State *L, const MapNode &n, INodeDefManager *ndef)
632 lua_pushstring(L, ndef->get(n).name.c_str());
633 lua_setfield(L, -2, "name");
634 lua_pushnumber(L, n.getParam1());
635 lua_setfield(L, -2, "param1");
636 lua_pushnumber(L, n.getParam2());
637 lua_setfield(L, -2, "param2");
640 /******************************************************************************/
641 void warn_if_field_exists(lua_State *L, int table,
642 const char *fieldname, const std::string &message)
644 lua_getfield(L, table, fieldname);
645 if(!lua_isnil(L, -1)){
646 //TODO find way to access backtrace fct from here
647 // infostream<<script_get_backtrace(L)<<std::endl;
648 infostream<<"WARNING: field \""<<fieldname<<"\": "
649 <<message<<std::endl;
654 /******************************************************************************/
655 int getenumfield(lua_State *L, int table,
656 const char *fieldname, const EnumString *spec, int default_)
658 int result = default_;
659 string_to_enum(spec, result,
660 getstringfield_default(L, table, fieldname, ""));
664 /******************************************************************************/
665 bool string_to_enum(const EnumString *spec, int &result,
666 const std::string &str)
668 const EnumString *esp = spec;
670 if(str == std::string(esp->str)){
679 /******************************************************************************/
680 ItemStack read_item(lua_State* L, int index,Server* srv)
683 index = lua_gettop(L) + 1 + index;
685 if(lua_isnil(L, index))
689 else if(lua_isuserdata(L, index))
691 // Convert from LuaItemStack
692 LuaItemStack *o = LuaItemStack::checkobject(L, index);
695 else if(lua_isstring(L, index))
697 // Convert from itemstring
698 std::string itemstring = lua_tostring(L, index);
699 IItemDefManager *idef = srv->idef();
703 item.deSerialize(itemstring, idef);
706 catch(SerializationError &e)
708 infostream<<"WARNING: unable to create item from itemstring"
709 <<": "<<itemstring<<std::endl;
713 else if(lua_istable(L, index))
715 // Convert from table
716 IItemDefManager *idef = srv->idef();
717 std::string name = getstringfield_default(L, index, "name", "");
718 int count = getintfield_default(L, index, "count", 1);
719 int wear = getintfield_default(L, index, "wear", 0);
720 std::string metadata = getstringfield_default(L, index, "metadata", "");
721 return ItemStack(name, count, wear, metadata, idef);
725 throw LuaError("Expecting itemstack, itemstring, table or nil");
729 /******************************************************************************/
730 void push_tool_capabilities(lua_State *L,
731 const ToolCapabilities &toolcap)
734 setfloatfield(L, -1, "full_punch_interval", toolcap.full_punch_interval);
735 setintfield(L, -1, "max_drop_level", toolcap.max_drop_level);
736 // Create groupcaps table
739 for(std::map<std::string, ToolGroupCap>::const_iterator
740 i = toolcap.groupcaps.begin(); i != toolcap.groupcaps.end(); i++){
741 // Create groupcap table
743 const std::string &name = i->first;
744 const ToolGroupCap &groupcap = i->second;
745 // Create subtable "times"
747 for(std::map<int, float>::const_iterator
748 i = groupcap.times.begin(); i != groupcap.times.end(); i++){
749 int rating = i->first;
750 float time = i->second;
751 lua_pushinteger(L, rating);
752 lua_pushnumber(L, time);
755 // Set subtable "times"
756 lua_setfield(L, -2, "times");
757 // Set simple parameters
758 setintfield(L, -1, "maxlevel", groupcap.maxlevel);
759 setintfield(L, -1, "uses", groupcap.uses);
760 // Insert groupcap table into groupcaps table
761 lua_setfield(L, -2, name.c_str());
763 // Set groupcaps table
764 lua_setfield(L, -2, "groupcaps");
765 //Create damage_groups table
767 // For each damage group
768 for(std::map<std::string, s16>::const_iterator
769 i = toolcap.damageGroups.begin(); i != toolcap.damageGroups.end(); i++){
770 // Create damage group table
771 lua_pushinteger(L, i->second);
772 lua_setfield(L, -2, i->first.c_str());
774 lua_setfield(L, -2, "damage_groups");
777 /******************************************************************************/
778 void push_inventory_list(lua_State *L, Inventory *inv, const char *name)
780 InventoryList *invlist = inv->getList(name);
785 std::vector<ItemStack> items;
786 for(u32 i=0; i<invlist->getSize(); i++)
787 items.push_back(invlist->getItem(i));
788 push_items(L, items);
791 /******************************************************************************/
792 void read_inventory_list(lua_State *L, int tableindex,
793 Inventory *inv, const char *name, Server* srv, int forcesize)
796 tableindex = lua_gettop(L) + 1 + tableindex;
797 // If nil, delete list
798 if(lua_isnil(L, tableindex)){
799 inv->deleteList(name);
802 // Otherwise set list
803 std::vector<ItemStack> items = read_items(L, tableindex,srv);
804 int listsize = (forcesize != -1) ? forcesize : items.size();
805 InventoryList *invlist = inv->addList(name, listsize);
807 for(std::vector<ItemStack>::const_iterator
808 i = items.begin(); i != items.end(); i++){
809 if(forcesize != -1 && index == forcesize)
811 invlist->changeItem(index, *i);
814 while(forcesize != -1 && index < forcesize){
815 invlist->deleteItem(index);
820 /******************************************************************************/
821 ToolCapabilities read_tool_capabilities(
822 lua_State *L, int table)
824 ToolCapabilities toolcap;
825 getfloatfield(L, table, "full_punch_interval", toolcap.full_punch_interval);
826 getintfield(L, table, "max_drop_level", toolcap.max_drop_level);
827 lua_getfield(L, table, "groupcaps");
828 if(lua_istable(L, -1)){
829 int table_groupcaps = lua_gettop(L);
831 while(lua_next(L, table_groupcaps) != 0){
832 // key at index -2 and value at index -1
833 std::string groupname = luaL_checkstring(L, -2);
834 if(lua_istable(L, -1)){
835 int table_groupcap = lua_gettop(L);
836 // This will be created
837 ToolGroupCap groupcap;
838 // Read simple parameters
839 getintfield(L, table_groupcap, "maxlevel", groupcap.maxlevel);
840 getintfield(L, table_groupcap, "uses", groupcap.uses);
841 // DEPRECATED: maxwear
843 if(getfloatfield(L, table_groupcap, "maxwear", maxwear)){
845 groupcap.uses = 1.0/maxwear;
848 infostream<<script_get_backtrace(L)<<std::endl;
849 infostream<<"WARNING: field \"maxwear\" is deprecated; "
850 <<"should replace with uses=1/maxwear"<<std::endl;
852 // Read "times" table
853 lua_getfield(L, table_groupcap, "times");
854 if(lua_istable(L, -1)){
855 int table_times = lua_gettop(L);
857 while(lua_next(L, table_times) != 0){
858 // key at index -2 and value at index -1
859 int rating = luaL_checkinteger(L, -2);
860 float time = luaL_checknumber(L, -1);
861 groupcap.times[rating] = time;
862 // removes value, keeps key for next iteration
867 // Insert groupcap into toolcap
868 toolcap.groupcaps[groupname] = groupcap;
870 // removes value, keeps key for next iteration
876 lua_getfield(L, table, "damage_groups");
877 if(lua_istable(L, -1)){
878 int table_damage_groups = lua_gettop(L);
880 while(lua_next(L, table_damage_groups) != 0){
881 // key at index -2 and value at index -1
882 std::string groupname = luaL_checkstring(L, -2);
883 u16 value = luaL_checkinteger(L, -1);
884 toolcap.damageGroups[groupname] = value;
885 // removes value, keeps key for next iteration
893 /******************************************************************************/
894 void push_dig_params(lua_State *L,const DigParams ¶ms)
897 setboolfield(L, -1, "diggable", params.diggable);
898 setfloatfield(L, -1, "time", params.time);
899 setintfield(L, -1, "wear", params.wear);
902 /******************************************************************************/
903 void push_hit_params(lua_State *L,const HitParams ¶ms)
906 setintfield(L, -1, "hp", params.hp);
907 setintfield(L, -1, "wear", params.wear);
910 /******************************************************************************/
912 bool getflagsfield(lua_State *L, int table, const char *fieldname,
913 FlagDesc *flagdesc, u32 *flags, u32 *flagmask)
915 lua_getfield(L, table, fieldname);
917 bool success = read_flags(L, -1, flagdesc, flags, flagmask);
924 bool read_flags(lua_State *L, int index, FlagDesc *flagdesc,
925 u32 *flags, u32 *flagmask)
927 if (lua_isstring(L, index)) {
928 std::string flagstr = lua_tostring(L, index);
929 *flags = readFlagString(flagstr, flagdesc, flagmask);
930 } else if (lua_istable(L, index)) {
931 *flags = read_flags_table(L, index, flagdesc, flagmask);
939 u32 read_flags_table(lua_State *L, int table, FlagDesc *flagdesc, u32 *flagmask)
941 u32 flags = 0, mask = 0;
942 char fnamebuf[64] = "no";
944 for (int i = 0; flagdesc[i].name; i++) {
947 if (getboolfield(L, table, flagdesc[i].name, result)) {
948 mask |= flagdesc[i].flag;
950 flags |= flagdesc[i].flag;
953 strlcpy(fnamebuf + 2, flagdesc[i].name, sizeof(fnamebuf) - 2);
954 if (getboolfield(L, table, fnamebuf, result))
955 mask |= flagdesc[i].flag;
964 void push_flags_string(lua_State *L, FlagDesc *flagdesc, u32 flags, u32 flagmask)
966 std::string flagstring = writeFlagString(flags, flagdesc, flagmask);
967 lua_pushlstring(L, flagstring.c_str(), flagstring.size());
970 /******************************************************************************/
971 /* Lua Stored data! */
972 /******************************************************************************/
974 /******************************************************************************/
975 void read_groups(lua_State *L, int index,
976 std::map<std::string, int> &result)
978 if (!lua_istable(L,index))
984 while(lua_next(L, index) != 0){
985 // key at index -2 and value at index -1
986 std::string name = luaL_checkstring(L, -2);
987 int rating = luaL_checkinteger(L, -1);
988 result[name] = rating;
989 // removes value, keeps key for next iteration
994 /******************************************************************************/
995 void push_groups(lua_State *L, const std::map<std::string, int> &groups)
998 std::map<std::string, int>::const_iterator it;
999 for (it = groups.begin(); it != groups.end(); ++it) {
1000 lua_pushnumber(L, it->second);
1001 lua_setfield(L, -2, it->first.c_str());
1005 /******************************************************************************/
1006 void push_items(lua_State *L, const std::vector<ItemStack> &items)
1008 lua_createtable(L, items.size(), 0);
1009 for (u32 i = 0; i != items.size(); i++) {
1010 LuaItemStack::create(L, items[i]);
1011 lua_rawseti(L, -2, i + 1);
1015 /******************************************************************************/
1016 std::vector<ItemStack> read_items(lua_State *L, int index, Server *srv)
1019 index = lua_gettop(L) + 1 + index;
1021 std::vector<ItemStack> items;
1022 luaL_checktype(L, index, LUA_TTABLE);
1024 while (lua_next(L, index)) {
1025 s32 key = luaL_checkinteger(L, -2);
1027 throw LuaError("Invalid inventory list index");
1029 if (items.size() < (u32) key) {
1032 items[key - 1] = read_item(L, -1, srv);
1038 /******************************************************************************/
1039 void luaentity_get(lua_State *L, u16 id)
1041 // Get luaentities[i]
1042 lua_getglobal(L, "core");
1043 lua_getfield(L, -1, "luaentities");
1044 luaL_checktype(L, -1, LUA_TTABLE);
1045 lua_pushnumber(L, id);
1046 lua_gettable(L, -2);
1047 lua_remove(L, -2); // Remove luaentities
1048 lua_remove(L, -2); // Remove core
1051 /******************************************************************************/
1052 bool read_noiseparams(lua_State *L, int index, NoiseParams *np)
1055 index = lua_gettop(L) + 1 + index;
1057 if (!lua_istable(L, index))
1060 getfloatfield(L, index, "offset", np->offset);
1061 getfloatfield(L, index, "scale", np->scale);
1062 getfloatfield(L, index, "persist", np->persist);
1063 getfloatfield(L, index, "persistence", np->persist);
1064 getfloatfield(L, index, "lacunarity", np->lacunarity);
1065 getintfield(L, index, "seed", np->seed);
1066 getintfield(L, index, "octaves", np->octaves);
1070 np->flags = getflagsfield(L, index, "flags", flagdesc_noiseparams,
1071 &flags, &flagmask) ? flags : NOISE_FLAG_DEFAULTS;
1073 lua_getfield(L, index, "spread");
1074 np->spread = read_v3f(L, -1);
1080 void push_noiseparams(lua_State *L, NoiseParams *np)
1083 lua_pushnumber(L, np->offset);
1084 lua_setfield(L, -2, "offset");
1085 lua_pushnumber(L, np->scale);
1086 lua_setfield(L, -2, "scale");
1087 lua_pushnumber(L, np->persist);
1088 lua_setfield(L, -2, "persistence");
1089 lua_pushnumber(L, np->lacunarity);
1090 lua_setfield(L, -2, "lacunarity");
1091 lua_pushnumber(L, np->seed);
1092 lua_setfield(L, -2, "seed");
1093 lua_pushnumber(L, np->octaves);
1094 lua_setfield(L, -2, "octaves");
1096 push_flags_string(L, flagdesc_noiseparams, np->flags,
1098 lua_setfield(L, -2, "flags");
1100 push_v3f(L, np->spread);
1101 lua_setfield(L, -2, "spread");
1104 /******************************************************************************/
1105 // Returns depth of json value tree
1106 static int push_json_value_getdepth(const Json::Value &value)
1108 if (!value.isArray() && !value.isObject())
1112 for (Json::Value::const_iterator it = value.begin();
1113 it != value.end(); ++it) {
1114 int elemdepth = push_json_value_getdepth(*it);
1115 if (elemdepth > maxdepth)
1116 maxdepth = elemdepth;
1118 return maxdepth + 1;
1120 // Recursive function to convert JSON --> Lua table
1121 static bool push_json_value_helper(lua_State *L, const Json::Value &value,
1124 switch(value.type()) {
1125 case Json::nullValue:
1127 lua_pushvalue(L, nullindex);
1129 case Json::intValue:
1130 lua_pushinteger(L, value.asInt());
1132 case Json::uintValue:
1133 lua_pushinteger(L, value.asUInt());
1135 case Json::realValue:
1136 lua_pushnumber(L, value.asDouble());
1138 case Json::stringValue:
1140 const char *str = value.asCString();
1141 lua_pushstring(L, str ? str : "");
1144 case Json::booleanValue:
1145 lua_pushboolean(L, value.asInt());
1147 case Json::arrayValue:
1149 for (Json::Value::const_iterator it = value.begin();
1150 it != value.end(); ++it) {
1151 push_json_value_helper(L, *it, nullindex);
1152 lua_rawseti(L, -2, it.index() + 1);
1155 case Json::objectValue:
1157 for (Json::Value::const_iterator it = value.begin();
1158 it != value.end(); ++it) {
1159 const char *str = it.memberName();
1160 lua_pushstring(L, str ? str : "");
1161 push_json_value_helper(L, *it, nullindex);
1168 // converts JSON --> Lua table; returns false if lua stack limit exceeded
1169 // nullindex: Lua stack index of value to use in place of JSON null
1170 bool push_json_value(lua_State *L, const Json::Value &value, int nullindex)
1173 nullindex = lua_gettop(L) + 1 + nullindex;
1175 int depth = push_json_value_getdepth(value);
1177 // The maximum number of Lua stack slots used at each recursion level
1178 // of push_json_value_helper is 2, so make sure there a depth * 2 slots
1179 if (lua_checkstack(L, depth * 2))
1180 return push_json_value_helper(L, value, nullindex);
1185 // Converts Lua table --> JSON
1186 void read_json_value(lua_State *L, Json::Value &root, int index, u8 recursion)
1188 if (recursion > 16) {
1189 throw SerializationError("Maximum recursion depth exceeded");
1191 int type = lua_type(L, index);
1192 if (type == LUA_TBOOLEAN) {
1193 root = (bool) lua_toboolean(L, index);
1194 } else if (type == LUA_TNUMBER) {
1195 root = lua_tonumber(L, index);
1196 } else if (type == LUA_TSTRING) {
1198 const char *str = lua_tolstring(L, index, &len);
1199 root = std::string(str, len);
1200 } else if (type == LUA_TTABLE) {
1202 while (lua_next(L, index)) {
1203 // Key is at -2 and value is at -1
1205 read_json_value(L, value, lua_gettop(L), recursion + 1);
1207 Json::ValueType roottype = root.type();
1208 int keytype = lua_type(L, -1);
1209 if (keytype == LUA_TNUMBER) {
1210 lua_Number key = lua_tonumber(L, -1);
1211 if (roottype != Json::nullValue && roottype != Json::arrayValue) {
1212 throw SerializationError("Can't mix array and object values in JSON");
1213 } else if (key < 1) {
1214 throw SerializationError("Can't use zero-based or negative indexes in JSON");
1215 } else if (floor(key) != key) {
1216 throw SerializationError("Can't use indexes with a fractional part in JSON");
1218 root[(Json::ArrayIndex) key - 1] = value;
1219 } else if (keytype == LUA_TSTRING) {
1220 if (roottype != Json::nullValue && roottype != Json::objectValue) {
1221 throw SerializationError("Can't mix array and object values in JSON");
1223 root[lua_tostring(L, -1)] = value;
1225 throw SerializationError("Lua key to convert to JSON is not a string or number");
1228 } else if (type == LUA_TNIL) {
1229 root = Json::nullValue;
1231 throw SerializationError("Can only store booleans, numbers, strings, objects, arrays, and null in JSON");
1233 lua_pop(L, 1); // Pop value