3 Copyright (C) 2011 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.
20 #include "scriptapi.h"
34 #include "serverobject.h"
36 #include "object_properties.h"
37 #include "content_sao.h" // For LuaEntitySAO and PlayerSAO
41 #include "main.h" // For g_settings
42 #include "settings.h" // For accessing g_settings
43 #include "nodemetadata.h"
44 #include "mapblock.h" // For getNodeBlockPos
45 #include "content_nodemeta.h"
47 #include "daynightratio.h"
48 #include "noise.h" // PseudoRandom for LuaPseudoRandom
49 #include "util/pointedthing.h"
52 static void stackDump(lua_State *L, std::ostream &o)
55 int top = lua_gettop(L);
56 for (i = 1; i <= top; i++) { /* repeat for each level */
57 int t = lua_type(L, i);
60 case LUA_TSTRING: /* strings */
61 o<<"\""<<lua_tostring(L, i)<<"\"";
64 case LUA_TBOOLEAN: /* booleans */
65 o<<(lua_toboolean(L, i) ? "true" : "false");
68 case LUA_TNUMBER: /* numbers */ {
70 snprintf(buf, 10, "%g", lua_tonumber(L, i));
74 default: /* other values */
75 o<<lua_typename(L, t);
84 static void realitycheck(lua_State *L)
86 int top = lua_gettop(L);
88 dstream<<"Stack is over 30:"<<std::endl;
89 stackDump(L, dstream);
90 script_error(L, "Stack is over 30 (reality check)");
100 StackUnroller(lua_State *L):
104 m_original_top = lua_gettop(m_lua); // store stack height
108 lua_settop(m_lua, m_original_top); // restore stack height
117 ModNameStorer(lua_State *L_, const std::string modname):
120 // Store current modname in registry
121 lua_pushstring(L, modname.c_str());
122 lua_setfield(L, LUA_REGISTRYINDEX, "minetest_current_modname");
126 // Clear current modname in registry
128 lua_setfield(L, LUA_REGISTRYINDEX, "minetest_current_modname");
133 Getters for stuff in main tables
136 static Server* get_server(lua_State *L)
138 // Get server from registry
139 lua_getfield(L, LUA_REGISTRYINDEX, "minetest_server");
140 Server *server = (Server*)lua_touserdata(L, -1);
145 static ServerEnvironment* get_env(lua_State *L)
147 // Get environment from registry
148 lua_getfield(L, LUA_REGISTRYINDEX, "minetest_env");
149 ServerEnvironment *env = (ServerEnvironment*)lua_touserdata(L, -1);
154 static void objectref_get(lua_State *L, u16 id)
156 // Get minetest.object_refs[i]
157 lua_getglobal(L, "minetest");
158 lua_getfield(L, -1, "object_refs");
159 luaL_checktype(L, -1, LUA_TTABLE);
160 lua_pushnumber(L, id);
162 lua_remove(L, -2); // object_refs
163 lua_remove(L, -2); // minetest
166 static void luaentity_get(lua_State *L, u16 id)
168 // Get minetest.luaentities[i]
169 lua_getglobal(L, "minetest");
170 lua_getfield(L, -1, "luaentities");
171 luaL_checktype(L, -1, LUA_TTABLE);
172 lua_pushnumber(L, id);
174 lua_remove(L, -2); // luaentities
175 lua_remove(L, -2); // minetest
182 static bool getstringfield(lua_State *L, int table,
183 const char *fieldname, std::string &result)
185 lua_getfield(L, table, fieldname);
187 if(lua_isstring(L, -1)){
189 const char *ptr = lua_tolstring(L, -1, &len);
190 result.assign(ptr, len);
197 static bool getintfield(lua_State *L, int table,
198 const char *fieldname, int &result)
200 lua_getfield(L, table, fieldname);
202 if(lua_isnumber(L, -1)){
203 result = lua_tonumber(L, -1);
210 static bool getfloatfield(lua_State *L, int table,
211 const char *fieldname, float &result)
213 lua_getfield(L, table, fieldname);
215 if(lua_isnumber(L, -1)){
216 result = lua_tonumber(L, -1);
223 static bool getboolfield(lua_State *L, int table,
224 const char *fieldname, bool &result)
226 lua_getfield(L, table, fieldname);
228 if(lua_isboolean(L, -1)){
229 result = lua_toboolean(L, -1);
236 static std::string checkstringfield(lua_State *L, int table,
237 const char *fieldname)
239 lua_getfield(L, table, fieldname);
240 std::string s = luaL_checkstring(L, -1);
245 static std::string getstringfield_default(lua_State *L, int table,
246 const char *fieldname, const std::string &default_)
248 std::string result = default_;
249 getstringfield(L, table, fieldname, result);
253 static int getintfield_default(lua_State *L, int table,
254 const char *fieldname, int default_)
256 int result = default_;
257 getintfield(L, table, fieldname, result);
261 static float getfloatfield_default(lua_State *L, int table,
262 const char *fieldname, float default_)
264 float result = default_;
265 getfloatfield(L, table, fieldname, result);
269 static bool getboolfield_default(lua_State *L, int table,
270 const char *fieldname, bool default_)
272 bool result = default_;
273 getboolfield(L, table, fieldname, result);
283 static bool string_to_enum(const EnumString *spec, int &result,
284 const std::string &str)
286 const EnumString *esp = spec;
288 if(str == std::string(esp->str)){
297 /*static bool enum_to_string(const EnumString *spec, std::string &result,
300 const EnumString *esp = spec;
311 static int getenumfield(lua_State *L, int table,
312 const char *fieldname, const EnumString *spec, int default_)
314 int result = default_;
315 string_to_enum(spec, result,
316 getstringfield_default(L, table, fieldname, ""));
320 static void setintfield(lua_State *L, int table,
321 const char *fieldname, int value)
323 lua_pushinteger(L, value);
326 lua_setfield(L, table, fieldname);
329 static void setfloatfield(lua_State *L, int table,
330 const char *fieldname, float value)
332 lua_pushnumber(L, value);
335 lua_setfield(L, table, fieldname);
338 static void setboolfield(lua_State *L, int table,
339 const char *fieldname, bool value)
341 lua_pushboolean(L, value);
344 lua_setfield(L, table, fieldname);
347 static void warn_if_field_exists(lua_State *L, int table,
348 const char *fieldname, const std::string &message)
350 lua_getfield(L, table, fieldname);
351 if(!lua_isnil(L, -1)){
352 infostream<<script_get_backtrace(L)<<std::endl;
353 infostream<<"WARNING: field \""<<fieldname<<"\": "
354 <<message<<std::endl;
360 EnumString definitions
363 struct EnumString es_ItemType[] =
367 {ITEM_CRAFT, "craft"},
372 struct EnumString es_DrawType[] =
374 {NDT_NORMAL, "normal"},
375 {NDT_AIRLIKE, "airlike"},
376 {NDT_LIQUID, "liquid"},
377 {NDT_FLOWINGLIQUID, "flowingliquid"},
378 {NDT_GLASSLIKE, "glasslike"},
379 {NDT_ALLFACES, "allfaces"},
380 {NDT_ALLFACES_OPTIONAL, "allfaces_optional"},
381 {NDT_TORCHLIKE, "torchlike"},
382 {NDT_SIGNLIKE, "signlike"},
383 {NDT_PLANTLIKE, "plantlike"},
384 {NDT_FENCELIKE, "fencelike"},
385 {NDT_RAILLIKE, "raillike"},
386 {NDT_NODEBOX, "nodebox"},
390 struct EnumString es_ContentParamType[] =
393 {CPT_LIGHT, "light"},
397 struct EnumString es_ContentParamType2[] =
401 {CPT2_FLOWINGLIQUID, "flowingliquid"},
402 {CPT2_FACEDIR, "facedir"},
403 {CPT2_WALLMOUNTED, "wallmounted"},
407 struct EnumString es_LiquidType[] =
409 {LIQUID_NONE, "none"},
410 {LIQUID_FLOWING, "flowing"},
411 {LIQUID_SOURCE, "source"},
415 struct EnumString es_NodeBoxType[] =
417 {NODEBOX_REGULAR, "regular"},
418 {NODEBOX_FIXED, "fixed"},
419 {NODEBOX_WALLMOUNTED, "wallmounted"},
423 struct EnumString es_CraftMethod[] =
425 {CRAFT_METHOD_NORMAL, "normal"},
426 {CRAFT_METHOD_COOKING, "cooking"},
427 {CRAFT_METHOD_FUEL, "fuel"},
431 struct EnumString es_TileAnimationType[] =
434 {TAT_VERTICAL_FRAMES, "vertical_frames"},
439 C struct <-> Lua table converter functions
442 static void push_v3f(lua_State *L, v3f p)
445 lua_pushnumber(L, p.X);
446 lua_setfield(L, -2, "x");
447 lua_pushnumber(L, p.Y);
448 lua_setfield(L, -2, "y");
449 lua_pushnumber(L, p.Z);
450 lua_setfield(L, -2, "z");
453 static v2s16 read_v2s16(lua_State *L, int index)
456 luaL_checktype(L, index, LUA_TTABLE);
457 lua_getfield(L, index, "x");
458 p.X = lua_tonumber(L, -1);
460 lua_getfield(L, index, "y");
461 p.Y = lua_tonumber(L, -1);
466 static v2f read_v2f(lua_State *L, int index)
469 luaL_checktype(L, index, LUA_TTABLE);
470 lua_getfield(L, index, "x");
471 p.X = lua_tonumber(L, -1);
473 lua_getfield(L, index, "y");
474 p.Y = lua_tonumber(L, -1);
479 static v3f read_v3f(lua_State *L, int index)
482 luaL_checktype(L, index, LUA_TTABLE);
483 lua_getfield(L, index, "x");
484 pos.X = lua_tonumber(L, -1);
486 lua_getfield(L, index, "y");
487 pos.Y = lua_tonumber(L, -1);
489 lua_getfield(L, index, "z");
490 pos.Z = lua_tonumber(L, -1);
495 static v3f check_v3f(lua_State *L, int index)
498 luaL_checktype(L, index, LUA_TTABLE);
499 lua_getfield(L, index, "x");
500 pos.X = luaL_checknumber(L, -1);
502 lua_getfield(L, index, "y");
503 pos.Y = luaL_checknumber(L, -1);
505 lua_getfield(L, index, "z");
506 pos.Z = luaL_checknumber(L, -1);
511 static void pushFloatPos(lua_State *L, v3f p)
517 static v3f checkFloatPos(lua_State *L, int index)
519 return check_v3f(L, index) * BS;
522 static void push_v3s16(lua_State *L, v3s16 p)
525 lua_pushnumber(L, p.X);
526 lua_setfield(L, -2, "x");
527 lua_pushnumber(L, p.Y);
528 lua_setfield(L, -2, "y");
529 lua_pushnumber(L, p.Z);
530 lua_setfield(L, -2, "z");
533 static v3s16 read_v3s16(lua_State *L, int index)
535 // Correct rounding at <0
536 v3f pf = read_v3f(L, index);
537 return floatToInt(pf, 1.0);
540 static v3s16 check_v3s16(lua_State *L, int index)
542 // Correct rounding at <0
543 v3f pf = check_v3f(L, index);
544 return floatToInt(pf, 1.0);
547 static void pushnode(lua_State *L, const MapNode &n, INodeDefManager *ndef)
550 lua_pushstring(L, ndef->get(n).name.c_str());
551 lua_setfield(L, -2, "name");
552 lua_pushnumber(L, n.getParam1());
553 lua_setfield(L, -2, "param1");
554 lua_pushnumber(L, n.getParam2());
555 lua_setfield(L, -2, "param2");
558 static MapNode readnode(lua_State *L, int index, INodeDefManager *ndef)
560 lua_getfield(L, index, "name");
561 const char *name = luaL_checkstring(L, -1);
564 lua_getfield(L, index, "param1");
568 param1 = lua_tonumber(L, -1);
571 lua_getfield(L, index, "param2");
575 param2 = lua_tonumber(L, -1);
577 return MapNode(ndef, name, param1, param2);
580 static video::SColor readARGB8(lua_State *L, int index)
583 luaL_checktype(L, index, LUA_TTABLE);
584 lua_getfield(L, index, "a");
585 if(lua_isnumber(L, -1))
586 color.setAlpha(lua_tonumber(L, -1));
588 lua_getfield(L, index, "r");
589 color.setRed(lua_tonumber(L, -1));
591 lua_getfield(L, index, "g");
592 color.setGreen(lua_tonumber(L, -1));
594 lua_getfield(L, index, "b");
595 color.setBlue(lua_tonumber(L, -1));
600 static aabb3f read_aabb3f(lua_State *L, int index, f32 scale)
603 if(lua_istable(L, index)){
604 lua_rawgeti(L, index, 1);
605 box.MinEdge.X = lua_tonumber(L, -1) * scale;
607 lua_rawgeti(L, index, 2);
608 box.MinEdge.Y = lua_tonumber(L, -1) * scale;
610 lua_rawgeti(L, index, 3);
611 box.MinEdge.Z = lua_tonumber(L, -1) * scale;
613 lua_rawgeti(L, index, 4);
614 box.MaxEdge.X = lua_tonumber(L, -1) * scale;
616 lua_rawgeti(L, index, 5);
617 box.MaxEdge.Y = lua_tonumber(L, -1) * scale;
619 lua_rawgeti(L, index, 6);
620 box.MaxEdge.Z = lua_tonumber(L, -1) * scale;
626 static std::vector<aabb3f> read_aabb3f_vector(lua_State *L, int index, f32 scale)
628 std::vector<aabb3f> boxes;
629 if(lua_istable(L, index)){
630 int n = lua_objlen(L, index);
631 // Check if it's a single box or a list of boxes
632 bool possibly_single_box = (n == 6);
633 for(int i = 1; i <= n && possibly_single_box; i++){
634 lua_rawgeti(L, index, i);
635 if(!lua_isnumber(L, -1))
636 possibly_single_box = false;
639 if(possibly_single_box){
641 boxes.push_back(read_aabb3f(L, index, scale));
643 // Read a list of boxes
644 for(int i = 1; i <= n; i++){
645 lua_rawgeti(L, index, i);
646 boxes.push_back(read_aabb3f(L, -1, scale));
654 static NodeBox read_nodebox(lua_State *L, int index)
657 if(lua_istable(L, -1)){
658 nodebox.type = (NodeBoxType)getenumfield(L, index, "type",
659 es_NodeBoxType, NODEBOX_REGULAR);
661 lua_getfield(L, index, "fixed");
662 if(lua_istable(L, -1))
663 nodebox.fixed = read_aabb3f_vector(L, -1, BS);
666 lua_getfield(L, index, "wall_top");
667 if(lua_istable(L, -1))
668 nodebox.wall_top = read_aabb3f(L, -1, BS);
671 lua_getfield(L, index, "wall_bottom");
672 if(lua_istable(L, -1))
673 nodebox.wall_bottom = read_aabb3f(L, -1, BS);
676 lua_getfield(L, index, "wall_side");
677 if(lua_istable(L, -1))
678 nodebox.wall_side = read_aabb3f(L, -1, BS);
687 static void read_groups(lua_State *L, int index,
688 std::map<std::string, int> &result)
690 if (!lua_istable(L,index))
696 while(lua_next(L, index) != 0){
697 // key at index -2 and value at index -1
698 std::string name = luaL_checkstring(L, -2);
699 int rating = luaL_checkinteger(L, -1);
700 result[name] = rating;
701 // removes value, keeps key for next iteration
709 static void read_privileges(lua_State *L, int index,
710 std::set<std::string> &result)
716 while(lua_next(L, index) != 0){
717 // key at index -2 and value at index -1
718 std::string key = luaL_checkstring(L, -2);
719 bool value = lua_toboolean(L, -1);
722 // removes value, keeps key for next iteration
731 static ToolCapabilities read_tool_capabilities(
732 lua_State *L, int table)
734 ToolCapabilities toolcap;
735 getfloatfield(L, table, "full_punch_interval", toolcap.full_punch_interval);
736 getintfield(L, table, "max_drop_level", toolcap.max_drop_level);
737 lua_getfield(L, table, "groupcaps");
738 if(lua_istable(L, -1)){
739 int table_groupcaps = lua_gettop(L);
741 while(lua_next(L, table_groupcaps) != 0){
742 // key at index -2 and value at index -1
743 std::string groupname = luaL_checkstring(L, -2);
744 if(lua_istable(L, -1)){
745 int table_groupcap = lua_gettop(L);
746 // This will be created
747 ToolGroupCap groupcap;
748 // Read simple parameters
749 getintfield(L, table_groupcap, "maxlevel", groupcap.maxlevel);
750 getintfield(L, table_groupcap, "uses", groupcap.uses);
751 // DEPRECATED: maxwear
753 if(getfloatfield(L, table_groupcap, "maxwear", maxwear)){
755 groupcap.uses = 1.0/maxwear;
758 infostream<<script_get_backtrace(L)<<std::endl;
759 infostream<<"WARNING: field \"maxwear\" is deprecated; "
760 <<"should replace with uses=1/maxwear"<<std::endl;
762 // Read "times" table
763 lua_getfield(L, table_groupcap, "times");
764 if(lua_istable(L, -1)){
765 int table_times = lua_gettop(L);
767 while(lua_next(L, table_times) != 0){
768 // key at index -2 and value at index -1
769 int rating = luaL_checkinteger(L, -2);
770 float time = luaL_checknumber(L, -1);
771 groupcap.times[rating] = time;
772 // removes value, keeps key for next iteration
777 // Insert groupcap into toolcap
778 toolcap.groupcaps[groupname] = groupcap;
780 // removes value, keeps key for next iteration
788 static void set_tool_capabilities(lua_State *L, int table,
789 const ToolCapabilities &toolcap)
791 setfloatfield(L, table, "full_punch_interval", toolcap.full_punch_interval);
792 setintfield(L, table, "max_drop_level", toolcap.max_drop_level);
793 // Create groupcaps table
796 for(std::map<std::string, ToolGroupCap>::const_iterator
797 i = toolcap.groupcaps.begin(); i != toolcap.groupcaps.end(); i++){
798 // Create groupcap table
800 const std::string &name = i->first;
801 const ToolGroupCap &groupcap = i->second;
802 // Create subtable "times"
804 for(std::map<int, float>::const_iterator
805 i = groupcap.times.begin(); i != groupcap.times.end(); i++){
806 int rating = i->first;
807 float time = i->second;
808 lua_pushinteger(L, rating);
809 lua_pushnumber(L, time);
812 // Set subtable "times"
813 lua_setfield(L, -2, "times");
814 // Set simple parameters
815 setintfield(L, -1, "maxlevel", groupcap.maxlevel);
816 setintfield(L, -1, "uses", groupcap.uses);
817 // Insert groupcap table into groupcaps table
818 lua_setfield(L, -2, name.c_str());
820 // Set groupcaps table
821 lua_setfield(L, -2, "groupcaps");
824 static void push_tool_capabilities(lua_State *L,
825 const ToolCapabilities &prop)
828 set_tool_capabilities(L, -1, prop);
835 static void set_dig_params(lua_State *L, int table,
836 const DigParams ¶ms)
838 setboolfield(L, table, "diggable", params.diggable);
839 setfloatfield(L, table, "time", params.time);
840 setintfield(L, table, "wear", params.wear);
843 static void push_dig_params(lua_State *L,
844 const DigParams ¶ms)
847 set_dig_params(L, -1, params);
854 static void set_hit_params(lua_State *L, int table,
855 const HitParams ¶ms)
857 setintfield(L, table, "hp", params.hp);
858 setintfield(L, table, "wear", params.wear);
861 static void push_hit_params(lua_State *L,
862 const HitParams ¶ms)
865 set_hit_params(L, -1, params);
872 static void push_pointed_thing(lua_State *L, const PointedThing& pointed)
875 if(pointed.type == POINTEDTHING_NODE)
877 lua_pushstring(L, "node");
878 lua_setfield(L, -2, "type");
879 push_v3s16(L, pointed.node_undersurface);
880 lua_setfield(L, -2, "under");
881 push_v3s16(L, pointed.node_abovesurface);
882 lua_setfield(L, -2, "above");
884 else if(pointed.type == POINTEDTHING_OBJECT)
886 lua_pushstring(L, "object");
887 lua_setfield(L, -2, "type");
888 objectref_get(L, pointed.object_id);
889 lua_setfield(L, -2, "ref");
893 lua_pushstring(L, "nothing");
894 lua_setfield(L, -2, "type");
902 static void read_soundspec(lua_State *L, int index, SimpleSoundSpec &spec)
905 index = lua_gettop(L) + 1 + index;
906 if(lua_isnil(L, index)){
907 } else if(lua_istable(L, index)){
908 getstringfield(L, index, "name", spec.name);
909 getfloatfield(L, index, "gain", spec.gain);
910 } else if(lua_isstring(L, index)){
911 spec.name = lua_tostring(L, index);
919 static void read_object_properties(lua_State *L, int index,
920 ObjectProperties *prop)
923 index = lua_gettop(L) + 1 + index;
924 if(!lua_istable(L, index))
927 prop->hp_max = getintfield_default(L, -1, "hp_max", 10);
929 getboolfield(L, -1, "physical", prop->physical);
931 getfloatfield(L, -1, "weight", prop->weight);
933 lua_getfield(L, -1, "collisionbox");
934 if(lua_istable(L, -1))
935 prop->collisionbox = read_aabb3f(L, -1, 1.0);
938 getstringfield(L, -1, "visual", prop->visual);
940 lua_getfield(L, -1, "visual_size");
941 if(lua_istable(L, -1))
942 prop->visual_size = read_v2f(L, -1);
945 lua_getfield(L, -1, "textures");
946 if(lua_istable(L, -1)){
947 prop->textures.clear();
948 int table = lua_gettop(L);
950 while(lua_next(L, table) != 0){
951 // key at index -2 and value at index -1
952 if(lua_isstring(L, -1))
953 prop->textures.push_back(lua_tostring(L, -1));
955 prop->textures.push_back("");
956 // removes value, keeps key for next iteration
962 lua_getfield(L, -1, "spritediv");
963 if(lua_istable(L, -1))
964 prop->spritediv = read_v2s16(L, -1);
967 lua_getfield(L, -1, "initial_sprite_basepos");
968 if(lua_istable(L, -1))
969 prop->initial_sprite_basepos = read_v2s16(L, -1);
972 getboolfield(L, -1, "is_visible", prop->is_visible);
973 getboolfield(L, -1, "makes_footstep_sound", prop->makes_footstep_sound);
974 getfloatfield(L, -1, "automatic_rotate", prop->automatic_rotate);
981 static ItemDefinition read_item_definition(lua_State *L, int index,
982 ItemDefinition default_def = ItemDefinition())
985 index = lua_gettop(L) + 1 + index;
987 // Read the item definition
988 ItemDefinition def = default_def;
990 def.type = (ItemType)getenumfield(L, index, "type",
991 es_ItemType, ITEM_NONE);
992 getstringfield(L, index, "name", def.name);
993 getstringfield(L, index, "description", def.description);
994 getstringfield(L, index, "inventory_image", def.inventory_image);
995 getstringfield(L, index, "wield_image", def.wield_image);
997 lua_getfield(L, index, "wield_scale");
998 if(lua_istable(L, -1)){
999 def.wield_scale = check_v3f(L, -1);
1003 def.stack_max = getintfield_default(L, index, "stack_max", def.stack_max);
1004 if(def.stack_max == 0)
1007 lua_getfield(L, index, "on_use");
1008 def.usable = lua_isfunction(L, -1);
1011 getboolfield(L, index, "liquids_pointable", def.liquids_pointable);
1013 warn_if_field_exists(L, index, "tool_digging_properties",
1014 "deprecated: use tool_capabilities");
1016 lua_getfield(L, index, "tool_capabilities");
1017 if(lua_istable(L, -1)){
1018 def.tool_capabilities = new ToolCapabilities(
1019 read_tool_capabilities(L, -1));
1022 // If name is "" (hand), ensure there are ToolCapabilities
1023 // because it will be looked up there whenever any other item has
1024 // no ToolCapabilities
1025 if(def.name == "" && def.tool_capabilities == NULL){
1026 def.tool_capabilities = new ToolCapabilities();
1029 lua_getfield(L, index, "groups");
1030 read_groups(L, -1, def.groups);
1033 // Client shall immediately place this node when player places the item.
1034 // Server will update the precise end result a moment later.
1035 // "" = no prediction
1036 getstringfield(L, index, "node_placement_prediction",
1037 def.node_placement_prediction);
1046 static TileDef read_tiledef(lua_State *L, int index)
1049 index = lua_gettop(L) + 1 + index;
1053 // key at index -2 and value at index
1054 if(lua_isstring(L, index)){
1055 // "default_lava.png"
1056 tiledef.name = lua_tostring(L, index);
1058 else if(lua_istable(L, index))
1060 // {name="default_lava.png", animation={}}
1062 getstringfield(L, index, "name", tiledef.name);
1063 getstringfield(L, index, "image", tiledef.name); // MaterialSpec compat.
1064 tiledef.backface_culling = getboolfield_default(
1065 L, index, "backface_culling", true);
1067 lua_getfield(L, index, "animation");
1068 if(lua_istable(L, -1)){
1069 // {type="vertical_frames", aspect_w=16, aspect_h=16, length=2.0}
1070 tiledef.animation.type = (TileAnimationType)
1071 getenumfield(L, -1, "type", es_TileAnimationType,
1073 tiledef.animation.aspect_w =
1074 getintfield_default(L, -1, "aspect_w", 16);
1075 tiledef.animation.aspect_h =
1076 getintfield_default(L, -1, "aspect_h", 16);
1077 tiledef.animation.length =
1078 getfloatfield_default(L, -1, "length", 1.0);
1090 static ContentFeatures read_content_features(lua_State *L, int index)
1093 index = lua_gettop(L) + 1 + index;
1097 /* Cache existence of some callbacks */
1098 lua_getfield(L, index, "on_construct");
1099 if(!lua_isnil(L, -1)) f.has_on_construct = true;
1101 lua_getfield(L, index, "on_destruct");
1102 if(!lua_isnil(L, -1)) f.has_on_destruct = true;
1104 lua_getfield(L, index, "after_destruct");
1105 if(!lua_isnil(L, -1)) f.has_after_destruct = true;
1109 getstringfield(L, index, "name", f.name);
1112 lua_getfield(L, index, "groups");
1113 read_groups(L, -1, f.groups);
1116 /* Visual definition */
1118 f.drawtype = (NodeDrawType)getenumfield(L, index, "drawtype", es_DrawType,
1120 getfloatfield(L, index, "visual_scale", f.visual_scale);
1123 lua_getfield(L, index, "tiles");
1124 // If nil, try the deprecated name "tile_images" instead
1125 if(lua_isnil(L, -1)){
1127 warn_if_field_exists(L, index, "tile_images",
1128 "Deprecated; new name is \"tiles\".");
1129 lua_getfield(L, index, "tile_images");
1131 if(lua_istable(L, -1)){
1132 int table = lua_gettop(L);
1135 while(lua_next(L, table) != 0){
1136 // Read tiledef from value
1137 f.tiledef[i] = read_tiledef(L, -1);
1138 // removes value, keeps key for next iteration
1146 // Copy last value to all remaining textures
1148 TileDef lasttile = f.tiledef[i-1];
1150 f.tiledef[i] = lasttile;
1157 // special_tiles = {}
1158 lua_getfield(L, index, "special_tiles");
1159 // If nil, try the deprecated name "special_materials" instead
1160 if(lua_isnil(L, -1)){
1162 warn_if_field_exists(L, index, "special_materials",
1163 "Deprecated; new name is \"special_tiles\".");
1164 lua_getfield(L, index, "special_materials");
1166 if(lua_istable(L, -1)){
1167 int table = lua_gettop(L);
1170 while(lua_next(L, table) != 0){
1171 // Read tiledef from value
1172 f.tiledef_special[i] = read_tiledef(L, -1);
1173 // removes value, keeps key for next iteration
1184 f.alpha = getintfield_default(L, index, "alpha", 255);
1188 lua_getfield(L, index, "post_effect_color");
1189 if(!lua_isnil(L, -1))
1190 f.post_effect_color = readARGB8(L, -1);
1193 f.param_type = (ContentParamType)getenumfield(L, index, "paramtype",
1194 es_ContentParamType, CPT_NONE);
1195 f.param_type_2 = (ContentParamType2)getenumfield(L, index, "paramtype2",
1196 es_ContentParamType2, CPT2_NONE);
1198 // Warn about some deprecated fields
1199 warn_if_field_exists(L, index, "wall_mounted",
1200 "deprecated: use paramtype2 = 'wallmounted'");
1201 warn_if_field_exists(L, index, "light_propagates",
1202 "deprecated: determined from paramtype");
1203 warn_if_field_exists(L, index, "dug_item",
1204 "deprecated: use 'drop' field");
1205 warn_if_field_exists(L, index, "extra_dug_item",
1206 "deprecated: use 'drop' field");
1207 warn_if_field_exists(L, index, "extra_dug_item_rarity",
1208 "deprecated: use 'drop' field");
1209 warn_if_field_exists(L, index, "metadata_name",
1210 "deprecated: use on_add and metadata callbacks");
1212 // True for all ground-like things like stone and mud, false for eg. trees
1213 getboolfield(L, index, "is_ground_content", f.is_ground_content);
1214 f.light_propagates = (f.param_type == CPT_LIGHT);
1215 getboolfield(L, index, "sunlight_propagates", f.sunlight_propagates);
1216 // This is used for collision detection.
1217 // Also for general solidness queries.
1218 getboolfield(L, index, "walkable", f.walkable);
1219 // Player can point to these
1220 getboolfield(L, index, "pointable", f.pointable);
1221 // Player can dig these
1222 getboolfield(L, index, "diggable", f.diggable);
1223 // Player can climb these
1224 getboolfield(L, index, "climbable", f.climbable);
1225 // Player can build on these
1226 getboolfield(L, index, "buildable_to", f.buildable_to);
1227 // Whether the node is non-liquid, source liquid or flowing liquid
1228 f.liquid_type = (LiquidType)getenumfield(L, index, "liquidtype",
1229 es_LiquidType, LIQUID_NONE);
1230 // If the content is liquid, this is the flowing version of the liquid.
1231 getstringfield(L, index, "liquid_alternative_flowing",
1232 f.liquid_alternative_flowing);
1233 // If the content is liquid, this is the source version of the liquid.
1234 getstringfield(L, index, "liquid_alternative_source",
1235 f.liquid_alternative_source);
1236 // Viscosity for fluid flow, ranging from 1 to 7, with
1237 // 1 giving almost instantaneous propagation and 7 being
1238 // the slowest possible
1239 f.liquid_viscosity = getintfield_default(L, index,
1240 "liquid_viscosity", f.liquid_viscosity);
1241 // Amount of light the node emits
1242 f.light_source = getintfield_default(L, index,
1243 "light_source", f.light_source);
1244 f.damage_per_second = getintfield_default(L, index,
1245 "damage_per_second", f.damage_per_second);
1247 lua_getfield(L, index, "node_box");
1248 if(lua_istable(L, -1))
1249 f.node_box = read_nodebox(L, -1);
1252 lua_getfield(L, index, "selection_box");
1253 if(lua_istable(L, -1))
1254 f.selection_box = read_nodebox(L, -1);
1257 // Set to true if paramtype used to be 'facedir_simple'
1258 getboolfield(L, index, "legacy_facedir_simple", f.legacy_facedir_simple);
1259 // Set to true if wall_mounted used to be set to true
1260 getboolfield(L, index, "legacy_wallmounted", f.legacy_wallmounted);
1263 lua_getfield(L, index, "sounds");
1264 if(lua_istable(L, -1)){
1265 lua_getfield(L, -1, "footstep");
1266 read_soundspec(L, -1, f.sound_footstep);
1268 lua_getfield(L, -1, "dig");
1269 read_soundspec(L, -1, f.sound_dig);
1271 lua_getfield(L, -1, "dug");
1272 read_soundspec(L, -1, f.sound_dug);
1284 static ItemStack read_item(lua_State *L, int index);
1285 static std::vector<ItemStack> read_items(lua_State *L, int index);
1286 // creates a table of ItemStacks
1287 static void push_items(lua_State *L, const std::vector<ItemStack> &items);
1289 static void inventory_set_list_from_lua(Inventory *inv, const char *name,
1290 lua_State *L, int tableindex, int forcesize=-1)
1293 tableindex = lua_gettop(L) + 1 + tableindex;
1294 // If nil, delete list
1295 if(lua_isnil(L, tableindex)){
1296 inv->deleteList(name);
1299 // Otherwise set list
1300 std::vector<ItemStack> items = read_items(L, tableindex);
1301 int listsize = (forcesize != -1) ? forcesize : items.size();
1302 InventoryList *invlist = inv->addList(name, listsize);
1304 for(std::vector<ItemStack>::const_iterator
1305 i = items.begin(); i != items.end(); i++){
1306 if(forcesize != -1 && index == forcesize)
1308 invlist->changeItem(index, *i);
1311 while(forcesize != -1 && index < forcesize){
1312 invlist->deleteItem(index);
1317 static void inventory_get_list_to_lua(Inventory *inv, const char *name,
1320 InventoryList *invlist = inv->getList(name);
1321 if(invlist == NULL){
1325 std::vector<ItemStack> items;
1326 for(u32 i=0; i<invlist->getSize(); i++)
1327 items.push_back(invlist->getItem(i));
1328 push_items(L, items);
1332 Helpful macros for userdata classes
1335 #define method(class, name) {#name, class::l_##name}
1346 static const char className[];
1347 static const luaL_reg methods[];
1349 // Exported functions
1351 // garbage collector
1352 static int gc_object(lua_State *L)
1354 LuaItemStack *o = *(LuaItemStack **)(lua_touserdata(L, 1));
1359 // is_empty(self) -> true/false
1360 static int l_is_empty(lua_State *L)
1362 LuaItemStack *o = checkobject(L, 1);
1363 ItemStack &item = o->m_stack;
1364 lua_pushboolean(L, item.empty());
1368 // get_name(self) -> string
1369 static int l_get_name(lua_State *L)
1371 LuaItemStack *o = checkobject(L, 1);
1372 ItemStack &item = o->m_stack;
1373 lua_pushstring(L, item.name.c_str());
1377 // get_count(self) -> number
1378 static int l_get_count(lua_State *L)
1380 LuaItemStack *o = checkobject(L, 1);
1381 ItemStack &item = o->m_stack;
1382 lua_pushinteger(L, item.count);
1386 // get_wear(self) -> number
1387 static int l_get_wear(lua_State *L)
1389 LuaItemStack *o = checkobject(L, 1);
1390 ItemStack &item = o->m_stack;
1391 lua_pushinteger(L, item.wear);
1395 // get_metadata(self) -> string
1396 static int l_get_metadata(lua_State *L)
1398 LuaItemStack *o = checkobject(L, 1);
1399 ItemStack &item = o->m_stack;
1400 lua_pushlstring(L, item.metadata.c_str(), item.metadata.size());
1404 // clear(self) -> true
1405 static int l_clear(lua_State *L)
1407 LuaItemStack *o = checkobject(L, 1);
1409 lua_pushboolean(L, true);
1413 // replace(self, itemstack or itemstring or table or nil) -> true
1414 static int l_replace(lua_State *L)
1416 LuaItemStack *o = checkobject(L, 1);
1417 o->m_stack = read_item(L, 2);
1418 lua_pushboolean(L, true);
1422 // to_string(self) -> string
1423 static int l_to_string(lua_State *L)
1425 LuaItemStack *o = checkobject(L, 1);
1426 std::string itemstring = o->m_stack.getItemString();
1427 lua_pushstring(L, itemstring.c_str());
1431 // to_table(self) -> table or nil
1432 static int l_to_table(lua_State *L)
1434 LuaItemStack *o = checkobject(L, 1);
1435 const ItemStack &item = o->m_stack;
1443 lua_pushstring(L, item.name.c_str());
1444 lua_setfield(L, -2, "name");
1445 lua_pushinteger(L, item.count);
1446 lua_setfield(L, -2, "count");
1447 lua_pushinteger(L, item.wear);
1448 lua_setfield(L, -2, "wear");
1449 lua_pushlstring(L, item.metadata.c_str(), item.metadata.size());
1450 lua_setfield(L, -2, "metadata");
1455 // get_stack_max(self) -> number
1456 static int l_get_stack_max(lua_State *L)
1458 LuaItemStack *o = checkobject(L, 1);
1459 ItemStack &item = o->m_stack;
1460 lua_pushinteger(L, item.getStackMax(get_server(L)->idef()));
1464 // get_free_space(self) -> number
1465 static int l_get_free_space(lua_State *L)
1467 LuaItemStack *o = checkobject(L, 1);
1468 ItemStack &item = o->m_stack;
1469 lua_pushinteger(L, item.freeSpace(get_server(L)->idef()));
1473 // is_known(self) -> true/false
1474 // Checks if the item is defined.
1475 static int l_is_known(lua_State *L)
1477 LuaItemStack *o = checkobject(L, 1);
1478 ItemStack &item = o->m_stack;
1479 bool is_known = item.isKnown(get_server(L)->idef());
1480 lua_pushboolean(L, is_known);
1484 // get_definition(self) -> table
1485 // Returns the item definition table from minetest.registered_items,
1486 // or a fallback one (name="unknown")
1487 static int l_get_definition(lua_State *L)
1489 LuaItemStack *o = checkobject(L, 1);
1490 ItemStack &item = o->m_stack;
1492 // Get minetest.registered_items[name]
1493 lua_getglobal(L, "minetest");
1494 lua_getfield(L, -1, "registered_items");
1495 luaL_checktype(L, -1, LUA_TTABLE);
1496 lua_getfield(L, -1, item.name.c_str());
1497 if(lua_isnil(L, -1))
1500 lua_getfield(L, -1, "unknown");
1505 // get_tool_capabilities(self) -> table
1506 // Returns the effective tool digging properties.
1507 // Returns those of the hand ("") if this item has none associated.
1508 static int l_get_tool_capabilities(lua_State *L)
1510 LuaItemStack *o = checkobject(L, 1);
1511 ItemStack &item = o->m_stack;
1512 const ToolCapabilities &prop =
1513 item.getToolCapabilities(get_server(L)->idef());
1514 push_tool_capabilities(L, prop);
1518 // add_wear(self, amount) -> true/false
1519 // The range for "amount" is [0,65535]. Wear is only added if the item
1520 // is a tool. Adding wear might destroy the item.
1521 // Returns true if the item is (or was) a tool.
1522 static int l_add_wear(lua_State *L)
1524 LuaItemStack *o = checkobject(L, 1);
1525 ItemStack &item = o->m_stack;
1526 int amount = lua_tointeger(L, 2);
1527 bool result = item.addWear(amount, get_server(L)->idef());
1528 lua_pushboolean(L, result);
1532 // add_item(self, itemstack or itemstring or table or nil) -> itemstack
1533 // Returns leftover item stack
1534 static int l_add_item(lua_State *L)
1536 LuaItemStack *o = checkobject(L, 1);
1537 ItemStack &item = o->m_stack;
1538 ItemStack newitem = read_item(L, 2);
1539 ItemStack leftover = item.addItem(newitem, get_server(L)->idef());
1540 create(L, leftover);
1544 // item_fits(self, itemstack or itemstring or table or nil) -> true/false, itemstack
1545 // First return value is true iff the new item fits fully into the stack
1546 // Second return value is the would-be-left-over item stack
1547 static int l_item_fits(lua_State *L)
1549 LuaItemStack *o = checkobject(L, 1);
1550 ItemStack &item = o->m_stack;
1551 ItemStack newitem = read_item(L, 2);
1553 bool fits = item.itemFits(newitem, &restitem, get_server(L)->idef());
1554 lua_pushboolean(L, fits); // first return value
1555 create(L, restitem); // second return value
1559 // take_item(self, takecount=1) -> itemstack
1560 static int l_take_item(lua_State *L)
1562 LuaItemStack *o = checkobject(L, 1);
1563 ItemStack &item = o->m_stack;
1565 if(!lua_isnone(L, 2))
1566 takecount = luaL_checkinteger(L, 2);
1567 ItemStack taken = item.takeItem(takecount);
1572 // peek_item(self, peekcount=1) -> itemstack
1573 static int l_peek_item(lua_State *L)
1575 LuaItemStack *o = checkobject(L, 1);
1576 ItemStack &item = o->m_stack;
1578 if(!lua_isnone(L, 2))
1579 peekcount = lua_tointeger(L, 2);
1580 ItemStack peekaboo = item.peekItem(peekcount);
1581 create(L, peekaboo);
1586 LuaItemStack(const ItemStack &item):
1595 const ItemStack& getItem() const
1599 ItemStack& getItem()
1604 // LuaItemStack(itemstack or itemstring or table or nil)
1605 // Creates an LuaItemStack and leaves it on top of stack
1606 static int create_object(lua_State *L)
1608 ItemStack item = read_item(L, 1);
1609 LuaItemStack *o = new LuaItemStack(item);
1610 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
1611 luaL_getmetatable(L, className);
1612 lua_setmetatable(L, -2);
1615 // Not callable from Lua
1616 static int create(lua_State *L, const ItemStack &item)
1618 LuaItemStack *o = new LuaItemStack(item);
1619 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
1620 luaL_getmetatable(L, className);
1621 lua_setmetatable(L, -2);
1625 static LuaItemStack* checkobject(lua_State *L, int narg)
1627 luaL_checktype(L, narg, LUA_TUSERDATA);
1628 void *ud = luaL_checkudata(L, narg, className);
1629 if(!ud) luaL_typerror(L, narg, className);
1630 return *(LuaItemStack**)ud; // unbox pointer
1633 static void Register(lua_State *L)
1636 int methodtable = lua_gettop(L);
1637 luaL_newmetatable(L, className);
1638 int metatable = lua_gettop(L);
1640 lua_pushliteral(L, "__metatable");
1641 lua_pushvalue(L, methodtable);
1642 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
1644 lua_pushliteral(L, "__index");
1645 lua_pushvalue(L, methodtable);
1646 lua_settable(L, metatable);
1648 lua_pushliteral(L, "__gc");
1649 lua_pushcfunction(L, gc_object);
1650 lua_settable(L, metatable);
1652 lua_pop(L, 1); // drop metatable
1654 luaL_openlib(L, 0, methods, 0); // fill methodtable
1655 lua_pop(L, 1); // drop methodtable
1657 // Can be created from Lua (LuaItemStack(itemstack or itemstring or table or nil))
1658 lua_register(L, className, create_object);
1661 const char LuaItemStack::className[] = "ItemStack";
1662 const luaL_reg LuaItemStack::methods[] = {
1663 method(LuaItemStack, is_empty),
1664 method(LuaItemStack, get_name),
1665 method(LuaItemStack, get_count),
1666 method(LuaItemStack, get_wear),
1667 method(LuaItemStack, get_metadata),
1668 method(LuaItemStack, clear),
1669 method(LuaItemStack, replace),
1670 method(LuaItemStack, to_string),
1671 method(LuaItemStack, to_table),
1672 method(LuaItemStack, get_stack_max),
1673 method(LuaItemStack, get_free_space),
1674 method(LuaItemStack, is_known),
1675 method(LuaItemStack, get_definition),
1676 method(LuaItemStack, get_tool_capabilities),
1677 method(LuaItemStack, add_wear),
1678 method(LuaItemStack, add_item),
1679 method(LuaItemStack, item_fits),
1680 method(LuaItemStack, take_item),
1681 method(LuaItemStack, peek_item),
1685 static ItemStack read_item(lua_State *L, int index)
1688 index = lua_gettop(L) + 1 + index;
1690 if(lua_isnil(L, index))
1694 else if(lua_isuserdata(L, index))
1696 // Convert from LuaItemStack
1697 LuaItemStack *o = LuaItemStack::checkobject(L, index);
1698 return o->getItem();
1700 else if(lua_isstring(L, index))
1702 // Convert from itemstring
1703 std::string itemstring = lua_tostring(L, index);
1704 IItemDefManager *idef = get_server(L)->idef();
1708 item.deSerialize(itemstring, idef);
1711 catch(SerializationError &e)
1713 infostream<<"WARNING: unable to create item from itemstring"
1714 <<": "<<itemstring<<std::endl;
1718 else if(lua_istable(L, index))
1720 // Convert from table
1721 IItemDefManager *idef = get_server(L)->idef();
1722 std::string name = getstringfield_default(L, index, "name", "");
1723 int count = getintfield_default(L, index, "count", 1);
1724 int wear = getintfield_default(L, index, "wear", 0);
1725 std::string metadata = getstringfield_default(L, index, "metadata", "");
1726 return ItemStack(name, count, wear, metadata, idef);
1730 throw LuaError(L, "Expecting itemstack, itemstring, table or nil");
1734 static std::vector<ItemStack> read_items(lua_State *L, int index)
1737 index = lua_gettop(L) + 1 + index;
1739 std::vector<ItemStack> items;
1740 luaL_checktype(L, index, LUA_TTABLE);
1742 while(lua_next(L, index) != 0){
1743 // key at index -2 and value at index -1
1744 items.push_back(read_item(L, -1));
1745 // removes value, keeps key for next iteration
1751 // creates a table of ItemStacks
1752 static void push_items(lua_State *L, const std::vector<ItemStack> &items)
1754 // Get the table insert function
1755 lua_getglobal(L, "table");
1756 lua_getfield(L, -1, "insert");
1757 int table_insert = lua_gettop(L);
1758 // Create and fill table
1760 int table = lua_gettop(L);
1761 for(u32 i=0; i<items.size(); i++){
1762 ItemStack item = items[i];
1763 lua_pushvalue(L, table_insert);
1764 lua_pushvalue(L, table);
1765 LuaItemStack::create(L, item);
1766 if(lua_pcall(L, 2, 0, 0))
1767 script_error(L, "error: %s", lua_tostring(L, -1));
1769 lua_remove(L, -2); // Remove table
1770 lua_remove(L, -2); // Remove insert
1780 InventoryLocation m_loc;
1782 static const char className[];
1783 static const luaL_reg methods[];
1785 static InvRef *checkobject(lua_State *L, int narg)
1787 luaL_checktype(L, narg, LUA_TUSERDATA);
1788 void *ud = luaL_checkudata(L, narg, className);
1789 if(!ud) luaL_typerror(L, narg, className);
1790 return *(InvRef**)ud; // unbox pointer
1793 static Inventory* getinv(lua_State *L, InvRef *ref)
1795 return get_server(L)->getInventory(ref->m_loc);
1798 static InventoryList* getlist(lua_State *L, InvRef *ref,
1799 const char *listname)
1801 Inventory *inv = getinv(L, ref);
1804 return inv->getList(listname);
1807 static void reportInventoryChange(lua_State *L, InvRef *ref)
1809 // Inform other things that the inventory has changed
1810 get_server(L)->setInventoryModified(ref->m_loc);
1813 // Exported functions
1815 // garbage collector
1816 static int gc_object(lua_State *L) {
1817 InvRef *o = *(InvRef **)(lua_touserdata(L, 1));
1822 // is_empty(self, listname) -> true/false
1823 static int l_is_empty(lua_State *L)
1825 InvRef *ref = checkobject(L, 1);
1826 const char *listname = luaL_checkstring(L, 2);
1827 InventoryList *list = getlist(L, ref, listname);
1828 if(list && list->getUsedSlots() > 0){
1829 lua_pushboolean(L, false);
1831 lua_pushboolean(L, true);
1836 // get_size(self, listname)
1837 static int l_get_size(lua_State *L)
1839 InvRef *ref = checkobject(L, 1);
1840 const char *listname = luaL_checkstring(L, 2);
1841 InventoryList *list = getlist(L, ref, listname);
1843 lua_pushinteger(L, list->getSize());
1845 lua_pushinteger(L, 0);
1850 // get_width(self, listname)
1851 static int l_get_width(lua_State *L)
1853 InvRef *ref = checkobject(L, 1);
1854 const char *listname = luaL_checkstring(L, 2);
1855 InventoryList *list = getlist(L, ref, listname);
1857 lua_pushinteger(L, list->getWidth());
1859 lua_pushinteger(L, 0);
1864 // set_size(self, listname, size)
1865 static int l_set_size(lua_State *L)
1867 InvRef *ref = checkobject(L, 1);
1868 const char *listname = luaL_checkstring(L, 2);
1869 int newsize = luaL_checknumber(L, 3);
1870 Inventory *inv = getinv(L, ref);
1872 inv->deleteList(listname);
1873 reportInventoryChange(L, ref);
1876 InventoryList *list = inv->getList(listname);
1878 list->setSize(newsize);
1880 list = inv->addList(listname, newsize);
1882 reportInventoryChange(L, ref);
1886 // set_width(self, listname, size)
1887 static int l_set_width(lua_State *L)
1889 InvRef *ref = checkobject(L, 1);
1890 const char *listname = luaL_checkstring(L, 2);
1891 int newwidth = luaL_checknumber(L, 3);
1892 Inventory *inv = getinv(L, ref);
1893 InventoryList *list = inv->getList(listname);
1895 list->setWidth(newwidth);
1899 reportInventoryChange(L, ref);
1903 // get_stack(self, listname, i) -> itemstack
1904 static int l_get_stack(lua_State *L)
1906 InvRef *ref = checkobject(L, 1);
1907 const char *listname = luaL_checkstring(L, 2);
1908 int i = luaL_checknumber(L, 3) - 1;
1909 InventoryList *list = getlist(L, ref, listname);
1911 if(list != NULL && i >= 0 && i < (int) list->getSize())
1912 item = list->getItem(i);
1913 LuaItemStack::create(L, item);
1917 // set_stack(self, listname, i, stack) -> true/false
1918 static int l_set_stack(lua_State *L)
1920 InvRef *ref = checkobject(L, 1);
1921 const char *listname = luaL_checkstring(L, 2);
1922 int i = luaL_checknumber(L, 3) - 1;
1923 ItemStack newitem = read_item(L, 4);
1924 InventoryList *list = getlist(L, ref, listname);
1925 if(list != NULL && i >= 0 && i < (int) list->getSize()){
1926 list->changeItem(i, newitem);
1927 reportInventoryChange(L, ref);
1928 lua_pushboolean(L, true);
1930 lua_pushboolean(L, false);
1935 // get_list(self, listname) -> list or nil
1936 static int l_get_list(lua_State *L)
1938 InvRef *ref = checkobject(L, 1);
1939 const char *listname = luaL_checkstring(L, 2);
1940 Inventory *inv = getinv(L, ref);
1941 inventory_get_list_to_lua(inv, listname, L);
1945 // set_list(self, listname, list)
1946 static int l_set_list(lua_State *L)
1948 InvRef *ref = checkobject(L, 1);
1949 const char *listname = luaL_checkstring(L, 2);
1950 Inventory *inv = getinv(L, ref);
1951 InventoryList *list = inv->getList(listname);
1953 inventory_set_list_from_lua(inv, listname, L, 3,
1956 inventory_set_list_from_lua(inv, listname, L, 3);
1957 reportInventoryChange(L, ref);
1961 // add_item(self, listname, itemstack or itemstring or table or nil) -> itemstack
1962 // Returns the leftover stack
1963 static int l_add_item(lua_State *L)
1965 InvRef *ref = checkobject(L, 1);
1966 const char *listname = luaL_checkstring(L, 2);
1967 ItemStack item = read_item(L, 3);
1968 InventoryList *list = getlist(L, ref, listname);
1970 ItemStack leftover = list->addItem(item);
1971 if(leftover.count != item.count)
1972 reportInventoryChange(L, ref);
1973 LuaItemStack::create(L, leftover);
1975 LuaItemStack::create(L, item);
1980 // room_for_item(self, listname, itemstack or itemstring or table or nil) -> true/false
1981 // Returns true if the item completely fits into the list
1982 static int l_room_for_item(lua_State *L)
1984 InvRef *ref = checkobject(L, 1);
1985 const char *listname = luaL_checkstring(L, 2);
1986 ItemStack item = read_item(L, 3);
1987 InventoryList *list = getlist(L, ref, listname);
1989 lua_pushboolean(L, list->roomForItem(item));
1991 lua_pushboolean(L, false);
1996 // contains_item(self, listname, itemstack or itemstring or table or nil) -> true/false
1997 // Returns true if the list contains the given count of the given item name
1998 static int l_contains_item(lua_State *L)
2000 InvRef *ref = checkobject(L, 1);
2001 const char *listname = luaL_checkstring(L, 2);
2002 ItemStack item = read_item(L, 3);
2003 InventoryList *list = getlist(L, ref, listname);
2005 lua_pushboolean(L, list->containsItem(item));
2007 lua_pushboolean(L, false);
2012 // remove_item(self, listname, itemstack or itemstring or table or nil) -> itemstack
2013 // Returns the items that were actually removed
2014 static int l_remove_item(lua_State *L)
2016 InvRef *ref = checkobject(L, 1);
2017 const char *listname = luaL_checkstring(L, 2);
2018 ItemStack item = read_item(L, 3);
2019 InventoryList *list = getlist(L, ref, listname);
2021 ItemStack removed = list->removeItem(item);
2022 if(!removed.empty())
2023 reportInventoryChange(L, ref);
2024 LuaItemStack::create(L, removed);
2026 LuaItemStack::create(L, ItemStack());
2032 InvRef(const InventoryLocation &loc):
2041 // Creates an InvRef and leaves it on top of stack
2042 // Not callable from Lua; all references are created on the C side.
2043 static void create(lua_State *L, const InventoryLocation &loc)
2045 InvRef *o = new InvRef(loc);
2046 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
2047 luaL_getmetatable(L, className);
2048 lua_setmetatable(L, -2);
2050 static void createPlayer(lua_State *L, Player *player)
2052 InventoryLocation loc;
2053 loc.setPlayer(player->getName());
2056 static void createNodeMeta(lua_State *L, v3s16 p)
2058 InventoryLocation loc;
2063 static void Register(lua_State *L)
2066 int methodtable = lua_gettop(L);
2067 luaL_newmetatable(L, className);
2068 int metatable = lua_gettop(L);
2070 lua_pushliteral(L, "__metatable");
2071 lua_pushvalue(L, methodtable);
2072 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
2074 lua_pushliteral(L, "__index");
2075 lua_pushvalue(L, methodtable);
2076 lua_settable(L, metatable);
2078 lua_pushliteral(L, "__gc");
2079 lua_pushcfunction(L, gc_object);
2080 lua_settable(L, metatable);
2082 lua_pop(L, 1); // drop metatable
2084 luaL_openlib(L, 0, methods, 0); // fill methodtable
2085 lua_pop(L, 1); // drop methodtable
2087 // Cannot be created from Lua
2088 //lua_register(L, className, create_object);
2091 const char InvRef::className[] = "InvRef";
2092 const luaL_reg InvRef::methods[] = {
2093 method(InvRef, is_empty),
2094 method(InvRef, get_size),
2095 method(InvRef, set_size),
2096 method(InvRef, get_width),
2097 method(InvRef, set_width),
2098 method(InvRef, get_stack),
2099 method(InvRef, set_stack),
2100 method(InvRef, get_list),
2101 method(InvRef, set_list),
2102 method(InvRef, add_item),
2103 method(InvRef, room_for_item),
2104 method(InvRef, contains_item),
2105 method(InvRef, remove_item),
2117 ServerEnvironment *m_env;
2119 static const char className[];
2120 static const luaL_reg methods[];
2122 static NodeMetaRef *checkobject(lua_State *L, int narg)
2124 luaL_checktype(L, narg, LUA_TUSERDATA);
2125 void *ud = luaL_checkudata(L, narg, className);
2126 if(!ud) luaL_typerror(L, narg, className);
2127 return *(NodeMetaRef**)ud; // unbox pointer
2130 static NodeMetadata* getmeta(NodeMetaRef *ref, bool auto_create)
2132 NodeMetadata *meta = ref->m_env->getMap().getNodeMetadata(ref->m_p);
2133 if(meta == NULL && auto_create)
2135 meta = new NodeMetadata(ref->m_env->getGameDef());
2136 ref->m_env->getMap().setNodeMetadata(ref->m_p, meta);
2141 static void reportMetadataChange(NodeMetaRef *ref)
2143 // NOTE: This same code is in rollback_interface.cpp
2144 // Inform other things that the metadata has changed
2145 v3s16 blockpos = getNodeBlockPos(ref->m_p);
2147 event.type = MEET_BLOCK_NODE_METADATA_CHANGED;
2149 ref->m_env->getMap().dispatchEvent(&event);
2150 // Set the block to be saved
2151 MapBlock *block = ref->m_env->getMap().getBlockNoCreateNoEx(blockpos);
2153 block->raiseModified(MOD_STATE_WRITE_NEEDED,
2154 "NodeMetaRef::reportMetadataChange");
2157 // Exported functions
2159 // garbage collector
2160 static int gc_object(lua_State *L) {
2161 NodeMetaRef *o = *(NodeMetaRef **)(lua_touserdata(L, 1));
2166 // get_string(self, name)
2167 static int l_get_string(lua_State *L)
2169 NodeMetaRef *ref = checkobject(L, 1);
2170 std::string name = luaL_checkstring(L, 2);
2172 NodeMetadata *meta = getmeta(ref, false);
2174 lua_pushlstring(L, "", 0);
2177 std::string str = meta->getString(name);
2178 lua_pushlstring(L, str.c_str(), str.size());
2182 // set_string(self, name, var)
2183 static int l_set_string(lua_State *L)
2185 NodeMetaRef *ref = checkobject(L, 1);
2186 std::string name = luaL_checkstring(L, 2);
2188 const char *s = lua_tolstring(L, 3, &len);
2189 std::string str(s, len);
2191 NodeMetadata *meta = getmeta(ref, !str.empty());
2192 if(meta == NULL || str == meta->getString(name))
2194 meta->setString(name, str);
2195 reportMetadataChange(ref);
2199 // get_int(self, name)
2200 static int l_get_int(lua_State *L)
2202 NodeMetaRef *ref = checkobject(L, 1);
2203 std::string name = lua_tostring(L, 2);
2205 NodeMetadata *meta = getmeta(ref, false);
2207 lua_pushnumber(L, 0);
2210 std::string str = meta->getString(name);
2211 lua_pushnumber(L, stoi(str));
2215 // set_int(self, name, var)
2216 static int l_set_int(lua_State *L)
2218 NodeMetaRef *ref = checkobject(L, 1);
2219 std::string name = lua_tostring(L, 2);
2220 int a = lua_tointeger(L, 3);
2221 std::string str = itos(a);
2223 NodeMetadata *meta = getmeta(ref, true);
2224 if(meta == NULL || str == meta->getString(name))
2226 meta->setString(name, str);
2227 reportMetadataChange(ref);
2231 // get_float(self, name)
2232 static int l_get_float(lua_State *L)
2234 NodeMetaRef *ref = checkobject(L, 1);
2235 std::string name = lua_tostring(L, 2);
2237 NodeMetadata *meta = getmeta(ref, false);
2239 lua_pushnumber(L, 0);
2242 std::string str = meta->getString(name);
2243 lua_pushnumber(L, stof(str));
2247 // set_float(self, name, var)
2248 static int l_set_float(lua_State *L)
2250 NodeMetaRef *ref = checkobject(L, 1);
2251 std::string name = lua_tostring(L, 2);
2252 float a = lua_tonumber(L, 3);
2253 std::string str = ftos(a);
2255 NodeMetadata *meta = getmeta(ref, true);
2256 if(meta == NULL || str == meta->getString(name))
2258 meta->setString(name, str);
2259 reportMetadataChange(ref);
2263 // get_inventory(self)
2264 static int l_get_inventory(lua_State *L)
2266 NodeMetaRef *ref = checkobject(L, 1);
2267 getmeta(ref, true); // try to ensure the metadata exists
2268 InvRef::createNodeMeta(L, ref->m_p);
2273 static int l_to_table(lua_State *L)
2275 NodeMetaRef *ref = checkobject(L, 1);
2277 NodeMetadata *meta = getmeta(ref, true);
2286 std::map<std::string, std::string> fields = meta->getStrings();
2287 for(std::map<std::string, std::string>::const_iterator
2288 i = fields.begin(); i != fields.end(); i++){
2289 const std::string &name = i->first;
2290 const std::string &value = i->second;
2291 lua_pushlstring(L, name.c_str(), name.size());
2292 lua_pushlstring(L, value.c_str(), value.size());
2293 lua_settable(L, -3);
2296 lua_setfield(L, -2, "fields");
2299 Inventory *inv = meta->getInventory();
2301 std::vector<const InventoryList*> lists = inv->getLists();
2302 for(std::vector<const InventoryList*>::const_iterator
2303 i = lists.begin(); i != lists.end(); i++){
2304 inventory_get_list_to_lua(inv, (*i)->getName().c_str(), L);
2305 lua_setfield(L, -2, (*i)->getName().c_str());
2308 lua_setfield(L, -2, "inventory");
2312 // from_table(self, table)
2313 static int l_from_table(lua_State *L)
2315 NodeMetaRef *ref = checkobject(L, 1);
2318 if(lua_isnil(L, base)){
2320 ref->m_env->getMap().removeNodeMetadata(ref->m_p);
2321 lua_pushboolean(L, true);
2325 // Has metadata; clear old one first
2326 ref->m_env->getMap().removeNodeMetadata(ref->m_p);
2327 // Create new metadata
2328 NodeMetadata *meta = getmeta(ref, true);
2330 lua_getfield(L, base, "fields");
2331 int fieldstable = lua_gettop(L);
2333 while(lua_next(L, fieldstable) != 0){
2334 // key at index -2 and value at index -1
2335 std::string name = lua_tostring(L, -2);
2337 const char *cs = lua_tolstring(L, -1, &cl);
2338 std::string value(cs, cl);
2339 meta->setString(name, value);
2340 lua_pop(L, 1); // removes value, keeps key for next iteration
2343 Inventory *inv = meta->getInventory();
2344 lua_getfield(L, base, "inventory");
2345 int inventorytable = lua_gettop(L);
2347 while(lua_next(L, inventorytable) != 0){
2348 // key at index -2 and value at index -1
2349 std::string name = lua_tostring(L, -2);
2350 inventory_set_list_from_lua(inv, name.c_str(), L, -1);
2351 lua_pop(L, 1); // removes value, keeps key for next iteration
2353 reportMetadataChange(ref);
2354 lua_pushboolean(L, true);
2359 NodeMetaRef(v3s16 p, ServerEnvironment *env):
2369 // Creates an NodeMetaRef and leaves it on top of stack
2370 // Not callable from Lua; all references are created on the C side.
2371 static void create(lua_State *L, v3s16 p, ServerEnvironment *env)
2373 NodeMetaRef *o = new NodeMetaRef(p, env);
2374 //infostream<<"NodeMetaRef::create: o="<<o<<std::endl;
2375 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
2376 luaL_getmetatable(L, className);
2377 lua_setmetatable(L, -2);
2380 static void Register(lua_State *L)
2383 int methodtable = lua_gettop(L);
2384 luaL_newmetatable(L, className);
2385 int metatable = lua_gettop(L);
2387 lua_pushliteral(L, "__metatable");
2388 lua_pushvalue(L, methodtable);
2389 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
2391 lua_pushliteral(L, "__index");
2392 lua_pushvalue(L, methodtable);
2393 lua_settable(L, metatable);
2395 lua_pushliteral(L, "__gc");
2396 lua_pushcfunction(L, gc_object);
2397 lua_settable(L, metatable);
2399 lua_pop(L, 1); // drop metatable
2401 luaL_openlib(L, 0, methods, 0); // fill methodtable
2402 lua_pop(L, 1); // drop methodtable
2404 // Cannot be created from Lua
2405 //lua_register(L, className, create_object);
2408 const char NodeMetaRef::className[] = "NodeMetaRef";
2409 const luaL_reg NodeMetaRef::methods[] = {
2410 method(NodeMetaRef, get_string),
2411 method(NodeMetaRef, set_string),
2412 method(NodeMetaRef, get_int),
2413 method(NodeMetaRef, set_int),
2414 method(NodeMetaRef, get_float),
2415 method(NodeMetaRef, set_float),
2416 method(NodeMetaRef, get_inventory),
2417 method(NodeMetaRef, to_table),
2418 method(NodeMetaRef, from_table),
2429 ServerActiveObject *m_object;
2431 static const char className[];
2432 static const luaL_reg methods[];
2434 static ObjectRef *checkobject(lua_State *L, int narg)
2436 luaL_checktype(L, narg, LUA_TUSERDATA);
2437 void *ud = luaL_checkudata(L, narg, className);
2438 if(!ud) luaL_typerror(L, narg, className);
2439 return *(ObjectRef**)ud; // unbox pointer
2442 static ServerActiveObject* getobject(ObjectRef *ref)
2444 ServerActiveObject *co = ref->m_object;
2448 static LuaEntitySAO* getluaobject(ObjectRef *ref)
2450 ServerActiveObject *obj = getobject(ref);
2453 if(obj->getType() != ACTIVEOBJECT_TYPE_LUAENTITY)
2455 return (LuaEntitySAO*)obj;
2458 static PlayerSAO* getplayersao(ObjectRef *ref)
2460 ServerActiveObject *obj = getobject(ref);
2463 if(obj->getType() != ACTIVEOBJECT_TYPE_PLAYER)
2465 return (PlayerSAO*)obj;
2468 static Player* getplayer(ObjectRef *ref)
2470 PlayerSAO *playersao = getplayersao(ref);
2471 if(playersao == NULL)
2473 return playersao->getPlayer();
2476 // Exported functions
2478 // garbage collector
2479 static int gc_object(lua_State *L) {
2480 ObjectRef *o = *(ObjectRef **)(lua_touserdata(L, 1));
2481 //infostream<<"ObjectRef::gc_object: o="<<o<<std::endl;
2487 static int l_remove(lua_State *L)
2489 ObjectRef *ref = checkobject(L, 1);
2490 ServerActiveObject *co = getobject(ref);
2491 if(co == NULL) return 0;
2492 verbosestream<<"ObjectRef::l_remove(): id="<<co->getId()<<std::endl;
2493 co->m_removed = true;
2498 // returns: {x=num, y=num, z=num}
2499 static int l_getpos(lua_State *L)
2501 ObjectRef *ref = checkobject(L, 1);
2502 ServerActiveObject *co = getobject(ref);
2503 if(co == NULL) return 0;
2504 v3f pos = co->getBasePosition() / BS;
2506 lua_pushnumber(L, pos.X);
2507 lua_setfield(L, -2, "x");
2508 lua_pushnumber(L, pos.Y);
2509 lua_setfield(L, -2, "y");
2510 lua_pushnumber(L, pos.Z);
2511 lua_setfield(L, -2, "z");
2515 // setpos(self, pos)
2516 static int l_setpos(lua_State *L)
2518 ObjectRef *ref = checkobject(L, 1);
2519 //LuaEntitySAO *co = getluaobject(ref);
2520 ServerActiveObject *co = getobject(ref);
2521 if(co == NULL) return 0;
2523 v3f pos = checkFloatPos(L, 2);
2529 // moveto(self, pos, continuous=false)
2530 static int l_moveto(lua_State *L)
2532 ObjectRef *ref = checkobject(L, 1);
2533 //LuaEntitySAO *co = getluaobject(ref);
2534 ServerActiveObject *co = getobject(ref);
2535 if(co == NULL) return 0;
2537 v3f pos = checkFloatPos(L, 2);
2539 bool continuous = lua_toboolean(L, 3);
2541 co->moveTo(pos, continuous);
2545 // punch(self, puncher, time_from_last_punch, tool_capabilities, dir)
2546 static int l_punch(lua_State *L)
2548 ObjectRef *ref = checkobject(L, 1);
2549 ObjectRef *puncher_ref = checkobject(L, 2);
2550 ServerActiveObject *co = getobject(ref);
2551 ServerActiveObject *puncher = getobject(puncher_ref);
2552 if(co == NULL) return 0;
2553 if(puncher == NULL) return 0;
2555 if(lua_type(L, 5) != LUA_TTABLE)
2556 dir = co->getBasePosition() - puncher->getBasePosition();
2558 dir = read_v3f(L, 5);
2559 float time_from_last_punch = 1000000;
2560 if(lua_isnumber(L, 3))
2561 time_from_last_punch = lua_tonumber(L, 3);
2562 ToolCapabilities toolcap = read_tool_capabilities(L, 4);
2565 co->punch(dir, &toolcap, puncher, time_from_last_punch);
2569 // right_click(self, clicker); clicker = an another ObjectRef
2570 static int l_right_click(lua_State *L)
2572 ObjectRef *ref = checkobject(L, 1);
2573 ObjectRef *ref2 = checkobject(L, 2);
2574 ServerActiveObject *co = getobject(ref);
2575 ServerActiveObject *co2 = getobject(ref2);
2576 if(co == NULL) return 0;
2577 if(co2 == NULL) return 0;
2579 co->rightClick(co2);
2584 // hp = number of hitpoints (2 * number of hearts)
2586 static int l_set_hp(lua_State *L)
2588 ObjectRef *ref = checkobject(L, 1);
2589 luaL_checknumber(L, 2);
2590 ServerActiveObject *co = getobject(ref);
2591 if(co == NULL) return 0;
2592 int hp = lua_tonumber(L, 2);
2593 /*infostream<<"ObjectRef::l_set_hp(): id="<<co->getId()
2594 <<" hp="<<hp<<std::endl;*/
2602 // returns: number of hitpoints (2 * number of hearts)
2603 // 0 if not applicable to this type of object
2604 static int l_get_hp(lua_State *L)
2606 ObjectRef *ref = checkobject(L, 1);
2607 ServerActiveObject *co = getobject(ref);
2610 lua_pushnumber(L, 1);
2613 int hp = co->getHP();
2614 /*infostream<<"ObjectRef::l_get_hp(): id="<<co->getId()
2615 <<" hp="<<hp<<std::endl;*/
2617 lua_pushnumber(L, hp);
2621 // get_inventory(self)
2622 static int l_get_inventory(lua_State *L)
2624 ObjectRef *ref = checkobject(L, 1);
2625 ServerActiveObject *co = getobject(ref);
2626 if(co == NULL) return 0;
2628 InventoryLocation loc = co->getInventoryLocation();
2629 if(get_server(L)->getInventory(loc) != NULL)
2630 InvRef::create(L, loc);
2632 lua_pushnil(L); // An object may have no inventory (nil)
2636 // get_wield_list(self)
2637 static int l_get_wield_list(lua_State *L)
2639 ObjectRef *ref = checkobject(L, 1);
2640 ServerActiveObject *co = getobject(ref);
2641 if(co == NULL) return 0;
2643 lua_pushstring(L, co->getWieldList().c_str());
2647 // get_wield_index(self)
2648 static int l_get_wield_index(lua_State *L)
2650 ObjectRef *ref = checkobject(L, 1);
2651 ServerActiveObject *co = getobject(ref);
2652 if(co == NULL) return 0;
2654 lua_pushinteger(L, co->getWieldIndex() + 1);
2658 // get_wielded_item(self)
2659 static int l_get_wielded_item(lua_State *L)
2661 ObjectRef *ref = checkobject(L, 1);
2662 ServerActiveObject *co = getobject(ref);
2665 LuaItemStack::create(L, ItemStack());
2669 LuaItemStack::create(L, co->getWieldedItem());
2673 // set_wielded_item(self, itemstack or itemstring or table or nil)
2674 static int l_set_wielded_item(lua_State *L)
2676 ObjectRef *ref = checkobject(L, 1);
2677 ServerActiveObject *co = getobject(ref);
2678 if(co == NULL) return 0;
2680 ItemStack item = read_item(L, 2);
2681 bool success = co->setWieldedItem(item);
2682 lua_pushboolean(L, success);
2686 // set_armor_groups(self, groups)
2687 static int l_set_armor_groups(lua_State *L)
2689 ObjectRef *ref = checkobject(L, 1);
2690 ServerActiveObject *co = getobject(ref);
2691 if(co == NULL) return 0;
2693 ItemGroupList groups;
2694 read_groups(L, 2, groups);
2695 co->setArmorGroups(groups);
2699 // set_properties(self, properties)
2700 static int l_set_properties(lua_State *L)
2702 ObjectRef *ref = checkobject(L, 1);
2703 ServerActiveObject *co = getobject(ref);
2704 if(co == NULL) return 0;
2705 ObjectProperties *prop = co->accessObjectProperties();
2708 read_object_properties(L, 2, prop);
2709 co->notifyObjectPropertiesModified();
2713 /* LuaEntitySAO-only */
2715 // setvelocity(self, {x=num, y=num, z=num})
2716 static int l_setvelocity(lua_State *L)
2718 ObjectRef *ref = checkobject(L, 1);
2719 LuaEntitySAO *co = getluaobject(ref);
2720 if(co == NULL) return 0;
2721 v3f pos = checkFloatPos(L, 2);
2723 co->setVelocity(pos);
2727 // getvelocity(self)
2728 static int l_getvelocity(lua_State *L)
2730 ObjectRef *ref = checkobject(L, 1);
2731 LuaEntitySAO *co = getluaobject(ref);
2732 if(co == NULL) return 0;
2734 v3f v = co->getVelocity();
2739 // setacceleration(self, {x=num, y=num, z=num})
2740 static int l_setacceleration(lua_State *L)
2742 ObjectRef *ref = checkobject(L, 1);
2743 LuaEntitySAO *co = getluaobject(ref);
2744 if(co == NULL) return 0;
2746 v3f pos = checkFloatPos(L, 2);
2748 co->setAcceleration(pos);
2752 // getacceleration(self)
2753 static int l_getacceleration(lua_State *L)
2755 ObjectRef *ref = checkobject(L, 1);
2756 LuaEntitySAO *co = getluaobject(ref);
2757 if(co == NULL) return 0;
2759 v3f v = co->getAcceleration();
2764 // setyaw(self, radians)
2765 static int l_setyaw(lua_State *L)
2767 ObjectRef *ref = checkobject(L, 1);
2768 LuaEntitySAO *co = getluaobject(ref);
2769 if(co == NULL) return 0;
2770 float yaw = luaL_checknumber(L, 2) * core::RADTODEG;
2777 static int l_getyaw(lua_State *L)
2779 ObjectRef *ref = checkobject(L, 1);
2780 LuaEntitySAO *co = getluaobject(ref);
2781 if(co == NULL) return 0;
2783 float yaw = co->getYaw() * core::DEGTORAD;
2784 lua_pushnumber(L, yaw);
2788 // settexturemod(self, mod)
2789 static int l_settexturemod(lua_State *L)
2791 ObjectRef *ref = checkobject(L, 1);
2792 LuaEntitySAO *co = getluaobject(ref);
2793 if(co == NULL) return 0;
2795 std::string mod = luaL_checkstring(L, 2);
2796 co->setTextureMod(mod);
2800 // setsprite(self, p={x=0,y=0}, num_frames=1, framelength=0.2,
2801 // select_horiz_by_yawpitch=false)
2802 static int l_setsprite(lua_State *L)
2804 ObjectRef *ref = checkobject(L, 1);
2805 LuaEntitySAO *co = getluaobject(ref);
2806 if(co == NULL) return 0;
2809 if(!lua_isnil(L, 2))
2810 p = read_v2s16(L, 2);
2812 if(!lua_isnil(L, 3))
2813 num_frames = lua_tonumber(L, 3);
2814 float framelength = 0.2;
2815 if(!lua_isnil(L, 4))
2816 framelength = lua_tonumber(L, 4);
2817 bool select_horiz_by_yawpitch = false;
2818 if(!lua_isnil(L, 5))
2819 select_horiz_by_yawpitch = lua_toboolean(L, 5);
2820 co->setSprite(p, num_frames, framelength, select_horiz_by_yawpitch);
2825 // get_entity_name(self)
2826 static int l_get_entity_name(lua_State *L)
2828 ObjectRef *ref = checkobject(L, 1);
2829 LuaEntitySAO *co = getluaobject(ref);
2830 if(co == NULL) return 0;
2832 std::string name = co->getName();
2833 lua_pushstring(L, name.c_str());
2837 // get_luaentity(self)
2838 static int l_get_luaentity(lua_State *L)
2840 ObjectRef *ref = checkobject(L, 1);
2841 LuaEntitySAO *co = getluaobject(ref);
2842 if(co == NULL) return 0;
2844 luaentity_get(L, co->getId());
2851 static int l_is_player(lua_State *L)
2853 ObjectRef *ref = checkobject(L, 1);
2854 Player *player = getplayer(ref);
2855 lua_pushboolean(L, (player != NULL));
2859 // get_player_name(self)
2860 static int l_get_player_name(lua_State *L)
2862 ObjectRef *ref = checkobject(L, 1);
2863 Player *player = getplayer(ref);
2865 lua_pushlstring(L, "", 0);
2869 lua_pushstring(L, player->getName());
2873 // get_look_dir(self)
2874 static int l_get_look_dir(lua_State *L)
2876 ObjectRef *ref = checkobject(L, 1);
2877 Player *player = getplayer(ref);
2878 if(player == NULL) return 0;
2880 float pitch = player->getRadPitch();
2881 float yaw = player->getRadYaw();
2882 v3f v(cos(pitch)*cos(yaw), sin(pitch), cos(pitch)*sin(yaw));
2887 // get_look_pitch(self)
2888 static int l_get_look_pitch(lua_State *L)
2890 ObjectRef *ref = checkobject(L, 1);
2891 Player *player = getplayer(ref);
2892 if(player == NULL) return 0;
2894 lua_pushnumber(L, player->getRadPitch());
2898 // get_look_yaw(self)
2899 static int l_get_look_yaw(lua_State *L)
2901 ObjectRef *ref = checkobject(L, 1);
2902 Player *player = getplayer(ref);
2903 if(player == NULL) return 0;
2905 lua_pushnumber(L, player->getRadYaw());
2909 // set_inventory_formspec(self, formspec)
2910 static int l_set_inventory_formspec(lua_State *L)
2912 ObjectRef *ref = checkobject(L, 1);
2913 Player *player = getplayer(ref);
2914 if(player == NULL) return 0;
2915 std::string formspec = luaL_checkstring(L, 2);
2917 player->inventory_formspec = formspec;
2918 get_server(L)->reportInventoryFormspecModified(player->getName());
2919 lua_pushboolean(L, true);
2923 // get_inventory_formspec(self) -> formspec
2924 static int l_get_inventory_formspec(lua_State *L)
2926 ObjectRef *ref = checkobject(L, 1);
2927 Player *player = getplayer(ref);
2928 if(player == NULL) return 0;
2930 std::string formspec = player->inventory_formspec;
2931 lua_pushlstring(L, formspec.c_str(), formspec.size());
2936 ObjectRef(ServerActiveObject *object):
2939 //infostream<<"ObjectRef created for id="<<m_object->getId()<<std::endl;
2945 infostream<<"ObjectRef destructing for id="
2946 <<m_object->getId()<<std::endl;
2948 infostream<<"ObjectRef destructing for id=unknown"<<std::endl;*/
2951 // Creates an ObjectRef and leaves it on top of stack
2952 // Not callable from Lua; all references are created on the C side.
2953 static void create(lua_State *L, ServerActiveObject *object)
2955 ObjectRef *o = new ObjectRef(object);
2956 //infostream<<"ObjectRef::create: o="<<o<<std::endl;
2957 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
2958 luaL_getmetatable(L, className);
2959 lua_setmetatable(L, -2);
2962 static void set_null(lua_State *L)
2964 ObjectRef *o = checkobject(L, -1);
2968 static void Register(lua_State *L)
2971 int methodtable = lua_gettop(L);
2972 luaL_newmetatable(L, className);
2973 int metatable = lua_gettop(L);
2975 lua_pushliteral(L, "__metatable");
2976 lua_pushvalue(L, methodtable);
2977 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
2979 lua_pushliteral(L, "__index");
2980 lua_pushvalue(L, methodtable);
2981 lua_settable(L, metatable);
2983 lua_pushliteral(L, "__gc");
2984 lua_pushcfunction(L, gc_object);
2985 lua_settable(L, metatable);
2987 lua_pop(L, 1); // drop metatable
2989 luaL_openlib(L, 0, methods, 0); // fill methodtable
2990 lua_pop(L, 1); // drop methodtable
2992 // Cannot be created from Lua
2993 //lua_register(L, className, create_object);
2996 const char ObjectRef::className[] = "ObjectRef";
2997 const luaL_reg ObjectRef::methods[] = {
2998 // ServerActiveObject
2999 method(ObjectRef, remove),
3000 method(ObjectRef, getpos),
3001 method(ObjectRef, setpos),
3002 method(ObjectRef, moveto),
3003 method(ObjectRef, punch),
3004 method(ObjectRef, right_click),
3005 method(ObjectRef, set_hp),
3006 method(ObjectRef, get_hp),
3007 method(ObjectRef, get_inventory),
3008 method(ObjectRef, get_wield_list),
3009 method(ObjectRef, get_wield_index),
3010 method(ObjectRef, get_wielded_item),
3011 method(ObjectRef, set_wielded_item),
3012 method(ObjectRef, set_armor_groups),
3013 method(ObjectRef, set_properties),
3014 // LuaEntitySAO-only
3015 method(ObjectRef, setvelocity),
3016 method(ObjectRef, getvelocity),
3017 method(ObjectRef, setacceleration),
3018 method(ObjectRef, getacceleration),
3019 method(ObjectRef, setyaw),
3020 method(ObjectRef, getyaw),
3021 method(ObjectRef, settexturemod),
3022 method(ObjectRef, setsprite),
3023 method(ObjectRef, get_entity_name),
3024 method(ObjectRef, get_luaentity),
3026 method(ObjectRef, is_player),
3027 method(ObjectRef, get_player_name),
3028 method(ObjectRef, get_look_dir),
3029 method(ObjectRef, get_look_pitch),
3030 method(ObjectRef, get_look_yaw),
3031 method(ObjectRef, set_inventory_formspec),
3032 method(ObjectRef, get_inventory_formspec),
3036 // Creates a new anonymous reference if cobj=NULL or id=0
3037 static void objectref_get_or_create(lua_State *L,
3038 ServerActiveObject *cobj)
3040 if(cobj == NULL || cobj->getId() == 0){
3041 ObjectRef::create(L, cobj);
3043 objectref_get(L, cobj->getId());
3052 class LuaPerlinNoise
3059 static const char className[];
3060 static const luaL_reg methods[];
3062 // Exported functions
3064 // garbage collector
3065 static int gc_object(lua_State *L)
3067 LuaPerlinNoise *o = *(LuaPerlinNoise **)(lua_touserdata(L, 1));
3072 static int l_get2d(lua_State *L)
3074 LuaPerlinNoise *o = checkobject(L, 1);
3075 v2f pos2d = read_v2f(L,2);
3076 lua_Number val = noise2d_perlin(pos2d.X/o->scale, pos2d.Y/o->scale, o->seed, o->octaves, o->persistence);
3077 lua_pushnumber(L, val);
3080 static int l_get3d(lua_State *L)
3082 LuaPerlinNoise *o = checkobject(L, 1);
3083 v3f pos3d = read_v3f(L,2);
3084 lua_Number val = noise3d_perlin(pos3d.X/o->scale, pos3d.Y/o->scale, pos3d.Z/o->scale, o->seed, o->octaves, o->persistence);
3085 lua_pushnumber(L, val);
3090 LuaPerlinNoise(int a_seed, int a_octaves, double a_persistence,
3094 persistence(a_persistence),
3103 // LuaPerlinNoise(seed, octaves, persistence, scale)
3104 // Creates an LuaPerlinNoise and leaves it on top of stack
3105 static int create_object(lua_State *L)
3107 int seed = luaL_checkint(L, 1);
3108 int octaves = luaL_checkint(L, 2);
3109 double persistence = luaL_checknumber(L, 3);
3110 double scale = luaL_checknumber(L, 4);
3111 LuaPerlinNoise *o = new LuaPerlinNoise(seed, octaves, persistence, scale);
3112 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
3113 luaL_getmetatable(L, className);
3114 lua_setmetatable(L, -2);
3118 static LuaPerlinNoise* checkobject(lua_State *L, int narg)
3120 luaL_checktype(L, narg, LUA_TUSERDATA);
3121 void *ud = luaL_checkudata(L, narg, className);
3122 if(!ud) luaL_typerror(L, narg, className);
3123 return *(LuaPerlinNoise**)ud; // unbox pointer
3126 static void Register(lua_State *L)
3129 int methodtable = lua_gettop(L);
3130 luaL_newmetatable(L, className);
3131 int metatable = lua_gettop(L);
3133 lua_pushliteral(L, "__metatable");
3134 lua_pushvalue(L, methodtable);
3135 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
3137 lua_pushliteral(L, "__index");
3138 lua_pushvalue(L, methodtable);
3139 lua_settable(L, metatable);
3141 lua_pushliteral(L, "__gc");
3142 lua_pushcfunction(L, gc_object);
3143 lua_settable(L, metatable);
3145 lua_pop(L, 1); // drop metatable
3147 luaL_openlib(L, 0, methods, 0); // fill methodtable
3148 lua_pop(L, 1); // drop methodtable
3150 // Can be created from Lua (PerlinNoise(seed, octaves, persistence)
3151 lua_register(L, className, create_object);
3154 const char LuaPerlinNoise::className[] = "PerlinNoise";
3155 const luaL_reg LuaPerlinNoise::methods[] = {
3156 method(LuaPerlinNoise, get2d),
3157 method(LuaPerlinNoise, get3d),
3169 ServerEnvironment *m_env;
3171 static const char className[];
3172 static const luaL_reg methods[];
3174 static int gc_object(lua_State *L) {
3175 NodeTimerRef *o = *(NodeTimerRef **)(lua_touserdata(L, 1));
3180 static NodeTimerRef *checkobject(lua_State *L, int narg)
3182 luaL_checktype(L, narg, LUA_TUSERDATA);
3183 void *ud = luaL_checkudata(L, narg, className);
3184 if(!ud) luaL_typerror(L, narg, className);
3185 return *(NodeTimerRef**)ud; // unbox pointer
3188 static int l_set(lua_State *L)
3190 NodeTimerRef *o = checkobject(L, 1);
3191 ServerEnvironment *env = o->m_env;
3192 if(env == NULL) return 0;
3193 f32 t = luaL_checknumber(L,2);
3194 f32 e = luaL_checknumber(L,3);
3195 env->getMap().setNodeTimer(o->m_p,NodeTimer(t,e));
3199 static int l_start(lua_State *L)
3201 NodeTimerRef *o = checkobject(L, 1);
3202 ServerEnvironment *env = o->m_env;
3203 if(env == NULL) return 0;
3204 f32 t = luaL_checknumber(L,2);
3205 env->getMap().setNodeTimer(o->m_p,NodeTimer(t,0));
3209 static int l_stop(lua_State *L)
3211 NodeTimerRef *o = checkobject(L, 1);
3212 ServerEnvironment *env = o->m_env;
3213 if(env == NULL) return 0;
3214 env->getMap().removeNodeTimer(o->m_p);
3218 static int l_is_started(lua_State *L)
3220 NodeTimerRef *o = checkobject(L, 1);
3221 ServerEnvironment *env = o->m_env;
3222 if(env == NULL) return 0;
3224 NodeTimer t = env->getMap().getNodeTimer(o->m_p);
3225 lua_pushboolean(L,(t.timeout != 0));
3229 static int l_get_timeout(lua_State *L)
3231 NodeTimerRef *o = checkobject(L, 1);
3232 ServerEnvironment *env = o->m_env;
3233 if(env == NULL) return 0;
3235 NodeTimer t = env->getMap().getNodeTimer(o->m_p);
3236 lua_pushnumber(L,t.timeout);
3240 static int l_get_elapsed(lua_State *L)
3242 NodeTimerRef *o = checkobject(L, 1);
3243 ServerEnvironment *env = o->m_env;
3244 if(env == NULL) return 0;
3246 NodeTimer t = env->getMap().getNodeTimer(o->m_p);
3247 lua_pushnumber(L,t.elapsed);
3252 NodeTimerRef(v3s16 p, ServerEnvironment *env):
3262 // Creates an NodeTimerRef and leaves it on top of stack
3263 // Not callable from Lua; all references are created on the C side.
3264 static void create(lua_State *L, v3s16 p, ServerEnvironment *env)
3266 NodeTimerRef *o = new NodeTimerRef(p, env);
3267 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
3268 luaL_getmetatable(L, className);
3269 lua_setmetatable(L, -2);
3272 static void set_null(lua_State *L)
3274 NodeTimerRef *o = checkobject(L, -1);
3278 static void Register(lua_State *L)
3281 int methodtable = lua_gettop(L);
3282 luaL_newmetatable(L, className);
3283 int metatable = lua_gettop(L);
3285 lua_pushliteral(L, "__metatable");
3286 lua_pushvalue(L, methodtable);
3287 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
3289 lua_pushliteral(L, "__index");
3290 lua_pushvalue(L, methodtable);
3291 lua_settable(L, metatable);
3293 lua_pushliteral(L, "__gc");
3294 lua_pushcfunction(L, gc_object);
3295 lua_settable(L, metatable);
3297 lua_pop(L, 1); // drop metatable
3299 luaL_openlib(L, 0, methods, 0); // fill methodtable
3300 lua_pop(L, 1); // drop methodtable
3302 // Cannot be created from Lua
3303 //lua_register(L, className, create_object);
3306 const char NodeTimerRef::className[] = "NodeTimerRef";
3307 const luaL_reg NodeTimerRef::methods[] = {
3308 method(NodeTimerRef, start),
3309 method(NodeTimerRef, set),
3310 method(NodeTimerRef, stop),
3311 method(NodeTimerRef, is_started),
3312 method(NodeTimerRef, get_timeout),
3313 method(NodeTimerRef, get_elapsed),
3324 ServerEnvironment *m_env;
3326 static const char className[];
3327 static const luaL_reg methods[];
3329 static int gc_object(lua_State *L) {
3330 EnvRef *o = *(EnvRef **)(lua_touserdata(L, 1));
3335 static EnvRef *checkobject(lua_State *L, int narg)
3337 luaL_checktype(L, narg, LUA_TUSERDATA);
3338 void *ud = luaL_checkudata(L, narg, className);
3339 if(!ud) luaL_typerror(L, narg, className);
3340 return *(EnvRef**)ud; // unbox pointer
3343 // Exported functions
3345 // EnvRef:set_node(pos, node)
3346 // pos = {x=num, y=num, z=num}
3347 static int l_set_node(lua_State *L)
3349 EnvRef *o = checkobject(L, 1);
3350 ServerEnvironment *env = o->m_env;
3351 if(env == NULL) return 0;
3352 INodeDefManager *ndef = env->getGameDef()->ndef();
3354 v3s16 pos = read_v3s16(L, 2);
3355 MapNode n = readnode(L, 3, ndef);
3357 MapNode n_old = env->getMap().getNodeNoEx(pos);
3359 if(ndef->get(n_old).has_on_destruct)
3360 scriptapi_node_on_destruct(L, pos, n_old);
3362 bool succeeded = env->getMap().addNodeWithEvent(pos, n);
3364 // Call post-destructor
3365 if(ndef->get(n_old).has_after_destruct)
3366 scriptapi_node_after_destruct(L, pos, n_old);
3368 if(ndef->get(n).has_on_construct)
3369 scriptapi_node_on_construct(L, pos, n);
3371 lua_pushboolean(L, succeeded);
3375 static int l_add_node(lua_State *L)
3377 return l_set_node(L);
3380 // EnvRef:remove_node(pos)
3381 // pos = {x=num, y=num, z=num}
3382 static int l_remove_node(lua_State *L)
3384 EnvRef *o = checkobject(L, 1);
3385 ServerEnvironment *env = o->m_env;
3386 if(env == NULL) return 0;
3387 INodeDefManager *ndef = env->getGameDef()->ndef();
3389 v3s16 pos = read_v3s16(L, 2);
3391 MapNode n_old = env->getMap().getNodeNoEx(pos);
3393 if(ndef->get(n_old).has_on_destruct)
3394 scriptapi_node_on_destruct(L, pos, n_old);
3396 // This is slightly optimized compared to addNodeWithEvent(air)
3397 bool succeeded = env->getMap().removeNodeWithEvent(pos);
3399 // Call post-destructor
3400 if(ndef->get(n_old).has_after_destruct)
3401 scriptapi_node_after_destruct(L, pos, n_old);
3403 lua_pushboolean(L, succeeded);
3404 // Air doesn't require constructor
3408 // EnvRef:get_node(pos)
3409 // pos = {x=num, y=num, z=num}
3410 static int l_get_node(lua_State *L)
3412 EnvRef *o = checkobject(L, 1);
3413 ServerEnvironment *env = o->m_env;
3414 if(env == NULL) return 0;
3416 v3s16 pos = read_v3s16(L, 2);
3418 MapNode n = env->getMap().getNodeNoEx(pos);
3420 pushnode(L, n, env->getGameDef()->ndef());
3424 // EnvRef:get_node_or_nil(pos)
3425 // pos = {x=num, y=num, z=num}
3426 static int l_get_node_or_nil(lua_State *L)
3428 EnvRef *o = checkobject(L, 1);
3429 ServerEnvironment *env = o->m_env;
3430 if(env == NULL) return 0;
3432 v3s16 pos = read_v3s16(L, 2);
3435 MapNode n = env->getMap().getNode(pos);
3437 pushnode(L, n, env->getGameDef()->ndef());
3439 } catch(InvalidPositionException &e)
3446 // EnvRef:get_node_light(pos, timeofday)
3447 // pos = {x=num, y=num, z=num}
3448 // timeofday: nil = current time, 0 = night, 0.5 = day
3449 static int l_get_node_light(lua_State *L)
3451 EnvRef *o = checkobject(L, 1);
3452 ServerEnvironment *env = o->m_env;
3453 if(env == NULL) return 0;
3455 v3s16 pos = read_v3s16(L, 2);
3456 u32 time_of_day = env->getTimeOfDay();
3457 if(lua_isnumber(L, 3))
3458 time_of_day = 24000.0 * lua_tonumber(L, 3);
3459 time_of_day %= 24000;
3460 u32 dnr = time_to_daynight_ratio(time_of_day);
3461 MapNode n = env->getMap().getNodeNoEx(pos);
3463 MapNode n = env->getMap().getNode(pos);
3464 INodeDefManager *ndef = env->getGameDef()->ndef();
3465 lua_pushinteger(L, n.getLightBlend(dnr, ndef));
3467 } catch(InvalidPositionException &e)
3474 // EnvRef:place_node(pos, node)
3475 // pos = {x=num, y=num, z=num}
3476 static int l_place_node(lua_State *L)
3478 EnvRef *o = checkobject(L, 1);
3479 ServerEnvironment *env = o->m_env;
3480 if(env == NULL) return 0;
3481 v3s16 pos = read_v3s16(L, 2);
3482 MapNode n = readnode(L, 3, env->getGameDef()->ndef());
3484 // Don't attempt to load non-loaded area as of now
3485 MapNode n_old = env->getMap().getNodeNoEx(pos);
3486 if(n_old.getContent() == CONTENT_IGNORE){
3487 lua_pushboolean(L, false);
3490 // Create item to place
3491 INodeDefManager *ndef = get_server(L)->ndef();
3492 IItemDefManager *idef = get_server(L)->idef();
3493 ItemStack item(ndef->get(n).name, 1, 0, "", idef);
3494 // Make pointed position
3495 PointedThing pointed;
3496 pointed.type = POINTEDTHING_NODE;
3497 pointed.node_abovesurface = pos;
3498 pointed.node_undersurface = pos + v3s16(0,-1,0);
3499 // Place it with a NULL placer (appears in Lua as a non-functional
3501 bool success = scriptapi_item_on_place(L, item, NULL, pointed);
3502 lua_pushboolean(L, success);
3506 // EnvRef:dig_node(pos)
3507 // pos = {x=num, y=num, z=num}
3508 static int l_dig_node(lua_State *L)
3510 EnvRef *o = checkobject(L, 1);
3511 ServerEnvironment *env = o->m_env;
3512 if(env == NULL) return 0;
3513 v3s16 pos = read_v3s16(L, 2);
3515 // Don't attempt to load non-loaded area as of now
3516 MapNode n = env->getMap().getNodeNoEx(pos);
3517 if(n.getContent() == CONTENT_IGNORE){
3518 lua_pushboolean(L, false);
3521 // Dig it out with a NULL digger (appears in Lua as a
3522 // non-functional ObjectRef)
3523 bool success = scriptapi_node_on_dig(L, pos, n, NULL);
3524 lua_pushboolean(L, success);
3528 // EnvRef:punch_node(pos)
3529 // pos = {x=num, y=num, z=num}
3530 static int l_punch_node(lua_State *L)
3532 EnvRef *o = checkobject(L, 1);
3533 ServerEnvironment *env = o->m_env;
3534 if(env == NULL) return 0;
3535 v3s16 pos = read_v3s16(L, 2);
3537 // Don't attempt to load non-loaded area as of now
3538 MapNode n = env->getMap().getNodeNoEx(pos);
3539 if(n.getContent() == CONTENT_IGNORE){
3540 lua_pushboolean(L, false);
3543 // Punch it with a NULL puncher (appears in Lua as a non-functional
3545 bool success = scriptapi_node_on_punch(L, pos, n, NULL);
3546 lua_pushboolean(L, success);
3550 // EnvRef:get_meta(pos)
3551 static int l_get_meta(lua_State *L)
3553 //infostream<<"EnvRef::l_get_meta()"<<std::endl;
3554 EnvRef *o = checkobject(L, 1);
3555 ServerEnvironment *env = o->m_env;
3556 if(env == NULL) return 0;
3558 v3s16 p = read_v3s16(L, 2);
3559 NodeMetaRef::create(L, p, env);
3563 // EnvRef:get_node_timer(pos)
3564 static int l_get_node_timer(lua_State *L)
3566 EnvRef *o = checkobject(L, 1);
3567 ServerEnvironment *env = o->m_env;
3568 if(env == NULL) return 0;
3570 v3s16 p = read_v3s16(L, 2);
3571 NodeTimerRef::create(L, p, env);
3575 // EnvRef:add_entity(pos, entityname) -> ObjectRef or nil
3576 // pos = {x=num, y=num, z=num}
3577 static int l_add_entity(lua_State *L)
3579 //infostream<<"EnvRef::l_add_entity()"<<std::endl;
3580 EnvRef *o = checkobject(L, 1);
3581 ServerEnvironment *env = o->m_env;
3582 if(env == NULL) return 0;
3584 v3f pos = checkFloatPos(L, 2);
3586 const char *name = luaL_checkstring(L, 3);
3588 ServerActiveObject *obj = new LuaEntitySAO(env, pos, name, "");
3589 int objectid = env->addActiveObject(obj);
3590 // If failed to add, return nothing (reads as nil)
3594 objectref_get_or_create(L, obj);
3598 // EnvRef:add_item(pos, itemstack or itemstring or table) -> ObjectRef or nil
3599 // pos = {x=num, y=num, z=num}
3600 static int l_add_item(lua_State *L)
3602 //infostream<<"EnvRef::l_add_item()"<<std::endl;
3603 EnvRef *o = checkobject(L, 1);
3604 ServerEnvironment *env = o->m_env;
3605 if(env == NULL) return 0;
3607 v3f pos = checkFloatPos(L, 2);
3609 ItemStack item = read_item(L, 3);
3610 if(item.empty() || !item.isKnown(get_server(L)->idef()))
3612 // Use minetest.spawn_item to spawn a __builtin:item
3613 lua_getglobal(L, "minetest");
3614 lua_getfield(L, -1, "spawn_item");
3615 if(lua_isnil(L, -1))
3617 lua_pushvalue(L, 2);
3618 lua_pushstring(L, item.getItemString().c_str());
3619 if(lua_pcall(L, 2, 1, 0))
3620 script_error(L, "error: %s", lua_tostring(L, -1));
3622 /*lua_pushvalue(L, 1);
3623 lua_pushstring(L, "__builtin:item");
3624 lua_pushstring(L, item.getItemString().c_str());
3625 return l_add_entity(L);*/
3627 ServerActiveObject *obj = createItemSAO(env, pos, item.getItemString());
3628 int objectid = env->addActiveObject(obj);
3629 // If failed to add, return nothing (reads as nil)
3633 objectref_get_or_create(L, obj);
3637 // EnvRef:add_rat(pos)
3638 // pos = {x=num, y=num, z=num}
3639 static int l_add_rat(lua_State *L)
3641 infostream<<"EnvRef::l_add_rat(): C++ mobs have been removed."
3642 <<" Doing nothing."<<std::endl;
3646 // EnvRef:add_firefly(pos)
3647 // pos = {x=num, y=num, z=num}
3648 static int l_add_firefly(lua_State *L)
3650 infostream<<"EnvRef::l_add_firefly(): C++ mobs have been removed."
3651 <<" Doing nothing."<<std::endl;
3655 // EnvRef:get_player_by_name(name)
3656 static int l_get_player_by_name(lua_State *L)
3658 EnvRef *o = checkobject(L, 1);
3659 ServerEnvironment *env = o->m_env;
3660 if(env == NULL) return 0;
3662 const char *name = luaL_checkstring(L, 2);
3663 Player *player = env->getPlayer(name);
3668 PlayerSAO *sao = player->getPlayerSAO();
3673 // Put player on stack
3674 objectref_get_or_create(L, sao);
3678 // EnvRef:get_objects_inside_radius(pos, radius)
3679 static int l_get_objects_inside_radius(lua_State *L)
3681 // Get the table insert function
3682 lua_getglobal(L, "table");
3683 lua_getfield(L, -1, "insert");
3684 int table_insert = lua_gettop(L);
3686 EnvRef *o = checkobject(L, 1);
3687 ServerEnvironment *env = o->m_env;
3688 if(env == NULL) return 0;
3690 v3f pos = checkFloatPos(L, 2);
3691 float radius = luaL_checknumber(L, 3) * BS;
3692 std::set<u16> ids = env->getObjectsInsideRadius(pos, radius);
3694 int table = lua_gettop(L);
3695 for(std::set<u16>::const_iterator
3696 i = ids.begin(); i != ids.end(); i++){
3697 ServerActiveObject *obj = env->getActiveObject(*i);
3698 // Insert object reference into table
3699 lua_pushvalue(L, table_insert);
3700 lua_pushvalue(L, table);
3701 objectref_get_or_create(L, obj);
3702 if(lua_pcall(L, 2, 0, 0))
3703 script_error(L, "error: %s", lua_tostring(L, -1));
3708 // EnvRef:set_timeofday(val)
3710 static int l_set_timeofday(lua_State *L)
3712 EnvRef *o = checkobject(L, 1);
3713 ServerEnvironment *env = o->m_env;
3714 if(env == NULL) return 0;
3716 float timeofday_f = luaL_checknumber(L, 2);
3717 assert(timeofday_f >= 0.0 && timeofday_f <= 1.0);
3718 int timeofday_mh = (int)(timeofday_f * 24000.0);
3719 // This should be set directly in the environment but currently
3720 // such changes aren't immediately sent to the clients, so call
3721 // the server instead.
3722 //env->setTimeOfDay(timeofday_mh);
3723 get_server(L)->setTimeOfDay(timeofday_mh);
3727 // EnvRef:get_timeofday() -> 0...1
3728 static int l_get_timeofday(lua_State *L)
3730 EnvRef *o = checkobject(L, 1);
3731 ServerEnvironment *env = o->m_env;
3732 if(env == NULL) return 0;
3734 int timeofday_mh = env->getTimeOfDay();
3735 float timeofday_f = (float)timeofday_mh / 24000.0;
3736 lua_pushnumber(L, timeofday_f);
3741 // EnvRef:find_node_near(pos, radius, nodenames) -> pos or nil
3742 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
3743 static int l_find_node_near(lua_State *L)
3745 EnvRef *o = checkobject(L, 1);
3746 ServerEnvironment *env = o->m_env;
3747 if(env == NULL) return 0;
3748 INodeDefManager *ndef = get_server(L)->ndef();
3749 v3s16 pos = read_v3s16(L, 2);
3750 int radius = luaL_checkinteger(L, 3);
3751 std::set<content_t> filter;
3752 if(lua_istable(L, 4)){
3755 while(lua_next(L, table) != 0){
3756 // key at index -2 and value at index -1
3757 luaL_checktype(L, -1, LUA_TSTRING);
3758 ndef->getIds(lua_tostring(L, -1), filter);
3759 // removes value, keeps key for next iteration
3762 } else if(lua_isstring(L, 4)){
3763 ndef->getIds(lua_tostring(L, 4), filter);
3766 for(int d=1; d<=radius; d++){
3767 core::list<v3s16> list;
3768 getFacePositions(list, d);
3769 for(core::list<v3s16>::Iterator i = list.begin();
3770 i != list.end(); i++){
3771 v3s16 p = pos + (*i);
3772 content_t c = env->getMap().getNodeNoEx(p).getContent();
3773 if(filter.count(c) != 0){
3782 // EnvRef:find_nodes_in_area(minp, maxp, nodenames) -> list of positions
3783 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
3784 static int l_find_nodes_in_area(lua_State *L)
3786 EnvRef *o = checkobject(L, 1);
3787 ServerEnvironment *env = o->m_env;
3788 if(env == NULL) return 0;
3789 INodeDefManager *ndef = get_server(L)->ndef();
3790 v3s16 minp = read_v3s16(L, 2);
3791 v3s16 maxp = read_v3s16(L, 3);
3792 std::set<content_t> filter;
3793 if(lua_istable(L, 4)){
3796 while(lua_next(L, table) != 0){
3797 // key at index -2 and value at index -1
3798 luaL_checktype(L, -1, LUA_TSTRING);
3799 ndef->getIds(lua_tostring(L, -1), filter);
3800 // removes value, keeps key for next iteration
3803 } else if(lua_isstring(L, 4)){
3804 ndef->getIds(lua_tostring(L, 4), filter);
3807 // Get the table insert function
3808 lua_getglobal(L, "table");
3809 lua_getfield(L, -1, "insert");
3810 int table_insert = lua_gettop(L);
3813 int table = lua_gettop(L);
3814 for(s16 x=minp.X; x<=maxp.X; x++)
3815 for(s16 y=minp.Y; y<=maxp.Y; y++)
3816 for(s16 z=minp.Z; z<=maxp.Z; z++)
3819 content_t c = env->getMap().getNodeNoEx(p).getContent();
3820 if(filter.count(c) != 0){
3821 lua_pushvalue(L, table_insert);
3822 lua_pushvalue(L, table);
3824 if(lua_pcall(L, 2, 0, 0))
3825 script_error(L, "error: %s", lua_tostring(L, -1));
3831 // EnvRef:get_perlin(seeddiff, octaves, persistence, scale)
3832 // returns world-specific PerlinNoise
3833 static int l_get_perlin(lua_State *L)
3835 EnvRef *o = checkobject(L, 1);
3836 ServerEnvironment *env = o->m_env;
3837 if(env == NULL) return 0;
3839 int seeddiff = luaL_checkint(L, 2);
3840 int octaves = luaL_checkint(L, 3);
3841 double persistence = luaL_checknumber(L, 4);
3842 double scale = luaL_checknumber(L, 5);
3844 LuaPerlinNoise *n = new LuaPerlinNoise(seeddiff + int(env->getServerMap().getSeed()), octaves, persistence, scale);
3845 *(void **)(lua_newuserdata(L, sizeof(void *))) = n;
3846 luaL_getmetatable(L, "PerlinNoise");
3847 lua_setmetatable(L, -2);
3851 // EnvRef:clear_objects()
3852 // clear all objects in the environment
3853 static int l_clear_objects(lua_State *L)
3855 EnvRef *o = checkobject(L, 1);
3856 o->m_env->clearAllObjects();
3861 EnvRef(ServerEnvironment *env):
3864 //infostream<<"EnvRef created"<<std::endl;
3869 //infostream<<"EnvRef destructing"<<std::endl;
3872 // Creates an EnvRef and leaves it on top of stack
3873 // Not callable from Lua; all references are created on the C side.
3874 static void create(lua_State *L, ServerEnvironment *env)
3876 EnvRef *o = new EnvRef(env);
3877 //infostream<<"EnvRef::create: o="<<o<<std::endl;
3878 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
3879 luaL_getmetatable(L, className);
3880 lua_setmetatable(L, -2);
3883 static void set_null(lua_State *L)
3885 EnvRef *o = checkobject(L, -1);
3889 static void Register(lua_State *L)
3892 int methodtable = lua_gettop(L);
3893 luaL_newmetatable(L, className);
3894 int metatable = lua_gettop(L);
3896 lua_pushliteral(L, "__metatable");
3897 lua_pushvalue(L, methodtable);
3898 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
3900 lua_pushliteral(L, "__index");
3901 lua_pushvalue(L, methodtable);
3902 lua_settable(L, metatable);
3904 lua_pushliteral(L, "__gc");
3905 lua_pushcfunction(L, gc_object);
3906 lua_settable(L, metatable);
3908 lua_pop(L, 1); // drop metatable
3910 luaL_openlib(L, 0, methods, 0); // fill methodtable
3911 lua_pop(L, 1); // drop methodtable
3913 // Cannot be created from Lua
3914 //lua_register(L, className, create_object);
3917 const char EnvRef::className[] = "EnvRef";
3918 const luaL_reg EnvRef::methods[] = {
3919 method(EnvRef, set_node),
3920 method(EnvRef, add_node),
3921 method(EnvRef, remove_node),
3922 method(EnvRef, get_node),
3923 method(EnvRef, get_node_or_nil),
3924 method(EnvRef, get_node_light),
3925 method(EnvRef, place_node),
3926 method(EnvRef, dig_node),
3927 method(EnvRef, punch_node),
3928 method(EnvRef, add_entity),
3929 method(EnvRef, add_item),
3930 method(EnvRef, add_rat),
3931 method(EnvRef, add_firefly),
3932 method(EnvRef, get_meta),
3933 method(EnvRef, get_node_timer),
3934 method(EnvRef, get_player_by_name),
3935 method(EnvRef, get_objects_inside_radius),
3936 method(EnvRef, set_timeofday),
3937 method(EnvRef, get_timeofday),
3938 method(EnvRef, find_node_near),
3939 method(EnvRef, find_nodes_in_area),
3940 method(EnvRef, get_perlin),
3941 method(EnvRef, clear_objects),
3950 class LuaPseudoRandom
3953 PseudoRandom m_pseudo;
3955 static const char className[];
3956 static const luaL_reg methods[];
3958 // Exported functions
3960 // garbage collector
3961 static int gc_object(lua_State *L)
3963 LuaPseudoRandom *o = *(LuaPseudoRandom **)(lua_touserdata(L, 1));
3968 // next(self, min=0, max=32767) -> get next value
3969 static int l_next(lua_State *L)
3971 LuaPseudoRandom *o = checkobject(L, 1);
3974 lua_settop(L, 3); // Fill 2 and 3 with nil if they don't exist
3975 if(!lua_isnil(L, 2))
3976 min = luaL_checkinteger(L, 2);
3977 if(!lua_isnil(L, 3))
3978 max = luaL_checkinteger(L, 3);
3980 errorstream<<"PseudoRandom.next(): max="<<max<<" min="<<min<<std::endl;
3981 throw LuaError(L, "PseudoRandom.next(): max < min");
3983 if(max - min != 32767 && max - min > 32767/5)
3984 throw LuaError(L, "PseudoRandom.next() max-min is not 32767 and is > 32768/5. This is disallowed due to the bad random distribution the implementation would otherwise make.");
3985 PseudoRandom &pseudo = o->m_pseudo;
3986 int val = pseudo.next();
3987 val = (val % (max-min+1)) + min;
3988 lua_pushinteger(L, val);
3993 LuaPseudoRandom(int seed):
4002 const PseudoRandom& getItem() const
4006 PseudoRandom& getItem()
4011 // LuaPseudoRandom(seed)
4012 // Creates an LuaPseudoRandom and leaves it on top of stack
4013 static int create_object(lua_State *L)
4015 int seed = luaL_checknumber(L, 1);
4016 LuaPseudoRandom *o = new LuaPseudoRandom(seed);
4017 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
4018 luaL_getmetatable(L, className);
4019 lua_setmetatable(L, -2);
4023 static LuaPseudoRandom* checkobject(lua_State *L, int narg)
4025 luaL_checktype(L, narg, LUA_TUSERDATA);
4026 void *ud = luaL_checkudata(L, narg, className);
4027 if(!ud) luaL_typerror(L, narg, className);
4028 return *(LuaPseudoRandom**)ud; // unbox pointer
4031 static void Register(lua_State *L)
4034 int methodtable = lua_gettop(L);
4035 luaL_newmetatable(L, className);
4036 int metatable = lua_gettop(L);
4038 lua_pushliteral(L, "__metatable");
4039 lua_pushvalue(L, methodtable);
4040 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
4042 lua_pushliteral(L, "__index");
4043 lua_pushvalue(L, methodtable);
4044 lua_settable(L, metatable);
4046 lua_pushliteral(L, "__gc");
4047 lua_pushcfunction(L, gc_object);
4048 lua_settable(L, metatable);
4050 lua_pop(L, 1); // drop metatable
4052 luaL_openlib(L, 0, methods, 0); // fill methodtable
4053 lua_pop(L, 1); // drop methodtable
4055 // Can be created from Lua (LuaPseudoRandom(seed))
4056 lua_register(L, className, create_object);
4059 const char LuaPseudoRandom::className[] = "PseudoRandom";
4060 const luaL_reg LuaPseudoRandom::methods[] = {
4061 method(LuaPseudoRandom, next),
4071 class LuaABM : public ActiveBlockModifier
4077 std::set<std::string> m_trigger_contents;
4078 std::set<std::string> m_required_neighbors;
4079 float m_trigger_interval;
4080 u32 m_trigger_chance;
4082 LuaABM(lua_State *L, int id,
4083 const std::set<std::string> &trigger_contents,
4084 const std::set<std::string> &required_neighbors,
4085 float trigger_interval, u32 trigger_chance):
4088 m_trigger_contents(trigger_contents),
4089 m_required_neighbors(required_neighbors),
4090 m_trigger_interval(trigger_interval),
4091 m_trigger_chance(trigger_chance)
4094 virtual std::set<std::string> getTriggerContents()
4096 return m_trigger_contents;
4098 virtual std::set<std::string> getRequiredNeighbors()
4100 return m_required_neighbors;
4102 virtual float getTriggerInterval()
4104 return m_trigger_interval;
4106 virtual u32 getTriggerChance()
4108 return m_trigger_chance;
4110 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
4111 u32 active_object_count, u32 active_object_count_wider)
4113 lua_State *L = m_lua;
4116 assert(lua_checkstack(L, 20));
4117 StackUnroller stack_unroller(L);
4119 // Get minetest.registered_abms
4120 lua_getglobal(L, "minetest");
4121 lua_getfield(L, -1, "registered_abms");
4122 luaL_checktype(L, -1, LUA_TTABLE);
4123 int registered_abms = lua_gettop(L);
4125 // Get minetest.registered_abms[m_id]
4126 lua_pushnumber(L, m_id);
4127 lua_gettable(L, registered_abms);
4128 if(lua_isnil(L, -1))
4132 luaL_checktype(L, -1, LUA_TTABLE);
4133 lua_getfield(L, -1, "action");
4134 luaL_checktype(L, -1, LUA_TFUNCTION);
4136 pushnode(L, n, env->getGameDef()->ndef());
4137 lua_pushnumber(L, active_object_count);
4138 lua_pushnumber(L, active_object_count_wider);
4139 if(lua_pcall(L, 4, 0, 0))
4140 script_error(L, "error: %s", lua_tostring(L, -1));
4148 static void read_server_sound_params(lua_State *L, int index,
4149 ServerSoundParams ¶ms)
4152 index = lua_gettop(L) + 1 + index;
4154 params = ServerSoundParams();
4155 if(lua_istable(L, index)){
4156 getfloatfield(L, index, "gain", params.gain);
4157 getstringfield(L, index, "to_player", params.to_player);
4158 lua_getfield(L, index, "pos");
4159 if(!lua_isnil(L, -1)){
4160 v3f p = read_v3f(L, -1)*BS;
4162 params.type = ServerSoundParams::SSP_POSITIONAL;
4165 lua_getfield(L, index, "object");
4166 if(!lua_isnil(L, -1)){
4167 ObjectRef *ref = ObjectRef::checkobject(L, -1);
4168 ServerActiveObject *sao = ObjectRef::getobject(ref);
4170 params.object = sao->getId();
4171 params.type = ServerSoundParams::SSP_OBJECT;
4175 params.max_hear_distance = BS*getfloatfield_default(L, index,
4176 "max_hear_distance", params.max_hear_distance/BS);
4177 getboolfield(L, index, "loop", params.loop);
4186 // Writes a line to dstream
4187 static int l_debug(lua_State *L)
4189 std::string text = lua_tostring(L, 1);
4190 dstream << text << std::endl;
4194 // log([level,] text)
4195 // Writes a line to the logger.
4196 // The one-argument version logs to infostream.
4197 // The two-argument version accept a log level: error, action, info, or verbose.
4198 static int l_log(lua_State *L)
4201 LogMessageLevel level = LMT_INFO;
4202 if(lua_isnone(L, 2))
4204 text = lua_tostring(L, 1);
4208 std::string levelname = lua_tostring(L, 1);
4209 text = lua_tostring(L, 2);
4210 if(levelname == "error")
4212 else if(levelname == "action")
4214 else if(levelname == "verbose")
4215 level = LMT_VERBOSE;
4217 log_printline(level, text);
4221 // request_shutdown()
4222 static int l_request_shutdown(lua_State *L)
4224 get_server(L)->requestShutdown();
4228 // get_server_status()
4229 static int l_get_server_status(lua_State *L)
4231 lua_pushstring(L, wide_to_narrow(get_server(L)->getStatusString()).c_str());
4235 // register_item_raw({lots of stuff})
4236 static int l_register_item_raw(lua_State *L)
4238 luaL_checktype(L, 1, LUA_TTABLE);
4241 // Get the writable item and node definition managers from the server
4242 IWritableItemDefManager *idef =
4243 get_server(L)->getWritableItemDefManager();
4244 IWritableNodeDefManager *ndef =
4245 get_server(L)->getWritableNodeDefManager();
4247 // Check if name is defined
4249 lua_getfield(L, table, "name");
4250 if(lua_isstring(L, -1)){
4251 name = lua_tostring(L, -1);
4252 verbosestream<<"register_item_raw: "<<name<<std::endl;
4254 throw LuaError(L, "register_item_raw: name is not defined or not a string");
4257 // Check if on_use is defined
4260 // Set a distinctive default value to check if this is set
4261 def.node_placement_prediction = "__default";
4263 // Read the item definition
4264 def = read_item_definition(L, table, def);
4266 // Default to having client-side placement prediction for nodes
4267 // ("" in item definition sets it off)
4268 if(def.node_placement_prediction == "__default"){
4269 if(def.type == ITEM_NODE)
4270 def.node_placement_prediction = name;
4272 def.node_placement_prediction = "";
4275 // Register item definition
4276 idef->registerItem(def);
4278 // Read the node definition (content features) and register it
4279 if(def.type == ITEM_NODE)
4281 ContentFeatures f = read_content_features(L, table);
4282 ndef->set(f.name, f);
4285 return 0; /* number of results */
4288 // register_alias_raw(name, convert_to_name)
4289 static int l_register_alias_raw(lua_State *L)
4291 std::string name = luaL_checkstring(L, 1);
4292 std::string convert_to = luaL_checkstring(L, 2);
4294 // Get the writable item definition manager from the server
4295 IWritableItemDefManager *idef =
4296 get_server(L)->getWritableItemDefManager();
4298 idef->registerAlias(name, convert_to);
4300 return 0; /* number of results */
4303 // helper for register_craft
4304 static bool read_craft_recipe_shaped(lua_State *L, int index,
4305 int &width, std::vector<std::string> &recipe)
4308 index = lua_gettop(L) + 1 + index;
4310 if(!lua_istable(L, index))
4315 while(lua_next(L, index) != 0){
4317 // key at index -2 and value at index -1
4318 if(!lua_istable(L, -1))
4320 int table2 = lua_gettop(L);
4322 while(lua_next(L, table2) != 0){
4323 // key at index -2 and value at index -1
4324 if(!lua_isstring(L, -1))
4326 recipe.push_back(lua_tostring(L, -1));
4327 // removes value, keeps key for next iteration
4334 if(colcount != width)
4337 // removes value, keeps key for next iteration
4344 // helper for register_craft
4345 static bool read_craft_recipe_shapeless(lua_State *L, int index,
4346 std::vector<std::string> &recipe)
4349 index = lua_gettop(L) + 1 + index;
4351 if(!lua_istable(L, index))
4355 while(lua_next(L, index) != 0){
4356 // key at index -2 and value at index -1
4357 if(!lua_isstring(L, -1))
4359 recipe.push_back(lua_tostring(L, -1));
4360 // removes value, keeps key for next iteration
4366 // helper for register_craft
4367 static bool read_craft_replacements(lua_State *L, int index,
4368 CraftReplacements &replacements)
4371 index = lua_gettop(L) + 1 + index;
4373 if(!lua_istable(L, index))
4377 while(lua_next(L, index) != 0){
4378 // key at index -2 and value at index -1
4379 if(!lua_istable(L, -1))
4381 lua_rawgeti(L, -1, 1);
4382 if(!lua_isstring(L, -1))
4384 std::string replace_from = lua_tostring(L, -1);
4386 lua_rawgeti(L, -1, 2);
4387 if(!lua_isstring(L, -1))
4389 std::string replace_to = lua_tostring(L, -1);
4391 replacements.pairs.push_back(
4392 std::make_pair(replace_from, replace_to));
4393 // removes value, keeps key for next iteration
4398 // register_craft({output=item, recipe={{item00,item10},{item01,item11}})
4399 static int l_register_craft(lua_State *L)
4401 //infostream<<"register_craft"<<std::endl;
4402 luaL_checktype(L, 1, LUA_TTABLE);
4405 // Get the writable craft definition manager from the server
4406 IWritableCraftDefManager *craftdef =
4407 get_server(L)->getWritableCraftDefManager();
4409 std::string type = getstringfield_default(L, table, "type", "shaped");
4412 CraftDefinitionShaped
4414 if(type == "shaped"){
4415 std::string output = getstringfield_default(L, table, "output", "");
4417 throw LuaError(L, "Crafting definition is missing an output");
4420 std::vector<std::string> recipe;
4421 lua_getfield(L, table, "recipe");
4422 if(lua_isnil(L, -1))
4423 throw LuaError(L, "Crafting definition is missing a recipe"
4424 " (output=\"" + output + "\")");
4425 if(!read_craft_recipe_shaped(L, -1, width, recipe))
4426 throw LuaError(L, "Invalid crafting recipe"
4427 " (output=\"" + output + "\")");
4429 CraftReplacements replacements;
4430 lua_getfield(L, table, "replacements");
4431 if(!lua_isnil(L, -1))
4433 if(!read_craft_replacements(L, -1, replacements))
4434 throw LuaError(L, "Invalid replacements"
4435 " (output=\"" + output + "\")");
4438 CraftDefinition *def = new CraftDefinitionShaped(
4439 output, width, recipe, replacements);
4440 craftdef->registerCraft(def);
4443 CraftDefinitionShapeless
4445 else if(type == "shapeless"){
4446 std::string output = getstringfield_default(L, table, "output", "");
4448 throw LuaError(L, "Crafting definition (shapeless)"
4449 " is missing an output");
4451 std::vector<std::string> recipe;
4452 lua_getfield(L, table, "recipe");
4453 if(lua_isnil(L, -1))
4454 throw LuaError(L, "Crafting definition (shapeless)"
4455 " is missing a recipe"
4456 " (output=\"" + output + "\")");
4457 if(!read_craft_recipe_shapeless(L, -1, recipe))
4458 throw LuaError(L, "Invalid crafting recipe"
4459 " (output=\"" + output + "\")");
4461 CraftReplacements replacements;
4462 lua_getfield(L, table, "replacements");
4463 if(!lua_isnil(L, -1))
4465 if(!read_craft_replacements(L, -1, replacements))
4466 throw LuaError(L, "Invalid replacements"
4467 " (output=\"" + output + "\")");
4470 CraftDefinition *def = new CraftDefinitionShapeless(
4471 output, recipe, replacements);
4472 craftdef->registerCraft(def);
4475 CraftDefinitionToolRepair
4477 else if(type == "toolrepair"){
4478 float additional_wear = getfloatfield_default(L, table,
4479 "additional_wear", 0.0);
4481 CraftDefinition *def = new CraftDefinitionToolRepair(
4483 craftdef->registerCraft(def);
4486 CraftDefinitionCooking
4488 else if(type == "cooking"){
4489 std::string output = getstringfield_default(L, table, "output", "");
4491 throw LuaError(L, "Crafting definition (cooking)"
4492 " is missing an output");
4494 std::string recipe = getstringfield_default(L, table, "recipe", "");
4496 throw LuaError(L, "Crafting definition (cooking)"
4497 " is missing a recipe"
4498 " (output=\"" + output + "\")");
4500 float cooktime = getfloatfield_default(L, table, "cooktime", 3.0);
4502 CraftReplacements replacements;
4503 lua_getfield(L, table, "replacements");
4504 if(!lua_isnil(L, -1))
4506 if(!read_craft_replacements(L, -1, replacements))
4507 throw LuaError(L, "Invalid replacements"
4508 " (cooking output=\"" + output + "\")");
4511 CraftDefinition *def = new CraftDefinitionCooking(
4512 output, recipe, cooktime, replacements);
4513 craftdef->registerCraft(def);
4518 else if(type == "fuel"){
4519 std::string recipe = getstringfield_default(L, table, "recipe", "");
4521 throw LuaError(L, "Crafting definition (fuel)"
4522 " is missing a recipe");
4524 float burntime = getfloatfield_default(L, table, "burntime", 1.0);
4526 CraftReplacements replacements;
4527 lua_getfield(L, table, "replacements");
4528 if(!lua_isnil(L, -1))
4530 if(!read_craft_replacements(L, -1, replacements))
4531 throw LuaError(L, "Invalid replacements"
4532 " (fuel recipe=\"" + recipe + "\")");
4535 CraftDefinition *def = new CraftDefinitionFuel(
4536 recipe, burntime, replacements);
4537 craftdef->registerCraft(def);
4541 throw LuaError(L, "Unknown crafting definition type: \"" + type + "\"");
4545 return 0; /* number of results */
4548 // setting_set(name, value)
4549 static int l_setting_set(lua_State *L)
4551 const char *name = luaL_checkstring(L, 1);
4552 const char *value = luaL_checkstring(L, 2);
4553 g_settings->set(name, value);
4557 // setting_get(name)
4558 static int l_setting_get(lua_State *L)
4560 const char *name = luaL_checkstring(L, 1);
4562 std::string value = g_settings->get(name);
4563 lua_pushstring(L, value.c_str());
4564 } catch(SettingNotFoundException &e){
4570 // setting_getbool(name)
4571 static int l_setting_getbool(lua_State *L)
4573 const char *name = luaL_checkstring(L, 1);
4575 bool value = g_settings->getBool(name);
4576 lua_pushboolean(L, value);
4577 } catch(SettingNotFoundException &e){
4583 // chat_send_all(text)
4584 static int l_chat_send_all(lua_State *L)
4586 const char *text = luaL_checkstring(L, 1);
4587 // Get server from registry
4588 Server *server = get_server(L);
4590 server->notifyPlayers(narrow_to_wide(text));
4594 // chat_send_player(name, text)
4595 static int l_chat_send_player(lua_State *L)
4597 const char *name = luaL_checkstring(L, 1);
4598 const char *text = luaL_checkstring(L, 2);
4599 // Get server from registry
4600 Server *server = get_server(L);
4602 server->notifyPlayer(name, narrow_to_wide(text));
4606 // get_player_privs(name, text)
4607 static int l_get_player_privs(lua_State *L)
4609 const char *name = luaL_checkstring(L, 1);
4610 // Get server from registry
4611 Server *server = get_server(L);
4614 int table = lua_gettop(L);
4615 std::set<std::string> privs_s = server->getPlayerEffectivePrivs(name);
4616 for(std::set<std::string>::const_iterator
4617 i = privs_s.begin(); i != privs_s.end(); i++){
4618 lua_pushboolean(L, true);
4619 lua_setfield(L, table, i->c_str());
4621 lua_pushvalue(L, table);
4626 static int l_get_ban_list(lua_State *L)
4628 lua_pushstring(L, get_server(L)->getBanDescription("").c_str());
4632 // get_ban_description()
4633 static int l_get_ban_description(lua_State *L)
4635 const char * ip_or_name = luaL_checkstring(L, 1);
4636 lua_pushstring(L, get_server(L)->getBanDescription(std::string(ip_or_name)).c_str());
4641 static int l_ban_player(lua_State *L)
4643 const char * name = luaL_checkstring(L, 1);
4644 Player *player = get_env(L)->getPlayer(name);
4647 lua_pushboolean(L, false); // no such player
4652 Address addr = get_server(L)->getPeerAddress(get_env(L)->getPlayer(name)->peer_id);
4653 std::string ip_str = addr.serializeString();
4654 get_server(L)->setIpBanned(ip_str, name);
4656 catch(con::PeerNotFoundException) // unlikely
4658 dstream << __FUNCTION_NAME << ": peer was not found" << std::endl;
4659 lua_pushboolean(L, false); // error
4662 lua_pushboolean(L, true);
4666 // unban_player_or_ip()
4667 static int l_unban_player_of_ip(lua_State *L)
4669 const char * ip_or_name = luaL_checkstring(L, 1);
4670 get_server(L)->unsetIpBanned(ip_or_name);
4671 lua_pushboolean(L, true);
4675 // get_inventory(location)
4676 static int l_get_inventory(lua_State *L)
4678 InventoryLocation loc;
4680 std::string type = checkstringfield(L, 1, "type");
4681 if(type == "player"){
4682 std::string name = checkstringfield(L, 1, "name");
4683 loc.setPlayer(name);
4684 } else if(type == "node"){
4685 lua_getfield(L, 1, "pos");
4686 v3s16 pos = check_v3s16(L, -1);
4687 loc.setNodeMeta(pos);
4688 } else if(type == "detached"){
4689 std::string name = checkstringfield(L, 1, "name");
4690 loc.setDetached(name);
4693 if(get_server(L)->getInventory(loc) != NULL)
4694 InvRef::create(L, loc);
4700 // create_detached_inventory_raw(name)
4701 static int l_create_detached_inventory_raw(lua_State *L)
4703 const char *name = luaL_checkstring(L, 1);
4704 if(get_server(L)->createDetachedInventory(name) != NULL){
4705 InventoryLocation loc;
4706 loc.setDetached(name);
4707 InvRef::create(L, loc);
4714 // get_dig_params(groups, tool_capabilities[, time_from_last_punch])
4715 static int l_get_dig_params(lua_State *L)
4717 std::map<std::string, int> groups;
4718 read_groups(L, 1, groups);
4719 ToolCapabilities tp = read_tool_capabilities(L, 2);
4720 if(lua_isnoneornil(L, 3))
4721 push_dig_params(L, getDigParams(groups, &tp));
4723 push_dig_params(L, getDigParams(groups, &tp,
4724 luaL_checknumber(L, 3)));
4728 // get_hit_params(groups, tool_capabilities[, time_from_last_punch])
4729 static int l_get_hit_params(lua_State *L)
4731 std::map<std::string, int> groups;
4732 read_groups(L, 1, groups);
4733 ToolCapabilities tp = read_tool_capabilities(L, 2);
4734 if(lua_isnoneornil(L, 3))
4735 push_hit_params(L, getHitParams(groups, &tp));
4737 push_hit_params(L, getHitParams(groups, &tp,
4738 luaL_checknumber(L, 3)));
4742 // get_current_modname()
4743 static int l_get_current_modname(lua_State *L)
4745 lua_getfield(L, LUA_REGISTRYINDEX, "minetest_current_modname");
4749 // get_modpath(modname)
4750 static int l_get_modpath(lua_State *L)
4752 std::string modname = luaL_checkstring(L, 1);
4754 if(modname == "__builtin"){
4755 std::string path = get_server(L)->getBuiltinLuaPath();
4756 lua_pushstring(L, path.c_str());
4759 const ModSpec *mod = get_server(L)->getModSpec(modname);
4764 lua_pushstring(L, mod->path.c_str());
4769 // the returned list is sorted alphabetically for you
4770 static int l_get_modnames(lua_State *L)
4772 // Get a list of mods
4773 core::list<std::string> mods_unsorted, mods_sorted;
4774 get_server(L)->getModNames(mods_unsorted);
4776 // Take unsorted items from mods_unsorted and sort them into
4777 // mods_sorted; not great performance but the number of mods on a
4778 // server will likely be small.
4779 for(core::list<std::string>::Iterator i = mods_unsorted.begin();
4780 i != mods_unsorted.end(); i++)
4783 for(core::list<std::string>::Iterator x = mods_sorted.begin();
4784 x != mods_unsorted.end(); x++)
4786 // I doubt anybody using Minetest will be using
4787 // anything not ASCII based :)
4788 if((*i).compare(*x) <= 0)
4790 mods_sorted.insert_before(x, *i);
4796 mods_sorted.push_back(*i);
4799 // Get the table insertion function from Lua.
4800 lua_getglobal(L, "table");
4801 lua_getfield(L, -1, "insert");
4802 int insertion_func = lua_gettop(L);
4804 // Package them up for Lua
4806 int new_table = lua_gettop(L);
4807 core::list<std::string>::Iterator i = mods_sorted.begin();
4808 while(i != mods_sorted.end())
4810 lua_pushvalue(L, insertion_func);
4811 lua_pushvalue(L, new_table);
4812 lua_pushstring(L, (*i).c_str());
4813 if(lua_pcall(L, 2, 0, 0) != 0)
4815 script_error(L, "error: %s", lua_tostring(L, -1));
4823 static int l_get_worldpath(lua_State *L)
4825 std::string worldpath = get_server(L)->getWorldPath();
4826 lua_pushstring(L, worldpath.c_str());
4830 // sound_play(spec, parameters)
4831 static int l_sound_play(lua_State *L)
4833 SimpleSoundSpec spec;
4834 read_soundspec(L, 1, spec);
4835 ServerSoundParams params;
4836 read_server_sound_params(L, 2, params);
4837 s32 handle = get_server(L)->playSound(spec, params);
4838 lua_pushinteger(L, handle);
4842 // sound_stop(handle)
4843 static int l_sound_stop(lua_State *L)
4845 int handle = luaL_checkinteger(L, 1);
4846 get_server(L)->stopSound(handle);
4850 // is_singleplayer()
4851 static int l_is_singleplayer(lua_State *L)
4853 lua_pushboolean(L, get_server(L)->isSingleplayer());
4857 // get_password_hash(name, raw_password)
4858 static int l_get_password_hash(lua_State *L)
4860 std::string name = luaL_checkstring(L, 1);
4861 std::string raw_password = luaL_checkstring(L, 2);
4862 std::string hash = translatePassword(name,
4863 narrow_to_wide(raw_password));
4864 lua_pushstring(L, hash.c_str());
4868 // notify_authentication_modified(name)
4869 static int l_notify_authentication_modified(lua_State *L)
4871 std::string name = "";
4872 if(lua_isstring(L, 1))
4873 name = lua_tostring(L, 1);
4874 get_server(L)->reportPrivsModified(name);
4878 // get_craft_result(input)
4879 static int l_get_craft_result(lua_State *L)
4882 std::string method_s = getstringfield_default(L, input_i, "method", "normal");
4883 enum CraftMethod method = (CraftMethod)getenumfield(L, input_i, "method",
4884 es_CraftMethod, CRAFT_METHOD_NORMAL);
4886 lua_getfield(L, input_i, "width");
4887 if(lua_isnumber(L, -1))
4888 width = luaL_checkinteger(L, -1);
4890 lua_getfield(L, input_i, "items");
4891 std::vector<ItemStack> items = read_items(L, -1);
4892 lua_pop(L, 1); // items
4894 IGameDef *gdef = get_server(L);
4895 ICraftDefManager *cdef = gdef->cdef();
4896 CraftInput input(method, width, items);
4898 bool got = cdef->getCraftResult(input, output, true, gdef);
4899 lua_newtable(L); // output table
4902 item.deSerialize(output.item, gdef->idef());
4903 LuaItemStack::create(L, item);
4904 lua_setfield(L, -2, "item");
4905 setintfield(L, -1, "time", output.time);
4907 LuaItemStack::create(L, ItemStack());
4908 lua_setfield(L, -2, "item");
4909 setintfield(L, -1, "time", 0);
4911 lua_newtable(L); // decremented input table
4912 lua_pushstring(L, method_s.c_str());
4913 lua_setfield(L, -2, "method");
4914 lua_pushinteger(L, width);
4915 lua_setfield(L, -2, "width");
4916 push_items(L, input.items);
4917 lua_setfield(L, -2, "items");
4921 // get_craft_recipe(result item)
4922 static int l_get_craft_recipe(lua_State *L)
4927 std::string o_item = luaL_checkstring(L,input_i);
4929 IGameDef *gdef = get_server(L);
4930 ICraftDefManager *cdef = gdef->cdef();
4932 CraftOutput output(o_item,0);
4933 bool got = cdef->getCraftRecipe(input, output, gdef);
4934 lua_newtable(L); // output table
4937 for(std::vector<ItemStack>::const_iterator
4938 i = input.items.begin();
4939 i != input.items.end(); i++, k++)
4945 sprintf(tmp,"%d",k);
4946 lua_pushstring(L,tmp);
4947 lua_pushstring(L,i->name.c_str());
4948 lua_settable(L, -3);
4950 lua_setfield(L, -2, "items");
4951 setintfield(L, -1, "width", input.width);
4952 switch (input.method) {
4953 case CRAFT_METHOD_NORMAL:
4954 lua_pushstring(L,"normal");
4956 case CRAFT_METHOD_COOKING:
4957 lua_pushstring(L,"cooking");
4959 case CRAFT_METHOD_FUEL:
4960 lua_pushstring(L,"fuel");
4963 lua_pushstring(L,"unknown");
4965 lua_setfield(L, -2, "type");
4968 lua_setfield(L, -2, "items");
4969 setintfield(L, -1, "width", 0);
4974 // rollback_get_last_node_actor(p, range, seconds) -> actor, p, seconds
4975 static int l_rollback_get_last_node_actor(lua_State *L)
4977 v3s16 p = read_v3s16(L, 1);
4978 int range = luaL_checknumber(L, 2);
4979 int seconds = luaL_checknumber(L, 3);
4980 Server *server = get_server(L);
4981 IRollbackManager *rollback = server->getRollbackManager();
4983 int act_seconds = 0;
4984 std::string actor = rollback->getLastNodeActor(p, range, seconds, &act_p, &act_seconds);
4985 lua_pushstring(L, actor.c_str());
4986 push_v3s16(L, act_p);
4987 lua_pushnumber(L, act_seconds);
4991 // rollback_revert_actions_by(actor, seconds) -> bool, log messages
4992 static int l_rollback_revert_actions_by(lua_State *L)
4994 std::string actor = luaL_checkstring(L, 1);
4995 int seconds = luaL_checknumber(L, 2);
4996 Server *server = get_server(L);
4997 IRollbackManager *rollback = server->getRollbackManager();
4998 std::list<RollbackAction> actions = rollback->getRevertActions(actor, seconds);
4999 std::list<std::string> log;
5000 bool success = server->rollbackRevertActions(actions, &log);
5001 // Push boolean result
5002 lua_pushboolean(L, success);
5003 // Get the table insert function and push the log table
5004 lua_getglobal(L, "table");
5005 lua_getfield(L, -1, "insert");
5006 int table_insert = lua_gettop(L);
5008 int table = lua_gettop(L);
5009 for(std::list<std::string>::const_iterator i = log.begin();
5010 i != log.end(); i++)
5012 lua_pushvalue(L, table_insert);
5013 lua_pushvalue(L, table);
5014 lua_pushstring(L, i->c_str());
5015 if(lua_pcall(L, 2, 0, 0))
5016 script_error(L, "error: %s", lua_tostring(L, -1));
5018 lua_remove(L, -2); // Remove table
5019 lua_remove(L, -2); // Remove insert
5023 static const struct luaL_Reg minetest_f [] = {
5026 {"request_shutdown", l_request_shutdown},
5027 {"get_server_status", l_get_server_status},
5028 {"register_item_raw", l_register_item_raw},
5029 {"register_alias_raw", l_register_alias_raw},
5030 {"register_craft", l_register_craft},
5031 {"setting_set", l_setting_set},
5032 {"setting_get", l_setting_get},
5033 {"setting_getbool", l_setting_getbool},
5034 {"chat_send_all", l_chat_send_all},
5035 {"chat_send_player", l_chat_send_player},
5036 {"get_player_privs", l_get_player_privs},
5037 {"get_ban_list", l_get_ban_list},
5038 {"get_ban_description", l_get_ban_description},
5039 {"ban_player", l_ban_player},
5040 {"unban_player_or_ip", l_unban_player_of_ip},
5041 {"get_inventory", l_get_inventory},
5042 {"create_detached_inventory_raw", l_create_detached_inventory_raw},
5043 {"get_dig_params", l_get_dig_params},
5044 {"get_hit_params", l_get_hit_params},
5045 {"get_current_modname", l_get_current_modname},
5046 {"get_modpath", l_get_modpath},
5047 {"get_modnames", l_get_modnames},
5048 {"get_worldpath", l_get_worldpath},
5049 {"sound_play", l_sound_play},
5050 {"sound_stop", l_sound_stop},
5051 {"is_singleplayer", l_is_singleplayer},
5052 {"get_password_hash", l_get_password_hash},
5053 {"notify_authentication_modified", l_notify_authentication_modified},
5054 {"get_craft_result", l_get_craft_result},
5055 {"get_craft_recipe", l_get_craft_recipe},
5056 {"rollback_get_last_node_actor", l_rollback_get_last_node_actor},
5057 {"rollback_revert_actions_by", l_rollback_revert_actions_by},
5062 Main export function
5065 void scriptapi_export(lua_State *L, Server *server)
5068 assert(lua_checkstack(L, 20));
5069 verbosestream<<"scriptapi_export()"<<std::endl;
5070 StackUnroller stack_unroller(L);
5072 // Store server as light userdata in registry
5073 lua_pushlightuserdata(L, server);
5074 lua_setfield(L, LUA_REGISTRYINDEX, "minetest_server");
5076 // Register global functions in table minetest
5078 luaL_register(L, NULL, minetest_f);
5079 lua_setglobal(L, "minetest");
5081 // Get the main minetest table
5082 lua_getglobal(L, "minetest");
5084 // Add tables to minetest
5086 lua_setfield(L, -2, "object_refs");
5088 lua_setfield(L, -2, "luaentities");
5090 // Register wrappers
5091 LuaItemStack::Register(L);
5092 InvRef::Register(L);
5093 NodeMetaRef::Register(L);
5094 NodeTimerRef::Register(L);
5095 ObjectRef::Register(L);
5096 EnvRef::Register(L);
5097 LuaPseudoRandom::Register(L);
5098 LuaPerlinNoise::Register(L);
5101 bool scriptapi_loadmod(lua_State *L, const std::string &scriptpath,
5102 const std::string &modname)
5104 ModNameStorer modnamestorer(L, modname);
5106 if(!string_allowed(modname, "abcdefghijklmnopqrstuvwxyz"
5108 errorstream<<"Error loading mod \""<<modname
5109 <<"\": modname does not follow naming conventions: "
5110 <<"Only chararacters [a-z0-9_] are allowed."<<std::endl;
5114 bool success = false;
5117 success = script_load(L, scriptpath.c_str());
5120 errorstream<<"Error loading mod \""<<modname
5121 <<"\": "<<e.what()<<std::endl;
5127 void scriptapi_add_environment(lua_State *L, ServerEnvironment *env)
5130 assert(lua_checkstack(L, 20));
5131 verbosestream<<"scriptapi_add_environment"<<std::endl;
5132 StackUnroller stack_unroller(L);
5134 // Create EnvRef on stack
5135 EnvRef::create(L, env);
5136 int envref = lua_gettop(L);
5138 // minetest.env = envref
5139 lua_getglobal(L, "minetest");
5140 luaL_checktype(L, -1, LUA_TTABLE);
5141 lua_pushvalue(L, envref);
5142 lua_setfield(L, -2, "env");
5144 // Store environment as light userdata in registry
5145 lua_pushlightuserdata(L, env);
5146 lua_setfield(L, LUA_REGISTRYINDEX, "minetest_env");
5149 Add ActiveBlockModifiers to environment
5152 // Get minetest.registered_abms
5153 lua_getglobal(L, "minetest");
5154 lua_getfield(L, -1, "registered_abms");
5155 luaL_checktype(L, -1, LUA_TTABLE);
5156 int registered_abms = lua_gettop(L);
5158 if(lua_istable(L, registered_abms)){
5159 int table = lua_gettop(L);
5161 while(lua_next(L, table) != 0){
5162 // key at index -2 and value at index -1
5163 int id = lua_tonumber(L, -2);
5164 int current_abm = lua_gettop(L);
5166 std::set<std::string> trigger_contents;
5167 lua_getfield(L, current_abm, "nodenames");
5168 if(lua_istable(L, -1)){
5169 int table = lua_gettop(L);
5171 while(lua_next(L, table) != 0){
5172 // key at index -2 and value at index -1
5173 luaL_checktype(L, -1, LUA_TSTRING);
5174 trigger_contents.insert(lua_tostring(L, -1));
5175 // removes value, keeps key for next iteration
5178 } else if(lua_isstring(L, -1)){
5179 trigger_contents.insert(lua_tostring(L, -1));
5183 std::set<std::string> required_neighbors;
5184 lua_getfield(L, current_abm, "neighbors");
5185 if(lua_istable(L, -1)){
5186 int table = lua_gettop(L);
5188 while(lua_next(L, table) != 0){
5189 // key at index -2 and value at index -1
5190 luaL_checktype(L, -1, LUA_TSTRING);
5191 required_neighbors.insert(lua_tostring(L, -1));
5192 // removes value, keeps key for next iteration
5195 } else if(lua_isstring(L, -1)){
5196 required_neighbors.insert(lua_tostring(L, -1));
5200 float trigger_interval = 10.0;
5201 getfloatfield(L, current_abm, "interval", trigger_interval);
5203 int trigger_chance = 50;
5204 getintfield(L, current_abm, "chance", trigger_chance);
5206 LuaABM *abm = new LuaABM(L, id, trigger_contents,
5207 required_neighbors, trigger_interval, trigger_chance);
5209 env->addActiveBlockModifier(abm);
5211 // removes value, keeps key for next iteration
5219 // Dump stack top with the dump2 function
5220 static void dump2(lua_State *L, const char *name)
5222 // Dump object (debug)
5223 lua_getglobal(L, "dump2");
5224 luaL_checktype(L, -1, LUA_TFUNCTION);
5225 lua_pushvalue(L, -2); // Get previous stack top as first parameter
5226 lua_pushstring(L, name);
5227 if(lua_pcall(L, 2, 0, 0))
5228 script_error(L, "error: %s", lua_tostring(L, -1));
5236 void scriptapi_add_object_reference(lua_State *L, ServerActiveObject *cobj)
5239 assert(lua_checkstack(L, 20));
5240 //infostream<<"scriptapi_add_object_reference: id="<<cobj->getId()<<std::endl;
5241 StackUnroller stack_unroller(L);
5243 // Create object on stack
5244 ObjectRef::create(L, cobj); // Puts ObjectRef (as userdata) on stack
5245 int object = lua_gettop(L);
5247 // Get minetest.object_refs table
5248 lua_getglobal(L, "minetest");
5249 lua_getfield(L, -1, "object_refs");
5250 luaL_checktype(L, -1, LUA_TTABLE);
5251 int objectstable = lua_gettop(L);
5253 // object_refs[id] = object
5254 lua_pushnumber(L, cobj->getId()); // Push id
5255 lua_pushvalue(L, object); // Copy object to top of stack
5256 lua_settable(L, objectstable);
5259 void scriptapi_rm_object_reference(lua_State *L, ServerActiveObject *cobj)
5262 assert(lua_checkstack(L, 20));
5263 //infostream<<"scriptapi_rm_object_reference: id="<<cobj->getId()<<std::endl;
5264 StackUnroller stack_unroller(L);
5266 // Get minetest.object_refs table
5267 lua_getglobal(L, "minetest");
5268 lua_getfield(L, -1, "object_refs");
5269 luaL_checktype(L, -1, LUA_TTABLE);
5270 int objectstable = lua_gettop(L);
5272 // Get object_refs[id]
5273 lua_pushnumber(L, cobj->getId()); // Push id
5274 lua_gettable(L, objectstable);
5275 // Set object reference to NULL
5276 ObjectRef::set_null(L);
5277 lua_pop(L, 1); // pop object
5279 // Set object_refs[id] = nil
5280 lua_pushnumber(L, cobj->getId()); // Push id
5282 lua_settable(L, objectstable);
5289 // What scriptapi_run_callbacks does with the return values of callbacks.
5290 // Regardless of the mode, if only one callback is defined,
5291 // its return value is the total return value.
5292 // Modes only affect the case where 0 or >= 2 callbacks are defined.
5293 enum RunCallbacksMode
5295 // Returns the return value of the first callback
5296 // Returns nil if list of callbacks is empty
5297 RUN_CALLBACKS_MODE_FIRST,
5298 // Returns the return value of the last callback
5299 // Returns nil if list of callbacks is empty
5300 RUN_CALLBACKS_MODE_LAST,
5301 // If any callback returns a false value, the first such is returned
5302 // Otherwise, the first callback's return value (trueish) is returned
5303 // Returns true if list of callbacks is empty
5304 RUN_CALLBACKS_MODE_AND,
5305 // Like above, but stops calling callbacks (short circuit)
5306 // after seeing the first false value
5307 RUN_CALLBACKS_MODE_AND_SC,
5308 // If any callback returns a true value, the first such is returned
5309 // Otherwise, the first callback's return value (falseish) is returned
5310 // Returns false if list of callbacks is empty
5311 RUN_CALLBACKS_MODE_OR,
5312 // Like above, but stops calling callbacks (short circuit)
5313 // after seeing the first true value
5314 RUN_CALLBACKS_MODE_OR_SC,
5315 // Note: "a true value" and "a false value" refer to values that
5316 // are converted by lua_toboolean to true or false, respectively.
5319 // Push the list of callbacks (a lua table).
5320 // Then push nargs arguments.
5321 // Then call this function, which
5322 // - runs the callbacks
5323 // - removes the table and arguments from the lua stack
5324 // - pushes the return value, computed depending on mode
5325 static void scriptapi_run_callbacks(lua_State *L, int nargs,
5326 RunCallbacksMode mode)
5328 // Insert the return value into the lua stack, below the table
5329 assert(lua_gettop(L) >= nargs + 1);
5331 lua_insert(L, -(nargs + 1) - 1);
5332 // Stack now looks like this:
5333 // ... <return value = nil> <table> <arg#1> <arg#2> ... <arg#n>
5335 int rv = lua_gettop(L) - nargs - 1;
5337 int arg = table + 1;
5339 luaL_checktype(L, table, LUA_TTABLE);
5343 bool first_loop = true;
5344 while(lua_next(L, table) != 0){
5345 // key at index -2 and value at index -1
5346 luaL_checktype(L, -1, LUA_TFUNCTION);
5348 for(int i = 0; i < nargs; i++)
5349 lua_pushvalue(L, arg+i);
5350 if(lua_pcall(L, nargs, 1, 0))
5351 script_error(L, "error: %s", lua_tostring(L, -1));
5353 // Move return value to designated space in stack
5356 // Result of first callback is always moved
5360 // Otherwise, what happens depends on the mode
5361 if(mode == RUN_CALLBACKS_MODE_FIRST)
5363 else if(mode == RUN_CALLBACKS_MODE_LAST)
5365 else if(mode == RUN_CALLBACKS_MODE_AND ||
5366 mode == RUN_CALLBACKS_MODE_AND_SC){
5367 if(lua_toboolean(L, rv) == true &&
5368 lua_toboolean(L, -1) == false)
5373 else if(mode == RUN_CALLBACKS_MODE_OR ||
5374 mode == RUN_CALLBACKS_MODE_OR_SC){
5375 if(lua_toboolean(L, rv) == false &&
5376 lua_toboolean(L, -1) == true)
5385 // Handle short circuit modes
5386 if(mode == RUN_CALLBACKS_MODE_AND_SC &&
5387 lua_toboolean(L, rv) == false)
5389 else if(mode == RUN_CALLBACKS_MODE_OR_SC &&
5390 lua_toboolean(L, rv) == true)
5393 // value removed, keep key for next iteration
5396 // Remove stuff from stack, leaving only the return value
5399 // Fix return value in case no callbacks were called
5401 if(mode == RUN_CALLBACKS_MODE_AND ||
5402 mode == RUN_CALLBACKS_MODE_AND_SC){
5404 lua_pushboolean(L, true);
5406 else if(mode == RUN_CALLBACKS_MODE_OR ||
5407 mode == RUN_CALLBACKS_MODE_OR_SC){
5409 lua_pushboolean(L, false);
5414 bool scriptapi_on_chat_message(lua_State *L, const std::string &name,
5415 const std::string &message)
5418 assert(lua_checkstack(L, 20));
5419 StackUnroller stack_unroller(L);
5421 // Get minetest.registered_on_chat_messages
5422 lua_getglobal(L, "minetest");
5423 lua_getfield(L, -1, "registered_on_chat_messages");
5425 lua_pushstring(L, name.c_str());
5426 lua_pushstring(L, message.c_str());
5427 scriptapi_run_callbacks(L, 2, RUN_CALLBACKS_MODE_OR_SC);
5428 bool ate = lua_toboolean(L, -1);
5432 void scriptapi_on_newplayer(lua_State *L, ServerActiveObject *player)
5435 assert(lua_checkstack(L, 20));
5436 StackUnroller stack_unroller(L);
5438 // Get minetest.registered_on_newplayers
5439 lua_getglobal(L, "minetest");
5440 lua_getfield(L, -1, "registered_on_newplayers");
5442 objectref_get_or_create(L, player);
5443 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
5446 void scriptapi_on_dieplayer(lua_State *L, ServerActiveObject *player)
5449 assert(lua_checkstack(L, 20));
5450 StackUnroller stack_unroller(L);
5452 // Get minetest.registered_on_dieplayers
5453 lua_getglobal(L, "minetest");
5454 lua_getfield(L, -1, "registered_on_dieplayers");
5456 objectref_get_or_create(L, player);
5457 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
5460 bool scriptapi_on_respawnplayer(lua_State *L, ServerActiveObject *player)
5463 assert(lua_checkstack(L, 20));
5464 StackUnroller stack_unroller(L);
5466 // Get minetest.registered_on_respawnplayers
5467 lua_getglobal(L, "minetest");
5468 lua_getfield(L, -1, "registered_on_respawnplayers");
5470 objectref_get_or_create(L, player);
5471 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_OR);
5472 bool positioning_handled_by_some = lua_toboolean(L, -1);
5473 return positioning_handled_by_some;
5476 void scriptapi_on_joinplayer(lua_State *L, ServerActiveObject *player)
5479 assert(lua_checkstack(L, 20));
5480 StackUnroller stack_unroller(L);
5482 // Get minetest.registered_on_joinplayers
5483 lua_getglobal(L, "minetest");
5484 lua_getfield(L, -1, "registered_on_joinplayers");
5486 objectref_get_or_create(L, player);
5487 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
5490 void scriptapi_on_leaveplayer(lua_State *L, ServerActiveObject *player)
5493 assert(lua_checkstack(L, 20));
5494 StackUnroller stack_unroller(L);
5496 // Get minetest.registered_on_leaveplayers
5497 lua_getglobal(L, "minetest");
5498 lua_getfield(L, -1, "registered_on_leaveplayers");
5500 objectref_get_or_create(L, player);
5501 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
5504 static void get_auth_handler(lua_State *L)
5506 lua_getglobal(L, "minetest");
5507 lua_getfield(L, -1, "registered_auth_handler");
5508 if(lua_isnil(L, -1)){
5510 lua_getfield(L, -1, "builtin_auth_handler");
5512 if(lua_type(L, -1) != LUA_TTABLE)
5513 throw LuaError(L, "Authentication handler table not valid");
5516 bool scriptapi_get_auth(lua_State *L, const std::string &playername,
5517 std::string *dst_password, std::set<std::string> *dst_privs)
5520 assert(lua_checkstack(L, 20));
5521 StackUnroller stack_unroller(L);
5523 get_auth_handler(L);
5524 lua_getfield(L, -1, "get_auth");
5525 if(lua_type(L, -1) != LUA_TFUNCTION)
5526 throw LuaError(L, "Authentication handler missing get_auth");
5527 lua_pushstring(L, playername.c_str());
5528 if(lua_pcall(L, 1, 1, 0))
5529 script_error(L, "error: %s", lua_tostring(L, -1));
5531 // nil = login not allowed
5532 if(lua_isnil(L, -1))
5534 luaL_checktype(L, -1, LUA_TTABLE);
5536 std::string password;
5537 bool found = getstringfield(L, -1, "password", password);
5539 throw LuaError(L, "Authentication handler didn't return password");
5541 *dst_password = password;
5543 lua_getfield(L, -1, "privileges");
5544 if(!lua_istable(L, -1))
5546 "Authentication handler didn't return privilege table");
5548 read_privileges(L, -1, *dst_privs);
5554 void scriptapi_create_auth(lua_State *L, const std::string &playername,
5555 const std::string &password)
5558 assert(lua_checkstack(L, 20));
5559 StackUnroller stack_unroller(L);
5561 get_auth_handler(L);
5562 lua_getfield(L, -1, "create_auth");
5563 if(lua_type(L, -1) != LUA_TFUNCTION)
5564 throw LuaError(L, "Authentication handler missing create_auth");
5565 lua_pushstring(L, playername.c_str());
5566 lua_pushstring(L, password.c_str());
5567 if(lua_pcall(L, 2, 0, 0))
5568 script_error(L, "error: %s", lua_tostring(L, -1));
5571 bool scriptapi_set_password(lua_State *L, const std::string &playername,
5572 const std::string &password)
5575 assert(lua_checkstack(L, 20));
5576 StackUnroller stack_unroller(L);
5578 get_auth_handler(L);
5579 lua_getfield(L, -1, "set_password");
5580 if(lua_type(L, -1) != LUA_TFUNCTION)
5581 throw LuaError(L, "Authentication handler missing set_password");
5582 lua_pushstring(L, playername.c_str());
5583 lua_pushstring(L, password.c_str());
5584 if(lua_pcall(L, 2, 1, 0))
5585 script_error(L, "error: %s", lua_tostring(L, -1));
5586 return lua_toboolean(L, -1);
5593 void scriptapi_on_player_receive_fields(lua_State *L,
5594 ServerActiveObject *player,
5595 const std::string &formname,
5596 const std::map<std::string, std::string> &fields)
5599 assert(lua_checkstack(L, 20));
5600 StackUnroller stack_unroller(L);
5602 // Get minetest.registered_on_chat_messages
5603 lua_getglobal(L, "minetest");
5604 lua_getfield(L, -1, "registered_on_player_receive_fields");
5607 objectref_get_or_create(L, player);
5609 lua_pushstring(L, formname.c_str());
5612 for(std::map<std::string, std::string>::const_iterator
5613 i = fields.begin(); i != fields.end(); i++){
5614 const std::string &name = i->first;
5615 const std::string &value = i->second;
5616 lua_pushstring(L, name.c_str());
5617 lua_pushlstring(L, value.c_str(), value.size());
5618 lua_settable(L, -3);
5620 scriptapi_run_callbacks(L, 3, RUN_CALLBACKS_MODE_OR_SC);
5624 item callbacks and node callbacks
5627 // Retrieves minetest.registered_items[name][callbackname]
5628 // If that is nil or on error, return false and stack is unchanged
5629 // If that is a function, returns true and pushes the
5630 // function onto the stack
5631 // If minetest.registered_items[name] doesn't exist, minetest.nodedef_default
5632 // is tried instead so unknown items can still be manipulated to some degree
5633 static bool get_item_callback(lua_State *L,
5634 const char *name, const char *callbackname)
5636 lua_getglobal(L, "minetest");
5637 lua_getfield(L, -1, "registered_items");
5639 luaL_checktype(L, -1, LUA_TTABLE);
5640 lua_getfield(L, -1, name);
5642 // Should be a table
5643 if(lua_type(L, -1) != LUA_TTABLE)
5645 // Report error and clean up
5646 errorstream<<"Item \""<<name<<"\" not defined"<<std::endl;
5649 // Try minetest.nodedef_default instead
5650 lua_getglobal(L, "minetest");
5651 lua_getfield(L, -1, "nodedef_default");
5653 luaL_checktype(L, -1, LUA_TTABLE);
5655 lua_getfield(L, -1, callbackname);
5657 // Should be a function or nil
5658 if(lua_type(L, -1) == LUA_TFUNCTION)
5662 else if(lua_isnil(L, -1))
5669 errorstream<<"Item \""<<name<<"\" callback \""
5670 <<callbackname<<" is not a function"<<std::endl;
5676 bool scriptapi_item_on_drop(lua_State *L, ItemStack &item,
5677 ServerActiveObject *dropper, v3f pos)
5680 assert(lua_checkstack(L, 20));
5681 StackUnroller stack_unroller(L);
5683 // Push callback function on stack
5684 if(!get_item_callback(L, item.name.c_str(), "on_drop"))
5688 LuaItemStack::create(L, item);
5689 objectref_get_or_create(L, dropper);
5690 pushFloatPos(L, pos);
5691 if(lua_pcall(L, 3, 1, 0))
5692 script_error(L, "error: %s", lua_tostring(L, -1));
5693 if(!lua_isnil(L, -1))
5694 item = read_item(L, -1);
5698 bool scriptapi_item_on_place(lua_State *L, ItemStack &item,
5699 ServerActiveObject *placer, const PointedThing &pointed)
5702 assert(lua_checkstack(L, 20));
5703 StackUnroller stack_unroller(L);
5705 // Push callback function on stack
5706 if(!get_item_callback(L, item.name.c_str(), "on_place"))
5710 LuaItemStack::create(L, item);
5711 objectref_get_or_create(L, placer);
5712 push_pointed_thing(L, pointed);
5713 if(lua_pcall(L, 3, 1, 0))
5714 script_error(L, "error: %s", lua_tostring(L, -1));
5715 if(!lua_isnil(L, -1))
5716 item = read_item(L, -1);
5720 bool scriptapi_item_on_use(lua_State *L, ItemStack &item,
5721 ServerActiveObject *user, const PointedThing &pointed)
5724 assert(lua_checkstack(L, 20));
5725 StackUnroller stack_unroller(L);
5727 // Push callback function on stack
5728 if(!get_item_callback(L, item.name.c_str(), "on_use"))
5732 LuaItemStack::create(L, item);
5733 objectref_get_or_create(L, user);
5734 push_pointed_thing(L, pointed);
5735 if(lua_pcall(L, 3, 1, 0))
5736 script_error(L, "error: %s", lua_tostring(L, -1));
5737 if(!lua_isnil(L, -1))
5738 item = read_item(L, -1);
5742 bool scriptapi_node_on_punch(lua_State *L, v3s16 p, MapNode node,
5743 ServerActiveObject *puncher)
5746 assert(lua_checkstack(L, 20));
5747 StackUnroller stack_unroller(L);
5749 INodeDefManager *ndef = get_server(L)->ndef();
5751 // Push callback function on stack
5752 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_punch"))
5757 pushnode(L, node, ndef);
5758 objectref_get_or_create(L, puncher);
5759 if(lua_pcall(L, 3, 0, 0))
5760 script_error(L, "error: %s", lua_tostring(L, -1));
5764 bool scriptapi_node_on_dig(lua_State *L, v3s16 p, MapNode node,
5765 ServerActiveObject *digger)
5768 assert(lua_checkstack(L, 20));
5769 StackUnroller stack_unroller(L);
5771 INodeDefManager *ndef = get_server(L)->ndef();
5773 // Push callback function on stack
5774 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_dig"))
5779 pushnode(L, node, ndef);
5780 objectref_get_or_create(L, digger);
5781 if(lua_pcall(L, 3, 0, 0))
5782 script_error(L, "error: %s", lua_tostring(L, -1));
5786 void scriptapi_node_on_construct(lua_State *L, v3s16 p, MapNode node)
5789 assert(lua_checkstack(L, 20));
5790 StackUnroller stack_unroller(L);
5792 INodeDefManager *ndef = get_server(L)->ndef();
5794 // Push callback function on stack
5795 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_construct"))
5800 if(lua_pcall(L, 1, 0, 0))
5801 script_error(L, "error: %s", lua_tostring(L, -1));
5804 void scriptapi_node_on_destruct(lua_State *L, v3s16 p, MapNode node)
5807 assert(lua_checkstack(L, 20));
5808 StackUnroller stack_unroller(L);
5810 INodeDefManager *ndef = get_server(L)->ndef();
5812 // Push callback function on stack
5813 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_destruct"))
5818 if(lua_pcall(L, 1, 0, 0))
5819 script_error(L, "error: %s", lua_tostring(L, -1));
5822 void scriptapi_node_after_destruct(lua_State *L, v3s16 p, MapNode node)
5825 assert(lua_checkstack(L, 20));
5826 StackUnroller stack_unroller(L);
5828 INodeDefManager *ndef = get_server(L)->ndef();
5830 // Push callback function on stack
5831 if(!get_item_callback(L, ndef->get(node).name.c_str(), "after_destruct"))
5836 pushnode(L, node, ndef);
5837 if(lua_pcall(L, 2, 0, 0))
5838 script_error(L, "error: %s", lua_tostring(L, -1));
5841 bool scriptapi_node_on_timer(lua_State *L, v3s16 p, MapNode node, f32 dtime)
5844 assert(lua_checkstack(L, 20));
5845 StackUnroller stack_unroller(L);
5847 INodeDefManager *ndef = get_server(L)->ndef();
5849 // Push callback function on stack
5850 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_timer"))
5855 lua_pushnumber(L,dtime);
5856 if(lua_pcall(L, 2, 1, 0))
5857 script_error(L, "error: %s", lua_tostring(L, -1));
5858 if(lua_isboolean(L,-1) && lua_toboolean(L,-1) == true)
5864 void scriptapi_node_on_receive_fields(lua_State *L, v3s16 p,
5865 const std::string &formname,
5866 const std::map<std::string, std::string> &fields,
5867 ServerActiveObject *sender)
5870 assert(lua_checkstack(L, 20));
5871 StackUnroller stack_unroller(L);
5873 INodeDefManager *ndef = get_server(L)->ndef();
5875 // If node doesn't exist, we don't know what callback to call
5876 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
5877 if(node.getContent() == CONTENT_IGNORE)
5880 // Push callback function on stack
5881 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_receive_fields"))
5888 lua_pushstring(L, formname.c_str());
5891 for(std::map<std::string, std::string>::const_iterator
5892 i = fields.begin(); i != fields.end(); i++){
5893 const std::string &name = i->first;
5894 const std::string &value = i->second;
5895 lua_pushstring(L, name.c_str());
5896 lua_pushlstring(L, value.c_str(), value.size());
5897 lua_settable(L, -3);
5900 objectref_get_or_create(L, sender);
5901 if(lua_pcall(L, 4, 0, 0))
5902 script_error(L, "error: %s", lua_tostring(L, -1));
5906 Node metadata inventory callbacks
5909 // Return number of accepted items to be moved
5910 int scriptapi_nodemeta_inventory_allow_move(lua_State *L, v3s16 p,
5911 const std::string &from_list, int from_index,
5912 const std::string &to_list, int to_index,
5913 int count, ServerActiveObject *player)
5916 assert(lua_checkstack(L, 20));
5917 StackUnroller stack_unroller(L);
5919 INodeDefManager *ndef = get_server(L)->ndef();
5921 // If node doesn't exist, we don't know what callback to call
5922 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
5923 if(node.getContent() == CONTENT_IGNORE)
5926 // Push callback function on stack
5927 if(!get_item_callback(L, ndef->get(node).name.c_str(),
5928 "allow_metadata_inventory_move"))
5931 // function(pos, from_list, from_index, to_list, to_index, count, player)
5935 lua_pushstring(L, from_list.c_str());
5937 lua_pushinteger(L, from_index + 1);
5939 lua_pushstring(L, to_list.c_str());
5941 lua_pushinteger(L, to_index + 1);
5943 lua_pushinteger(L, count);
5945 objectref_get_or_create(L, player);
5946 if(lua_pcall(L, 7, 1, 0))
5947 script_error(L, "error: %s", lua_tostring(L, -1));
5948 if(!lua_isnumber(L, -1))
5949 throw LuaError(L, "allow_metadata_inventory_move should return a number");
5950 return luaL_checkinteger(L, -1);
5953 // Return number of accepted items to be put
5954 int scriptapi_nodemeta_inventory_allow_put(lua_State *L, v3s16 p,
5955 const std::string &listname, int index, ItemStack &stack,
5956 ServerActiveObject *player)
5959 assert(lua_checkstack(L, 20));
5960 StackUnroller stack_unroller(L);
5962 INodeDefManager *ndef = get_server(L)->ndef();
5964 // If node doesn't exist, we don't know what callback to call
5965 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
5966 if(node.getContent() == CONTENT_IGNORE)
5969 // Push callback function on stack
5970 if(!get_item_callback(L, ndef->get(node).name.c_str(),
5971 "allow_metadata_inventory_put"))
5974 // Call function(pos, listname, index, stack, player)
5978 lua_pushstring(L, listname.c_str());
5980 lua_pushinteger(L, index + 1);
5982 LuaItemStack::create(L, stack);
5984 objectref_get_or_create(L, player);
5985 if(lua_pcall(L, 5, 1, 0))
5986 script_error(L, "error: %s", lua_tostring(L, -1));
5987 if(!lua_isnumber(L, -1))
5988 throw LuaError(L, "allow_metadata_inventory_put should return a number");
5989 return luaL_checkinteger(L, -1);
5992 // Return number of accepted items to be taken
5993 int scriptapi_nodemeta_inventory_allow_take(lua_State *L, v3s16 p,
5994 const std::string &listname, int index, ItemStack &stack,
5995 ServerActiveObject *player)
5998 assert(lua_checkstack(L, 20));
5999 StackUnroller stack_unroller(L);
6001 INodeDefManager *ndef = get_server(L)->ndef();
6003 // If node doesn't exist, we don't know what callback to call
6004 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6005 if(node.getContent() == CONTENT_IGNORE)
6008 // Push callback function on stack
6009 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6010 "allow_metadata_inventory_take"))
6013 // Call function(pos, listname, index, count, player)
6017 lua_pushstring(L, listname.c_str());
6019 lua_pushinteger(L, index + 1);
6021 LuaItemStack::create(L, stack);
6023 objectref_get_or_create(L, player);
6024 if(lua_pcall(L, 5, 1, 0))
6025 script_error(L, "error: %s", lua_tostring(L, -1));
6026 if(!lua_isnumber(L, -1))
6027 throw LuaError(L, "allow_metadata_inventory_take should return a number");
6028 return luaL_checkinteger(L, -1);
6031 // Report moved items
6032 void scriptapi_nodemeta_inventory_on_move(lua_State *L, v3s16 p,
6033 const std::string &from_list, int from_index,
6034 const std::string &to_list, int to_index,
6035 int count, ServerActiveObject *player)
6038 assert(lua_checkstack(L, 20));
6039 StackUnroller stack_unroller(L);
6041 INodeDefManager *ndef = get_server(L)->ndef();
6043 // If node doesn't exist, we don't know what callback to call
6044 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6045 if(node.getContent() == CONTENT_IGNORE)
6048 // Push callback function on stack
6049 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6050 "on_metadata_inventory_move"))
6053 // function(pos, from_list, from_index, to_list, to_index, count, player)
6057 lua_pushstring(L, from_list.c_str());
6059 lua_pushinteger(L, from_index + 1);
6061 lua_pushstring(L, to_list.c_str());
6063 lua_pushinteger(L, to_index + 1);
6065 lua_pushinteger(L, count);
6067 objectref_get_or_create(L, player);
6068 if(lua_pcall(L, 7, 0, 0))
6069 script_error(L, "error: %s", lua_tostring(L, -1));
6073 void scriptapi_nodemeta_inventory_on_put(lua_State *L, v3s16 p,
6074 const std::string &listname, int index, ItemStack &stack,
6075 ServerActiveObject *player)
6078 assert(lua_checkstack(L, 20));
6079 StackUnroller stack_unroller(L);
6081 INodeDefManager *ndef = get_server(L)->ndef();
6083 // If node doesn't exist, we don't know what callback to call
6084 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6085 if(node.getContent() == CONTENT_IGNORE)
6088 // Push callback function on stack
6089 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6090 "on_metadata_inventory_put"))
6093 // Call function(pos, listname, index, stack, player)
6097 lua_pushstring(L, listname.c_str());
6099 lua_pushinteger(L, index + 1);
6101 LuaItemStack::create(L, stack);
6103 objectref_get_or_create(L, player);
6104 if(lua_pcall(L, 5, 0, 0))
6105 script_error(L, "error: %s", lua_tostring(L, -1));
6108 // Report taken items
6109 void scriptapi_nodemeta_inventory_on_take(lua_State *L, v3s16 p,
6110 const std::string &listname, int index, ItemStack &stack,
6111 ServerActiveObject *player)
6114 assert(lua_checkstack(L, 20));
6115 StackUnroller stack_unroller(L);
6117 INodeDefManager *ndef = get_server(L)->ndef();
6119 // If node doesn't exist, we don't know what callback to call
6120 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6121 if(node.getContent() == CONTENT_IGNORE)
6124 // Push callback function on stack
6125 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6126 "on_metadata_inventory_take"))
6129 // Call function(pos, listname, index, stack, player)
6133 lua_pushstring(L, listname.c_str());
6135 lua_pushinteger(L, index + 1);
6137 LuaItemStack::create(L, stack);
6139 objectref_get_or_create(L, player);
6140 if(lua_pcall(L, 5, 0, 0))
6141 script_error(L, "error: %s", lua_tostring(L, -1));
6145 Detached inventory callbacks
6148 // Retrieves minetest.detached_inventories[name][callbackname]
6149 // If that is nil or on error, return false and stack is unchanged
6150 // If that is a function, returns true and pushes the
6151 // function onto the stack
6152 static bool get_detached_inventory_callback(lua_State *L,
6153 const std::string &name, const char *callbackname)
6155 lua_getglobal(L, "minetest");
6156 lua_getfield(L, -1, "detached_inventories");
6158 luaL_checktype(L, -1, LUA_TTABLE);
6159 lua_getfield(L, -1, name.c_str());
6161 // Should be a table
6162 if(lua_type(L, -1) != LUA_TTABLE)
6164 errorstream<<"Item \""<<name<<"\" not defined"<<std::endl;
6168 lua_getfield(L, -1, callbackname);
6170 // Should be a function or nil
6171 if(lua_type(L, -1) == LUA_TFUNCTION)
6175 else if(lua_isnil(L, -1))
6182 errorstream<<"Detached inventory \""<<name<<"\" callback \""
6183 <<callbackname<<"\" is not a function"<<std::endl;
6189 // Return number of accepted items to be moved
6190 int scriptapi_detached_inventory_allow_move(lua_State *L,
6191 const std::string &name,
6192 const std::string &from_list, int from_index,
6193 const std::string &to_list, int to_index,
6194 int count, ServerActiveObject *player)
6197 assert(lua_checkstack(L, 20));
6198 StackUnroller stack_unroller(L);
6200 // Push callback function on stack
6201 if(!get_detached_inventory_callback(L, name, "allow_move"))
6204 // function(inv, from_list, from_index, to_list, to_index, count, player)
6206 InventoryLocation loc;
6207 loc.setDetached(name);
6208 InvRef::create(L, loc);
6210 lua_pushstring(L, from_list.c_str());
6212 lua_pushinteger(L, from_index + 1);
6214 lua_pushstring(L, to_list.c_str());
6216 lua_pushinteger(L, to_index + 1);
6218 lua_pushinteger(L, count);
6220 objectref_get_or_create(L, player);
6221 if(lua_pcall(L, 7, 1, 0))
6222 script_error(L, "error: %s", lua_tostring(L, -1));
6223 if(!lua_isnumber(L, -1))
6224 throw LuaError(L, "allow_move should return a number");
6225 return luaL_checkinteger(L, -1);
6228 // Return number of accepted items to be put
6229 int scriptapi_detached_inventory_allow_put(lua_State *L,
6230 const std::string &name,
6231 const std::string &listname, int index, ItemStack &stack,
6232 ServerActiveObject *player)
6235 assert(lua_checkstack(L, 20));
6236 StackUnroller stack_unroller(L);
6238 // Push callback function on stack
6239 if(!get_detached_inventory_callback(L, name, "allow_put"))
6240 return stack.count; // All will be accepted
6242 // Call function(inv, listname, index, stack, player)
6244 InventoryLocation loc;
6245 loc.setDetached(name);
6246 InvRef::create(L, loc);
6248 lua_pushstring(L, listname.c_str());
6250 lua_pushinteger(L, index + 1);
6252 LuaItemStack::create(L, stack);
6254 objectref_get_or_create(L, player);
6255 if(lua_pcall(L, 5, 1, 0))
6256 script_error(L, "error: %s", lua_tostring(L, -1));
6257 if(!lua_isnumber(L, -1))
6258 throw LuaError(L, "allow_put should return a number");
6259 return luaL_checkinteger(L, -1);
6262 // Return number of accepted items to be taken
6263 int scriptapi_detached_inventory_allow_take(lua_State *L,
6264 const std::string &name,
6265 const std::string &listname, int index, ItemStack &stack,
6266 ServerActiveObject *player)
6269 assert(lua_checkstack(L, 20));
6270 StackUnroller stack_unroller(L);
6272 // Push callback function on stack
6273 if(!get_detached_inventory_callback(L, name, "allow_take"))
6274 return stack.count; // All will be accepted
6276 // Call function(inv, listname, index, stack, player)
6278 InventoryLocation loc;
6279 loc.setDetached(name);
6280 InvRef::create(L, loc);
6282 lua_pushstring(L, listname.c_str());
6284 lua_pushinteger(L, index + 1);
6286 LuaItemStack::create(L, stack);
6288 objectref_get_or_create(L, player);
6289 if(lua_pcall(L, 5, 1, 0))
6290 script_error(L, "error: %s", lua_tostring(L, -1));
6291 if(!lua_isnumber(L, -1))
6292 throw LuaError(L, "allow_take should return a number");
6293 return luaL_checkinteger(L, -1);
6296 // Report moved items
6297 void scriptapi_detached_inventory_on_move(lua_State *L,
6298 const std::string &name,
6299 const std::string &from_list, int from_index,
6300 const std::string &to_list, int to_index,
6301 int count, ServerActiveObject *player)
6304 assert(lua_checkstack(L, 20));
6305 StackUnroller stack_unroller(L);
6307 // Push callback function on stack
6308 if(!get_detached_inventory_callback(L, name, "on_move"))
6311 // function(inv, from_list, from_index, to_list, to_index, count, player)
6313 InventoryLocation loc;
6314 loc.setDetached(name);
6315 InvRef::create(L, loc);
6317 lua_pushstring(L, from_list.c_str());
6319 lua_pushinteger(L, from_index + 1);
6321 lua_pushstring(L, to_list.c_str());
6323 lua_pushinteger(L, to_index + 1);
6325 lua_pushinteger(L, count);
6327 objectref_get_or_create(L, player);
6328 if(lua_pcall(L, 7, 0, 0))
6329 script_error(L, "error: %s", lua_tostring(L, -1));
6333 void scriptapi_detached_inventory_on_put(lua_State *L,
6334 const std::string &name,
6335 const std::string &listname, int index, ItemStack &stack,
6336 ServerActiveObject *player)
6339 assert(lua_checkstack(L, 20));
6340 StackUnroller stack_unroller(L);
6342 // Push callback function on stack
6343 if(!get_detached_inventory_callback(L, name, "on_put"))
6346 // Call function(inv, listname, index, stack, player)
6348 InventoryLocation loc;
6349 loc.setDetached(name);
6350 InvRef::create(L, loc);
6352 lua_pushstring(L, listname.c_str());
6354 lua_pushinteger(L, index + 1);
6356 LuaItemStack::create(L, stack);
6358 objectref_get_or_create(L, player);
6359 if(lua_pcall(L, 5, 0, 0))
6360 script_error(L, "error: %s", lua_tostring(L, -1));
6363 // Report taken items
6364 void scriptapi_detached_inventory_on_take(lua_State *L,
6365 const std::string &name,
6366 const std::string &listname, int index, ItemStack &stack,
6367 ServerActiveObject *player)
6370 assert(lua_checkstack(L, 20));
6371 StackUnroller stack_unroller(L);
6373 // Push callback function on stack
6374 if(!get_detached_inventory_callback(L, name, "on_take"))
6377 // Call function(inv, listname, index, stack, player)
6379 InventoryLocation loc;
6380 loc.setDetached(name);
6381 InvRef::create(L, loc);
6383 lua_pushstring(L, listname.c_str());
6385 lua_pushinteger(L, index + 1);
6387 LuaItemStack::create(L, stack);
6389 objectref_get_or_create(L, player);
6390 if(lua_pcall(L, 5, 0, 0))
6391 script_error(L, "error: %s", lua_tostring(L, -1));
6398 void scriptapi_environment_step(lua_State *L, float dtime)
6401 assert(lua_checkstack(L, 20));
6402 //infostream<<"scriptapi_environment_step"<<std::endl;
6403 StackUnroller stack_unroller(L);
6405 // Get minetest.registered_globalsteps
6406 lua_getglobal(L, "minetest");
6407 lua_getfield(L, -1, "registered_globalsteps");
6409 lua_pushnumber(L, dtime);
6410 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
6413 void scriptapi_environment_on_generated(lua_State *L, v3s16 minp, v3s16 maxp,
6417 assert(lua_checkstack(L, 20));
6418 //infostream<<"scriptapi_environment_on_generated"<<std::endl;
6419 StackUnroller stack_unroller(L);
6421 // Get minetest.registered_on_generateds
6422 lua_getglobal(L, "minetest");
6423 lua_getfield(L, -1, "registered_on_generateds");
6425 push_v3s16(L, minp);
6426 push_v3s16(L, maxp);
6427 lua_pushnumber(L, blockseed);
6428 scriptapi_run_callbacks(L, 3, RUN_CALLBACKS_MODE_FIRST);
6435 bool scriptapi_luaentity_add(lua_State *L, u16 id, const char *name)
6438 assert(lua_checkstack(L, 20));
6439 verbosestream<<"scriptapi_luaentity_add: id="<<id<<" name=\""
6440 <<name<<"\""<<std::endl;
6441 StackUnroller stack_unroller(L);
6443 // Get minetest.registered_entities[name]
6444 lua_getglobal(L, "minetest");
6445 lua_getfield(L, -1, "registered_entities");
6446 luaL_checktype(L, -1, LUA_TTABLE);
6447 lua_pushstring(L, name);
6448 lua_gettable(L, -2);
6449 // Should be a table, which we will use as a prototype
6450 //luaL_checktype(L, -1, LUA_TTABLE);
6451 if(lua_type(L, -1) != LUA_TTABLE){
6452 errorstream<<"LuaEntity name \""<<name<<"\" not defined"<<std::endl;
6455 int prototype_table = lua_gettop(L);
6456 //dump2(L, "prototype_table");
6458 // Create entity object
6460 int object = lua_gettop(L);
6462 // Set object metatable
6463 lua_pushvalue(L, prototype_table);
6464 lua_setmetatable(L, -2);
6466 // Add object reference
6467 // This should be userdata with metatable ObjectRef
6468 objectref_get(L, id);
6469 luaL_checktype(L, -1, LUA_TUSERDATA);
6470 if(!luaL_checkudata(L, -1, "ObjectRef"))
6471 luaL_typerror(L, -1, "ObjectRef");
6472 lua_setfield(L, -2, "object");
6474 // minetest.luaentities[id] = object
6475 lua_getglobal(L, "minetest");
6476 lua_getfield(L, -1, "luaentities");
6477 luaL_checktype(L, -1, LUA_TTABLE);
6478 lua_pushnumber(L, id); // Push id
6479 lua_pushvalue(L, object); // Copy object to top of stack
6480 lua_settable(L, -3);
6485 void scriptapi_luaentity_activate(lua_State *L, u16 id,
6486 const std::string &staticdata, u32 dtime_s)
6489 assert(lua_checkstack(L, 20));
6490 verbosestream<<"scriptapi_luaentity_activate: id="<<id<<std::endl;
6491 StackUnroller stack_unroller(L);
6493 // Get minetest.luaentities[id]
6494 luaentity_get(L, id);
6495 int object = lua_gettop(L);
6497 // Get on_activate function
6498 lua_pushvalue(L, object);
6499 lua_getfield(L, -1, "on_activate");
6500 if(!lua_isnil(L, -1)){
6501 luaL_checktype(L, -1, LUA_TFUNCTION);
6502 lua_pushvalue(L, object); // self
6503 lua_pushlstring(L, staticdata.c_str(), staticdata.size());
6504 lua_pushinteger(L, dtime_s);
6505 // Call with 3 arguments, 0 results
6506 if(lua_pcall(L, 3, 0, 0))
6507 script_error(L, "error running function on_activate: %s\n",
6508 lua_tostring(L, -1));
6512 void scriptapi_luaentity_rm(lua_State *L, u16 id)
6515 assert(lua_checkstack(L, 20));
6516 verbosestream<<"scriptapi_luaentity_rm: id="<<id<<std::endl;
6518 // Get minetest.luaentities table
6519 lua_getglobal(L, "minetest");
6520 lua_getfield(L, -1, "luaentities");
6521 luaL_checktype(L, -1, LUA_TTABLE);
6522 int objectstable = lua_gettop(L);
6524 // Set luaentities[id] = nil
6525 lua_pushnumber(L, id); // Push id
6527 lua_settable(L, objectstable);
6529 lua_pop(L, 2); // pop luaentities, minetest
6532 std::string scriptapi_luaentity_get_staticdata(lua_State *L, u16 id)
6535 assert(lua_checkstack(L, 20));
6536 //infostream<<"scriptapi_luaentity_get_staticdata: id="<<id<<std::endl;
6537 StackUnroller stack_unroller(L);
6539 // Get minetest.luaentities[id]
6540 luaentity_get(L, id);
6541 int object = lua_gettop(L);
6543 // Get get_staticdata function
6544 lua_pushvalue(L, object);
6545 lua_getfield(L, -1, "get_staticdata");
6546 if(lua_isnil(L, -1))
6549 luaL_checktype(L, -1, LUA_TFUNCTION);
6550 lua_pushvalue(L, object); // self
6551 // Call with 1 arguments, 1 results
6552 if(lua_pcall(L, 1, 1, 0))
6553 script_error(L, "error running function get_staticdata: %s\n",
6554 lua_tostring(L, -1));
6557 const char *s = lua_tolstring(L, -1, &len);
6558 return std::string(s, len);
6561 void scriptapi_luaentity_get_properties(lua_State *L, u16 id,
6562 ObjectProperties *prop)
6565 assert(lua_checkstack(L, 20));
6566 //infostream<<"scriptapi_luaentity_get_properties: id="<<id<<std::endl;
6567 StackUnroller stack_unroller(L);
6569 // Get minetest.luaentities[id]
6570 luaentity_get(L, id);
6571 //int object = lua_gettop(L);
6573 // Set default values that differ from ObjectProperties defaults
6578 prop->hp_max = getintfield_default(L, -1, "hp_max", 10);
6580 getboolfield(L, -1, "physical", prop->physical);
6582 getfloatfield(L, -1, "weight", prop->weight);
6584 lua_getfield(L, -1, "collisionbox");
6585 if(lua_istable(L, -1))
6586 prop->collisionbox = read_aabb3f(L, -1, 1.0);
6589 getstringfield(L, -1, "visual", prop->visual);
6591 // Deprecated: read object properties directly
6592 read_object_properties(L, -1, prop);
6594 // Read initial_properties
6595 lua_getfield(L, -1, "initial_properties");
6596 read_object_properties(L, -1, prop);
6600 void scriptapi_luaentity_step(lua_State *L, u16 id, float dtime)
6603 assert(lua_checkstack(L, 20));
6604 //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
6605 StackUnroller stack_unroller(L);
6607 // Get minetest.luaentities[id]
6608 luaentity_get(L, id);
6609 int object = lua_gettop(L);
6610 // State: object is at top of stack
6611 // Get step function
6612 lua_getfield(L, -1, "on_step");
6613 if(lua_isnil(L, -1))
6615 luaL_checktype(L, -1, LUA_TFUNCTION);
6616 lua_pushvalue(L, object); // self
6617 lua_pushnumber(L, dtime); // dtime
6618 // Call with 2 arguments, 0 results
6619 if(lua_pcall(L, 2, 0, 0))
6620 script_error(L, "error running function 'on_step': %s\n", lua_tostring(L, -1));
6623 // Calls entity:on_punch(ObjectRef puncher, time_from_last_punch,
6624 // tool_capabilities, direction)
6625 void scriptapi_luaentity_punch(lua_State *L, u16 id,
6626 ServerActiveObject *puncher, float time_from_last_punch,
6627 const ToolCapabilities *toolcap, v3f dir)
6630 assert(lua_checkstack(L, 20));
6631 //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
6632 StackUnroller stack_unroller(L);
6634 // Get minetest.luaentities[id]
6635 luaentity_get(L, id);
6636 int object = lua_gettop(L);
6637 // State: object is at top of stack
6639 lua_getfield(L, -1, "on_punch");
6640 if(lua_isnil(L, -1))
6642 luaL_checktype(L, -1, LUA_TFUNCTION);
6643 lua_pushvalue(L, object); // self
6644 objectref_get_or_create(L, puncher); // Clicker reference
6645 lua_pushnumber(L, time_from_last_punch);
6646 push_tool_capabilities(L, *toolcap);
6648 // Call with 5 arguments, 0 results
6649 if(lua_pcall(L, 5, 0, 0))
6650 script_error(L, "error running function 'on_punch': %s\n", lua_tostring(L, -1));
6653 // Calls entity:on_rightclick(ObjectRef clicker)
6654 void scriptapi_luaentity_rightclick(lua_State *L, u16 id,
6655 ServerActiveObject *clicker)
6658 assert(lua_checkstack(L, 20));
6659 //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
6660 StackUnroller stack_unroller(L);
6662 // Get minetest.luaentities[id]
6663 luaentity_get(L, id);
6664 int object = lua_gettop(L);
6665 // State: object is at top of stack
6667 lua_getfield(L, -1, "on_rightclick");
6668 if(lua_isnil(L, -1))
6670 luaL_checktype(L, -1, LUA_TFUNCTION);
6671 lua_pushvalue(L, object); // self
6672 objectref_get_or_create(L, clicker); // Clicker reference
6673 // Call with 2 arguments, 0 results
6674 if(lua_pcall(L, 2, 0, 0))
6675 script_error(L, "error running function 'on_rightclick': %s\n", lua_tostring(L, -1));