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, tool_capabilities, direction, time_from_last_punch)
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;
2554 ToolCapabilities toolcap = read_tool_capabilities(L, 3);
2555 v3f dir = read_v3f(L, 4);
2556 float time_from_last_punch = 1000000;
2557 if(lua_isnumber(L, 5))
2558 time_from_last_punch = lua_tonumber(L, 5);
2560 puncher->punch(dir, &toolcap, puncher, time_from_last_punch);
2564 // right_click(self, clicker); clicker = an another ObjectRef
2565 static int l_right_click(lua_State *L)
2567 ObjectRef *ref = checkobject(L, 1);
2568 ObjectRef *ref2 = checkobject(L, 2);
2569 ServerActiveObject *co = getobject(ref);
2570 ServerActiveObject *co2 = getobject(ref2);
2571 if(co == NULL) return 0;
2572 if(co2 == NULL) return 0;
2574 co->rightClick(co2);
2579 // hp = number of hitpoints (2 * number of hearts)
2581 static int l_set_hp(lua_State *L)
2583 ObjectRef *ref = checkobject(L, 1);
2584 luaL_checknumber(L, 2);
2585 ServerActiveObject *co = getobject(ref);
2586 if(co == NULL) return 0;
2587 int hp = lua_tonumber(L, 2);
2588 /*infostream<<"ObjectRef::l_set_hp(): id="<<co->getId()
2589 <<" hp="<<hp<<std::endl;*/
2597 // returns: number of hitpoints (2 * number of hearts)
2598 // 0 if not applicable to this type of object
2599 static int l_get_hp(lua_State *L)
2601 ObjectRef *ref = checkobject(L, 1);
2602 ServerActiveObject *co = getobject(ref);
2605 lua_pushnumber(L, 1);
2608 int hp = co->getHP();
2609 /*infostream<<"ObjectRef::l_get_hp(): id="<<co->getId()
2610 <<" hp="<<hp<<std::endl;*/
2612 lua_pushnumber(L, hp);
2616 // get_inventory(self)
2617 static int l_get_inventory(lua_State *L)
2619 ObjectRef *ref = checkobject(L, 1);
2620 ServerActiveObject *co = getobject(ref);
2621 if(co == NULL) return 0;
2623 InventoryLocation loc = co->getInventoryLocation();
2624 if(get_server(L)->getInventory(loc) != NULL)
2625 InvRef::create(L, loc);
2627 lua_pushnil(L); // An object may have no inventory (nil)
2631 // get_wield_list(self)
2632 static int l_get_wield_list(lua_State *L)
2634 ObjectRef *ref = checkobject(L, 1);
2635 ServerActiveObject *co = getobject(ref);
2636 if(co == NULL) return 0;
2638 lua_pushstring(L, co->getWieldList().c_str());
2642 // get_wield_index(self)
2643 static int l_get_wield_index(lua_State *L)
2645 ObjectRef *ref = checkobject(L, 1);
2646 ServerActiveObject *co = getobject(ref);
2647 if(co == NULL) return 0;
2649 lua_pushinteger(L, co->getWieldIndex() + 1);
2653 // get_wielded_item(self)
2654 static int l_get_wielded_item(lua_State *L)
2656 ObjectRef *ref = checkobject(L, 1);
2657 ServerActiveObject *co = getobject(ref);
2660 LuaItemStack::create(L, ItemStack());
2664 LuaItemStack::create(L, co->getWieldedItem());
2668 // set_wielded_item(self, itemstack or itemstring or table or nil)
2669 static int l_set_wielded_item(lua_State *L)
2671 ObjectRef *ref = checkobject(L, 1);
2672 ServerActiveObject *co = getobject(ref);
2673 if(co == NULL) return 0;
2675 ItemStack item = read_item(L, 2);
2676 bool success = co->setWieldedItem(item);
2677 lua_pushboolean(L, success);
2681 // set_armor_groups(self, groups)
2682 static int l_set_armor_groups(lua_State *L)
2684 ObjectRef *ref = checkobject(L, 1);
2685 ServerActiveObject *co = getobject(ref);
2686 if(co == NULL) return 0;
2688 ItemGroupList groups;
2689 read_groups(L, 2, groups);
2690 co->setArmorGroups(groups);
2694 // set_properties(self, properties)
2695 static int l_set_properties(lua_State *L)
2697 ObjectRef *ref = checkobject(L, 1);
2698 ServerActiveObject *co = getobject(ref);
2699 if(co == NULL) return 0;
2700 ObjectProperties *prop = co->accessObjectProperties();
2703 read_object_properties(L, 2, prop);
2704 co->notifyObjectPropertiesModified();
2708 /* LuaEntitySAO-only */
2710 // setvelocity(self, {x=num, y=num, z=num})
2711 static int l_setvelocity(lua_State *L)
2713 ObjectRef *ref = checkobject(L, 1);
2714 LuaEntitySAO *co = getluaobject(ref);
2715 if(co == NULL) return 0;
2716 v3f pos = checkFloatPos(L, 2);
2718 co->setVelocity(pos);
2722 // getvelocity(self)
2723 static int l_getvelocity(lua_State *L)
2725 ObjectRef *ref = checkobject(L, 1);
2726 LuaEntitySAO *co = getluaobject(ref);
2727 if(co == NULL) return 0;
2729 v3f v = co->getVelocity();
2734 // setacceleration(self, {x=num, y=num, z=num})
2735 static int l_setacceleration(lua_State *L)
2737 ObjectRef *ref = checkobject(L, 1);
2738 LuaEntitySAO *co = getluaobject(ref);
2739 if(co == NULL) return 0;
2741 v3f pos = checkFloatPos(L, 2);
2743 co->setAcceleration(pos);
2747 // getacceleration(self)
2748 static int l_getacceleration(lua_State *L)
2750 ObjectRef *ref = checkobject(L, 1);
2751 LuaEntitySAO *co = getluaobject(ref);
2752 if(co == NULL) return 0;
2754 v3f v = co->getAcceleration();
2759 // setyaw(self, radians)
2760 static int l_setyaw(lua_State *L)
2762 ObjectRef *ref = checkobject(L, 1);
2763 LuaEntitySAO *co = getluaobject(ref);
2764 if(co == NULL) return 0;
2765 float yaw = luaL_checknumber(L, 2) * core::RADTODEG;
2772 static int l_getyaw(lua_State *L)
2774 ObjectRef *ref = checkobject(L, 1);
2775 LuaEntitySAO *co = getluaobject(ref);
2776 if(co == NULL) return 0;
2778 float yaw = co->getYaw() * core::DEGTORAD;
2779 lua_pushnumber(L, yaw);
2783 // settexturemod(self, mod)
2784 static int l_settexturemod(lua_State *L)
2786 ObjectRef *ref = checkobject(L, 1);
2787 LuaEntitySAO *co = getluaobject(ref);
2788 if(co == NULL) return 0;
2790 std::string mod = luaL_checkstring(L, 2);
2791 co->setTextureMod(mod);
2795 // setsprite(self, p={x=0,y=0}, num_frames=1, framelength=0.2,
2796 // select_horiz_by_yawpitch=false)
2797 static int l_setsprite(lua_State *L)
2799 ObjectRef *ref = checkobject(L, 1);
2800 LuaEntitySAO *co = getluaobject(ref);
2801 if(co == NULL) return 0;
2804 if(!lua_isnil(L, 2))
2805 p = read_v2s16(L, 2);
2807 if(!lua_isnil(L, 3))
2808 num_frames = lua_tonumber(L, 3);
2809 float framelength = 0.2;
2810 if(!lua_isnil(L, 4))
2811 framelength = lua_tonumber(L, 4);
2812 bool select_horiz_by_yawpitch = false;
2813 if(!lua_isnil(L, 5))
2814 select_horiz_by_yawpitch = lua_toboolean(L, 5);
2815 co->setSprite(p, num_frames, framelength, select_horiz_by_yawpitch);
2820 // get_entity_name(self)
2821 static int l_get_entity_name(lua_State *L)
2823 ObjectRef *ref = checkobject(L, 1);
2824 LuaEntitySAO *co = getluaobject(ref);
2825 if(co == NULL) return 0;
2827 std::string name = co->getName();
2828 lua_pushstring(L, name.c_str());
2832 // get_luaentity(self)
2833 static int l_get_luaentity(lua_State *L)
2835 ObjectRef *ref = checkobject(L, 1);
2836 LuaEntitySAO *co = getluaobject(ref);
2837 if(co == NULL) return 0;
2839 luaentity_get(L, co->getId());
2846 static int l_is_player(lua_State *L)
2848 ObjectRef *ref = checkobject(L, 1);
2849 Player *player = getplayer(ref);
2850 lua_pushboolean(L, (player != NULL));
2854 // get_player_name(self)
2855 static int l_get_player_name(lua_State *L)
2857 ObjectRef *ref = checkobject(L, 1);
2858 Player *player = getplayer(ref);
2860 lua_pushlstring(L, "", 0);
2864 lua_pushstring(L, player->getName());
2868 // get_look_dir(self)
2869 static int l_get_look_dir(lua_State *L)
2871 ObjectRef *ref = checkobject(L, 1);
2872 Player *player = getplayer(ref);
2873 if(player == NULL) return 0;
2875 float pitch = player->getRadPitch();
2876 float yaw = player->getRadYaw();
2877 v3f v(cos(pitch)*cos(yaw), sin(pitch), cos(pitch)*sin(yaw));
2882 // get_look_pitch(self)
2883 static int l_get_look_pitch(lua_State *L)
2885 ObjectRef *ref = checkobject(L, 1);
2886 Player *player = getplayer(ref);
2887 if(player == NULL) return 0;
2889 lua_pushnumber(L, player->getRadPitch());
2893 // get_look_yaw(self)
2894 static int l_get_look_yaw(lua_State *L)
2896 ObjectRef *ref = checkobject(L, 1);
2897 Player *player = getplayer(ref);
2898 if(player == NULL) return 0;
2900 lua_pushnumber(L, player->getRadYaw());
2904 // set_inventory_formspec(self, formspec)
2905 static int l_set_inventory_formspec(lua_State *L)
2907 ObjectRef *ref = checkobject(L, 1);
2908 Player *player = getplayer(ref);
2909 if(player == NULL) return 0;
2910 std::string formspec = luaL_checkstring(L, 2);
2912 player->inventory_formspec = formspec;
2913 get_server(L)->reportInventoryFormspecModified(player->getName());
2914 lua_pushboolean(L, true);
2918 // get_inventory_formspec(self) -> formspec
2919 static int l_get_inventory_formspec(lua_State *L)
2921 ObjectRef *ref = checkobject(L, 1);
2922 Player *player = getplayer(ref);
2923 if(player == NULL) return 0;
2925 std::string formspec = player->inventory_formspec;
2926 lua_pushlstring(L, formspec.c_str(), formspec.size());
2931 ObjectRef(ServerActiveObject *object):
2934 //infostream<<"ObjectRef created for id="<<m_object->getId()<<std::endl;
2940 infostream<<"ObjectRef destructing for id="
2941 <<m_object->getId()<<std::endl;
2943 infostream<<"ObjectRef destructing for id=unknown"<<std::endl;*/
2946 // Creates an ObjectRef and leaves it on top of stack
2947 // Not callable from Lua; all references are created on the C side.
2948 static void create(lua_State *L, ServerActiveObject *object)
2950 ObjectRef *o = new ObjectRef(object);
2951 //infostream<<"ObjectRef::create: o="<<o<<std::endl;
2952 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
2953 luaL_getmetatable(L, className);
2954 lua_setmetatable(L, -2);
2957 static void set_null(lua_State *L)
2959 ObjectRef *o = checkobject(L, -1);
2963 static void Register(lua_State *L)
2966 int methodtable = lua_gettop(L);
2967 luaL_newmetatable(L, className);
2968 int metatable = lua_gettop(L);
2970 lua_pushliteral(L, "__metatable");
2971 lua_pushvalue(L, methodtable);
2972 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
2974 lua_pushliteral(L, "__index");
2975 lua_pushvalue(L, methodtable);
2976 lua_settable(L, metatable);
2978 lua_pushliteral(L, "__gc");
2979 lua_pushcfunction(L, gc_object);
2980 lua_settable(L, metatable);
2982 lua_pop(L, 1); // drop metatable
2984 luaL_openlib(L, 0, methods, 0); // fill methodtable
2985 lua_pop(L, 1); // drop methodtable
2987 // Cannot be created from Lua
2988 //lua_register(L, className, create_object);
2991 const char ObjectRef::className[] = "ObjectRef";
2992 const luaL_reg ObjectRef::methods[] = {
2993 // ServerActiveObject
2994 method(ObjectRef, remove),
2995 method(ObjectRef, getpos),
2996 method(ObjectRef, setpos),
2997 method(ObjectRef, moveto),
2998 method(ObjectRef, punch),
2999 method(ObjectRef, right_click),
3000 method(ObjectRef, set_hp),
3001 method(ObjectRef, get_hp),
3002 method(ObjectRef, get_inventory),
3003 method(ObjectRef, get_wield_list),
3004 method(ObjectRef, get_wield_index),
3005 method(ObjectRef, get_wielded_item),
3006 method(ObjectRef, set_wielded_item),
3007 method(ObjectRef, set_armor_groups),
3008 method(ObjectRef, set_properties),
3009 // LuaEntitySAO-only
3010 method(ObjectRef, setvelocity),
3011 method(ObjectRef, getvelocity),
3012 method(ObjectRef, setacceleration),
3013 method(ObjectRef, getacceleration),
3014 method(ObjectRef, setyaw),
3015 method(ObjectRef, getyaw),
3016 method(ObjectRef, settexturemod),
3017 method(ObjectRef, setsprite),
3018 method(ObjectRef, get_entity_name),
3019 method(ObjectRef, get_luaentity),
3021 method(ObjectRef, is_player),
3022 method(ObjectRef, get_player_name),
3023 method(ObjectRef, get_look_dir),
3024 method(ObjectRef, get_look_pitch),
3025 method(ObjectRef, get_look_yaw),
3026 method(ObjectRef, set_inventory_formspec),
3027 method(ObjectRef, get_inventory_formspec),
3031 // Creates a new anonymous reference if cobj=NULL or id=0
3032 static void objectref_get_or_create(lua_State *L,
3033 ServerActiveObject *cobj)
3035 if(cobj == NULL || cobj->getId() == 0){
3036 ObjectRef::create(L, cobj);
3038 objectref_get(L, cobj->getId());
3047 class LuaPerlinNoise
3054 static const char className[];
3055 static const luaL_reg methods[];
3057 // Exported functions
3059 // garbage collector
3060 static int gc_object(lua_State *L)
3062 LuaPerlinNoise *o = *(LuaPerlinNoise **)(lua_touserdata(L, 1));
3067 static int l_get2d(lua_State *L)
3069 LuaPerlinNoise *o = checkobject(L, 1);
3070 v2f pos2d = read_v2f(L,2);
3071 lua_Number val = noise2d_perlin(pos2d.X/o->scale, pos2d.Y/o->scale, o->seed, o->octaves, o->persistence);
3072 lua_pushnumber(L, val);
3075 static int l_get3d(lua_State *L)
3077 LuaPerlinNoise *o = checkobject(L, 1);
3078 v3f pos3d = read_v3f(L,2);
3079 lua_Number val = noise3d_perlin(pos3d.X/o->scale, pos3d.Y/o->scale, pos3d.Z/o->scale, o->seed, o->octaves, o->persistence);
3080 lua_pushnumber(L, val);
3085 LuaPerlinNoise(int a_seed, int a_octaves, double a_persistence,
3089 persistence(a_persistence),
3098 // LuaPerlinNoise(seed, octaves, persistence, scale)
3099 // Creates an LuaPerlinNoise and leaves it on top of stack
3100 static int create_object(lua_State *L)
3102 int seed = luaL_checkint(L, 1);
3103 int octaves = luaL_checkint(L, 2);
3104 double persistence = luaL_checknumber(L, 3);
3105 double scale = luaL_checknumber(L, 4);
3106 LuaPerlinNoise *o = new LuaPerlinNoise(seed, octaves, persistence, scale);
3107 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
3108 luaL_getmetatable(L, className);
3109 lua_setmetatable(L, -2);
3113 static LuaPerlinNoise* checkobject(lua_State *L, int narg)
3115 luaL_checktype(L, narg, LUA_TUSERDATA);
3116 void *ud = luaL_checkudata(L, narg, className);
3117 if(!ud) luaL_typerror(L, narg, className);
3118 return *(LuaPerlinNoise**)ud; // unbox pointer
3121 static void Register(lua_State *L)
3124 int methodtable = lua_gettop(L);
3125 luaL_newmetatable(L, className);
3126 int metatable = lua_gettop(L);
3128 lua_pushliteral(L, "__metatable");
3129 lua_pushvalue(L, methodtable);
3130 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
3132 lua_pushliteral(L, "__index");
3133 lua_pushvalue(L, methodtable);
3134 lua_settable(L, metatable);
3136 lua_pushliteral(L, "__gc");
3137 lua_pushcfunction(L, gc_object);
3138 lua_settable(L, metatable);
3140 lua_pop(L, 1); // drop metatable
3142 luaL_openlib(L, 0, methods, 0); // fill methodtable
3143 lua_pop(L, 1); // drop methodtable
3145 // Can be created from Lua (PerlinNoise(seed, octaves, persistence)
3146 lua_register(L, className, create_object);
3149 const char LuaPerlinNoise::className[] = "PerlinNoise";
3150 const luaL_reg LuaPerlinNoise::methods[] = {
3151 method(LuaPerlinNoise, get2d),
3152 method(LuaPerlinNoise, get3d),
3164 ServerEnvironment *m_env;
3166 static const char className[];
3167 static const luaL_reg methods[];
3169 static int gc_object(lua_State *L) {
3170 NodeTimerRef *o = *(NodeTimerRef **)(lua_touserdata(L, 1));
3175 static NodeTimerRef *checkobject(lua_State *L, int narg)
3177 luaL_checktype(L, narg, LUA_TUSERDATA);
3178 void *ud = luaL_checkudata(L, narg, className);
3179 if(!ud) luaL_typerror(L, narg, className);
3180 return *(NodeTimerRef**)ud; // unbox pointer
3183 static int l_set(lua_State *L)
3185 NodeTimerRef *o = checkobject(L, 1);
3186 ServerEnvironment *env = o->m_env;
3187 if(env == NULL) return 0;
3188 f32 t = luaL_checknumber(L,2);
3189 f32 e = luaL_checknumber(L,3);
3190 env->getMap().setNodeTimer(o->m_p,NodeTimer(t,e));
3194 static int l_start(lua_State *L)
3196 NodeTimerRef *o = checkobject(L, 1);
3197 ServerEnvironment *env = o->m_env;
3198 if(env == NULL) return 0;
3199 f32 t = luaL_checknumber(L,2);
3200 env->getMap().setNodeTimer(o->m_p,NodeTimer(t,0));
3204 static int l_stop(lua_State *L)
3206 NodeTimerRef *o = checkobject(L, 1);
3207 ServerEnvironment *env = o->m_env;
3208 if(env == NULL) return 0;
3209 env->getMap().removeNodeTimer(o->m_p);
3213 static int l_is_started(lua_State *L)
3215 NodeTimerRef *o = checkobject(L, 1);
3216 ServerEnvironment *env = o->m_env;
3217 if(env == NULL) return 0;
3219 NodeTimer t = env->getMap().getNodeTimer(o->m_p);
3220 lua_pushboolean(L,(t.timeout != 0));
3224 static int l_get_timeout(lua_State *L)
3226 NodeTimerRef *o = checkobject(L, 1);
3227 ServerEnvironment *env = o->m_env;
3228 if(env == NULL) return 0;
3230 NodeTimer t = env->getMap().getNodeTimer(o->m_p);
3231 lua_pushnumber(L,t.timeout);
3235 static int l_get_elapsed(lua_State *L)
3237 NodeTimerRef *o = checkobject(L, 1);
3238 ServerEnvironment *env = o->m_env;
3239 if(env == NULL) return 0;
3241 NodeTimer t = env->getMap().getNodeTimer(o->m_p);
3242 lua_pushnumber(L,t.elapsed);
3247 NodeTimerRef(v3s16 p, ServerEnvironment *env):
3257 // Creates an NodeTimerRef and leaves it on top of stack
3258 // Not callable from Lua; all references are created on the C side.
3259 static void create(lua_State *L, v3s16 p, ServerEnvironment *env)
3261 NodeTimerRef *o = new NodeTimerRef(p, env);
3262 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
3263 luaL_getmetatable(L, className);
3264 lua_setmetatable(L, -2);
3267 static void set_null(lua_State *L)
3269 NodeTimerRef *o = checkobject(L, -1);
3273 static void Register(lua_State *L)
3276 int methodtable = lua_gettop(L);
3277 luaL_newmetatable(L, className);
3278 int metatable = lua_gettop(L);
3280 lua_pushliteral(L, "__metatable");
3281 lua_pushvalue(L, methodtable);
3282 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
3284 lua_pushliteral(L, "__index");
3285 lua_pushvalue(L, methodtable);
3286 lua_settable(L, metatable);
3288 lua_pushliteral(L, "__gc");
3289 lua_pushcfunction(L, gc_object);
3290 lua_settable(L, metatable);
3292 lua_pop(L, 1); // drop metatable
3294 luaL_openlib(L, 0, methods, 0); // fill methodtable
3295 lua_pop(L, 1); // drop methodtable
3297 // Cannot be created from Lua
3298 //lua_register(L, className, create_object);
3301 const char NodeTimerRef::className[] = "NodeTimerRef";
3302 const luaL_reg NodeTimerRef::methods[] = {
3303 method(NodeTimerRef, start),
3304 method(NodeTimerRef, set),
3305 method(NodeTimerRef, stop),
3306 method(NodeTimerRef, is_started),
3307 method(NodeTimerRef, get_timeout),
3308 method(NodeTimerRef, get_elapsed),
3319 ServerEnvironment *m_env;
3321 static const char className[];
3322 static const luaL_reg methods[];
3324 static int gc_object(lua_State *L) {
3325 EnvRef *o = *(EnvRef **)(lua_touserdata(L, 1));
3330 static EnvRef *checkobject(lua_State *L, int narg)
3332 luaL_checktype(L, narg, LUA_TUSERDATA);
3333 void *ud = luaL_checkudata(L, narg, className);
3334 if(!ud) luaL_typerror(L, narg, className);
3335 return *(EnvRef**)ud; // unbox pointer
3338 // Exported functions
3340 // EnvRef:set_node(pos, node)
3341 // pos = {x=num, y=num, z=num}
3342 static int l_set_node(lua_State *L)
3344 EnvRef *o = checkobject(L, 1);
3345 ServerEnvironment *env = o->m_env;
3346 if(env == NULL) return 0;
3347 INodeDefManager *ndef = env->getGameDef()->ndef();
3349 v3s16 pos = read_v3s16(L, 2);
3350 MapNode n = readnode(L, 3, ndef);
3352 MapNode n_old = env->getMap().getNodeNoEx(pos);
3354 if(ndef->get(n_old).has_on_destruct)
3355 scriptapi_node_on_destruct(L, pos, n_old);
3357 bool succeeded = env->getMap().addNodeWithEvent(pos, n);
3359 // Call post-destructor
3360 if(ndef->get(n_old).has_after_destruct)
3361 scriptapi_node_after_destruct(L, pos, n_old);
3363 if(ndef->get(n).has_on_construct)
3364 scriptapi_node_on_construct(L, pos, n);
3366 lua_pushboolean(L, succeeded);
3370 static int l_add_node(lua_State *L)
3372 return l_set_node(L);
3375 // EnvRef:remove_node(pos)
3376 // pos = {x=num, y=num, z=num}
3377 static int l_remove_node(lua_State *L)
3379 EnvRef *o = checkobject(L, 1);
3380 ServerEnvironment *env = o->m_env;
3381 if(env == NULL) return 0;
3382 INodeDefManager *ndef = env->getGameDef()->ndef();
3384 v3s16 pos = read_v3s16(L, 2);
3386 MapNode n_old = env->getMap().getNodeNoEx(pos);
3388 if(ndef->get(n_old).has_on_destruct)
3389 scriptapi_node_on_destruct(L, pos, n_old);
3391 // This is slightly optimized compared to addNodeWithEvent(air)
3392 bool succeeded = env->getMap().removeNodeWithEvent(pos);
3394 // Call post-destructor
3395 if(ndef->get(n_old).has_after_destruct)
3396 scriptapi_node_after_destruct(L, pos, n_old);
3398 lua_pushboolean(L, succeeded);
3399 // Air doesn't require constructor
3403 // EnvRef:get_node(pos)
3404 // pos = {x=num, y=num, z=num}
3405 static int l_get_node(lua_State *L)
3407 EnvRef *o = checkobject(L, 1);
3408 ServerEnvironment *env = o->m_env;
3409 if(env == NULL) return 0;
3411 v3s16 pos = read_v3s16(L, 2);
3413 MapNode n = env->getMap().getNodeNoEx(pos);
3415 pushnode(L, n, env->getGameDef()->ndef());
3419 // EnvRef:get_node_or_nil(pos)
3420 // pos = {x=num, y=num, z=num}
3421 static int l_get_node_or_nil(lua_State *L)
3423 EnvRef *o = checkobject(L, 1);
3424 ServerEnvironment *env = o->m_env;
3425 if(env == NULL) return 0;
3427 v3s16 pos = read_v3s16(L, 2);
3430 MapNode n = env->getMap().getNode(pos);
3432 pushnode(L, n, env->getGameDef()->ndef());
3434 } catch(InvalidPositionException &e)
3441 // EnvRef:get_node_light(pos, timeofday)
3442 // pos = {x=num, y=num, z=num}
3443 // timeofday: nil = current time, 0 = night, 0.5 = day
3444 static int l_get_node_light(lua_State *L)
3446 EnvRef *o = checkobject(L, 1);
3447 ServerEnvironment *env = o->m_env;
3448 if(env == NULL) return 0;
3450 v3s16 pos = read_v3s16(L, 2);
3451 u32 time_of_day = env->getTimeOfDay();
3452 if(lua_isnumber(L, 3))
3453 time_of_day = 24000.0 * lua_tonumber(L, 3);
3454 time_of_day %= 24000;
3455 u32 dnr = time_to_daynight_ratio(time_of_day);
3456 MapNode n = env->getMap().getNodeNoEx(pos);
3458 MapNode n = env->getMap().getNode(pos);
3459 INodeDefManager *ndef = env->getGameDef()->ndef();
3460 lua_pushinteger(L, n.getLightBlend(dnr, ndef));
3462 } catch(InvalidPositionException &e)
3469 // EnvRef:place_node(pos, node)
3470 // pos = {x=num, y=num, z=num}
3471 static int l_place_node(lua_State *L)
3473 EnvRef *o = checkobject(L, 1);
3474 ServerEnvironment *env = o->m_env;
3475 if(env == NULL) return 0;
3476 v3s16 pos = read_v3s16(L, 2);
3477 MapNode n = readnode(L, 3, env->getGameDef()->ndef());
3479 // Don't attempt to load non-loaded area as of now
3480 MapNode n_old = env->getMap().getNodeNoEx(pos);
3481 if(n_old.getContent() == CONTENT_IGNORE){
3482 lua_pushboolean(L, false);
3485 // Create item to place
3486 INodeDefManager *ndef = get_server(L)->ndef();
3487 IItemDefManager *idef = get_server(L)->idef();
3488 ItemStack item(ndef->get(n).name, 1, 0, "", idef);
3489 // Make pointed position
3490 PointedThing pointed;
3491 pointed.type = POINTEDTHING_NODE;
3492 pointed.node_abovesurface = pos;
3493 pointed.node_undersurface = pos + v3s16(0,-1,0);
3494 // Place it with a NULL placer (appears in Lua as a non-functional
3496 bool success = scriptapi_item_on_place(L, item, NULL, pointed);
3497 lua_pushboolean(L, success);
3501 // EnvRef:dig_node(pos)
3502 // pos = {x=num, y=num, z=num}
3503 static int l_dig_node(lua_State *L)
3505 EnvRef *o = checkobject(L, 1);
3506 ServerEnvironment *env = o->m_env;
3507 if(env == NULL) return 0;
3508 v3s16 pos = read_v3s16(L, 2);
3510 // Don't attempt to load non-loaded area as of now
3511 MapNode n = env->getMap().getNodeNoEx(pos);
3512 if(n.getContent() == CONTENT_IGNORE){
3513 lua_pushboolean(L, false);
3516 // Dig it out with a NULL digger (appears in Lua as a
3517 // non-functional ObjectRef)
3518 bool success = scriptapi_node_on_dig(L, pos, n, NULL);
3519 lua_pushboolean(L, success);
3523 // EnvRef:punch_node(pos)
3524 // pos = {x=num, y=num, z=num}
3525 static int l_punch_node(lua_State *L)
3527 EnvRef *o = checkobject(L, 1);
3528 ServerEnvironment *env = o->m_env;
3529 if(env == NULL) return 0;
3530 v3s16 pos = read_v3s16(L, 2);
3532 // Don't attempt to load non-loaded area as of now
3533 MapNode n = env->getMap().getNodeNoEx(pos);
3534 if(n.getContent() == CONTENT_IGNORE){
3535 lua_pushboolean(L, false);
3538 // Punch it with a NULL puncher (appears in Lua as a non-functional
3540 bool success = scriptapi_node_on_punch(L, pos, n, NULL);
3541 lua_pushboolean(L, success);
3545 // EnvRef:get_meta(pos)
3546 static int l_get_meta(lua_State *L)
3548 //infostream<<"EnvRef::l_get_meta()"<<std::endl;
3549 EnvRef *o = checkobject(L, 1);
3550 ServerEnvironment *env = o->m_env;
3551 if(env == NULL) return 0;
3553 v3s16 p = read_v3s16(L, 2);
3554 NodeMetaRef::create(L, p, env);
3558 // EnvRef:get_node_timer(pos)
3559 static int l_get_node_timer(lua_State *L)
3561 EnvRef *o = checkobject(L, 1);
3562 ServerEnvironment *env = o->m_env;
3563 if(env == NULL) return 0;
3565 v3s16 p = read_v3s16(L, 2);
3566 NodeTimerRef::create(L, p, env);
3570 // EnvRef:add_entity(pos, entityname) -> ObjectRef or nil
3571 // pos = {x=num, y=num, z=num}
3572 static int l_add_entity(lua_State *L)
3574 //infostream<<"EnvRef::l_add_entity()"<<std::endl;
3575 EnvRef *o = checkobject(L, 1);
3576 ServerEnvironment *env = o->m_env;
3577 if(env == NULL) return 0;
3579 v3f pos = checkFloatPos(L, 2);
3581 const char *name = luaL_checkstring(L, 3);
3583 ServerActiveObject *obj = new LuaEntitySAO(env, pos, name, "");
3584 int objectid = env->addActiveObject(obj);
3585 // If failed to add, return nothing (reads as nil)
3589 objectref_get_or_create(L, obj);
3593 // EnvRef:add_item(pos, itemstack or itemstring or table) -> ObjectRef or nil
3594 // pos = {x=num, y=num, z=num}
3595 static int l_add_item(lua_State *L)
3597 //infostream<<"EnvRef::l_add_item()"<<std::endl;
3598 EnvRef *o = checkobject(L, 1);
3599 ServerEnvironment *env = o->m_env;
3600 if(env == NULL) return 0;
3602 v3f pos = checkFloatPos(L, 2);
3604 ItemStack item = read_item(L, 3);
3605 if(item.empty() || !item.isKnown(get_server(L)->idef()))
3607 // Use minetest.spawn_item to spawn a __builtin:item
3608 lua_getglobal(L, "minetest");
3609 lua_getfield(L, -1, "spawn_item");
3610 if(lua_isnil(L, -1))
3612 lua_pushvalue(L, 2);
3613 lua_pushstring(L, item.getItemString().c_str());
3614 if(lua_pcall(L, 2, 1, 0))
3615 script_error(L, "error: %s", lua_tostring(L, -1));
3617 /*lua_pushvalue(L, 1);
3618 lua_pushstring(L, "__builtin:item");
3619 lua_pushstring(L, item.getItemString().c_str());
3620 return l_add_entity(L);*/
3622 ServerActiveObject *obj = createItemSAO(env, pos, item.getItemString());
3623 int objectid = env->addActiveObject(obj);
3624 // If failed to add, return nothing (reads as nil)
3628 objectref_get_or_create(L, obj);
3632 // EnvRef:add_rat(pos)
3633 // pos = {x=num, y=num, z=num}
3634 static int l_add_rat(lua_State *L)
3636 infostream<<"EnvRef::l_add_rat(): C++ mobs have been removed."
3637 <<" Doing nothing."<<std::endl;
3641 // EnvRef:add_firefly(pos)
3642 // pos = {x=num, y=num, z=num}
3643 static int l_add_firefly(lua_State *L)
3645 infostream<<"EnvRef::l_add_firefly(): C++ mobs have been removed."
3646 <<" Doing nothing."<<std::endl;
3650 // EnvRef:get_player_by_name(name)
3651 static int l_get_player_by_name(lua_State *L)
3653 EnvRef *o = checkobject(L, 1);
3654 ServerEnvironment *env = o->m_env;
3655 if(env == NULL) return 0;
3657 const char *name = luaL_checkstring(L, 2);
3658 Player *player = env->getPlayer(name);
3663 PlayerSAO *sao = player->getPlayerSAO();
3668 // Put player on stack
3669 objectref_get_or_create(L, sao);
3673 // EnvRef:get_objects_inside_radius(pos, radius)
3674 static int l_get_objects_inside_radius(lua_State *L)
3676 // Get the table insert function
3677 lua_getglobal(L, "table");
3678 lua_getfield(L, -1, "insert");
3679 int table_insert = lua_gettop(L);
3681 EnvRef *o = checkobject(L, 1);
3682 ServerEnvironment *env = o->m_env;
3683 if(env == NULL) return 0;
3685 v3f pos = checkFloatPos(L, 2);
3686 float radius = luaL_checknumber(L, 3) * BS;
3687 std::set<u16> ids = env->getObjectsInsideRadius(pos, radius);
3689 int table = lua_gettop(L);
3690 for(std::set<u16>::const_iterator
3691 i = ids.begin(); i != ids.end(); i++){
3692 ServerActiveObject *obj = env->getActiveObject(*i);
3693 // Insert object reference into table
3694 lua_pushvalue(L, table_insert);
3695 lua_pushvalue(L, table);
3696 objectref_get_or_create(L, obj);
3697 if(lua_pcall(L, 2, 0, 0))
3698 script_error(L, "error: %s", lua_tostring(L, -1));
3703 // EnvRef:set_timeofday(val)
3705 static int l_set_timeofday(lua_State *L)
3707 EnvRef *o = checkobject(L, 1);
3708 ServerEnvironment *env = o->m_env;
3709 if(env == NULL) return 0;
3711 float timeofday_f = luaL_checknumber(L, 2);
3712 assert(timeofday_f >= 0.0 && timeofday_f <= 1.0);
3713 int timeofday_mh = (int)(timeofday_f * 24000.0);
3714 // This should be set directly in the environment but currently
3715 // such changes aren't immediately sent to the clients, so call
3716 // the server instead.
3717 //env->setTimeOfDay(timeofday_mh);
3718 get_server(L)->setTimeOfDay(timeofday_mh);
3722 // EnvRef:get_timeofday() -> 0...1
3723 static int l_get_timeofday(lua_State *L)
3725 EnvRef *o = checkobject(L, 1);
3726 ServerEnvironment *env = o->m_env;
3727 if(env == NULL) return 0;
3729 int timeofday_mh = env->getTimeOfDay();
3730 float timeofday_f = (float)timeofday_mh / 24000.0;
3731 lua_pushnumber(L, timeofday_f);
3736 // EnvRef:find_node_near(pos, radius, nodenames) -> pos or nil
3737 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
3738 static int l_find_node_near(lua_State *L)
3740 EnvRef *o = checkobject(L, 1);
3741 ServerEnvironment *env = o->m_env;
3742 if(env == NULL) return 0;
3743 INodeDefManager *ndef = get_server(L)->ndef();
3744 v3s16 pos = read_v3s16(L, 2);
3745 int radius = luaL_checkinteger(L, 3);
3746 std::set<content_t> filter;
3747 if(lua_istable(L, 4)){
3750 while(lua_next(L, table) != 0){
3751 // key at index -2 and value at index -1
3752 luaL_checktype(L, -1, LUA_TSTRING);
3753 ndef->getIds(lua_tostring(L, -1), filter);
3754 // removes value, keeps key for next iteration
3757 } else if(lua_isstring(L, 4)){
3758 ndef->getIds(lua_tostring(L, 4), filter);
3761 for(int d=1; d<=radius; d++){
3762 core::list<v3s16> list;
3763 getFacePositions(list, d);
3764 for(core::list<v3s16>::Iterator i = list.begin();
3765 i != list.end(); i++){
3766 v3s16 p = pos + (*i);
3767 content_t c = env->getMap().getNodeNoEx(p).getContent();
3768 if(filter.count(c) != 0){
3777 // EnvRef:find_nodes_in_area(minp, maxp, nodenames) -> list of positions
3778 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
3779 static int l_find_nodes_in_area(lua_State *L)
3781 EnvRef *o = checkobject(L, 1);
3782 ServerEnvironment *env = o->m_env;
3783 if(env == NULL) return 0;
3784 INodeDefManager *ndef = get_server(L)->ndef();
3785 v3s16 minp = read_v3s16(L, 2);
3786 v3s16 maxp = read_v3s16(L, 3);
3787 std::set<content_t> filter;
3788 if(lua_istable(L, 4)){
3791 while(lua_next(L, table) != 0){
3792 // key at index -2 and value at index -1
3793 luaL_checktype(L, -1, LUA_TSTRING);
3794 ndef->getIds(lua_tostring(L, -1), filter);
3795 // removes value, keeps key for next iteration
3798 } else if(lua_isstring(L, 4)){
3799 ndef->getIds(lua_tostring(L, 4), filter);
3802 // Get the table insert function
3803 lua_getglobal(L, "table");
3804 lua_getfield(L, -1, "insert");
3805 int table_insert = lua_gettop(L);
3808 int table = lua_gettop(L);
3809 for(s16 x=minp.X; x<=maxp.X; x++)
3810 for(s16 y=minp.Y; y<=maxp.Y; y++)
3811 for(s16 z=minp.Z; z<=maxp.Z; z++)
3814 content_t c = env->getMap().getNodeNoEx(p).getContent();
3815 if(filter.count(c) != 0){
3816 lua_pushvalue(L, table_insert);
3817 lua_pushvalue(L, table);
3819 if(lua_pcall(L, 2, 0, 0))
3820 script_error(L, "error: %s", lua_tostring(L, -1));
3826 // EnvRef:get_perlin(seeddiff, octaves, persistence, scale)
3827 // returns world-specific PerlinNoise
3828 static int l_get_perlin(lua_State *L)
3830 EnvRef *o = checkobject(L, 1);
3831 ServerEnvironment *env = o->m_env;
3832 if(env == NULL) return 0;
3834 int seeddiff = luaL_checkint(L, 2);
3835 int octaves = luaL_checkint(L, 3);
3836 double persistence = luaL_checknumber(L, 4);
3837 double scale = luaL_checknumber(L, 5);
3839 LuaPerlinNoise *n = new LuaPerlinNoise(seeddiff + int(env->getServerMap().getSeed()), octaves, persistence, scale);
3840 *(void **)(lua_newuserdata(L, sizeof(void *))) = n;
3841 luaL_getmetatable(L, "PerlinNoise");
3842 lua_setmetatable(L, -2);
3846 // EnvRef:clear_objects()
3847 // clear all objects in the environment
3848 static int l_clear_objects(lua_State *L)
3850 EnvRef *o = checkobject(L, 1);
3851 o->m_env->clearAllObjects();
3856 EnvRef(ServerEnvironment *env):
3859 //infostream<<"EnvRef created"<<std::endl;
3864 //infostream<<"EnvRef destructing"<<std::endl;
3867 // Creates an EnvRef and leaves it on top of stack
3868 // Not callable from Lua; all references are created on the C side.
3869 static void create(lua_State *L, ServerEnvironment *env)
3871 EnvRef *o = new EnvRef(env);
3872 //infostream<<"EnvRef::create: o="<<o<<std::endl;
3873 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
3874 luaL_getmetatable(L, className);
3875 lua_setmetatable(L, -2);
3878 static void set_null(lua_State *L)
3880 EnvRef *o = checkobject(L, -1);
3884 static void Register(lua_State *L)
3887 int methodtable = lua_gettop(L);
3888 luaL_newmetatable(L, className);
3889 int metatable = lua_gettop(L);
3891 lua_pushliteral(L, "__metatable");
3892 lua_pushvalue(L, methodtable);
3893 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
3895 lua_pushliteral(L, "__index");
3896 lua_pushvalue(L, methodtable);
3897 lua_settable(L, metatable);
3899 lua_pushliteral(L, "__gc");
3900 lua_pushcfunction(L, gc_object);
3901 lua_settable(L, metatable);
3903 lua_pop(L, 1); // drop metatable
3905 luaL_openlib(L, 0, methods, 0); // fill methodtable
3906 lua_pop(L, 1); // drop methodtable
3908 // Cannot be created from Lua
3909 //lua_register(L, className, create_object);
3912 const char EnvRef::className[] = "EnvRef";
3913 const luaL_reg EnvRef::methods[] = {
3914 method(EnvRef, set_node),
3915 method(EnvRef, add_node),
3916 method(EnvRef, remove_node),
3917 method(EnvRef, get_node),
3918 method(EnvRef, get_node_or_nil),
3919 method(EnvRef, get_node_light),
3920 method(EnvRef, place_node),
3921 method(EnvRef, dig_node),
3922 method(EnvRef, punch_node),
3923 method(EnvRef, add_entity),
3924 method(EnvRef, add_item),
3925 method(EnvRef, add_rat),
3926 method(EnvRef, add_firefly),
3927 method(EnvRef, get_meta),
3928 method(EnvRef, get_node_timer),
3929 method(EnvRef, get_player_by_name),
3930 method(EnvRef, get_objects_inside_radius),
3931 method(EnvRef, set_timeofday),
3932 method(EnvRef, get_timeofday),
3933 method(EnvRef, find_node_near),
3934 method(EnvRef, find_nodes_in_area),
3935 method(EnvRef, get_perlin),
3936 method(EnvRef, clear_objects),
3945 class LuaPseudoRandom
3948 PseudoRandom m_pseudo;
3950 static const char className[];
3951 static const luaL_reg methods[];
3953 // Exported functions
3955 // garbage collector
3956 static int gc_object(lua_State *L)
3958 LuaPseudoRandom *o = *(LuaPseudoRandom **)(lua_touserdata(L, 1));
3963 // next(self, min=0, max=32767) -> get next value
3964 static int l_next(lua_State *L)
3966 LuaPseudoRandom *o = checkobject(L, 1);
3969 lua_settop(L, 3); // Fill 2 and 3 with nil if they don't exist
3970 if(!lua_isnil(L, 2))
3971 min = luaL_checkinteger(L, 2);
3972 if(!lua_isnil(L, 3))
3973 max = luaL_checkinteger(L, 3);
3975 errorstream<<"PseudoRandom.next(): max="<<max<<" min="<<min<<std::endl;
3976 throw LuaError(L, "PseudoRandom.next(): max < min");
3978 if(max - min != 32767 && max - min > 32767/5)
3979 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.");
3980 PseudoRandom &pseudo = o->m_pseudo;
3981 int val = pseudo.next();
3982 val = (val % (max-min+1)) + min;
3983 lua_pushinteger(L, val);
3988 LuaPseudoRandom(int seed):
3997 const PseudoRandom& getItem() const
4001 PseudoRandom& getItem()
4006 // LuaPseudoRandom(seed)
4007 // Creates an LuaPseudoRandom and leaves it on top of stack
4008 static int create_object(lua_State *L)
4010 int seed = luaL_checknumber(L, 1);
4011 LuaPseudoRandom *o = new LuaPseudoRandom(seed);
4012 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
4013 luaL_getmetatable(L, className);
4014 lua_setmetatable(L, -2);
4018 static LuaPseudoRandom* checkobject(lua_State *L, int narg)
4020 luaL_checktype(L, narg, LUA_TUSERDATA);
4021 void *ud = luaL_checkudata(L, narg, className);
4022 if(!ud) luaL_typerror(L, narg, className);
4023 return *(LuaPseudoRandom**)ud; // unbox pointer
4026 static void Register(lua_State *L)
4029 int methodtable = lua_gettop(L);
4030 luaL_newmetatable(L, className);
4031 int metatable = lua_gettop(L);
4033 lua_pushliteral(L, "__metatable");
4034 lua_pushvalue(L, methodtable);
4035 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
4037 lua_pushliteral(L, "__index");
4038 lua_pushvalue(L, methodtable);
4039 lua_settable(L, metatable);
4041 lua_pushliteral(L, "__gc");
4042 lua_pushcfunction(L, gc_object);
4043 lua_settable(L, metatable);
4045 lua_pop(L, 1); // drop metatable
4047 luaL_openlib(L, 0, methods, 0); // fill methodtable
4048 lua_pop(L, 1); // drop methodtable
4050 // Can be created from Lua (LuaPseudoRandom(seed))
4051 lua_register(L, className, create_object);
4054 const char LuaPseudoRandom::className[] = "PseudoRandom";
4055 const luaL_reg LuaPseudoRandom::methods[] = {
4056 method(LuaPseudoRandom, next),
4066 class LuaABM : public ActiveBlockModifier
4072 std::set<std::string> m_trigger_contents;
4073 std::set<std::string> m_required_neighbors;
4074 float m_trigger_interval;
4075 u32 m_trigger_chance;
4077 LuaABM(lua_State *L, int id,
4078 const std::set<std::string> &trigger_contents,
4079 const std::set<std::string> &required_neighbors,
4080 float trigger_interval, u32 trigger_chance):
4083 m_trigger_contents(trigger_contents),
4084 m_required_neighbors(required_neighbors),
4085 m_trigger_interval(trigger_interval),
4086 m_trigger_chance(trigger_chance)
4089 virtual std::set<std::string> getTriggerContents()
4091 return m_trigger_contents;
4093 virtual std::set<std::string> getRequiredNeighbors()
4095 return m_required_neighbors;
4097 virtual float getTriggerInterval()
4099 return m_trigger_interval;
4101 virtual u32 getTriggerChance()
4103 return m_trigger_chance;
4105 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
4106 u32 active_object_count, u32 active_object_count_wider)
4108 lua_State *L = m_lua;
4111 assert(lua_checkstack(L, 20));
4112 StackUnroller stack_unroller(L);
4114 // Get minetest.registered_abms
4115 lua_getglobal(L, "minetest");
4116 lua_getfield(L, -1, "registered_abms");
4117 luaL_checktype(L, -1, LUA_TTABLE);
4118 int registered_abms = lua_gettop(L);
4120 // Get minetest.registered_abms[m_id]
4121 lua_pushnumber(L, m_id);
4122 lua_gettable(L, registered_abms);
4123 if(lua_isnil(L, -1))
4127 luaL_checktype(L, -1, LUA_TTABLE);
4128 lua_getfield(L, -1, "action");
4129 luaL_checktype(L, -1, LUA_TFUNCTION);
4131 pushnode(L, n, env->getGameDef()->ndef());
4132 lua_pushnumber(L, active_object_count);
4133 lua_pushnumber(L, active_object_count_wider);
4134 if(lua_pcall(L, 4, 0, 0))
4135 script_error(L, "error: %s", lua_tostring(L, -1));
4143 static void read_server_sound_params(lua_State *L, int index,
4144 ServerSoundParams ¶ms)
4147 index = lua_gettop(L) + 1 + index;
4149 params = ServerSoundParams();
4150 if(lua_istable(L, index)){
4151 getfloatfield(L, index, "gain", params.gain);
4152 getstringfield(L, index, "to_player", params.to_player);
4153 lua_getfield(L, index, "pos");
4154 if(!lua_isnil(L, -1)){
4155 v3f p = read_v3f(L, -1)*BS;
4157 params.type = ServerSoundParams::SSP_POSITIONAL;
4160 lua_getfield(L, index, "object");
4161 if(!lua_isnil(L, -1)){
4162 ObjectRef *ref = ObjectRef::checkobject(L, -1);
4163 ServerActiveObject *sao = ObjectRef::getobject(ref);
4165 params.object = sao->getId();
4166 params.type = ServerSoundParams::SSP_OBJECT;
4170 params.max_hear_distance = BS*getfloatfield_default(L, index,
4171 "max_hear_distance", params.max_hear_distance/BS);
4172 getboolfield(L, index, "loop", params.loop);
4181 // Writes a line to dstream
4182 static int l_debug(lua_State *L)
4184 std::string text = lua_tostring(L, 1);
4185 dstream << text << std::endl;
4189 // log([level,] text)
4190 // Writes a line to the logger.
4191 // The one-argument version logs to infostream.
4192 // The two-argument version accept a log level: error, action, info, or verbose.
4193 static int l_log(lua_State *L)
4196 LogMessageLevel level = LMT_INFO;
4197 if(lua_isnone(L, 2))
4199 text = lua_tostring(L, 1);
4203 std::string levelname = lua_tostring(L, 1);
4204 text = lua_tostring(L, 2);
4205 if(levelname == "error")
4207 else if(levelname == "action")
4209 else if(levelname == "verbose")
4210 level = LMT_VERBOSE;
4212 log_printline(level, text);
4216 // request_shutdown()
4217 static int l_request_shutdown(lua_State *L)
4219 get_server(L)->requestShutdown();
4223 // get_server_status()
4224 static int l_get_server_status(lua_State *L)
4226 lua_pushstring(L, wide_to_narrow(get_server(L)->getStatusString()).c_str());
4230 // register_item_raw({lots of stuff})
4231 static int l_register_item_raw(lua_State *L)
4233 luaL_checktype(L, 1, LUA_TTABLE);
4236 // Get the writable item and node definition managers from the server
4237 IWritableItemDefManager *idef =
4238 get_server(L)->getWritableItemDefManager();
4239 IWritableNodeDefManager *ndef =
4240 get_server(L)->getWritableNodeDefManager();
4242 // Check if name is defined
4244 lua_getfield(L, table, "name");
4245 if(lua_isstring(L, -1)){
4246 name = lua_tostring(L, -1);
4247 verbosestream<<"register_item_raw: "<<name<<std::endl;
4249 throw LuaError(L, "register_item_raw: name is not defined or not a string");
4252 // Check if on_use is defined
4255 // Set a distinctive default value to check if this is set
4256 def.node_placement_prediction = "__default";
4258 // Read the item definition
4259 def = read_item_definition(L, table, def);
4261 // Default to having client-side placement prediction for nodes
4262 // ("" in item definition sets it off)
4263 if(def.node_placement_prediction == "__default"){
4264 if(def.type == ITEM_NODE)
4265 def.node_placement_prediction = name;
4267 def.node_placement_prediction = "";
4270 // Register item definition
4271 idef->registerItem(def);
4273 // Read the node definition (content features) and register it
4274 if(def.type == ITEM_NODE)
4276 ContentFeatures f = read_content_features(L, table);
4277 ndef->set(f.name, f);
4280 return 0; /* number of results */
4283 // register_alias_raw(name, convert_to_name)
4284 static int l_register_alias_raw(lua_State *L)
4286 std::string name = luaL_checkstring(L, 1);
4287 std::string convert_to = luaL_checkstring(L, 2);
4289 // Get the writable item definition manager from the server
4290 IWritableItemDefManager *idef =
4291 get_server(L)->getWritableItemDefManager();
4293 idef->registerAlias(name, convert_to);
4295 return 0; /* number of results */
4298 // helper for register_craft
4299 static bool read_craft_recipe_shaped(lua_State *L, int index,
4300 int &width, std::vector<std::string> &recipe)
4303 index = lua_gettop(L) + 1 + index;
4305 if(!lua_istable(L, index))
4310 while(lua_next(L, index) != 0){
4312 // key at index -2 and value at index -1
4313 if(!lua_istable(L, -1))
4315 int table2 = lua_gettop(L);
4317 while(lua_next(L, table2) != 0){
4318 // key at index -2 and value at index -1
4319 if(!lua_isstring(L, -1))
4321 recipe.push_back(lua_tostring(L, -1));
4322 // removes value, keeps key for next iteration
4329 if(colcount != width)
4332 // removes value, keeps key for next iteration
4339 // helper for register_craft
4340 static bool read_craft_recipe_shapeless(lua_State *L, int index,
4341 std::vector<std::string> &recipe)
4344 index = lua_gettop(L) + 1 + index;
4346 if(!lua_istable(L, index))
4350 while(lua_next(L, index) != 0){
4351 // key at index -2 and value at index -1
4352 if(!lua_isstring(L, -1))
4354 recipe.push_back(lua_tostring(L, -1));
4355 // removes value, keeps key for next iteration
4361 // helper for register_craft
4362 static bool read_craft_replacements(lua_State *L, int index,
4363 CraftReplacements &replacements)
4366 index = lua_gettop(L) + 1 + index;
4368 if(!lua_istable(L, index))
4372 while(lua_next(L, index) != 0){
4373 // key at index -2 and value at index -1
4374 if(!lua_istable(L, -1))
4376 lua_rawgeti(L, -1, 1);
4377 if(!lua_isstring(L, -1))
4379 std::string replace_from = lua_tostring(L, -1);
4381 lua_rawgeti(L, -1, 2);
4382 if(!lua_isstring(L, -1))
4384 std::string replace_to = lua_tostring(L, -1);
4386 replacements.pairs.push_back(
4387 std::make_pair(replace_from, replace_to));
4388 // removes value, keeps key for next iteration
4393 // register_craft({output=item, recipe={{item00,item10},{item01,item11}})
4394 static int l_register_craft(lua_State *L)
4396 //infostream<<"register_craft"<<std::endl;
4397 luaL_checktype(L, 1, LUA_TTABLE);
4400 // Get the writable craft definition manager from the server
4401 IWritableCraftDefManager *craftdef =
4402 get_server(L)->getWritableCraftDefManager();
4404 std::string type = getstringfield_default(L, table, "type", "shaped");
4407 CraftDefinitionShaped
4409 if(type == "shaped"){
4410 std::string output = getstringfield_default(L, table, "output", "");
4412 throw LuaError(L, "Crafting definition is missing an output");
4415 std::vector<std::string> recipe;
4416 lua_getfield(L, table, "recipe");
4417 if(lua_isnil(L, -1))
4418 throw LuaError(L, "Crafting definition is missing a recipe"
4419 " (output=\"" + output + "\")");
4420 if(!read_craft_recipe_shaped(L, -1, width, recipe))
4421 throw LuaError(L, "Invalid crafting recipe"
4422 " (output=\"" + output + "\")");
4424 CraftReplacements replacements;
4425 lua_getfield(L, table, "replacements");
4426 if(!lua_isnil(L, -1))
4428 if(!read_craft_replacements(L, -1, replacements))
4429 throw LuaError(L, "Invalid replacements"
4430 " (output=\"" + output + "\")");
4433 CraftDefinition *def = new CraftDefinitionShaped(
4434 output, width, recipe, replacements);
4435 craftdef->registerCraft(def);
4438 CraftDefinitionShapeless
4440 else if(type == "shapeless"){
4441 std::string output = getstringfield_default(L, table, "output", "");
4443 throw LuaError(L, "Crafting definition (shapeless)"
4444 " is missing an output");
4446 std::vector<std::string> recipe;
4447 lua_getfield(L, table, "recipe");
4448 if(lua_isnil(L, -1))
4449 throw LuaError(L, "Crafting definition (shapeless)"
4450 " is missing a recipe"
4451 " (output=\"" + output + "\")");
4452 if(!read_craft_recipe_shapeless(L, -1, recipe))
4453 throw LuaError(L, "Invalid crafting recipe"
4454 " (output=\"" + output + "\")");
4456 CraftReplacements replacements;
4457 lua_getfield(L, table, "replacements");
4458 if(!lua_isnil(L, -1))
4460 if(!read_craft_replacements(L, -1, replacements))
4461 throw LuaError(L, "Invalid replacements"
4462 " (output=\"" + output + "\")");
4465 CraftDefinition *def = new CraftDefinitionShapeless(
4466 output, recipe, replacements);
4467 craftdef->registerCraft(def);
4470 CraftDefinitionToolRepair
4472 else if(type == "toolrepair"){
4473 float additional_wear = getfloatfield_default(L, table,
4474 "additional_wear", 0.0);
4476 CraftDefinition *def = new CraftDefinitionToolRepair(
4478 craftdef->registerCraft(def);
4481 CraftDefinitionCooking
4483 else if(type == "cooking"){
4484 std::string output = getstringfield_default(L, table, "output", "");
4486 throw LuaError(L, "Crafting definition (cooking)"
4487 " is missing an output");
4489 std::string recipe = getstringfield_default(L, table, "recipe", "");
4491 throw LuaError(L, "Crafting definition (cooking)"
4492 " is missing a recipe"
4493 " (output=\"" + output + "\")");
4495 float cooktime = getfloatfield_default(L, table, "cooktime", 3.0);
4497 CraftReplacements replacements;
4498 lua_getfield(L, table, "replacements");
4499 if(!lua_isnil(L, -1))
4501 if(!read_craft_replacements(L, -1, replacements))
4502 throw LuaError(L, "Invalid replacements"
4503 " (cooking output=\"" + output + "\")");
4506 CraftDefinition *def = new CraftDefinitionCooking(
4507 output, recipe, cooktime, replacements);
4508 craftdef->registerCraft(def);
4513 else if(type == "fuel"){
4514 std::string recipe = getstringfield_default(L, table, "recipe", "");
4516 throw LuaError(L, "Crafting definition (fuel)"
4517 " is missing a recipe");
4519 float burntime = getfloatfield_default(L, table, "burntime", 1.0);
4521 CraftReplacements replacements;
4522 lua_getfield(L, table, "replacements");
4523 if(!lua_isnil(L, -1))
4525 if(!read_craft_replacements(L, -1, replacements))
4526 throw LuaError(L, "Invalid replacements"
4527 " (fuel recipe=\"" + recipe + "\")");
4530 CraftDefinition *def = new CraftDefinitionFuel(
4531 recipe, burntime, replacements);
4532 craftdef->registerCraft(def);
4536 throw LuaError(L, "Unknown crafting definition type: \"" + type + "\"");
4540 return 0; /* number of results */
4543 // setting_set(name, value)
4544 static int l_setting_set(lua_State *L)
4546 const char *name = luaL_checkstring(L, 1);
4547 const char *value = luaL_checkstring(L, 2);
4548 g_settings->set(name, value);
4552 // setting_get(name)
4553 static int l_setting_get(lua_State *L)
4555 const char *name = luaL_checkstring(L, 1);
4557 std::string value = g_settings->get(name);
4558 lua_pushstring(L, value.c_str());
4559 } catch(SettingNotFoundException &e){
4565 // setting_getbool(name)
4566 static int l_setting_getbool(lua_State *L)
4568 const char *name = luaL_checkstring(L, 1);
4570 bool value = g_settings->getBool(name);
4571 lua_pushboolean(L, value);
4572 } catch(SettingNotFoundException &e){
4578 // chat_send_all(text)
4579 static int l_chat_send_all(lua_State *L)
4581 const char *text = luaL_checkstring(L, 1);
4582 // Get server from registry
4583 Server *server = get_server(L);
4585 server->notifyPlayers(narrow_to_wide(text));
4589 // chat_send_player(name, text)
4590 static int l_chat_send_player(lua_State *L)
4592 const char *name = luaL_checkstring(L, 1);
4593 const char *text = luaL_checkstring(L, 2);
4594 // Get server from registry
4595 Server *server = get_server(L);
4597 server->notifyPlayer(name, narrow_to_wide(text));
4601 // get_player_privs(name, text)
4602 static int l_get_player_privs(lua_State *L)
4604 const char *name = luaL_checkstring(L, 1);
4605 // Get server from registry
4606 Server *server = get_server(L);
4609 int table = lua_gettop(L);
4610 std::set<std::string> privs_s = server->getPlayerEffectivePrivs(name);
4611 for(std::set<std::string>::const_iterator
4612 i = privs_s.begin(); i != privs_s.end(); i++){
4613 lua_pushboolean(L, true);
4614 lua_setfield(L, table, i->c_str());
4616 lua_pushvalue(L, table);
4621 static int l_get_ban_list(lua_State *L)
4623 lua_pushstring(L, get_server(L)->getBanDescription("").c_str());
4627 // get_ban_description()
4628 static int l_get_ban_description(lua_State *L)
4630 const char * ip_or_name = luaL_checkstring(L, 1);
4631 lua_pushstring(L, get_server(L)->getBanDescription(std::string(ip_or_name)).c_str());
4636 static int l_ban_player(lua_State *L)
4638 const char * name = luaL_checkstring(L, 1);
4639 Player *player = get_env(L)->getPlayer(name);
4642 lua_pushboolean(L, false); // no such player
4647 Address addr = get_server(L)->getPeerAddress(get_env(L)->getPlayer(name)->peer_id);
4648 std::string ip_str = addr.serializeString();
4649 get_server(L)->setIpBanned(ip_str, name);
4651 catch(con::PeerNotFoundException) // unlikely
4653 dstream << __FUNCTION_NAME << ": peer was not found" << std::endl;
4654 lua_pushboolean(L, false); // error
4657 lua_pushboolean(L, true);
4661 // unban_player_or_ip()
4662 static int l_unban_player_of_ip(lua_State *L)
4664 const char * ip_or_name = luaL_checkstring(L, 1);
4665 get_server(L)->unsetIpBanned(ip_or_name);
4666 lua_pushboolean(L, true);
4670 // get_inventory(location)
4671 static int l_get_inventory(lua_State *L)
4673 InventoryLocation loc;
4675 std::string type = checkstringfield(L, 1, "type");
4676 if(type == "player"){
4677 std::string name = checkstringfield(L, 1, "name");
4678 loc.setPlayer(name);
4679 } else if(type == "node"){
4680 lua_getfield(L, 1, "pos");
4681 v3s16 pos = check_v3s16(L, -1);
4682 loc.setNodeMeta(pos);
4683 } else if(type == "detached"){
4684 std::string name = checkstringfield(L, 1, "name");
4685 loc.setDetached(name);
4688 if(get_server(L)->getInventory(loc) != NULL)
4689 InvRef::create(L, loc);
4695 // create_detached_inventory_raw(name)
4696 static int l_create_detached_inventory_raw(lua_State *L)
4698 const char *name = luaL_checkstring(L, 1);
4699 if(get_server(L)->createDetachedInventory(name) != NULL){
4700 InventoryLocation loc;
4701 loc.setDetached(name);
4702 InvRef::create(L, loc);
4709 // get_dig_params(groups, tool_capabilities[, time_from_last_punch])
4710 static int l_get_dig_params(lua_State *L)
4712 std::map<std::string, int> groups;
4713 read_groups(L, 1, groups);
4714 ToolCapabilities tp = read_tool_capabilities(L, 2);
4715 if(lua_isnoneornil(L, 3))
4716 push_dig_params(L, getDigParams(groups, &tp));
4718 push_dig_params(L, getDigParams(groups, &tp,
4719 luaL_checknumber(L, 3)));
4723 // get_hit_params(groups, tool_capabilities[, time_from_last_punch])
4724 static int l_get_hit_params(lua_State *L)
4726 std::map<std::string, int> groups;
4727 read_groups(L, 1, groups);
4728 ToolCapabilities tp = read_tool_capabilities(L, 2);
4729 if(lua_isnoneornil(L, 3))
4730 push_hit_params(L, getHitParams(groups, &tp));
4732 push_hit_params(L, getHitParams(groups, &tp,
4733 luaL_checknumber(L, 3)));
4737 // get_current_modname()
4738 static int l_get_current_modname(lua_State *L)
4740 lua_getfield(L, LUA_REGISTRYINDEX, "minetest_current_modname");
4744 // get_modpath(modname)
4745 static int l_get_modpath(lua_State *L)
4747 std::string modname = luaL_checkstring(L, 1);
4749 if(modname == "__builtin"){
4750 std::string path = get_server(L)->getBuiltinLuaPath();
4751 lua_pushstring(L, path.c_str());
4754 const ModSpec *mod = get_server(L)->getModSpec(modname);
4759 lua_pushstring(L, mod->path.c_str());
4764 // the returned list is sorted alphabetically for you
4765 static int l_get_modnames(lua_State *L)
4767 // Get a list of mods
4768 core::list<std::string> mods_unsorted, mods_sorted;
4769 get_server(L)->getModNames(mods_unsorted);
4771 // Take unsorted items from mods_unsorted and sort them into
4772 // mods_sorted; not great performance but the number of mods on a
4773 // server will likely be small.
4774 for(core::list<std::string>::Iterator i = mods_unsorted.begin();
4775 i != mods_unsorted.end(); i++)
4778 for(core::list<std::string>::Iterator x = mods_sorted.begin();
4779 x != mods_unsorted.end(); x++)
4781 // I doubt anybody using Minetest will be using
4782 // anything not ASCII based :)
4783 if((*i).compare(*x) <= 0)
4785 mods_sorted.insert_before(x, *i);
4791 mods_sorted.push_back(*i);
4794 // Get the table insertion function from Lua.
4795 lua_getglobal(L, "table");
4796 lua_getfield(L, -1, "insert");
4797 int insertion_func = lua_gettop(L);
4799 // Package them up for Lua
4801 int new_table = lua_gettop(L);
4802 core::list<std::string>::Iterator i = mods_sorted.begin();
4803 while(i != mods_sorted.end())
4805 lua_pushvalue(L, insertion_func);
4806 lua_pushvalue(L, new_table);
4807 lua_pushstring(L, (*i).c_str());
4808 if(lua_pcall(L, 2, 0, 0) != 0)
4810 script_error(L, "error: %s", lua_tostring(L, -1));
4818 static int l_get_worldpath(lua_State *L)
4820 std::string worldpath = get_server(L)->getWorldPath();
4821 lua_pushstring(L, worldpath.c_str());
4825 // sound_play(spec, parameters)
4826 static int l_sound_play(lua_State *L)
4828 SimpleSoundSpec spec;
4829 read_soundspec(L, 1, spec);
4830 ServerSoundParams params;
4831 read_server_sound_params(L, 2, params);
4832 s32 handle = get_server(L)->playSound(spec, params);
4833 lua_pushinteger(L, handle);
4837 // sound_stop(handle)
4838 static int l_sound_stop(lua_State *L)
4840 int handle = luaL_checkinteger(L, 1);
4841 get_server(L)->stopSound(handle);
4845 // is_singleplayer()
4846 static int l_is_singleplayer(lua_State *L)
4848 lua_pushboolean(L, get_server(L)->isSingleplayer());
4852 // get_password_hash(name, raw_password)
4853 static int l_get_password_hash(lua_State *L)
4855 std::string name = luaL_checkstring(L, 1);
4856 std::string raw_password = luaL_checkstring(L, 2);
4857 std::string hash = translatePassword(name,
4858 narrow_to_wide(raw_password));
4859 lua_pushstring(L, hash.c_str());
4863 // notify_authentication_modified(name)
4864 static int l_notify_authentication_modified(lua_State *L)
4866 std::string name = "";
4867 if(lua_isstring(L, 1))
4868 name = lua_tostring(L, 1);
4869 get_server(L)->reportPrivsModified(name);
4873 // get_craft_result(input)
4874 static int l_get_craft_result(lua_State *L)
4877 std::string method_s = getstringfield_default(L, input_i, "method", "normal");
4878 enum CraftMethod method = (CraftMethod)getenumfield(L, input_i, "method",
4879 es_CraftMethod, CRAFT_METHOD_NORMAL);
4881 lua_getfield(L, input_i, "width");
4882 if(lua_isnumber(L, -1))
4883 width = luaL_checkinteger(L, -1);
4885 lua_getfield(L, input_i, "items");
4886 std::vector<ItemStack> items = read_items(L, -1);
4887 lua_pop(L, 1); // items
4889 IGameDef *gdef = get_server(L);
4890 ICraftDefManager *cdef = gdef->cdef();
4891 CraftInput input(method, width, items);
4893 bool got = cdef->getCraftResult(input, output, true, gdef);
4894 lua_newtable(L); // output table
4897 item.deSerialize(output.item, gdef->idef());
4898 LuaItemStack::create(L, item);
4899 lua_setfield(L, -2, "item");
4900 setintfield(L, -1, "time", output.time);
4902 LuaItemStack::create(L, ItemStack());
4903 lua_setfield(L, -2, "item");
4904 setintfield(L, -1, "time", 0);
4906 lua_newtable(L); // decremented input table
4907 lua_pushstring(L, method_s.c_str());
4908 lua_setfield(L, -2, "method");
4909 lua_pushinteger(L, width);
4910 lua_setfield(L, -2, "width");
4911 push_items(L, input.items);
4912 lua_setfield(L, -2, "items");
4916 // get_craft_recipe(result item)
4917 static int l_get_craft_recipe(lua_State *L)
4922 std::string o_item = luaL_checkstring(L,input_i);
4924 IGameDef *gdef = get_server(L);
4925 ICraftDefManager *cdef = gdef->cdef();
4927 CraftOutput output(o_item,0);
4928 bool got = cdef->getCraftRecipe(input, output, gdef);
4929 lua_newtable(L); // output table
4932 for(std::vector<ItemStack>::const_iterator
4933 i = input.items.begin();
4934 i != input.items.end(); i++, k++)
4940 sprintf(tmp,"%d",k);
4941 lua_pushstring(L,tmp);
4942 lua_pushstring(L,i->name.c_str());
4943 lua_settable(L, -3);
4945 lua_setfield(L, -2, "items");
4946 setintfield(L, -1, "width", input.width);
4947 switch (input.method) {
4948 case CRAFT_METHOD_NORMAL:
4949 lua_pushstring(L,"normal");
4951 case CRAFT_METHOD_COOKING:
4952 lua_pushstring(L,"cooking");
4954 case CRAFT_METHOD_FUEL:
4955 lua_pushstring(L,"fuel");
4958 lua_pushstring(L,"unknown");
4960 lua_setfield(L, -2, "type");
4963 lua_setfield(L, -2, "items");
4964 setintfield(L, -1, "width", 0);
4969 // rollback_get_last_node_actor(p, range, seconds) -> actor, p, seconds
4970 static int l_rollback_get_last_node_actor(lua_State *L)
4972 v3s16 p = read_v3s16(L, 1);
4973 int range = luaL_checknumber(L, 2);
4974 int seconds = luaL_checknumber(L, 3);
4975 Server *server = get_server(L);
4976 IRollbackManager *rollback = server->getRollbackManager();
4978 int act_seconds = 0;
4979 std::string actor = rollback->getLastNodeActor(p, range, seconds, &act_p, &act_seconds);
4980 lua_pushstring(L, actor.c_str());
4981 push_v3s16(L, act_p);
4982 lua_pushnumber(L, act_seconds);
4986 // rollback_revert_actions_by(actor, seconds) -> bool, log messages
4987 static int l_rollback_revert_actions_by(lua_State *L)
4989 std::string actor = luaL_checkstring(L, 1);
4990 int seconds = luaL_checknumber(L, 2);
4991 Server *server = get_server(L);
4992 IRollbackManager *rollback = server->getRollbackManager();
4993 std::list<RollbackAction> actions = rollback->getRevertActions(actor, seconds);
4994 std::list<std::string> log;
4995 bool success = server->rollbackRevertActions(actions, &log);
4996 // Push boolean result
4997 lua_pushboolean(L, success);
4998 // Get the table insert function and push the log table
4999 lua_getglobal(L, "table");
5000 lua_getfield(L, -1, "insert");
5001 int table_insert = lua_gettop(L);
5003 int table = lua_gettop(L);
5004 for(std::list<std::string>::const_iterator i = log.begin();
5005 i != log.end(); i++)
5007 lua_pushvalue(L, table_insert);
5008 lua_pushvalue(L, table);
5009 lua_pushstring(L, i->c_str());
5010 if(lua_pcall(L, 2, 0, 0))
5011 script_error(L, "error: %s", lua_tostring(L, -1));
5013 lua_remove(L, -2); // Remove table
5014 lua_remove(L, -2); // Remove insert
5018 static const struct luaL_Reg minetest_f [] = {
5021 {"request_shutdown", l_request_shutdown},
5022 {"get_server_status", l_get_server_status},
5023 {"register_item_raw", l_register_item_raw},
5024 {"register_alias_raw", l_register_alias_raw},
5025 {"register_craft", l_register_craft},
5026 {"setting_set", l_setting_set},
5027 {"setting_get", l_setting_get},
5028 {"setting_getbool", l_setting_getbool},
5029 {"chat_send_all", l_chat_send_all},
5030 {"chat_send_player", l_chat_send_player},
5031 {"get_player_privs", l_get_player_privs},
5032 {"get_ban_list", l_get_ban_list},
5033 {"get_ban_description", l_get_ban_description},
5034 {"ban_player", l_ban_player},
5035 {"unban_player_or_ip", l_unban_player_of_ip},
5036 {"get_inventory", l_get_inventory},
5037 {"create_detached_inventory_raw", l_create_detached_inventory_raw},
5038 {"get_dig_params", l_get_dig_params},
5039 {"get_hit_params", l_get_hit_params},
5040 {"get_current_modname", l_get_current_modname},
5041 {"get_modpath", l_get_modpath},
5042 {"get_modnames", l_get_modnames},
5043 {"get_worldpath", l_get_worldpath},
5044 {"sound_play", l_sound_play},
5045 {"sound_stop", l_sound_stop},
5046 {"is_singleplayer", l_is_singleplayer},
5047 {"get_password_hash", l_get_password_hash},
5048 {"notify_authentication_modified", l_notify_authentication_modified},
5049 {"get_craft_result", l_get_craft_result},
5050 {"get_craft_recipe", l_get_craft_recipe},
5051 {"rollback_get_last_node_actor", l_rollback_get_last_node_actor},
5052 {"rollback_revert_actions_by", l_rollback_revert_actions_by},
5057 Main export function
5060 void scriptapi_export(lua_State *L, Server *server)
5063 assert(lua_checkstack(L, 20));
5064 verbosestream<<"scriptapi_export()"<<std::endl;
5065 StackUnroller stack_unroller(L);
5067 // Store server as light userdata in registry
5068 lua_pushlightuserdata(L, server);
5069 lua_setfield(L, LUA_REGISTRYINDEX, "minetest_server");
5071 // Register global functions in table minetest
5073 luaL_register(L, NULL, minetest_f);
5074 lua_setglobal(L, "minetest");
5076 // Get the main minetest table
5077 lua_getglobal(L, "minetest");
5079 // Add tables to minetest
5081 lua_setfield(L, -2, "object_refs");
5083 lua_setfield(L, -2, "luaentities");
5085 // Register wrappers
5086 LuaItemStack::Register(L);
5087 InvRef::Register(L);
5088 NodeMetaRef::Register(L);
5089 NodeTimerRef::Register(L);
5090 ObjectRef::Register(L);
5091 EnvRef::Register(L);
5092 LuaPseudoRandom::Register(L);
5093 LuaPerlinNoise::Register(L);
5096 bool scriptapi_loadmod(lua_State *L, const std::string &scriptpath,
5097 const std::string &modname)
5099 ModNameStorer modnamestorer(L, modname);
5101 if(!string_allowed(modname, "abcdefghijklmnopqrstuvwxyz"
5103 errorstream<<"Error loading mod \""<<modname
5104 <<"\": modname does not follow naming conventions: "
5105 <<"Only chararacters [a-z0-9_] are allowed."<<std::endl;
5109 bool success = false;
5112 success = script_load(L, scriptpath.c_str());
5115 errorstream<<"Error loading mod \""<<modname
5116 <<"\": "<<e.what()<<std::endl;
5122 void scriptapi_add_environment(lua_State *L, ServerEnvironment *env)
5125 assert(lua_checkstack(L, 20));
5126 verbosestream<<"scriptapi_add_environment"<<std::endl;
5127 StackUnroller stack_unroller(L);
5129 // Create EnvRef on stack
5130 EnvRef::create(L, env);
5131 int envref = lua_gettop(L);
5133 // minetest.env = envref
5134 lua_getglobal(L, "minetest");
5135 luaL_checktype(L, -1, LUA_TTABLE);
5136 lua_pushvalue(L, envref);
5137 lua_setfield(L, -2, "env");
5139 // Store environment as light userdata in registry
5140 lua_pushlightuserdata(L, env);
5141 lua_setfield(L, LUA_REGISTRYINDEX, "minetest_env");
5144 Add ActiveBlockModifiers to environment
5147 // Get minetest.registered_abms
5148 lua_getglobal(L, "minetest");
5149 lua_getfield(L, -1, "registered_abms");
5150 luaL_checktype(L, -1, LUA_TTABLE);
5151 int registered_abms = lua_gettop(L);
5153 if(lua_istable(L, registered_abms)){
5154 int table = lua_gettop(L);
5156 while(lua_next(L, table) != 0){
5157 // key at index -2 and value at index -1
5158 int id = lua_tonumber(L, -2);
5159 int current_abm = lua_gettop(L);
5161 std::set<std::string> trigger_contents;
5162 lua_getfield(L, current_abm, "nodenames");
5163 if(lua_istable(L, -1)){
5164 int table = lua_gettop(L);
5166 while(lua_next(L, table) != 0){
5167 // key at index -2 and value at index -1
5168 luaL_checktype(L, -1, LUA_TSTRING);
5169 trigger_contents.insert(lua_tostring(L, -1));
5170 // removes value, keeps key for next iteration
5173 } else if(lua_isstring(L, -1)){
5174 trigger_contents.insert(lua_tostring(L, -1));
5178 std::set<std::string> required_neighbors;
5179 lua_getfield(L, current_abm, "neighbors");
5180 if(lua_istable(L, -1)){
5181 int table = lua_gettop(L);
5183 while(lua_next(L, table) != 0){
5184 // key at index -2 and value at index -1
5185 luaL_checktype(L, -1, LUA_TSTRING);
5186 required_neighbors.insert(lua_tostring(L, -1));
5187 // removes value, keeps key for next iteration
5190 } else if(lua_isstring(L, -1)){
5191 required_neighbors.insert(lua_tostring(L, -1));
5195 float trigger_interval = 10.0;
5196 getfloatfield(L, current_abm, "interval", trigger_interval);
5198 int trigger_chance = 50;
5199 getintfield(L, current_abm, "chance", trigger_chance);
5201 LuaABM *abm = new LuaABM(L, id, trigger_contents,
5202 required_neighbors, trigger_interval, trigger_chance);
5204 env->addActiveBlockModifier(abm);
5206 // removes value, keeps key for next iteration
5214 // Dump stack top with the dump2 function
5215 static void dump2(lua_State *L, const char *name)
5217 // Dump object (debug)
5218 lua_getglobal(L, "dump2");
5219 luaL_checktype(L, -1, LUA_TFUNCTION);
5220 lua_pushvalue(L, -2); // Get previous stack top as first parameter
5221 lua_pushstring(L, name);
5222 if(lua_pcall(L, 2, 0, 0))
5223 script_error(L, "error: %s", lua_tostring(L, -1));
5231 void scriptapi_add_object_reference(lua_State *L, ServerActiveObject *cobj)
5234 assert(lua_checkstack(L, 20));
5235 //infostream<<"scriptapi_add_object_reference: id="<<cobj->getId()<<std::endl;
5236 StackUnroller stack_unroller(L);
5238 // Create object on stack
5239 ObjectRef::create(L, cobj); // Puts ObjectRef (as userdata) on stack
5240 int object = lua_gettop(L);
5242 // Get minetest.object_refs table
5243 lua_getglobal(L, "minetest");
5244 lua_getfield(L, -1, "object_refs");
5245 luaL_checktype(L, -1, LUA_TTABLE);
5246 int objectstable = lua_gettop(L);
5248 // object_refs[id] = object
5249 lua_pushnumber(L, cobj->getId()); // Push id
5250 lua_pushvalue(L, object); // Copy object to top of stack
5251 lua_settable(L, objectstable);
5254 void scriptapi_rm_object_reference(lua_State *L, ServerActiveObject *cobj)
5257 assert(lua_checkstack(L, 20));
5258 //infostream<<"scriptapi_rm_object_reference: id="<<cobj->getId()<<std::endl;
5259 StackUnroller stack_unroller(L);
5261 // Get minetest.object_refs table
5262 lua_getglobal(L, "minetest");
5263 lua_getfield(L, -1, "object_refs");
5264 luaL_checktype(L, -1, LUA_TTABLE);
5265 int objectstable = lua_gettop(L);
5267 // Get object_refs[id]
5268 lua_pushnumber(L, cobj->getId()); // Push id
5269 lua_gettable(L, objectstable);
5270 // Set object reference to NULL
5271 ObjectRef::set_null(L);
5272 lua_pop(L, 1); // pop object
5274 // Set object_refs[id] = nil
5275 lua_pushnumber(L, cobj->getId()); // Push id
5277 lua_settable(L, objectstable);
5284 // What scriptapi_run_callbacks does with the return values of callbacks.
5285 // Regardless of the mode, if only one callback is defined,
5286 // its return value is the total return value.
5287 // Modes only affect the case where 0 or >= 2 callbacks are defined.
5288 enum RunCallbacksMode
5290 // Returns the return value of the first callback
5291 // Returns nil if list of callbacks is empty
5292 RUN_CALLBACKS_MODE_FIRST,
5293 // Returns the return value of the last callback
5294 // Returns nil if list of callbacks is empty
5295 RUN_CALLBACKS_MODE_LAST,
5296 // If any callback returns a false value, the first such is returned
5297 // Otherwise, the first callback's return value (trueish) is returned
5298 // Returns true if list of callbacks is empty
5299 RUN_CALLBACKS_MODE_AND,
5300 // Like above, but stops calling callbacks (short circuit)
5301 // after seeing the first false value
5302 RUN_CALLBACKS_MODE_AND_SC,
5303 // If any callback returns a true value, the first such is returned
5304 // Otherwise, the first callback's return value (falseish) is returned
5305 // Returns false if list of callbacks is empty
5306 RUN_CALLBACKS_MODE_OR,
5307 // Like above, but stops calling callbacks (short circuit)
5308 // after seeing the first true value
5309 RUN_CALLBACKS_MODE_OR_SC,
5310 // Note: "a true value" and "a false value" refer to values that
5311 // are converted by lua_toboolean to true or false, respectively.
5314 // Push the list of callbacks (a lua table).
5315 // Then push nargs arguments.
5316 // Then call this function, which
5317 // - runs the callbacks
5318 // - removes the table and arguments from the lua stack
5319 // - pushes the return value, computed depending on mode
5320 static void scriptapi_run_callbacks(lua_State *L, int nargs,
5321 RunCallbacksMode mode)
5323 // Insert the return value into the lua stack, below the table
5324 assert(lua_gettop(L) >= nargs + 1);
5326 lua_insert(L, -(nargs + 1) - 1);
5327 // Stack now looks like this:
5328 // ... <return value = nil> <table> <arg#1> <arg#2> ... <arg#n>
5330 int rv = lua_gettop(L) - nargs - 1;
5332 int arg = table + 1;
5334 luaL_checktype(L, table, LUA_TTABLE);
5338 bool first_loop = true;
5339 while(lua_next(L, table) != 0){
5340 // key at index -2 and value at index -1
5341 luaL_checktype(L, -1, LUA_TFUNCTION);
5343 for(int i = 0; i < nargs; i++)
5344 lua_pushvalue(L, arg+i);
5345 if(lua_pcall(L, nargs, 1, 0))
5346 script_error(L, "error: %s", lua_tostring(L, -1));
5348 // Move return value to designated space in stack
5351 // Result of first callback is always moved
5355 // Otherwise, what happens depends on the mode
5356 if(mode == RUN_CALLBACKS_MODE_FIRST)
5358 else if(mode == RUN_CALLBACKS_MODE_LAST)
5360 else if(mode == RUN_CALLBACKS_MODE_AND ||
5361 mode == RUN_CALLBACKS_MODE_AND_SC){
5362 if(lua_toboolean(L, rv) == true &&
5363 lua_toboolean(L, -1) == false)
5368 else if(mode == RUN_CALLBACKS_MODE_OR ||
5369 mode == RUN_CALLBACKS_MODE_OR_SC){
5370 if(lua_toboolean(L, rv) == false &&
5371 lua_toboolean(L, -1) == true)
5380 // Handle short circuit modes
5381 if(mode == RUN_CALLBACKS_MODE_AND_SC &&
5382 lua_toboolean(L, rv) == false)
5384 else if(mode == RUN_CALLBACKS_MODE_OR_SC &&
5385 lua_toboolean(L, rv) == true)
5388 // value removed, keep key for next iteration
5391 // Remove stuff from stack, leaving only the return value
5394 // Fix return value in case no callbacks were called
5396 if(mode == RUN_CALLBACKS_MODE_AND ||
5397 mode == RUN_CALLBACKS_MODE_AND_SC){
5399 lua_pushboolean(L, true);
5401 else if(mode == RUN_CALLBACKS_MODE_OR ||
5402 mode == RUN_CALLBACKS_MODE_OR_SC){
5404 lua_pushboolean(L, false);
5409 bool scriptapi_on_chat_message(lua_State *L, const std::string &name,
5410 const std::string &message)
5413 assert(lua_checkstack(L, 20));
5414 StackUnroller stack_unroller(L);
5416 // Get minetest.registered_on_chat_messages
5417 lua_getglobal(L, "minetest");
5418 lua_getfield(L, -1, "registered_on_chat_messages");
5420 lua_pushstring(L, name.c_str());
5421 lua_pushstring(L, message.c_str());
5422 scriptapi_run_callbacks(L, 2, RUN_CALLBACKS_MODE_OR_SC);
5423 bool ate = lua_toboolean(L, -1);
5427 void scriptapi_on_newplayer(lua_State *L, ServerActiveObject *player)
5430 assert(lua_checkstack(L, 20));
5431 StackUnroller stack_unroller(L);
5433 // Get minetest.registered_on_newplayers
5434 lua_getglobal(L, "minetest");
5435 lua_getfield(L, -1, "registered_on_newplayers");
5437 objectref_get_or_create(L, player);
5438 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
5441 void scriptapi_on_dieplayer(lua_State *L, ServerActiveObject *player)
5444 assert(lua_checkstack(L, 20));
5445 StackUnroller stack_unroller(L);
5447 // Get minetest.registered_on_dieplayers
5448 lua_getglobal(L, "minetest");
5449 lua_getfield(L, -1, "registered_on_dieplayers");
5451 objectref_get_or_create(L, player);
5452 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
5455 bool scriptapi_on_respawnplayer(lua_State *L, ServerActiveObject *player)
5458 assert(lua_checkstack(L, 20));
5459 StackUnroller stack_unroller(L);
5461 // Get minetest.registered_on_respawnplayers
5462 lua_getglobal(L, "minetest");
5463 lua_getfield(L, -1, "registered_on_respawnplayers");
5465 objectref_get_or_create(L, player);
5466 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_OR);
5467 bool positioning_handled_by_some = lua_toboolean(L, -1);
5468 return positioning_handled_by_some;
5471 void scriptapi_on_joinplayer(lua_State *L, ServerActiveObject *player)
5474 assert(lua_checkstack(L, 20));
5475 StackUnroller stack_unroller(L);
5477 // Get minetest.registered_on_joinplayers
5478 lua_getglobal(L, "minetest");
5479 lua_getfield(L, -1, "registered_on_joinplayers");
5481 objectref_get_or_create(L, player);
5482 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
5485 void scriptapi_on_leaveplayer(lua_State *L, ServerActiveObject *player)
5488 assert(lua_checkstack(L, 20));
5489 StackUnroller stack_unroller(L);
5491 // Get minetest.registered_on_leaveplayers
5492 lua_getglobal(L, "minetest");
5493 lua_getfield(L, -1, "registered_on_leaveplayers");
5495 objectref_get_or_create(L, player);
5496 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
5499 static void get_auth_handler(lua_State *L)
5501 lua_getglobal(L, "minetest");
5502 lua_getfield(L, -1, "registered_auth_handler");
5503 if(lua_isnil(L, -1)){
5505 lua_getfield(L, -1, "builtin_auth_handler");
5507 if(lua_type(L, -1) != LUA_TTABLE)
5508 throw LuaError(L, "Authentication handler table not valid");
5511 bool scriptapi_get_auth(lua_State *L, const std::string &playername,
5512 std::string *dst_password, std::set<std::string> *dst_privs)
5515 assert(lua_checkstack(L, 20));
5516 StackUnroller stack_unroller(L);
5518 get_auth_handler(L);
5519 lua_getfield(L, -1, "get_auth");
5520 if(lua_type(L, -1) != LUA_TFUNCTION)
5521 throw LuaError(L, "Authentication handler missing get_auth");
5522 lua_pushstring(L, playername.c_str());
5523 if(lua_pcall(L, 1, 1, 0))
5524 script_error(L, "error: %s", lua_tostring(L, -1));
5526 // nil = login not allowed
5527 if(lua_isnil(L, -1))
5529 luaL_checktype(L, -1, LUA_TTABLE);
5531 std::string password;
5532 bool found = getstringfield(L, -1, "password", password);
5534 throw LuaError(L, "Authentication handler didn't return password");
5536 *dst_password = password;
5538 lua_getfield(L, -1, "privileges");
5539 if(!lua_istable(L, -1))
5541 "Authentication handler didn't return privilege table");
5543 read_privileges(L, -1, *dst_privs);
5549 void scriptapi_create_auth(lua_State *L, const std::string &playername,
5550 const std::string &password)
5553 assert(lua_checkstack(L, 20));
5554 StackUnroller stack_unroller(L);
5556 get_auth_handler(L);
5557 lua_getfield(L, -1, "create_auth");
5558 if(lua_type(L, -1) != LUA_TFUNCTION)
5559 throw LuaError(L, "Authentication handler missing create_auth");
5560 lua_pushstring(L, playername.c_str());
5561 lua_pushstring(L, password.c_str());
5562 if(lua_pcall(L, 2, 0, 0))
5563 script_error(L, "error: %s", lua_tostring(L, -1));
5566 bool scriptapi_set_password(lua_State *L, const std::string &playername,
5567 const std::string &password)
5570 assert(lua_checkstack(L, 20));
5571 StackUnroller stack_unroller(L);
5573 get_auth_handler(L);
5574 lua_getfield(L, -1, "set_password");
5575 if(lua_type(L, -1) != LUA_TFUNCTION)
5576 throw LuaError(L, "Authentication handler missing set_password");
5577 lua_pushstring(L, playername.c_str());
5578 lua_pushstring(L, password.c_str());
5579 if(lua_pcall(L, 2, 1, 0))
5580 script_error(L, "error: %s", lua_tostring(L, -1));
5581 return lua_toboolean(L, -1);
5588 void scriptapi_on_player_receive_fields(lua_State *L,
5589 ServerActiveObject *player,
5590 const std::string &formname,
5591 const std::map<std::string, std::string> &fields)
5594 assert(lua_checkstack(L, 20));
5595 StackUnroller stack_unroller(L);
5597 // Get minetest.registered_on_chat_messages
5598 lua_getglobal(L, "minetest");
5599 lua_getfield(L, -1, "registered_on_player_receive_fields");
5602 objectref_get_or_create(L, player);
5604 lua_pushstring(L, formname.c_str());
5607 for(std::map<std::string, std::string>::const_iterator
5608 i = fields.begin(); i != fields.end(); i++){
5609 const std::string &name = i->first;
5610 const std::string &value = i->second;
5611 lua_pushstring(L, name.c_str());
5612 lua_pushlstring(L, value.c_str(), value.size());
5613 lua_settable(L, -3);
5615 scriptapi_run_callbacks(L, 3, RUN_CALLBACKS_MODE_OR_SC);
5619 item callbacks and node callbacks
5622 // Retrieves minetest.registered_items[name][callbackname]
5623 // If that is nil or on error, return false and stack is unchanged
5624 // If that is a function, returns true and pushes the
5625 // function onto the stack
5626 // If minetest.registered_items[name] doesn't exist, minetest.nodedef_default
5627 // is tried instead so unknown items can still be manipulated to some degree
5628 static bool get_item_callback(lua_State *L,
5629 const char *name, const char *callbackname)
5631 lua_getglobal(L, "minetest");
5632 lua_getfield(L, -1, "registered_items");
5634 luaL_checktype(L, -1, LUA_TTABLE);
5635 lua_getfield(L, -1, name);
5637 // Should be a table
5638 if(lua_type(L, -1) != LUA_TTABLE)
5640 // Report error and clean up
5641 errorstream<<"Item \""<<name<<"\" not defined"<<std::endl;
5644 // Try minetest.nodedef_default instead
5645 lua_getglobal(L, "minetest");
5646 lua_getfield(L, -1, "nodedef_default");
5648 luaL_checktype(L, -1, LUA_TTABLE);
5650 lua_getfield(L, -1, callbackname);
5652 // Should be a function or nil
5653 if(lua_type(L, -1) == LUA_TFUNCTION)
5657 else if(lua_isnil(L, -1))
5664 errorstream<<"Item \""<<name<<"\" callback \""
5665 <<callbackname<<" is not a function"<<std::endl;
5671 bool scriptapi_item_on_drop(lua_State *L, ItemStack &item,
5672 ServerActiveObject *dropper, v3f pos)
5675 assert(lua_checkstack(L, 20));
5676 StackUnroller stack_unroller(L);
5678 // Push callback function on stack
5679 if(!get_item_callback(L, item.name.c_str(), "on_drop"))
5683 LuaItemStack::create(L, item);
5684 objectref_get_or_create(L, dropper);
5685 pushFloatPos(L, pos);
5686 if(lua_pcall(L, 3, 1, 0))
5687 script_error(L, "error: %s", lua_tostring(L, -1));
5688 if(!lua_isnil(L, -1))
5689 item = read_item(L, -1);
5693 bool scriptapi_item_on_place(lua_State *L, ItemStack &item,
5694 ServerActiveObject *placer, const PointedThing &pointed)
5697 assert(lua_checkstack(L, 20));
5698 StackUnroller stack_unroller(L);
5700 // Push callback function on stack
5701 if(!get_item_callback(L, item.name.c_str(), "on_place"))
5705 LuaItemStack::create(L, item);
5706 objectref_get_or_create(L, placer);
5707 push_pointed_thing(L, pointed);
5708 if(lua_pcall(L, 3, 1, 0))
5709 script_error(L, "error: %s", lua_tostring(L, -1));
5710 if(!lua_isnil(L, -1))
5711 item = read_item(L, -1);
5715 bool scriptapi_item_on_use(lua_State *L, ItemStack &item,
5716 ServerActiveObject *user, const PointedThing &pointed)
5719 assert(lua_checkstack(L, 20));
5720 StackUnroller stack_unroller(L);
5722 // Push callback function on stack
5723 if(!get_item_callback(L, item.name.c_str(), "on_use"))
5727 LuaItemStack::create(L, item);
5728 objectref_get_or_create(L, user);
5729 push_pointed_thing(L, pointed);
5730 if(lua_pcall(L, 3, 1, 0))
5731 script_error(L, "error: %s", lua_tostring(L, -1));
5732 if(!lua_isnil(L, -1))
5733 item = read_item(L, -1);
5737 bool scriptapi_node_on_punch(lua_State *L, v3s16 p, MapNode node,
5738 ServerActiveObject *puncher)
5741 assert(lua_checkstack(L, 20));
5742 StackUnroller stack_unroller(L);
5744 INodeDefManager *ndef = get_server(L)->ndef();
5746 // Push callback function on stack
5747 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_punch"))
5752 pushnode(L, node, ndef);
5753 objectref_get_or_create(L, puncher);
5754 if(lua_pcall(L, 3, 0, 0))
5755 script_error(L, "error: %s", lua_tostring(L, -1));
5759 bool scriptapi_node_on_dig(lua_State *L, v3s16 p, MapNode node,
5760 ServerActiveObject *digger)
5763 assert(lua_checkstack(L, 20));
5764 StackUnroller stack_unroller(L);
5766 INodeDefManager *ndef = get_server(L)->ndef();
5768 // Push callback function on stack
5769 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_dig"))
5774 pushnode(L, node, ndef);
5775 objectref_get_or_create(L, digger);
5776 if(lua_pcall(L, 3, 0, 0))
5777 script_error(L, "error: %s", lua_tostring(L, -1));
5781 void scriptapi_node_on_construct(lua_State *L, v3s16 p, MapNode node)
5784 assert(lua_checkstack(L, 20));
5785 StackUnroller stack_unroller(L);
5787 INodeDefManager *ndef = get_server(L)->ndef();
5789 // Push callback function on stack
5790 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_construct"))
5795 if(lua_pcall(L, 1, 0, 0))
5796 script_error(L, "error: %s", lua_tostring(L, -1));
5799 void scriptapi_node_on_destruct(lua_State *L, v3s16 p, MapNode node)
5802 assert(lua_checkstack(L, 20));
5803 StackUnroller stack_unroller(L);
5805 INodeDefManager *ndef = get_server(L)->ndef();
5807 // Push callback function on stack
5808 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_destruct"))
5813 if(lua_pcall(L, 1, 0, 0))
5814 script_error(L, "error: %s", lua_tostring(L, -1));
5817 void scriptapi_node_after_destruct(lua_State *L, v3s16 p, MapNode node)
5820 assert(lua_checkstack(L, 20));
5821 StackUnroller stack_unroller(L);
5823 INodeDefManager *ndef = get_server(L)->ndef();
5825 // Push callback function on stack
5826 if(!get_item_callback(L, ndef->get(node).name.c_str(), "after_destruct"))
5831 pushnode(L, node, ndef);
5832 if(lua_pcall(L, 2, 0, 0))
5833 script_error(L, "error: %s", lua_tostring(L, -1));
5836 bool scriptapi_node_on_timer(lua_State *L, v3s16 p, MapNode node, f32 dtime)
5839 assert(lua_checkstack(L, 20));
5840 StackUnroller stack_unroller(L);
5842 INodeDefManager *ndef = get_server(L)->ndef();
5844 // Push callback function on stack
5845 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_timer"))
5850 lua_pushnumber(L,dtime);
5851 if(lua_pcall(L, 2, 1, 0))
5852 script_error(L, "error: %s", lua_tostring(L, -1));
5853 if(lua_isboolean(L,-1) && lua_toboolean(L,-1) == true)
5859 void scriptapi_node_on_receive_fields(lua_State *L, v3s16 p,
5860 const std::string &formname,
5861 const std::map<std::string, std::string> &fields,
5862 ServerActiveObject *sender)
5865 assert(lua_checkstack(L, 20));
5866 StackUnroller stack_unroller(L);
5868 INodeDefManager *ndef = get_server(L)->ndef();
5870 // If node doesn't exist, we don't know what callback to call
5871 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
5872 if(node.getContent() == CONTENT_IGNORE)
5875 // Push callback function on stack
5876 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_receive_fields"))
5883 lua_pushstring(L, formname.c_str());
5886 for(std::map<std::string, std::string>::const_iterator
5887 i = fields.begin(); i != fields.end(); i++){
5888 const std::string &name = i->first;
5889 const std::string &value = i->second;
5890 lua_pushstring(L, name.c_str());
5891 lua_pushlstring(L, value.c_str(), value.size());
5892 lua_settable(L, -3);
5895 objectref_get_or_create(L, sender);
5896 if(lua_pcall(L, 4, 0, 0))
5897 script_error(L, "error: %s", lua_tostring(L, -1));
5901 Node metadata inventory callbacks
5904 // Return number of accepted items to be moved
5905 int scriptapi_nodemeta_inventory_allow_move(lua_State *L, v3s16 p,
5906 const std::string &from_list, int from_index,
5907 const std::string &to_list, int to_index,
5908 int count, ServerActiveObject *player)
5911 assert(lua_checkstack(L, 20));
5912 StackUnroller stack_unroller(L);
5914 INodeDefManager *ndef = get_server(L)->ndef();
5916 // If node doesn't exist, we don't know what callback to call
5917 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
5918 if(node.getContent() == CONTENT_IGNORE)
5921 // Push callback function on stack
5922 if(!get_item_callback(L, ndef->get(node).name.c_str(),
5923 "allow_metadata_inventory_move"))
5926 // function(pos, from_list, from_index, to_list, to_index, count, player)
5930 lua_pushstring(L, from_list.c_str());
5932 lua_pushinteger(L, from_index + 1);
5934 lua_pushstring(L, to_list.c_str());
5936 lua_pushinteger(L, to_index + 1);
5938 lua_pushinteger(L, count);
5940 objectref_get_or_create(L, player);
5941 if(lua_pcall(L, 7, 1, 0))
5942 script_error(L, "error: %s", lua_tostring(L, -1));
5943 if(!lua_isnumber(L, -1))
5944 throw LuaError(L, "allow_metadata_inventory_move should return a number");
5945 return luaL_checkinteger(L, -1);
5948 // Return number of accepted items to be put
5949 int scriptapi_nodemeta_inventory_allow_put(lua_State *L, v3s16 p,
5950 const std::string &listname, int index, ItemStack &stack,
5951 ServerActiveObject *player)
5954 assert(lua_checkstack(L, 20));
5955 StackUnroller stack_unroller(L);
5957 INodeDefManager *ndef = get_server(L)->ndef();
5959 // If node doesn't exist, we don't know what callback to call
5960 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
5961 if(node.getContent() == CONTENT_IGNORE)
5964 // Push callback function on stack
5965 if(!get_item_callback(L, ndef->get(node).name.c_str(),
5966 "allow_metadata_inventory_put"))
5969 // Call function(pos, listname, index, stack, player)
5973 lua_pushstring(L, listname.c_str());
5975 lua_pushinteger(L, index + 1);
5977 LuaItemStack::create(L, stack);
5979 objectref_get_or_create(L, player);
5980 if(lua_pcall(L, 5, 1, 0))
5981 script_error(L, "error: %s", lua_tostring(L, -1));
5982 if(!lua_isnumber(L, -1))
5983 throw LuaError(L, "allow_metadata_inventory_put should return a number");
5984 return luaL_checkinteger(L, -1);
5987 // Return number of accepted items to be taken
5988 int scriptapi_nodemeta_inventory_allow_take(lua_State *L, v3s16 p,
5989 const std::string &listname, int index, ItemStack &stack,
5990 ServerActiveObject *player)
5993 assert(lua_checkstack(L, 20));
5994 StackUnroller stack_unroller(L);
5996 INodeDefManager *ndef = get_server(L)->ndef();
5998 // If node doesn't exist, we don't know what callback to call
5999 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6000 if(node.getContent() == CONTENT_IGNORE)
6003 // Push callback function on stack
6004 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6005 "allow_metadata_inventory_take"))
6008 // Call function(pos, listname, index, count, player)
6012 lua_pushstring(L, listname.c_str());
6014 lua_pushinteger(L, index + 1);
6016 LuaItemStack::create(L, stack);
6018 objectref_get_or_create(L, player);
6019 if(lua_pcall(L, 5, 1, 0))
6020 script_error(L, "error: %s", lua_tostring(L, -1));
6021 if(!lua_isnumber(L, -1))
6022 throw LuaError(L, "allow_metadata_inventory_take should return a number");
6023 return luaL_checkinteger(L, -1);
6026 // Report moved items
6027 void scriptapi_nodemeta_inventory_on_move(lua_State *L, v3s16 p,
6028 const std::string &from_list, int from_index,
6029 const std::string &to_list, int to_index,
6030 int count, ServerActiveObject *player)
6033 assert(lua_checkstack(L, 20));
6034 StackUnroller stack_unroller(L);
6036 INodeDefManager *ndef = get_server(L)->ndef();
6038 // If node doesn't exist, we don't know what callback to call
6039 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6040 if(node.getContent() == CONTENT_IGNORE)
6043 // Push callback function on stack
6044 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6045 "on_metadata_inventory_move"))
6048 // function(pos, from_list, from_index, to_list, to_index, count, player)
6052 lua_pushstring(L, from_list.c_str());
6054 lua_pushinteger(L, from_index + 1);
6056 lua_pushstring(L, to_list.c_str());
6058 lua_pushinteger(L, to_index + 1);
6060 lua_pushinteger(L, count);
6062 objectref_get_or_create(L, player);
6063 if(lua_pcall(L, 7, 0, 0))
6064 script_error(L, "error: %s", lua_tostring(L, -1));
6068 void scriptapi_nodemeta_inventory_on_put(lua_State *L, v3s16 p,
6069 const std::string &listname, int index, ItemStack &stack,
6070 ServerActiveObject *player)
6073 assert(lua_checkstack(L, 20));
6074 StackUnroller stack_unroller(L);
6076 INodeDefManager *ndef = get_server(L)->ndef();
6078 // If node doesn't exist, we don't know what callback to call
6079 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6080 if(node.getContent() == CONTENT_IGNORE)
6083 // Push callback function on stack
6084 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6085 "on_metadata_inventory_put"))
6088 // Call function(pos, listname, index, stack, player)
6092 lua_pushstring(L, listname.c_str());
6094 lua_pushinteger(L, index + 1);
6096 LuaItemStack::create(L, stack);
6098 objectref_get_or_create(L, player);
6099 if(lua_pcall(L, 5, 0, 0))
6100 script_error(L, "error: %s", lua_tostring(L, -1));
6103 // Report taken items
6104 void scriptapi_nodemeta_inventory_on_take(lua_State *L, v3s16 p,
6105 const std::string &listname, int index, ItemStack &stack,
6106 ServerActiveObject *player)
6109 assert(lua_checkstack(L, 20));
6110 StackUnroller stack_unroller(L);
6112 INodeDefManager *ndef = get_server(L)->ndef();
6114 // If node doesn't exist, we don't know what callback to call
6115 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6116 if(node.getContent() == CONTENT_IGNORE)
6119 // Push callback function on stack
6120 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6121 "on_metadata_inventory_take"))
6124 // Call function(pos, listname, index, stack, player)
6128 lua_pushstring(L, listname.c_str());
6130 lua_pushinteger(L, index + 1);
6132 LuaItemStack::create(L, stack);
6134 objectref_get_or_create(L, player);
6135 if(lua_pcall(L, 5, 0, 0))
6136 script_error(L, "error: %s", lua_tostring(L, -1));
6140 Detached inventory callbacks
6143 // Retrieves minetest.detached_inventories[name][callbackname]
6144 // If that is nil or on error, return false and stack is unchanged
6145 // If that is a function, returns true and pushes the
6146 // function onto the stack
6147 static bool get_detached_inventory_callback(lua_State *L,
6148 const std::string &name, const char *callbackname)
6150 lua_getglobal(L, "minetest");
6151 lua_getfield(L, -1, "detached_inventories");
6153 luaL_checktype(L, -1, LUA_TTABLE);
6154 lua_getfield(L, -1, name.c_str());
6156 // Should be a table
6157 if(lua_type(L, -1) != LUA_TTABLE)
6159 errorstream<<"Item \""<<name<<"\" not defined"<<std::endl;
6163 lua_getfield(L, -1, callbackname);
6165 // Should be a function or nil
6166 if(lua_type(L, -1) == LUA_TFUNCTION)
6170 else if(lua_isnil(L, -1))
6177 errorstream<<"Detached inventory \""<<name<<"\" callback \""
6178 <<callbackname<<"\" is not a function"<<std::endl;
6184 // Return number of accepted items to be moved
6185 int scriptapi_detached_inventory_allow_move(lua_State *L,
6186 const std::string &name,
6187 const std::string &from_list, int from_index,
6188 const std::string &to_list, int to_index,
6189 int count, ServerActiveObject *player)
6192 assert(lua_checkstack(L, 20));
6193 StackUnroller stack_unroller(L);
6195 // Push callback function on stack
6196 if(!get_detached_inventory_callback(L, name, "allow_move"))
6199 // function(inv, from_list, from_index, to_list, to_index, count, player)
6201 InventoryLocation loc;
6202 loc.setDetached(name);
6203 InvRef::create(L, loc);
6205 lua_pushstring(L, from_list.c_str());
6207 lua_pushinteger(L, from_index + 1);
6209 lua_pushstring(L, to_list.c_str());
6211 lua_pushinteger(L, to_index + 1);
6213 lua_pushinteger(L, count);
6215 objectref_get_or_create(L, player);
6216 if(lua_pcall(L, 7, 1, 0))
6217 script_error(L, "error: %s", lua_tostring(L, -1));
6218 if(!lua_isnumber(L, -1))
6219 throw LuaError(L, "allow_move should return a number");
6220 return luaL_checkinteger(L, -1);
6223 // Return number of accepted items to be put
6224 int scriptapi_detached_inventory_allow_put(lua_State *L,
6225 const std::string &name,
6226 const std::string &listname, int index, ItemStack &stack,
6227 ServerActiveObject *player)
6230 assert(lua_checkstack(L, 20));
6231 StackUnroller stack_unroller(L);
6233 // Push callback function on stack
6234 if(!get_detached_inventory_callback(L, name, "allow_put"))
6235 return stack.count; // All will be accepted
6237 // Call function(inv, listname, index, stack, player)
6239 InventoryLocation loc;
6240 loc.setDetached(name);
6241 InvRef::create(L, loc);
6243 lua_pushstring(L, listname.c_str());
6245 lua_pushinteger(L, index + 1);
6247 LuaItemStack::create(L, stack);
6249 objectref_get_or_create(L, player);
6250 if(lua_pcall(L, 5, 1, 0))
6251 script_error(L, "error: %s", lua_tostring(L, -1));
6252 if(!lua_isnumber(L, -1))
6253 throw LuaError(L, "allow_put should return a number");
6254 return luaL_checkinteger(L, -1);
6257 // Return number of accepted items to be taken
6258 int scriptapi_detached_inventory_allow_take(lua_State *L,
6259 const std::string &name,
6260 const std::string &listname, int index, ItemStack &stack,
6261 ServerActiveObject *player)
6264 assert(lua_checkstack(L, 20));
6265 StackUnroller stack_unroller(L);
6267 // Push callback function on stack
6268 if(!get_detached_inventory_callback(L, name, "allow_take"))
6269 return stack.count; // All will be accepted
6271 // Call function(inv, listname, index, stack, player)
6273 InventoryLocation loc;
6274 loc.setDetached(name);
6275 InvRef::create(L, loc);
6277 lua_pushstring(L, listname.c_str());
6279 lua_pushinteger(L, index + 1);
6281 LuaItemStack::create(L, stack);
6283 objectref_get_or_create(L, player);
6284 if(lua_pcall(L, 5, 1, 0))
6285 script_error(L, "error: %s", lua_tostring(L, -1));
6286 if(!lua_isnumber(L, -1))
6287 throw LuaError(L, "allow_take should return a number");
6288 return luaL_checkinteger(L, -1);
6291 // Report moved items
6292 void scriptapi_detached_inventory_on_move(lua_State *L,
6293 const std::string &name,
6294 const std::string &from_list, int from_index,
6295 const std::string &to_list, int to_index,
6296 int count, ServerActiveObject *player)
6299 assert(lua_checkstack(L, 20));
6300 StackUnroller stack_unroller(L);
6302 // Push callback function on stack
6303 if(!get_detached_inventory_callback(L, name, "on_move"))
6306 // function(inv, from_list, from_index, to_list, to_index, count, player)
6308 InventoryLocation loc;
6309 loc.setDetached(name);
6310 InvRef::create(L, loc);
6312 lua_pushstring(L, from_list.c_str());
6314 lua_pushinteger(L, from_index + 1);
6316 lua_pushstring(L, to_list.c_str());
6318 lua_pushinteger(L, to_index + 1);
6320 lua_pushinteger(L, count);
6322 objectref_get_or_create(L, player);
6323 if(lua_pcall(L, 7, 0, 0))
6324 script_error(L, "error: %s", lua_tostring(L, -1));
6328 void scriptapi_detached_inventory_on_put(lua_State *L,
6329 const std::string &name,
6330 const std::string &listname, int index, ItemStack &stack,
6331 ServerActiveObject *player)
6334 assert(lua_checkstack(L, 20));
6335 StackUnroller stack_unroller(L);
6337 // Push callback function on stack
6338 if(!get_detached_inventory_callback(L, name, "on_put"))
6341 // Call function(inv, listname, index, stack, player)
6343 InventoryLocation loc;
6344 loc.setDetached(name);
6345 InvRef::create(L, loc);
6347 lua_pushstring(L, listname.c_str());
6349 lua_pushinteger(L, index + 1);
6351 LuaItemStack::create(L, stack);
6353 objectref_get_or_create(L, player);
6354 if(lua_pcall(L, 5, 0, 0))
6355 script_error(L, "error: %s", lua_tostring(L, -1));
6358 // Report taken items
6359 void scriptapi_detached_inventory_on_take(lua_State *L,
6360 const std::string &name,
6361 const std::string &listname, int index, ItemStack &stack,
6362 ServerActiveObject *player)
6365 assert(lua_checkstack(L, 20));
6366 StackUnroller stack_unroller(L);
6368 // Push callback function on stack
6369 if(!get_detached_inventory_callback(L, name, "on_take"))
6372 // Call function(inv, listname, index, stack, player)
6374 InventoryLocation loc;
6375 loc.setDetached(name);
6376 InvRef::create(L, loc);
6378 lua_pushstring(L, listname.c_str());
6380 lua_pushinteger(L, index + 1);
6382 LuaItemStack::create(L, stack);
6384 objectref_get_or_create(L, player);
6385 if(lua_pcall(L, 5, 0, 0))
6386 script_error(L, "error: %s", lua_tostring(L, -1));
6393 void scriptapi_environment_step(lua_State *L, float dtime)
6396 assert(lua_checkstack(L, 20));
6397 //infostream<<"scriptapi_environment_step"<<std::endl;
6398 StackUnroller stack_unroller(L);
6400 // Get minetest.registered_globalsteps
6401 lua_getglobal(L, "minetest");
6402 lua_getfield(L, -1, "registered_globalsteps");
6404 lua_pushnumber(L, dtime);
6405 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
6408 void scriptapi_environment_on_generated(lua_State *L, v3s16 minp, v3s16 maxp,
6412 assert(lua_checkstack(L, 20));
6413 //infostream<<"scriptapi_environment_on_generated"<<std::endl;
6414 StackUnroller stack_unroller(L);
6416 // Get minetest.registered_on_generateds
6417 lua_getglobal(L, "minetest");
6418 lua_getfield(L, -1, "registered_on_generateds");
6420 push_v3s16(L, minp);
6421 push_v3s16(L, maxp);
6422 lua_pushnumber(L, blockseed);
6423 scriptapi_run_callbacks(L, 3, RUN_CALLBACKS_MODE_FIRST);
6430 bool scriptapi_luaentity_add(lua_State *L, u16 id, const char *name)
6433 assert(lua_checkstack(L, 20));
6434 verbosestream<<"scriptapi_luaentity_add: id="<<id<<" name=\""
6435 <<name<<"\""<<std::endl;
6436 StackUnroller stack_unroller(L);
6438 // Get minetest.registered_entities[name]
6439 lua_getglobal(L, "minetest");
6440 lua_getfield(L, -1, "registered_entities");
6441 luaL_checktype(L, -1, LUA_TTABLE);
6442 lua_pushstring(L, name);
6443 lua_gettable(L, -2);
6444 // Should be a table, which we will use as a prototype
6445 //luaL_checktype(L, -1, LUA_TTABLE);
6446 if(lua_type(L, -1) != LUA_TTABLE){
6447 errorstream<<"LuaEntity name \""<<name<<"\" not defined"<<std::endl;
6450 int prototype_table = lua_gettop(L);
6451 //dump2(L, "prototype_table");
6453 // Create entity object
6455 int object = lua_gettop(L);
6457 // Set object metatable
6458 lua_pushvalue(L, prototype_table);
6459 lua_setmetatable(L, -2);
6461 // Add object reference
6462 // This should be userdata with metatable ObjectRef
6463 objectref_get(L, id);
6464 luaL_checktype(L, -1, LUA_TUSERDATA);
6465 if(!luaL_checkudata(L, -1, "ObjectRef"))
6466 luaL_typerror(L, -1, "ObjectRef");
6467 lua_setfield(L, -2, "object");
6469 // minetest.luaentities[id] = object
6470 lua_getglobal(L, "minetest");
6471 lua_getfield(L, -1, "luaentities");
6472 luaL_checktype(L, -1, LUA_TTABLE);
6473 lua_pushnumber(L, id); // Push id
6474 lua_pushvalue(L, object); // Copy object to top of stack
6475 lua_settable(L, -3);
6480 void scriptapi_luaentity_activate(lua_State *L, u16 id,
6481 const std::string &staticdata)
6484 assert(lua_checkstack(L, 20));
6485 verbosestream<<"scriptapi_luaentity_activate: id="<<id<<std::endl;
6486 StackUnroller stack_unroller(L);
6488 // Get minetest.luaentities[id]
6489 luaentity_get(L, id);
6490 int object = lua_gettop(L);
6492 // Get on_activate function
6493 lua_pushvalue(L, object);
6494 lua_getfield(L, -1, "on_activate");
6495 if(!lua_isnil(L, -1)){
6496 luaL_checktype(L, -1, LUA_TFUNCTION);
6497 lua_pushvalue(L, object); // self
6498 lua_pushlstring(L, staticdata.c_str(), staticdata.size());
6499 // Call with 2 arguments, 0 results
6500 if(lua_pcall(L, 2, 0, 0))
6501 script_error(L, "error running function on_activate: %s\n",
6502 lua_tostring(L, -1));
6506 void scriptapi_luaentity_rm(lua_State *L, u16 id)
6509 assert(lua_checkstack(L, 20));
6510 verbosestream<<"scriptapi_luaentity_rm: id="<<id<<std::endl;
6512 // Get minetest.luaentities table
6513 lua_getglobal(L, "minetest");
6514 lua_getfield(L, -1, "luaentities");
6515 luaL_checktype(L, -1, LUA_TTABLE);
6516 int objectstable = lua_gettop(L);
6518 // Set luaentities[id] = nil
6519 lua_pushnumber(L, id); // Push id
6521 lua_settable(L, objectstable);
6523 lua_pop(L, 2); // pop luaentities, minetest
6526 std::string scriptapi_luaentity_get_staticdata(lua_State *L, u16 id)
6529 assert(lua_checkstack(L, 20));
6530 //infostream<<"scriptapi_luaentity_get_staticdata: id="<<id<<std::endl;
6531 StackUnroller stack_unroller(L);
6533 // Get minetest.luaentities[id]
6534 luaentity_get(L, id);
6535 int object = lua_gettop(L);
6537 // Get get_staticdata function
6538 lua_pushvalue(L, object);
6539 lua_getfield(L, -1, "get_staticdata");
6540 if(lua_isnil(L, -1))
6543 luaL_checktype(L, -1, LUA_TFUNCTION);
6544 lua_pushvalue(L, object); // self
6545 // Call with 1 arguments, 1 results
6546 if(lua_pcall(L, 1, 1, 0))
6547 script_error(L, "error running function get_staticdata: %s\n",
6548 lua_tostring(L, -1));
6551 const char *s = lua_tolstring(L, -1, &len);
6552 return std::string(s, len);
6555 void scriptapi_luaentity_get_properties(lua_State *L, u16 id,
6556 ObjectProperties *prop)
6559 assert(lua_checkstack(L, 20));
6560 //infostream<<"scriptapi_luaentity_get_properties: id="<<id<<std::endl;
6561 StackUnroller stack_unroller(L);
6563 // Get minetest.luaentities[id]
6564 luaentity_get(L, id);
6565 //int object = lua_gettop(L);
6567 // Set default values that differ from ObjectProperties defaults
6572 prop->hp_max = getintfield_default(L, -1, "hp_max", 10);
6574 getboolfield(L, -1, "physical", prop->physical);
6576 getfloatfield(L, -1, "weight", prop->weight);
6578 lua_getfield(L, -1, "collisionbox");
6579 if(lua_istable(L, -1))
6580 prop->collisionbox = read_aabb3f(L, -1, 1.0);
6583 getstringfield(L, -1, "visual", prop->visual);
6585 // Deprecated: read object properties directly
6586 read_object_properties(L, -1, prop);
6588 // Read initial_properties
6589 lua_getfield(L, -1, "initial_properties");
6590 read_object_properties(L, -1, prop);
6594 void scriptapi_luaentity_step(lua_State *L, u16 id, float dtime)
6597 assert(lua_checkstack(L, 20));
6598 //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
6599 StackUnroller stack_unroller(L);
6601 // Get minetest.luaentities[id]
6602 luaentity_get(L, id);
6603 int object = lua_gettop(L);
6604 // State: object is at top of stack
6605 // Get step function
6606 lua_getfield(L, -1, "on_step");
6607 if(lua_isnil(L, -1))
6609 luaL_checktype(L, -1, LUA_TFUNCTION);
6610 lua_pushvalue(L, object); // self
6611 lua_pushnumber(L, dtime); // dtime
6612 // Call with 2 arguments, 0 results
6613 if(lua_pcall(L, 2, 0, 0))
6614 script_error(L, "error running function 'on_step': %s\n", lua_tostring(L, -1));
6617 // Calls entity:on_punch(ObjectRef puncher, time_from_last_punch,
6618 // tool_capabilities, direction)
6619 void scriptapi_luaentity_punch(lua_State *L, u16 id,
6620 ServerActiveObject *puncher, float time_from_last_punch,
6621 const ToolCapabilities *toolcap, v3f dir)
6624 assert(lua_checkstack(L, 20));
6625 //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
6626 StackUnroller stack_unroller(L);
6628 // Get minetest.luaentities[id]
6629 luaentity_get(L, id);
6630 int object = lua_gettop(L);
6631 // State: object is at top of stack
6633 lua_getfield(L, -1, "on_punch");
6634 if(lua_isnil(L, -1))
6636 luaL_checktype(L, -1, LUA_TFUNCTION);
6637 lua_pushvalue(L, object); // self
6638 objectref_get_or_create(L, puncher); // Clicker reference
6639 lua_pushnumber(L, time_from_last_punch);
6640 push_tool_capabilities(L, *toolcap);
6642 // Call with 5 arguments, 0 results
6643 if(lua_pcall(L, 5, 0, 0))
6644 script_error(L, "error running function 'on_punch': %s\n", lua_tostring(L, -1));
6647 // Calls entity:on_rightclick(ObjectRef clicker)
6648 void scriptapi_luaentity_rightclick(lua_State *L, u16 id,
6649 ServerActiveObject *clicker)
6652 assert(lua_checkstack(L, 20));
6653 //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
6654 StackUnroller stack_unroller(L);
6656 // Get minetest.luaentities[id]
6657 luaentity_get(L, id);
6658 int object = lua_gettop(L);
6659 // State: object is at top of stack
6661 lua_getfield(L, -1, "on_rightclick");
6662 if(lua_isnil(L, -1))
6664 luaL_checktype(L, -1, LUA_TFUNCTION);
6665 lua_pushvalue(L, object); // self
6666 objectref_get_or_create(L, clicker); // Clicker reference
6667 // Call with 2 arguments, 0 results
6668 if(lua_pcall(L, 2, 0, 0))
6669 script_error(L, "error running function 'on_rightclick': %s\n", lua_tostring(L, -1));