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 getstringfield(L, -1, "mesh", prop->mesh);
942 lua_getfield(L, -1, "visual_size");
943 if(lua_istable(L, -1))
944 prop->visual_size = read_v2f(L, -1);
947 lua_getfield(L, -1, "textures");
948 if(lua_istable(L, -1)){
949 prop->textures.clear();
950 int table = lua_gettop(L);
952 while(lua_next(L, table) != 0){
953 // key at index -2 and value at index -1
954 if(lua_isstring(L, -1))
955 prop->textures.push_back(lua_tostring(L, -1));
957 prop->textures.push_back("");
958 // removes value, keeps key for next iteration
964 lua_getfield(L, -1, "colors");
965 if(lua_istable(L, -1)){
966 prop->colors.clear();
967 int table = lua_gettop(L);
969 while(lua_next(L, table) != 0){
970 // key at index -2 and value at index -1
971 if(lua_isstring(L, -1))
972 prop->colors.push_back(readARGB8(L, -1));
974 prop->colors.push_back(video::SColor(255, 255, 255, 255));
975 // removes value, keeps key for next iteration
981 lua_getfield(L, -1, "spritediv");
982 if(lua_istable(L, -1))
983 prop->spritediv = read_v2s16(L, -1);
986 lua_getfield(L, -1, "initial_sprite_basepos");
987 if(lua_istable(L, -1))
988 prop->initial_sprite_basepos = read_v2s16(L, -1);
991 getboolfield(L, -1, "is_visible", prop->is_visible);
992 getboolfield(L, -1, "makes_footstep_sound", prop->makes_footstep_sound);
993 getfloatfield(L, -1, "automatic_rotate", prop->automatic_rotate);
1000 static ItemDefinition read_item_definition(lua_State *L, int index,
1001 ItemDefinition default_def = ItemDefinition())
1004 index = lua_gettop(L) + 1 + index;
1006 // Read the item definition
1007 ItemDefinition def = default_def;
1009 def.type = (ItemType)getenumfield(L, index, "type",
1010 es_ItemType, ITEM_NONE);
1011 getstringfield(L, index, "name", def.name);
1012 getstringfield(L, index, "description", def.description);
1013 getstringfield(L, index, "inventory_image", def.inventory_image);
1014 getstringfield(L, index, "wield_image", def.wield_image);
1016 lua_getfield(L, index, "wield_scale");
1017 if(lua_istable(L, -1)){
1018 def.wield_scale = check_v3f(L, -1);
1022 def.stack_max = getintfield_default(L, index, "stack_max", def.stack_max);
1023 if(def.stack_max == 0)
1026 lua_getfield(L, index, "on_use");
1027 def.usable = lua_isfunction(L, -1);
1030 getboolfield(L, index, "liquids_pointable", def.liquids_pointable);
1032 warn_if_field_exists(L, index, "tool_digging_properties",
1033 "deprecated: use tool_capabilities");
1035 lua_getfield(L, index, "tool_capabilities");
1036 if(lua_istable(L, -1)){
1037 def.tool_capabilities = new ToolCapabilities(
1038 read_tool_capabilities(L, -1));
1041 // If name is "" (hand), ensure there are ToolCapabilities
1042 // because it will be looked up there whenever any other item has
1043 // no ToolCapabilities
1044 if(def.name == "" && def.tool_capabilities == NULL){
1045 def.tool_capabilities = new ToolCapabilities();
1048 lua_getfield(L, index, "groups");
1049 read_groups(L, -1, def.groups);
1052 // Client shall immediately place this node when player places the item.
1053 // Server will update the precise end result a moment later.
1054 // "" = no prediction
1055 getstringfield(L, index, "node_placement_prediction",
1056 def.node_placement_prediction);
1065 static TileDef read_tiledef(lua_State *L, int index)
1068 index = lua_gettop(L) + 1 + index;
1072 // key at index -2 and value at index
1073 if(lua_isstring(L, index)){
1074 // "default_lava.png"
1075 tiledef.name = lua_tostring(L, index);
1077 else if(lua_istable(L, index))
1079 // {name="default_lava.png", animation={}}
1081 getstringfield(L, index, "name", tiledef.name);
1082 getstringfield(L, index, "image", tiledef.name); // MaterialSpec compat.
1083 tiledef.backface_culling = getboolfield_default(
1084 L, index, "backface_culling", true);
1086 lua_getfield(L, index, "animation");
1087 if(lua_istable(L, -1)){
1088 // {type="vertical_frames", aspect_w=16, aspect_h=16, length=2.0}
1089 tiledef.animation.type = (TileAnimationType)
1090 getenumfield(L, -1, "type", es_TileAnimationType,
1092 tiledef.animation.aspect_w =
1093 getintfield_default(L, -1, "aspect_w", 16);
1094 tiledef.animation.aspect_h =
1095 getintfield_default(L, -1, "aspect_h", 16);
1096 tiledef.animation.length =
1097 getfloatfield_default(L, -1, "length", 1.0);
1109 static ContentFeatures read_content_features(lua_State *L, int index)
1112 index = lua_gettop(L) + 1 + index;
1116 /* Cache existence of some callbacks */
1117 lua_getfield(L, index, "on_construct");
1118 if(!lua_isnil(L, -1)) f.has_on_construct = true;
1120 lua_getfield(L, index, "on_destruct");
1121 if(!lua_isnil(L, -1)) f.has_on_destruct = true;
1123 lua_getfield(L, index, "after_destruct");
1124 if(!lua_isnil(L, -1)) f.has_after_destruct = true;
1128 getstringfield(L, index, "name", f.name);
1131 lua_getfield(L, index, "groups");
1132 read_groups(L, -1, f.groups);
1135 /* Visual definition */
1137 f.drawtype = (NodeDrawType)getenumfield(L, index, "drawtype", es_DrawType,
1139 getfloatfield(L, index, "visual_scale", f.visual_scale);
1142 lua_getfield(L, index, "tiles");
1143 // If nil, try the deprecated name "tile_images" instead
1144 if(lua_isnil(L, -1)){
1146 warn_if_field_exists(L, index, "tile_images",
1147 "Deprecated; new name is \"tiles\".");
1148 lua_getfield(L, index, "tile_images");
1150 if(lua_istable(L, -1)){
1151 int table = lua_gettop(L);
1154 while(lua_next(L, table) != 0){
1155 // Read tiledef from value
1156 f.tiledef[i] = read_tiledef(L, -1);
1157 // removes value, keeps key for next iteration
1165 // Copy last value to all remaining textures
1167 TileDef lasttile = f.tiledef[i-1];
1169 f.tiledef[i] = lasttile;
1176 // special_tiles = {}
1177 lua_getfield(L, index, "special_tiles");
1178 // If nil, try the deprecated name "special_materials" instead
1179 if(lua_isnil(L, -1)){
1181 warn_if_field_exists(L, index, "special_materials",
1182 "Deprecated; new name is \"special_tiles\".");
1183 lua_getfield(L, index, "special_materials");
1185 if(lua_istable(L, -1)){
1186 int table = lua_gettop(L);
1189 while(lua_next(L, table) != 0){
1190 // Read tiledef from value
1191 f.tiledef_special[i] = read_tiledef(L, -1);
1192 // removes value, keeps key for next iteration
1203 f.alpha = getintfield_default(L, index, "alpha", 255);
1207 lua_getfield(L, index, "post_effect_color");
1208 if(!lua_isnil(L, -1))
1209 f.post_effect_color = readARGB8(L, -1);
1212 f.param_type = (ContentParamType)getenumfield(L, index, "paramtype",
1213 es_ContentParamType, CPT_NONE);
1214 f.param_type_2 = (ContentParamType2)getenumfield(L, index, "paramtype2",
1215 es_ContentParamType2, CPT2_NONE);
1217 // Warn about some deprecated fields
1218 warn_if_field_exists(L, index, "wall_mounted",
1219 "deprecated: use paramtype2 = 'wallmounted'");
1220 warn_if_field_exists(L, index, "light_propagates",
1221 "deprecated: determined from paramtype");
1222 warn_if_field_exists(L, index, "dug_item",
1223 "deprecated: use 'drop' field");
1224 warn_if_field_exists(L, index, "extra_dug_item",
1225 "deprecated: use 'drop' field");
1226 warn_if_field_exists(L, index, "extra_dug_item_rarity",
1227 "deprecated: use 'drop' field");
1228 warn_if_field_exists(L, index, "metadata_name",
1229 "deprecated: use on_add and metadata callbacks");
1231 // True for all ground-like things like stone and mud, false for eg. trees
1232 getboolfield(L, index, "is_ground_content", f.is_ground_content);
1233 f.light_propagates = (f.param_type == CPT_LIGHT);
1234 getboolfield(L, index, "sunlight_propagates", f.sunlight_propagates);
1235 // This is used for collision detection.
1236 // Also for general solidness queries.
1237 getboolfield(L, index, "walkable", f.walkable);
1238 // Player can point to these
1239 getboolfield(L, index, "pointable", f.pointable);
1240 // Player can dig these
1241 getboolfield(L, index, "diggable", f.diggable);
1242 // Player can climb these
1243 getboolfield(L, index, "climbable", f.climbable);
1244 // Player can build on these
1245 getboolfield(L, index, "buildable_to", f.buildable_to);
1246 // Whether the node is non-liquid, source liquid or flowing liquid
1247 f.liquid_type = (LiquidType)getenumfield(L, index, "liquidtype",
1248 es_LiquidType, LIQUID_NONE);
1249 // If the content is liquid, this is the flowing version of the liquid.
1250 getstringfield(L, index, "liquid_alternative_flowing",
1251 f.liquid_alternative_flowing);
1252 // If the content is liquid, this is the source version of the liquid.
1253 getstringfield(L, index, "liquid_alternative_source",
1254 f.liquid_alternative_source);
1255 // Viscosity for fluid flow, ranging from 1 to 7, with
1256 // 1 giving almost instantaneous propagation and 7 being
1257 // the slowest possible
1258 f.liquid_viscosity = getintfield_default(L, index,
1259 "liquid_viscosity", f.liquid_viscosity);
1260 getboolfield(L, index, "liquid_renewable", f.liquid_renewable);
1261 // Amount of light the node emits
1262 f.light_source = getintfield_default(L, index,
1263 "light_source", f.light_source);
1264 f.damage_per_second = getintfield_default(L, index,
1265 "damage_per_second", f.damage_per_second);
1267 lua_getfield(L, index, "node_box");
1268 if(lua_istable(L, -1))
1269 f.node_box = read_nodebox(L, -1);
1272 lua_getfield(L, index, "selection_box");
1273 if(lua_istable(L, -1))
1274 f.selection_box = read_nodebox(L, -1);
1277 // Set to true if paramtype used to be 'facedir_simple'
1278 getboolfield(L, index, "legacy_facedir_simple", f.legacy_facedir_simple);
1279 // Set to true if wall_mounted used to be set to true
1280 getboolfield(L, index, "legacy_wallmounted", f.legacy_wallmounted);
1283 lua_getfield(L, index, "sounds");
1284 if(lua_istable(L, -1)){
1285 lua_getfield(L, -1, "footstep");
1286 read_soundspec(L, -1, f.sound_footstep);
1288 lua_getfield(L, -1, "dig");
1289 read_soundspec(L, -1, f.sound_dig);
1291 lua_getfield(L, -1, "dug");
1292 read_soundspec(L, -1, f.sound_dug);
1304 static ItemStack read_item(lua_State *L, int index);
1305 static std::vector<ItemStack> read_items(lua_State *L, int index);
1306 // creates a table of ItemStacks
1307 static void push_items(lua_State *L, const std::vector<ItemStack> &items);
1309 static void inventory_set_list_from_lua(Inventory *inv, const char *name,
1310 lua_State *L, int tableindex, int forcesize=-1)
1313 tableindex = lua_gettop(L) + 1 + tableindex;
1314 // If nil, delete list
1315 if(lua_isnil(L, tableindex)){
1316 inv->deleteList(name);
1319 // Otherwise set list
1320 std::vector<ItemStack> items = read_items(L, tableindex);
1321 int listsize = (forcesize != -1) ? forcesize : items.size();
1322 InventoryList *invlist = inv->addList(name, listsize);
1324 for(std::vector<ItemStack>::const_iterator
1325 i = items.begin(); i != items.end(); i++){
1326 if(forcesize != -1 && index == forcesize)
1328 invlist->changeItem(index, *i);
1331 while(forcesize != -1 && index < forcesize){
1332 invlist->deleteItem(index);
1337 static void inventory_get_list_to_lua(Inventory *inv, const char *name,
1340 InventoryList *invlist = inv->getList(name);
1341 if(invlist == NULL){
1345 std::vector<ItemStack> items;
1346 for(u32 i=0; i<invlist->getSize(); i++)
1347 items.push_back(invlist->getItem(i));
1348 push_items(L, items);
1352 Helpful macros for userdata classes
1355 #define method(class, name) {#name, class::l_##name}
1366 static const char className[];
1367 static const luaL_reg methods[];
1369 // Exported functions
1371 // garbage collector
1372 static int gc_object(lua_State *L)
1374 LuaItemStack *o = *(LuaItemStack **)(lua_touserdata(L, 1));
1379 // is_empty(self) -> true/false
1380 static int l_is_empty(lua_State *L)
1382 LuaItemStack *o = checkobject(L, 1);
1383 ItemStack &item = o->m_stack;
1384 lua_pushboolean(L, item.empty());
1388 // get_name(self) -> string
1389 static int l_get_name(lua_State *L)
1391 LuaItemStack *o = checkobject(L, 1);
1392 ItemStack &item = o->m_stack;
1393 lua_pushstring(L, item.name.c_str());
1397 // get_count(self) -> number
1398 static int l_get_count(lua_State *L)
1400 LuaItemStack *o = checkobject(L, 1);
1401 ItemStack &item = o->m_stack;
1402 lua_pushinteger(L, item.count);
1406 // get_wear(self) -> number
1407 static int l_get_wear(lua_State *L)
1409 LuaItemStack *o = checkobject(L, 1);
1410 ItemStack &item = o->m_stack;
1411 lua_pushinteger(L, item.wear);
1415 // get_metadata(self) -> string
1416 static int l_get_metadata(lua_State *L)
1418 LuaItemStack *o = checkobject(L, 1);
1419 ItemStack &item = o->m_stack;
1420 lua_pushlstring(L, item.metadata.c_str(), item.metadata.size());
1424 // clear(self) -> true
1425 static int l_clear(lua_State *L)
1427 LuaItemStack *o = checkobject(L, 1);
1429 lua_pushboolean(L, true);
1433 // replace(self, itemstack or itemstring or table or nil) -> true
1434 static int l_replace(lua_State *L)
1436 LuaItemStack *o = checkobject(L, 1);
1437 o->m_stack = read_item(L, 2);
1438 lua_pushboolean(L, true);
1442 // to_string(self) -> string
1443 static int l_to_string(lua_State *L)
1445 LuaItemStack *o = checkobject(L, 1);
1446 std::string itemstring = o->m_stack.getItemString();
1447 lua_pushstring(L, itemstring.c_str());
1451 // to_table(self) -> table or nil
1452 static int l_to_table(lua_State *L)
1454 LuaItemStack *o = checkobject(L, 1);
1455 const ItemStack &item = o->m_stack;
1463 lua_pushstring(L, item.name.c_str());
1464 lua_setfield(L, -2, "name");
1465 lua_pushinteger(L, item.count);
1466 lua_setfield(L, -2, "count");
1467 lua_pushinteger(L, item.wear);
1468 lua_setfield(L, -2, "wear");
1469 lua_pushlstring(L, item.metadata.c_str(), item.metadata.size());
1470 lua_setfield(L, -2, "metadata");
1475 // get_stack_max(self) -> number
1476 static int l_get_stack_max(lua_State *L)
1478 LuaItemStack *o = checkobject(L, 1);
1479 ItemStack &item = o->m_stack;
1480 lua_pushinteger(L, item.getStackMax(get_server(L)->idef()));
1484 // get_free_space(self) -> number
1485 static int l_get_free_space(lua_State *L)
1487 LuaItemStack *o = checkobject(L, 1);
1488 ItemStack &item = o->m_stack;
1489 lua_pushinteger(L, item.freeSpace(get_server(L)->idef()));
1493 // is_known(self) -> true/false
1494 // Checks if the item is defined.
1495 static int l_is_known(lua_State *L)
1497 LuaItemStack *o = checkobject(L, 1);
1498 ItemStack &item = o->m_stack;
1499 bool is_known = item.isKnown(get_server(L)->idef());
1500 lua_pushboolean(L, is_known);
1504 // get_definition(self) -> table
1505 // Returns the item definition table from minetest.registered_items,
1506 // or a fallback one (name="unknown")
1507 static int l_get_definition(lua_State *L)
1509 LuaItemStack *o = checkobject(L, 1);
1510 ItemStack &item = o->m_stack;
1512 // Get minetest.registered_items[name]
1513 lua_getglobal(L, "minetest");
1514 lua_getfield(L, -1, "registered_items");
1515 luaL_checktype(L, -1, LUA_TTABLE);
1516 lua_getfield(L, -1, item.name.c_str());
1517 if(lua_isnil(L, -1))
1520 lua_getfield(L, -1, "unknown");
1525 // get_tool_capabilities(self) -> table
1526 // Returns the effective tool digging properties.
1527 // Returns those of the hand ("") if this item has none associated.
1528 static int l_get_tool_capabilities(lua_State *L)
1530 LuaItemStack *o = checkobject(L, 1);
1531 ItemStack &item = o->m_stack;
1532 const ToolCapabilities &prop =
1533 item.getToolCapabilities(get_server(L)->idef());
1534 push_tool_capabilities(L, prop);
1538 // add_wear(self, amount) -> true/false
1539 // The range for "amount" is [0,65535]. Wear is only added if the item
1540 // is a tool. Adding wear might destroy the item.
1541 // Returns true if the item is (or was) a tool.
1542 static int l_add_wear(lua_State *L)
1544 LuaItemStack *o = checkobject(L, 1);
1545 ItemStack &item = o->m_stack;
1546 int amount = lua_tointeger(L, 2);
1547 bool result = item.addWear(amount, get_server(L)->idef());
1548 lua_pushboolean(L, result);
1552 // add_item(self, itemstack or itemstring or table or nil) -> itemstack
1553 // Returns leftover item stack
1554 static int l_add_item(lua_State *L)
1556 LuaItemStack *o = checkobject(L, 1);
1557 ItemStack &item = o->m_stack;
1558 ItemStack newitem = read_item(L, 2);
1559 ItemStack leftover = item.addItem(newitem, get_server(L)->idef());
1560 create(L, leftover);
1564 // item_fits(self, itemstack or itemstring or table or nil) -> true/false, itemstack
1565 // First return value is true iff the new item fits fully into the stack
1566 // Second return value is the would-be-left-over item stack
1567 static int l_item_fits(lua_State *L)
1569 LuaItemStack *o = checkobject(L, 1);
1570 ItemStack &item = o->m_stack;
1571 ItemStack newitem = read_item(L, 2);
1573 bool fits = item.itemFits(newitem, &restitem, get_server(L)->idef());
1574 lua_pushboolean(L, fits); // first return value
1575 create(L, restitem); // second return value
1579 // take_item(self, takecount=1) -> itemstack
1580 static int l_take_item(lua_State *L)
1582 LuaItemStack *o = checkobject(L, 1);
1583 ItemStack &item = o->m_stack;
1585 if(!lua_isnone(L, 2))
1586 takecount = luaL_checkinteger(L, 2);
1587 ItemStack taken = item.takeItem(takecount);
1592 // peek_item(self, peekcount=1) -> itemstack
1593 static int l_peek_item(lua_State *L)
1595 LuaItemStack *o = checkobject(L, 1);
1596 ItemStack &item = o->m_stack;
1598 if(!lua_isnone(L, 2))
1599 peekcount = lua_tointeger(L, 2);
1600 ItemStack peekaboo = item.peekItem(peekcount);
1601 create(L, peekaboo);
1606 LuaItemStack(const ItemStack &item):
1615 const ItemStack& getItem() const
1619 ItemStack& getItem()
1624 // LuaItemStack(itemstack or itemstring or table or nil)
1625 // Creates an LuaItemStack and leaves it on top of stack
1626 static int create_object(lua_State *L)
1628 ItemStack item = read_item(L, 1);
1629 LuaItemStack *o = new LuaItemStack(item);
1630 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
1631 luaL_getmetatable(L, className);
1632 lua_setmetatable(L, -2);
1635 // Not callable from Lua
1636 static int create(lua_State *L, const ItemStack &item)
1638 LuaItemStack *o = new LuaItemStack(item);
1639 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
1640 luaL_getmetatable(L, className);
1641 lua_setmetatable(L, -2);
1645 static LuaItemStack* checkobject(lua_State *L, int narg)
1647 luaL_checktype(L, narg, LUA_TUSERDATA);
1648 void *ud = luaL_checkudata(L, narg, className);
1649 if(!ud) luaL_typerror(L, narg, className);
1650 return *(LuaItemStack**)ud; // unbox pointer
1653 static void Register(lua_State *L)
1656 int methodtable = lua_gettop(L);
1657 luaL_newmetatable(L, className);
1658 int metatable = lua_gettop(L);
1660 lua_pushliteral(L, "__metatable");
1661 lua_pushvalue(L, methodtable);
1662 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
1664 lua_pushliteral(L, "__index");
1665 lua_pushvalue(L, methodtable);
1666 lua_settable(L, metatable);
1668 lua_pushliteral(L, "__gc");
1669 lua_pushcfunction(L, gc_object);
1670 lua_settable(L, metatable);
1672 lua_pop(L, 1); // drop metatable
1674 luaL_openlib(L, 0, methods, 0); // fill methodtable
1675 lua_pop(L, 1); // drop methodtable
1677 // Can be created from Lua (LuaItemStack(itemstack or itemstring or table or nil))
1678 lua_register(L, className, create_object);
1681 const char LuaItemStack::className[] = "ItemStack";
1682 const luaL_reg LuaItemStack::methods[] = {
1683 method(LuaItemStack, is_empty),
1684 method(LuaItemStack, get_name),
1685 method(LuaItemStack, get_count),
1686 method(LuaItemStack, get_wear),
1687 method(LuaItemStack, get_metadata),
1688 method(LuaItemStack, clear),
1689 method(LuaItemStack, replace),
1690 method(LuaItemStack, to_string),
1691 method(LuaItemStack, to_table),
1692 method(LuaItemStack, get_stack_max),
1693 method(LuaItemStack, get_free_space),
1694 method(LuaItemStack, is_known),
1695 method(LuaItemStack, get_definition),
1696 method(LuaItemStack, get_tool_capabilities),
1697 method(LuaItemStack, add_wear),
1698 method(LuaItemStack, add_item),
1699 method(LuaItemStack, item_fits),
1700 method(LuaItemStack, take_item),
1701 method(LuaItemStack, peek_item),
1705 static ItemStack read_item(lua_State *L, int index)
1708 index = lua_gettop(L) + 1 + index;
1710 if(lua_isnil(L, index))
1714 else if(lua_isuserdata(L, index))
1716 // Convert from LuaItemStack
1717 LuaItemStack *o = LuaItemStack::checkobject(L, index);
1718 return o->getItem();
1720 else if(lua_isstring(L, index))
1722 // Convert from itemstring
1723 std::string itemstring = lua_tostring(L, index);
1724 IItemDefManager *idef = get_server(L)->idef();
1728 item.deSerialize(itemstring, idef);
1731 catch(SerializationError &e)
1733 infostream<<"WARNING: unable to create item from itemstring"
1734 <<": "<<itemstring<<std::endl;
1738 else if(lua_istable(L, index))
1740 // Convert from table
1741 IItemDefManager *idef = get_server(L)->idef();
1742 std::string name = getstringfield_default(L, index, "name", "");
1743 int count = getintfield_default(L, index, "count", 1);
1744 int wear = getintfield_default(L, index, "wear", 0);
1745 std::string metadata = getstringfield_default(L, index, "metadata", "");
1746 return ItemStack(name, count, wear, metadata, idef);
1750 throw LuaError(L, "Expecting itemstack, itemstring, table or nil");
1754 static std::vector<ItemStack> read_items(lua_State *L, int index)
1757 index = lua_gettop(L) + 1 + index;
1759 std::vector<ItemStack> items;
1760 luaL_checktype(L, index, LUA_TTABLE);
1762 while(lua_next(L, index) != 0){
1763 // key at index -2 and value at index -1
1764 items.push_back(read_item(L, -1));
1765 // removes value, keeps key for next iteration
1771 // creates a table of ItemStacks
1772 static void push_items(lua_State *L, const std::vector<ItemStack> &items)
1774 // Get the table insert function
1775 lua_getglobal(L, "table");
1776 lua_getfield(L, -1, "insert");
1777 int table_insert = lua_gettop(L);
1778 // Create and fill table
1780 int table = lua_gettop(L);
1781 for(u32 i=0; i<items.size(); i++){
1782 ItemStack item = items[i];
1783 lua_pushvalue(L, table_insert);
1784 lua_pushvalue(L, table);
1785 LuaItemStack::create(L, item);
1786 if(lua_pcall(L, 2, 0, 0))
1787 script_error(L, "error: %s", lua_tostring(L, -1));
1789 lua_remove(L, -2); // Remove table
1790 lua_remove(L, -2); // Remove insert
1800 InventoryLocation m_loc;
1802 static const char className[];
1803 static const luaL_reg methods[];
1805 static InvRef *checkobject(lua_State *L, int narg)
1807 luaL_checktype(L, narg, LUA_TUSERDATA);
1808 void *ud = luaL_checkudata(L, narg, className);
1809 if(!ud) luaL_typerror(L, narg, className);
1810 return *(InvRef**)ud; // unbox pointer
1813 static Inventory* getinv(lua_State *L, InvRef *ref)
1815 return get_server(L)->getInventory(ref->m_loc);
1818 static InventoryList* getlist(lua_State *L, InvRef *ref,
1819 const char *listname)
1821 Inventory *inv = getinv(L, ref);
1824 return inv->getList(listname);
1827 static void reportInventoryChange(lua_State *L, InvRef *ref)
1829 // Inform other things that the inventory has changed
1830 get_server(L)->setInventoryModified(ref->m_loc);
1833 // Exported functions
1835 // garbage collector
1836 static int gc_object(lua_State *L) {
1837 InvRef *o = *(InvRef **)(lua_touserdata(L, 1));
1842 // is_empty(self, listname) -> true/false
1843 static int l_is_empty(lua_State *L)
1845 InvRef *ref = checkobject(L, 1);
1846 const char *listname = luaL_checkstring(L, 2);
1847 InventoryList *list = getlist(L, ref, listname);
1848 if(list && list->getUsedSlots() > 0){
1849 lua_pushboolean(L, false);
1851 lua_pushboolean(L, true);
1856 // get_size(self, listname)
1857 static int l_get_size(lua_State *L)
1859 InvRef *ref = checkobject(L, 1);
1860 const char *listname = luaL_checkstring(L, 2);
1861 InventoryList *list = getlist(L, ref, listname);
1863 lua_pushinteger(L, list->getSize());
1865 lua_pushinteger(L, 0);
1870 // get_width(self, listname)
1871 static int l_get_width(lua_State *L)
1873 InvRef *ref = checkobject(L, 1);
1874 const char *listname = luaL_checkstring(L, 2);
1875 InventoryList *list = getlist(L, ref, listname);
1877 lua_pushinteger(L, list->getWidth());
1879 lua_pushinteger(L, 0);
1884 // set_size(self, listname, size)
1885 static int l_set_size(lua_State *L)
1887 InvRef *ref = checkobject(L, 1);
1888 const char *listname = luaL_checkstring(L, 2);
1889 int newsize = luaL_checknumber(L, 3);
1890 Inventory *inv = getinv(L, ref);
1892 inv->deleteList(listname);
1893 reportInventoryChange(L, ref);
1896 InventoryList *list = inv->getList(listname);
1898 list->setSize(newsize);
1900 list = inv->addList(listname, newsize);
1902 reportInventoryChange(L, ref);
1906 // set_width(self, listname, size)
1907 static int l_set_width(lua_State *L)
1909 InvRef *ref = checkobject(L, 1);
1910 const char *listname = luaL_checkstring(L, 2);
1911 int newwidth = luaL_checknumber(L, 3);
1912 Inventory *inv = getinv(L, ref);
1913 InventoryList *list = inv->getList(listname);
1915 list->setWidth(newwidth);
1919 reportInventoryChange(L, ref);
1923 // get_stack(self, listname, i) -> itemstack
1924 static int l_get_stack(lua_State *L)
1926 InvRef *ref = checkobject(L, 1);
1927 const char *listname = luaL_checkstring(L, 2);
1928 int i = luaL_checknumber(L, 3) - 1;
1929 InventoryList *list = getlist(L, ref, listname);
1931 if(list != NULL && i >= 0 && i < (int) list->getSize())
1932 item = list->getItem(i);
1933 LuaItemStack::create(L, item);
1937 // set_stack(self, listname, i, stack) -> true/false
1938 static int l_set_stack(lua_State *L)
1940 InvRef *ref = checkobject(L, 1);
1941 const char *listname = luaL_checkstring(L, 2);
1942 int i = luaL_checknumber(L, 3) - 1;
1943 ItemStack newitem = read_item(L, 4);
1944 InventoryList *list = getlist(L, ref, listname);
1945 if(list != NULL && i >= 0 && i < (int) list->getSize()){
1946 list->changeItem(i, newitem);
1947 reportInventoryChange(L, ref);
1948 lua_pushboolean(L, true);
1950 lua_pushboolean(L, false);
1955 // get_list(self, listname) -> list or nil
1956 static int l_get_list(lua_State *L)
1958 InvRef *ref = checkobject(L, 1);
1959 const char *listname = luaL_checkstring(L, 2);
1960 Inventory *inv = getinv(L, ref);
1961 inventory_get_list_to_lua(inv, listname, L);
1965 // set_list(self, listname, list)
1966 static int l_set_list(lua_State *L)
1968 InvRef *ref = checkobject(L, 1);
1969 const char *listname = luaL_checkstring(L, 2);
1970 Inventory *inv = getinv(L, ref);
1971 InventoryList *list = inv->getList(listname);
1973 inventory_set_list_from_lua(inv, listname, L, 3,
1976 inventory_set_list_from_lua(inv, listname, L, 3);
1977 reportInventoryChange(L, ref);
1981 // add_item(self, listname, itemstack or itemstring or table or nil) -> itemstack
1982 // Returns the leftover stack
1983 static int l_add_item(lua_State *L)
1985 InvRef *ref = checkobject(L, 1);
1986 const char *listname = luaL_checkstring(L, 2);
1987 ItemStack item = read_item(L, 3);
1988 InventoryList *list = getlist(L, ref, listname);
1990 ItemStack leftover = list->addItem(item);
1991 if(leftover.count != item.count)
1992 reportInventoryChange(L, ref);
1993 LuaItemStack::create(L, leftover);
1995 LuaItemStack::create(L, item);
2000 // room_for_item(self, listname, itemstack or itemstring or table or nil) -> true/false
2001 // Returns true if the item completely fits into the list
2002 static int l_room_for_item(lua_State *L)
2004 InvRef *ref = checkobject(L, 1);
2005 const char *listname = luaL_checkstring(L, 2);
2006 ItemStack item = read_item(L, 3);
2007 InventoryList *list = getlist(L, ref, listname);
2009 lua_pushboolean(L, list->roomForItem(item));
2011 lua_pushboolean(L, false);
2016 // contains_item(self, listname, itemstack or itemstring or table or nil) -> true/false
2017 // Returns true if the list contains the given count of the given item name
2018 static int l_contains_item(lua_State *L)
2020 InvRef *ref = checkobject(L, 1);
2021 const char *listname = luaL_checkstring(L, 2);
2022 ItemStack item = read_item(L, 3);
2023 InventoryList *list = getlist(L, ref, listname);
2025 lua_pushboolean(L, list->containsItem(item));
2027 lua_pushboolean(L, false);
2032 // remove_item(self, listname, itemstack or itemstring or table or nil) -> itemstack
2033 // Returns the items that were actually removed
2034 static int l_remove_item(lua_State *L)
2036 InvRef *ref = checkobject(L, 1);
2037 const char *listname = luaL_checkstring(L, 2);
2038 ItemStack item = read_item(L, 3);
2039 InventoryList *list = getlist(L, ref, listname);
2041 ItemStack removed = list->removeItem(item);
2042 if(!removed.empty())
2043 reportInventoryChange(L, ref);
2044 LuaItemStack::create(L, removed);
2046 LuaItemStack::create(L, ItemStack());
2052 InvRef(const InventoryLocation &loc):
2061 // Creates an InvRef and leaves it on top of stack
2062 // Not callable from Lua; all references are created on the C side.
2063 static void create(lua_State *L, const InventoryLocation &loc)
2065 InvRef *o = new InvRef(loc);
2066 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
2067 luaL_getmetatable(L, className);
2068 lua_setmetatable(L, -2);
2070 static void createPlayer(lua_State *L, Player *player)
2072 InventoryLocation loc;
2073 loc.setPlayer(player->getName());
2076 static void createNodeMeta(lua_State *L, v3s16 p)
2078 InventoryLocation loc;
2083 static void Register(lua_State *L)
2086 int methodtable = lua_gettop(L);
2087 luaL_newmetatable(L, className);
2088 int metatable = lua_gettop(L);
2090 lua_pushliteral(L, "__metatable");
2091 lua_pushvalue(L, methodtable);
2092 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
2094 lua_pushliteral(L, "__index");
2095 lua_pushvalue(L, methodtable);
2096 lua_settable(L, metatable);
2098 lua_pushliteral(L, "__gc");
2099 lua_pushcfunction(L, gc_object);
2100 lua_settable(L, metatable);
2102 lua_pop(L, 1); // drop metatable
2104 luaL_openlib(L, 0, methods, 0); // fill methodtable
2105 lua_pop(L, 1); // drop methodtable
2107 // Cannot be created from Lua
2108 //lua_register(L, className, create_object);
2111 const char InvRef::className[] = "InvRef";
2112 const luaL_reg InvRef::methods[] = {
2113 method(InvRef, is_empty),
2114 method(InvRef, get_size),
2115 method(InvRef, set_size),
2116 method(InvRef, get_width),
2117 method(InvRef, set_width),
2118 method(InvRef, get_stack),
2119 method(InvRef, set_stack),
2120 method(InvRef, get_list),
2121 method(InvRef, set_list),
2122 method(InvRef, add_item),
2123 method(InvRef, room_for_item),
2124 method(InvRef, contains_item),
2125 method(InvRef, remove_item),
2137 ServerEnvironment *m_env;
2139 static const char className[];
2140 static const luaL_reg methods[];
2142 static NodeMetaRef *checkobject(lua_State *L, int narg)
2144 luaL_checktype(L, narg, LUA_TUSERDATA);
2145 void *ud = luaL_checkudata(L, narg, className);
2146 if(!ud) luaL_typerror(L, narg, className);
2147 return *(NodeMetaRef**)ud; // unbox pointer
2150 static NodeMetadata* getmeta(NodeMetaRef *ref, bool auto_create)
2152 NodeMetadata *meta = ref->m_env->getMap().getNodeMetadata(ref->m_p);
2153 if(meta == NULL && auto_create)
2155 meta = new NodeMetadata(ref->m_env->getGameDef());
2156 ref->m_env->getMap().setNodeMetadata(ref->m_p, meta);
2161 static void reportMetadataChange(NodeMetaRef *ref)
2163 // NOTE: This same code is in rollback_interface.cpp
2164 // Inform other things that the metadata has changed
2165 v3s16 blockpos = getNodeBlockPos(ref->m_p);
2167 event.type = MEET_BLOCK_NODE_METADATA_CHANGED;
2169 ref->m_env->getMap().dispatchEvent(&event);
2170 // Set the block to be saved
2171 MapBlock *block = ref->m_env->getMap().getBlockNoCreateNoEx(blockpos);
2173 block->raiseModified(MOD_STATE_WRITE_NEEDED,
2174 "NodeMetaRef::reportMetadataChange");
2177 // Exported functions
2179 // garbage collector
2180 static int gc_object(lua_State *L) {
2181 NodeMetaRef *o = *(NodeMetaRef **)(lua_touserdata(L, 1));
2186 // get_string(self, name)
2187 static int l_get_string(lua_State *L)
2189 NodeMetaRef *ref = checkobject(L, 1);
2190 std::string name = luaL_checkstring(L, 2);
2192 NodeMetadata *meta = getmeta(ref, false);
2194 lua_pushlstring(L, "", 0);
2197 std::string str = meta->getString(name);
2198 lua_pushlstring(L, str.c_str(), str.size());
2202 // set_string(self, name, var)
2203 static int l_set_string(lua_State *L)
2205 NodeMetaRef *ref = checkobject(L, 1);
2206 std::string name = luaL_checkstring(L, 2);
2208 const char *s = lua_tolstring(L, 3, &len);
2209 std::string str(s, len);
2211 NodeMetadata *meta = getmeta(ref, !str.empty());
2212 if(meta == NULL || str == meta->getString(name))
2214 meta->setString(name, str);
2215 reportMetadataChange(ref);
2219 // get_int(self, name)
2220 static int l_get_int(lua_State *L)
2222 NodeMetaRef *ref = checkobject(L, 1);
2223 std::string name = lua_tostring(L, 2);
2225 NodeMetadata *meta = getmeta(ref, false);
2227 lua_pushnumber(L, 0);
2230 std::string str = meta->getString(name);
2231 lua_pushnumber(L, stoi(str));
2235 // set_int(self, name, var)
2236 static int l_set_int(lua_State *L)
2238 NodeMetaRef *ref = checkobject(L, 1);
2239 std::string name = lua_tostring(L, 2);
2240 int a = lua_tointeger(L, 3);
2241 std::string str = itos(a);
2243 NodeMetadata *meta = getmeta(ref, true);
2244 if(meta == NULL || str == meta->getString(name))
2246 meta->setString(name, str);
2247 reportMetadataChange(ref);
2251 // get_float(self, name)
2252 static int l_get_float(lua_State *L)
2254 NodeMetaRef *ref = checkobject(L, 1);
2255 std::string name = lua_tostring(L, 2);
2257 NodeMetadata *meta = getmeta(ref, false);
2259 lua_pushnumber(L, 0);
2262 std::string str = meta->getString(name);
2263 lua_pushnumber(L, stof(str));
2267 // set_float(self, name, var)
2268 static int l_set_float(lua_State *L)
2270 NodeMetaRef *ref = checkobject(L, 1);
2271 std::string name = lua_tostring(L, 2);
2272 float a = lua_tonumber(L, 3);
2273 std::string str = ftos(a);
2275 NodeMetadata *meta = getmeta(ref, true);
2276 if(meta == NULL || str == meta->getString(name))
2278 meta->setString(name, str);
2279 reportMetadataChange(ref);
2283 // get_inventory(self)
2284 static int l_get_inventory(lua_State *L)
2286 NodeMetaRef *ref = checkobject(L, 1);
2287 getmeta(ref, true); // try to ensure the metadata exists
2288 InvRef::createNodeMeta(L, ref->m_p);
2293 static int l_to_table(lua_State *L)
2295 NodeMetaRef *ref = checkobject(L, 1);
2297 NodeMetadata *meta = getmeta(ref, true);
2306 std::map<std::string, std::string> fields = meta->getStrings();
2307 for(std::map<std::string, std::string>::const_iterator
2308 i = fields.begin(); i != fields.end(); i++){
2309 const std::string &name = i->first;
2310 const std::string &value = i->second;
2311 lua_pushlstring(L, name.c_str(), name.size());
2312 lua_pushlstring(L, value.c_str(), value.size());
2313 lua_settable(L, -3);
2316 lua_setfield(L, -2, "fields");
2319 Inventory *inv = meta->getInventory();
2321 std::vector<const InventoryList*> lists = inv->getLists();
2322 for(std::vector<const InventoryList*>::const_iterator
2323 i = lists.begin(); i != lists.end(); i++){
2324 inventory_get_list_to_lua(inv, (*i)->getName().c_str(), L);
2325 lua_setfield(L, -2, (*i)->getName().c_str());
2328 lua_setfield(L, -2, "inventory");
2332 // from_table(self, table)
2333 static int l_from_table(lua_State *L)
2335 NodeMetaRef *ref = checkobject(L, 1);
2338 if(lua_isnil(L, base)){
2340 ref->m_env->getMap().removeNodeMetadata(ref->m_p);
2341 lua_pushboolean(L, true);
2345 // Has metadata; clear old one first
2346 ref->m_env->getMap().removeNodeMetadata(ref->m_p);
2347 // Create new metadata
2348 NodeMetadata *meta = getmeta(ref, true);
2350 lua_getfield(L, base, "fields");
2351 int fieldstable = lua_gettop(L);
2353 while(lua_next(L, fieldstable) != 0){
2354 // key at index -2 and value at index -1
2355 std::string name = lua_tostring(L, -2);
2357 const char *cs = lua_tolstring(L, -1, &cl);
2358 std::string value(cs, cl);
2359 meta->setString(name, value);
2360 lua_pop(L, 1); // removes value, keeps key for next iteration
2363 Inventory *inv = meta->getInventory();
2364 lua_getfield(L, base, "inventory");
2365 int inventorytable = lua_gettop(L);
2367 while(lua_next(L, inventorytable) != 0){
2368 // key at index -2 and value at index -1
2369 std::string name = lua_tostring(L, -2);
2370 inventory_set_list_from_lua(inv, name.c_str(), L, -1);
2371 lua_pop(L, 1); // removes value, keeps key for next iteration
2373 reportMetadataChange(ref);
2374 lua_pushboolean(L, true);
2379 NodeMetaRef(v3s16 p, ServerEnvironment *env):
2389 // Creates an NodeMetaRef and leaves it on top of stack
2390 // Not callable from Lua; all references are created on the C side.
2391 static void create(lua_State *L, v3s16 p, ServerEnvironment *env)
2393 NodeMetaRef *o = new NodeMetaRef(p, env);
2394 //infostream<<"NodeMetaRef::create: o="<<o<<std::endl;
2395 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
2396 luaL_getmetatable(L, className);
2397 lua_setmetatable(L, -2);
2400 static void Register(lua_State *L)
2403 int methodtable = lua_gettop(L);
2404 luaL_newmetatable(L, className);
2405 int metatable = lua_gettop(L);
2407 lua_pushliteral(L, "__metatable");
2408 lua_pushvalue(L, methodtable);
2409 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
2411 lua_pushliteral(L, "__index");
2412 lua_pushvalue(L, methodtable);
2413 lua_settable(L, metatable);
2415 lua_pushliteral(L, "__gc");
2416 lua_pushcfunction(L, gc_object);
2417 lua_settable(L, metatable);
2419 lua_pop(L, 1); // drop metatable
2421 luaL_openlib(L, 0, methods, 0); // fill methodtable
2422 lua_pop(L, 1); // drop methodtable
2424 // Cannot be created from Lua
2425 //lua_register(L, className, create_object);
2428 const char NodeMetaRef::className[] = "NodeMetaRef";
2429 const luaL_reg NodeMetaRef::methods[] = {
2430 method(NodeMetaRef, get_string),
2431 method(NodeMetaRef, set_string),
2432 method(NodeMetaRef, get_int),
2433 method(NodeMetaRef, set_int),
2434 method(NodeMetaRef, get_float),
2435 method(NodeMetaRef, set_float),
2436 method(NodeMetaRef, get_inventory),
2437 method(NodeMetaRef, to_table),
2438 method(NodeMetaRef, from_table),
2449 ServerActiveObject *m_object;
2451 static const char className[];
2452 static const luaL_reg methods[];
2454 static ObjectRef *checkobject(lua_State *L, int narg)
2456 luaL_checktype(L, narg, LUA_TUSERDATA);
2457 void *ud = luaL_checkudata(L, narg, className);
2458 if(!ud) luaL_typerror(L, narg, className);
2459 return *(ObjectRef**)ud; // unbox pointer
2462 static ServerActiveObject* getobject(ObjectRef *ref)
2464 ServerActiveObject *co = ref->m_object;
2468 static LuaEntitySAO* getluaobject(ObjectRef *ref)
2470 ServerActiveObject *obj = getobject(ref);
2473 if(obj->getType() != ACTIVEOBJECT_TYPE_LUAENTITY)
2475 return (LuaEntitySAO*)obj;
2478 static PlayerSAO* getplayersao(ObjectRef *ref)
2480 ServerActiveObject *obj = getobject(ref);
2483 if(obj->getType() != ACTIVEOBJECT_TYPE_PLAYER)
2485 return (PlayerSAO*)obj;
2488 static Player* getplayer(ObjectRef *ref)
2490 PlayerSAO *playersao = getplayersao(ref);
2491 if(playersao == NULL)
2493 return playersao->getPlayer();
2496 // Exported functions
2498 // garbage collector
2499 static int gc_object(lua_State *L) {
2500 ObjectRef *o = *(ObjectRef **)(lua_touserdata(L, 1));
2501 //infostream<<"ObjectRef::gc_object: o="<<o<<std::endl;
2507 static int l_remove(lua_State *L)
2509 ObjectRef *ref = checkobject(L, 1);
2510 ServerActiveObject *co = getobject(ref);
2511 if(co == NULL) return 0;
2512 verbosestream<<"ObjectRef::l_remove(): id="<<co->getId()<<std::endl;
2513 co->m_removed = true;
2518 // returns: {x=num, y=num, z=num}
2519 static int l_getpos(lua_State *L)
2521 ObjectRef *ref = checkobject(L, 1);
2522 ServerActiveObject *co = getobject(ref);
2523 if(co == NULL) return 0;
2524 v3f pos = co->getBasePosition() / BS;
2526 lua_pushnumber(L, pos.X);
2527 lua_setfield(L, -2, "x");
2528 lua_pushnumber(L, pos.Y);
2529 lua_setfield(L, -2, "y");
2530 lua_pushnumber(L, pos.Z);
2531 lua_setfield(L, -2, "z");
2535 // setpos(self, pos)
2536 static int l_setpos(lua_State *L)
2538 ObjectRef *ref = checkobject(L, 1);
2539 //LuaEntitySAO *co = getluaobject(ref);
2540 ServerActiveObject *co = getobject(ref);
2541 if(co == NULL) return 0;
2543 v3f pos = checkFloatPos(L, 2);
2549 // moveto(self, pos, continuous=false)
2550 static int l_moveto(lua_State *L)
2552 ObjectRef *ref = checkobject(L, 1);
2553 //LuaEntitySAO *co = getluaobject(ref);
2554 ServerActiveObject *co = getobject(ref);
2555 if(co == NULL) return 0;
2557 v3f pos = checkFloatPos(L, 2);
2559 bool continuous = lua_toboolean(L, 3);
2561 co->moveTo(pos, continuous);
2565 // punch(self, puncher, time_from_last_punch, tool_capabilities, dir)
2566 static int l_punch(lua_State *L)
2568 ObjectRef *ref = checkobject(L, 1);
2569 ObjectRef *puncher_ref = checkobject(L, 2);
2570 ServerActiveObject *co = getobject(ref);
2571 ServerActiveObject *puncher = getobject(puncher_ref);
2572 if(co == NULL) return 0;
2573 if(puncher == NULL) return 0;
2575 if(lua_type(L, 5) != LUA_TTABLE)
2576 dir = co->getBasePosition() - puncher->getBasePosition();
2578 dir = read_v3f(L, 5);
2579 float time_from_last_punch = 1000000;
2580 if(lua_isnumber(L, 3))
2581 time_from_last_punch = lua_tonumber(L, 3);
2582 ToolCapabilities toolcap = read_tool_capabilities(L, 4);
2585 co->punch(dir, &toolcap, puncher, time_from_last_punch);
2589 // right_click(self, clicker); clicker = an another ObjectRef
2590 static int l_right_click(lua_State *L)
2592 ObjectRef *ref = checkobject(L, 1);
2593 ObjectRef *ref2 = checkobject(L, 2);
2594 ServerActiveObject *co = getobject(ref);
2595 ServerActiveObject *co2 = getobject(ref2);
2596 if(co == NULL) return 0;
2597 if(co2 == NULL) return 0;
2599 co->rightClick(co2);
2604 // hp = number of hitpoints (2 * number of hearts)
2606 static int l_set_hp(lua_State *L)
2608 ObjectRef *ref = checkobject(L, 1);
2609 luaL_checknumber(L, 2);
2610 ServerActiveObject *co = getobject(ref);
2611 if(co == NULL) return 0;
2612 int hp = lua_tonumber(L, 2);
2613 /*infostream<<"ObjectRef::l_set_hp(): id="<<co->getId()
2614 <<" hp="<<hp<<std::endl;*/
2622 // returns: number of hitpoints (2 * number of hearts)
2623 // 0 if not applicable to this type of object
2624 static int l_get_hp(lua_State *L)
2626 ObjectRef *ref = checkobject(L, 1);
2627 ServerActiveObject *co = getobject(ref);
2630 lua_pushnumber(L, 1);
2633 int hp = co->getHP();
2634 /*infostream<<"ObjectRef::l_get_hp(): id="<<co->getId()
2635 <<" hp="<<hp<<std::endl;*/
2637 lua_pushnumber(L, hp);
2641 // get_inventory(self)
2642 static int l_get_inventory(lua_State *L)
2644 ObjectRef *ref = checkobject(L, 1);
2645 ServerActiveObject *co = getobject(ref);
2646 if(co == NULL) return 0;
2648 InventoryLocation loc = co->getInventoryLocation();
2649 if(get_server(L)->getInventory(loc) != NULL)
2650 InvRef::create(L, loc);
2652 lua_pushnil(L); // An object may have no inventory (nil)
2656 // get_wield_list(self)
2657 static int l_get_wield_list(lua_State *L)
2659 ObjectRef *ref = checkobject(L, 1);
2660 ServerActiveObject *co = getobject(ref);
2661 if(co == NULL) return 0;
2663 lua_pushstring(L, co->getWieldList().c_str());
2667 // get_wield_index(self)
2668 static int l_get_wield_index(lua_State *L)
2670 ObjectRef *ref = checkobject(L, 1);
2671 ServerActiveObject *co = getobject(ref);
2672 if(co == NULL) return 0;
2674 lua_pushinteger(L, co->getWieldIndex() + 1);
2678 // get_wielded_item(self)
2679 static int l_get_wielded_item(lua_State *L)
2681 ObjectRef *ref = checkobject(L, 1);
2682 ServerActiveObject *co = getobject(ref);
2685 LuaItemStack::create(L, ItemStack());
2689 LuaItemStack::create(L, co->getWieldedItem());
2693 // set_wielded_item(self, itemstack or itemstring or table or nil)
2694 static int l_set_wielded_item(lua_State *L)
2696 ObjectRef *ref = checkobject(L, 1);
2697 ServerActiveObject *co = getobject(ref);
2698 if(co == NULL) return 0;
2700 ItemStack item = read_item(L, 2);
2701 bool success = co->setWieldedItem(item);
2702 lua_pushboolean(L, success);
2706 // set_armor_groups(self, groups)
2707 static int l_set_armor_groups(lua_State *L)
2709 ObjectRef *ref = checkobject(L, 1);
2710 ServerActiveObject *co = getobject(ref);
2711 if(co == NULL) return 0;
2713 ItemGroupList groups;
2714 read_groups(L, 2, groups);
2715 co->setArmorGroups(groups);
2719 // setanimations(self, frames, frame_speed, frame_blend)
2720 static int l_set_animations(lua_State *L)
2722 ObjectRef *ref = checkobject(L, 1);
2723 ServerActiveObject *co = getobject(ref);
2724 if(co == NULL) return 0;
2727 v2f frames = v2f(1, 1);
2728 if(!lua_isnil(L, 2))
2729 frames = read_v2f(L, 2);
2730 float frame_speed = 15;
2731 if(!lua_isnil(L, 3))
2732 frame_speed = lua_tonumber(L, 3);
2733 float frame_blend = 0;
2734 if(!lua_isnil(L, 4))
2735 frame_blend = lua_tonumber(L, 4);
2736 co->setAnimations(frames, frame_speed, frame_blend);
2740 // setboneposrot(std::string bone, v3f position, v3f rotation)
2741 static int l_set_bone_posrot(lua_State *L)
2743 ObjectRef *ref = checkobject(L, 1);
2744 ServerActiveObject *co = getobject(ref);
2745 if(co == NULL) return 0;
2748 std::string bone = "";
2749 if(!lua_isnil(L, 2))
2750 bone = lua_tostring(L, 2);
2751 v3f position = v3f(0, 0, 0);
2752 if(!lua_isnil(L, 3))
2753 position = read_v3f(L, 3);
2754 v3f rotation = v3f(0, 0, 0);
2755 if(!lua_isnil(L, 4))
2756 rotation = read_v3f(L, 4);
2757 co->setBonePosRot(bone, position, rotation);
2761 // Part of the attachment structure, not used yet!
2762 // set_attachment() // <- parameters here
2763 static int l_set_attachment(lua_State *L)
2765 ObjectRef *ref = checkobject(L, 1);
2766 ObjectRef *parent_ref = checkobject(L, 2);
2767 ServerActiveObject *co = getobject(ref);
2768 ServerActiveObject *parent = getobject(parent_ref);
2769 if(co == NULL) return 0;
2770 if(parent == NULL) return 0;
2771 std::string bone = "";
2772 if(!lua_isnil(L, 3))
2773 bone = lua_tostring(L, 3);
2774 v3f position = v3f(0, 0, 0);
2775 if(!lua_isnil(L, 4))
2776 position = read_v3f(L, 4);
2777 v3f rotation = v3f(0, 0, 0);
2778 if(!lua_isnil(L, 5))
2779 rotation = read_v3f(L, 5);
2782 //lua_pushnumber(L, cobj->getId()); // Push id
2784 co->setAttachment(parent, bone, position, rotation);
2788 // set_properties(self, properties)
2789 static int l_set_properties(lua_State *L)
2791 ObjectRef *ref = checkobject(L, 1);
2792 ServerActiveObject *co = getobject(ref);
2793 if(co == NULL) return 0;
2794 ObjectProperties *prop = co->accessObjectProperties();
2797 read_object_properties(L, 2, prop);
2798 co->notifyObjectPropertiesModified();
2802 /* LuaEntitySAO-only */
2804 // setvelocity(self, {x=num, y=num, z=num})
2805 static int l_setvelocity(lua_State *L)
2807 ObjectRef *ref = checkobject(L, 1);
2808 LuaEntitySAO *co = getluaobject(ref);
2809 if(co == NULL) return 0;
2810 v3f pos = checkFloatPos(L, 2);
2812 co->setVelocity(pos);
2816 // getvelocity(self)
2817 static int l_getvelocity(lua_State *L)
2819 ObjectRef *ref = checkobject(L, 1);
2820 LuaEntitySAO *co = getluaobject(ref);
2821 if(co == NULL) return 0;
2823 v3f v = co->getVelocity();
2828 // setacceleration(self, {x=num, y=num, z=num})
2829 static int l_setacceleration(lua_State *L)
2831 ObjectRef *ref = checkobject(L, 1);
2832 LuaEntitySAO *co = getluaobject(ref);
2833 if(co == NULL) return 0;
2835 v3f pos = checkFloatPos(L, 2);
2837 co->setAcceleration(pos);
2841 // getacceleration(self)
2842 static int l_getacceleration(lua_State *L)
2844 ObjectRef *ref = checkobject(L, 1);
2845 LuaEntitySAO *co = getluaobject(ref);
2846 if(co == NULL) return 0;
2848 v3f v = co->getAcceleration();
2853 // setyaw(self, radians)
2854 static int l_setyaw(lua_State *L)
2856 ObjectRef *ref = checkobject(L, 1);
2857 LuaEntitySAO *co = getluaobject(ref);
2858 if(co == NULL) return 0;
2859 float yaw = luaL_checknumber(L, 2) * core::RADTODEG;
2866 static int l_getyaw(lua_State *L)
2868 ObjectRef *ref = checkobject(L, 1);
2869 LuaEntitySAO *co = getluaobject(ref);
2870 if(co == NULL) return 0;
2872 float yaw = co->getYaw() * core::DEGTORAD;
2873 lua_pushnumber(L, yaw);
2877 // settexturemod(self, mod)
2878 static int l_settexturemod(lua_State *L)
2880 ObjectRef *ref = checkobject(L, 1);
2881 LuaEntitySAO *co = getluaobject(ref);
2882 if(co == NULL) return 0;
2884 std::string mod = luaL_checkstring(L, 2);
2885 co->setTextureMod(mod);
2889 // setsprite(self, p={x=0,y=0}, num_frames=1, framelength=0.2,
2890 // select_horiz_by_yawpitch=false)
2891 static int l_setsprite(lua_State *L)
2893 ObjectRef *ref = checkobject(L, 1);
2894 LuaEntitySAO *co = getluaobject(ref);
2895 if(co == NULL) return 0;
2898 if(!lua_isnil(L, 2))
2899 p = read_v2s16(L, 2);
2901 if(!lua_isnil(L, 3))
2902 num_frames = lua_tonumber(L, 3);
2903 float framelength = 0.2;
2904 if(!lua_isnil(L, 4))
2905 framelength = lua_tonumber(L, 4);
2906 bool select_horiz_by_yawpitch = false;
2907 if(!lua_isnil(L, 5))
2908 select_horiz_by_yawpitch = lua_toboolean(L, 5);
2909 co->setSprite(p, num_frames, framelength, select_horiz_by_yawpitch);
2914 // get_entity_name(self)
2915 static int l_get_entity_name(lua_State *L)
2917 ObjectRef *ref = checkobject(L, 1);
2918 LuaEntitySAO *co = getluaobject(ref);
2919 if(co == NULL) return 0;
2921 std::string name = co->getName();
2922 lua_pushstring(L, name.c_str());
2926 // get_luaentity(self)
2927 static int l_get_luaentity(lua_State *L)
2929 ObjectRef *ref = checkobject(L, 1);
2930 LuaEntitySAO *co = getluaobject(ref);
2931 if(co == NULL) return 0;
2933 luaentity_get(L, co->getId());
2940 static int l_is_player(lua_State *L)
2942 ObjectRef *ref = checkobject(L, 1);
2943 Player *player = getplayer(ref);
2944 lua_pushboolean(L, (player != NULL));
2948 // get_player_name(self)
2949 static int l_get_player_name(lua_State *L)
2951 ObjectRef *ref = checkobject(L, 1);
2952 Player *player = getplayer(ref);
2954 lua_pushlstring(L, "", 0);
2958 lua_pushstring(L, player->getName());
2962 // get_look_dir(self)
2963 static int l_get_look_dir(lua_State *L)
2965 ObjectRef *ref = checkobject(L, 1);
2966 Player *player = getplayer(ref);
2967 if(player == NULL) return 0;
2969 float pitch = player->getRadPitch();
2970 float yaw = player->getRadYaw();
2971 v3f v(cos(pitch)*cos(yaw), sin(pitch), cos(pitch)*sin(yaw));
2976 // get_look_pitch(self)
2977 static int l_get_look_pitch(lua_State *L)
2979 ObjectRef *ref = checkobject(L, 1);
2980 Player *player = getplayer(ref);
2981 if(player == NULL) return 0;
2983 lua_pushnumber(L, player->getRadPitch());
2987 // get_look_yaw(self)
2988 static int l_get_look_yaw(lua_State *L)
2990 ObjectRef *ref = checkobject(L, 1);
2991 Player *player = getplayer(ref);
2992 if(player == NULL) return 0;
2994 lua_pushnumber(L, player->getRadYaw());
2998 // set_inventory_formspec(self, formspec)
2999 static int l_set_inventory_formspec(lua_State *L)
3001 ObjectRef *ref = checkobject(L, 1);
3002 Player *player = getplayer(ref);
3003 if(player == NULL) return 0;
3004 std::string formspec = luaL_checkstring(L, 2);
3006 player->inventory_formspec = formspec;
3007 get_server(L)->reportInventoryFormspecModified(player->getName());
3008 lua_pushboolean(L, true);
3012 // get_inventory_formspec(self) -> formspec
3013 static int l_get_inventory_formspec(lua_State *L)
3015 ObjectRef *ref = checkobject(L, 1);
3016 Player *player = getplayer(ref);
3017 if(player == NULL) return 0;
3019 std::string formspec = player->inventory_formspec;
3020 lua_pushlstring(L, formspec.c_str(), formspec.size());
3025 ObjectRef(ServerActiveObject *object):
3028 //infostream<<"ObjectRef created for id="<<m_object->getId()<<std::endl;
3034 infostream<<"ObjectRef destructing for id="
3035 <<m_object->getId()<<std::endl;
3037 infostream<<"ObjectRef destructing for id=unknown"<<std::endl;*/
3040 // Creates an ObjectRef and leaves it on top of stack
3041 // Not callable from Lua; all references are created on the C side.
3042 static void create(lua_State *L, ServerActiveObject *object)
3044 ObjectRef *o = new ObjectRef(object);
3045 //infostream<<"ObjectRef::create: o="<<o<<std::endl;
3046 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
3047 luaL_getmetatable(L, className);
3048 lua_setmetatable(L, -2);
3051 static void set_null(lua_State *L)
3053 ObjectRef *o = checkobject(L, -1);
3057 static void Register(lua_State *L)
3060 int methodtable = lua_gettop(L);
3061 luaL_newmetatable(L, className);
3062 int metatable = lua_gettop(L);
3064 lua_pushliteral(L, "__metatable");
3065 lua_pushvalue(L, methodtable);
3066 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
3068 lua_pushliteral(L, "__index");
3069 lua_pushvalue(L, methodtable);
3070 lua_settable(L, metatable);
3072 lua_pushliteral(L, "__gc");
3073 lua_pushcfunction(L, gc_object);
3074 lua_settable(L, metatable);
3076 lua_pop(L, 1); // drop metatable
3078 luaL_openlib(L, 0, methods, 0); // fill methodtable
3079 lua_pop(L, 1); // drop methodtable
3081 // Cannot be created from Lua
3082 //lua_register(L, className, create_object);
3085 const char ObjectRef::className[] = "ObjectRef";
3086 const luaL_reg ObjectRef::methods[] = {
3087 // ServerActiveObject
3088 method(ObjectRef, remove),
3089 method(ObjectRef, getpos),
3090 method(ObjectRef, setpos),
3091 method(ObjectRef, moveto),
3092 method(ObjectRef, punch),
3093 method(ObjectRef, right_click),
3094 method(ObjectRef, set_hp),
3095 method(ObjectRef, get_hp),
3096 method(ObjectRef, get_inventory),
3097 method(ObjectRef, get_wield_list),
3098 method(ObjectRef, get_wield_index),
3099 method(ObjectRef, get_wielded_item),
3100 method(ObjectRef, set_wielded_item),
3101 method(ObjectRef, set_armor_groups),
3102 method(ObjectRef, set_animations),
3103 method(ObjectRef, set_bone_posrot),
3104 method(ObjectRef, set_attachment),
3105 method(ObjectRef, set_properties),
3106 // LuaEntitySAO-only
3107 method(ObjectRef, setvelocity),
3108 method(ObjectRef, getvelocity),
3109 method(ObjectRef, setacceleration),
3110 method(ObjectRef, getacceleration),
3111 method(ObjectRef, setyaw),
3112 method(ObjectRef, getyaw),
3113 method(ObjectRef, settexturemod),
3114 method(ObjectRef, setsprite),
3115 method(ObjectRef, get_entity_name),
3116 method(ObjectRef, get_luaentity),
3118 method(ObjectRef, is_player),
3119 method(ObjectRef, get_player_name),
3120 method(ObjectRef, get_look_dir),
3121 method(ObjectRef, get_look_pitch),
3122 method(ObjectRef, get_look_yaw),
3123 method(ObjectRef, set_inventory_formspec),
3124 method(ObjectRef, get_inventory_formspec),
3128 // Creates a new anonymous reference if cobj=NULL or id=0
3129 static void objectref_get_or_create(lua_State *L,
3130 ServerActiveObject *cobj)
3132 if(cobj == NULL || cobj->getId() == 0){
3133 ObjectRef::create(L, cobj);
3135 objectref_get(L, cobj->getId());
3144 class LuaPerlinNoise
3151 static const char className[];
3152 static const luaL_reg methods[];
3154 // Exported functions
3156 // garbage collector
3157 static int gc_object(lua_State *L)
3159 LuaPerlinNoise *o = *(LuaPerlinNoise **)(lua_touserdata(L, 1));
3164 static int l_get2d(lua_State *L)
3166 LuaPerlinNoise *o = checkobject(L, 1);
3167 v2f pos2d = read_v2f(L,2);
3168 lua_Number val = noise2d_perlin(pos2d.X/o->scale, pos2d.Y/o->scale, o->seed, o->octaves, o->persistence);
3169 lua_pushnumber(L, val);
3172 static int l_get3d(lua_State *L)
3174 LuaPerlinNoise *o = checkobject(L, 1);
3175 v3f pos3d = read_v3f(L,2);
3176 lua_Number val = noise3d_perlin(pos3d.X/o->scale, pos3d.Y/o->scale, pos3d.Z/o->scale, o->seed, o->octaves, o->persistence);
3177 lua_pushnumber(L, val);
3182 LuaPerlinNoise(int a_seed, int a_octaves, double a_persistence,
3186 persistence(a_persistence),
3195 // LuaPerlinNoise(seed, octaves, persistence, scale)
3196 // Creates an LuaPerlinNoise and leaves it on top of stack
3197 static int create_object(lua_State *L)
3199 int seed = luaL_checkint(L, 1);
3200 int octaves = luaL_checkint(L, 2);
3201 double persistence = luaL_checknumber(L, 3);
3202 double scale = luaL_checknumber(L, 4);
3203 LuaPerlinNoise *o = new LuaPerlinNoise(seed, octaves, persistence, scale);
3204 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
3205 luaL_getmetatable(L, className);
3206 lua_setmetatable(L, -2);
3210 static LuaPerlinNoise* checkobject(lua_State *L, int narg)
3212 luaL_checktype(L, narg, LUA_TUSERDATA);
3213 void *ud = luaL_checkudata(L, narg, className);
3214 if(!ud) luaL_typerror(L, narg, className);
3215 return *(LuaPerlinNoise**)ud; // unbox pointer
3218 static void Register(lua_State *L)
3221 int methodtable = lua_gettop(L);
3222 luaL_newmetatable(L, className);
3223 int metatable = lua_gettop(L);
3225 lua_pushliteral(L, "__metatable");
3226 lua_pushvalue(L, methodtable);
3227 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
3229 lua_pushliteral(L, "__index");
3230 lua_pushvalue(L, methodtable);
3231 lua_settable(L, metatable);
3233 lua_pushliteral(L, "__gc");
3234 lua_pushcfunction(L, gc_object);
3235 lua_settable(L, metatable);
3237 lua_pop(L, 1); // drop metatable
3239 luaL_openlib(L, 0, methods, 0); // fill methodtable
3240 lua_pop(L, 1); // drop methodtable
3242 // Can be created from Lua (PerlinNoise(seed, octaves, persistence)
3243 lua_register(L, className, create_object);
3246 const char LuaPerlinNoise::className[] = "PerlinNoise";
3247 const luaL_reg LuaPerlinNoise::methods[] = {
3248 method(LuaPerlinNoise, get2d),
3249 method(LuaPerlinNoise, get3d),
3261 ServerEnvironment *m_env;
3263 static const char className[];
3264 static const luaL_reg methods[];
3266 static int gc_object(lua_State *L) {
3267 NodeTimerRef *o = *(NodeTimerRef **)(lua_touserdata(L, 1));
3272 static NodeTimerRef *checkobject(lua_State *L, int narg)
3274 luaL_checktype(L, narg, LUA_TUSERDATA);
3275 void *ud = luaL_checkudata(L, narg, className);
3276 if(!ud) luaL_typerror(L, narg, className);
3277 return *(NodeTimerRef**)ud; // unbox pointer
3280 static int l_set(lua_State *L)
3282 NodeTimerRef *o = checkobject(L, 1);
3283 ServerEnvironment *env = o->m_env;
3284 if(env == NULL) return 0;
3285 f32 t = luaL_checknumber(L,2);
3286 f32 e = luaL_checknumber(L,3);
3287 env->getMap().setNodeTimer(o->m_p,NodeTimer(t,e));
3291 static int l_start(lua_State *L)
3293 NodeTimerRef *o = checkobject(L, 1);
3294 ServerEnvironment *env = o->m_env;
3295 if(env == NULL) return 0;
3296 f32 t = luaL_checknumber(L,2);
3297 env->getMap().setNodeTimer(o->m_p,NodeTimer(t,0));
3301 static int l_stop(lua_State *L)
3303 NodeTimerRef *o = checkobject(L, 1);
3304 ServerEnvironment *env = o->m_env;
3305 if(env == NULL) return 0;
3306 env->getMap().removeNodeTimer(o->m_p);
3310 static int l_is_started(lua_State *L)
3312 NodeTimerRef *o = checkobject(L, 1);
3313 ServerEnvironment *env = o->m_env;
3314 if(env == NULL) return 0;
3316 NodeTimer t = env->getMap().getNodeTimer(o->m_p);
3317 lua_pushboolean(L,(t.timeout != 0));
3321 static int l_get_timeout(lua_State *L)
3323 NodeTimerRef *o = checkobject(L, 1);
3324 ServerEnvironment *env = o->m_env;
3325 if(env == NULL) return 0;
3327 NodeTimer t = env->getMap().getNodeTimer(o->m_p);
3328 lua_pushnumber(L,t.timeout);
3332 static int l_get_elapsed(lua_State *L)
3334 NodeTimerRef *o = checkobject(L, 1);
3335 ServerEnvironment *env = o->m_env;
3336 if(env == NULL) return 0;
3338 NodeTimer t = env->getMap().getNodeTimer(o->m_p);
3339 lua_pushnumber(L,t.elapsed);
3344 NodeTimerRef(v3s16 p, ServerEnvironment *env):
3354 // Creates an NodeTimerRef and leaves it on top of stack
3355 // Not callable from Lua; all references are created on the C side.
3356 static void create(lua_State *L, v3s16 p, ServerEnvironment *env)
3358 NodeTimerRef *o = new NodeTimerRef(p, env);
3359 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
3360 luaL_getmetatable(L, className);
3361 lua_setmetatable(L, -2);
3364 static void set_null(lua_State *L)
3366 NodeTimerRef *o = checkobject(L, -1);
3370 static void Register(lua_State *L)
3373 int methodtable = lua_gettop(L);
3374 luaL_newmetatable(L, className);
3375 int metatable = lua_gettop(L);
3377 lua_pushliteral(L, "__metatable");
3378 lua_pushvalue(L, methodtable);
3379 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
3381 lua_pushliteral(L, "__index");
3382 lua_pushvalue(L, methodtable);
3383 lua_settable(L, metatable);
3385 lua_pushliteral(L, "__gc");
3386 lua_pushcfunction(L, gc_object);
3387 lua_settable(L, metatable);
3389 lua_pop(L, 1); // drop metatable
3391 luaL_openlib(L, 0, methods, 0); // fill methodtable
3392 lua_pop(L, 1); // drop methodtable
3394 // Cannot be created from Lua
3395 //lua_register(L, className, create_object);
3398 const char NodeTimerRef::className[] = "NodeTimerRef";
3399 const luaL_reg NodeTimerRef::methods[] = {
3400 method(NodeTimerRef, start),
3401 method(NodeTimerRef, set),
3402 method(NodeTimerRef, stop),
3403 method(NodeTimerRef, is_started),
3404 method(NodeTimerRef, get_timeout),
3405 method(NodeTimerRef, get_elapsed),
3416 ServerEnvironment *m_env;
3418 static const char className[];
3419 static const luaL_reg methods[];
3421 static int gc_object(lua_State *L) {
3422 EnvRef *o = *(EnvRef **)(lua_touserdata(L, 1));
3427 static EnvRef *checkobject(lua_State *L, int narg)
3429 luaL_checktype(L, narg, LUA_TUSERDATA);
3430 void *ud = luaL_checkudata(L, narg, className);
3431 if(!ud) luaL_typerror(L, narg, className);
3432 return *(EnvRef**)ud; // unbox pointer
3435 // Exported functions
3437 // EnvRef:set_node(pos, node)
3438 // pos = {x=num, y=num, z=num}
3439 static int l_set_node(lua_State *L)
3441 EnvRef *o = checkobject(L, 1);
3442 ServerEnvironment *env = o->m_env;
3443 if(env == NULL) return 0;
3444 INodeDefManager *ndef = env->getGameDef()->ndef();
3446 v3s16 pos = read_v3s16(L, 2);
3447 MapNode n = readnode(L, 3, ndef);
3449 MapNode n_old = env->getMap().getNodeNoEx(pos);
3451 if(ndef->get(n_old).has_on_destruct)
3452 scriptapi_node_on_destruct(L, pos, n_old);
3454 bool succeeded = env->getMap().addNodeWithEvent(pos, n);
3456 // Call post-destructor
3457 if(ndef->get(n_old).has_after_destruct)
3458 scriptapi_node_after_destruct(L, pos, n_old);
3460 if(ndef->get(n).has_on_construct)
3461 scriptapi_node_on_construct(L, pos, n);
3463 lua_pushboolean(L, succeeded);
3467 static int l_add_node(lua_State *L)
3469 return l_set_node(L);
3472 // EnvRef:remove_node(pos)
3473 // pos = {x=num, y=num, z=num}
3474 static int l_remove_node(lua_State *L)
3476 EnvRef *o = checkobject(L, 1);
3477 ServerEnvironment *env = o->m_env;
3478 if(env == NULL) return 0;
3479 INodeDefManager *ndef = env->getGameDef()->ndef();
3481 v3s16 pos = read_v3s16(L, 2);
3483 MapNode n_old = env->getMap().getNodeNoEx(pos);
3485 if(ndef->get(n_old).has_on_destruct)
3486 scriptapi_node_on_destruct(L, pos, n_old);
3488 // This is slightly optimized compared to addNodeWithEvent(air)
3489 bool succeeded = env->getMap().removeNodeWithEvent(pos);
3491 // Call post-destructor
3492 if(ndef->get(n_old).has_after_destruct)
3493 scriptapi_node_after_destruct(L, pos, n_old);
3495 lua_pushboolean(L, succeeded);
3496 // Air doesn't require constructor
3500 // EnvRef:get_node(pos)
3501 // pos = {x=num, y=num, z=num}
3502 static int l_get_node(lua_State *L)
3504 EnvRef *o = checkobject(L, 1);
3505 ServerEnvironment *env = o->m_env;
3506 if(env == NULL) return 0;
3508 v3s16 pos = read_v3s16(L, 2);
3510 MapNode n = env->getMap().getNodeNoEx(pos);
3512 pushnode(L, n, env->getGameDef()->ndef());
3516 // EnvRef:get_node_or_nil(pos)
3517 // pos = {x=num, y=num, z=num}
3518 static int l_get_node_or_nil(lua_State *L)
3520 EnvRef *o = checkobject(L, 1);
3521 ServerEnvironment *env = o->m_env;
3522 if(env == NULL) return 0;
3524 v3s16 pos = read_v3s16(L, 2);
3527 MapNode n = env->getMap().getNode(pos);
3529 pushnode(L, n, env->getGameDef()->ndef());
3531 } catch(InvalidPositionException &e)
3538 // EnvRef:get_node_light(pos, timeofday)
3539 // pos = {x=num, y=num, z=num}
3540 // timeofday: nil = current time, 0 = night, 0.5 = day
3541 static int l_get_node_light(lua_State *L)
3543 EnvRef *o = checkobject(L, 1);
3544 ServerEnvironment *env = o->m_env;
3545 if(env == NULL) return 0;
3547 v3s16 pos = read_v3s16(L, 2);
3548 u32 time_of_day = env->getTimeOfDay();
3549 if(lua_isnumber(L, 3))
3550 time_of_day = 24000.0 * lua_tonumber(L, 3);
3551 time_of_day %= 24000;
3552 u32 dnr = time_to_daynight_ratio(time_of_day);
3553 MapNode n = env->getMap().getNodeNoEx(pos);
3555 MapNode n = env->getMap().getNode(pos);
3556 INodeDefManager *ndef = env->getGameDef()->ndef();
3557 lua_pushinteger(L, n.getLightBlend(dnr, ndef));
3559 } catch(InvalidPositionException &e)
3566 // EnvRef:place_node(pos, node)
3567 // pos = {x=num, y=num, z=num}
3568 static int l_place_node(lua_State *L)
3570 EnvRef *o = checkobject(L, 1);
3571 ServerEnvironment *env = o->m_env;
3572 if(env == NULL) return 0;
3573 v3s16 pos = read_v3s16(L, 2);
3574 MapNode n = readnode(L, 3, env->getGameDef()->ndef());
3576 // Don't attempt to load non-loaded area as of now
3577 MapNode n_old = env->getMap().getNodeNoEx(pos);
3578 if(n_old.getContent() == CONTENT_IGNORE){
3579 lua_pushboolean(L, false);
3582 // Create item to place
3583 INodeDefManager *ndef = get_server(L)->ndef();
3584 IItemDefManager *idef = get_server(L)->idef();
3585 ItemStack item(ndef->get(n).name, 1, 0, "", idef);
3586 // Make pointed position
3587 PointedThing pointed;
3588 pointed.type = POINTEDTHING_NODE;
3589 pointed.node_abovesurface = pos;
3590 pointed.node_undersurface = pos + v3s16(0,-1,0);
3591 // Place it with a NULL placer (appears in Lua as a non-functional
3593 bool success = scriptapi_item_on_place(L, item, NULL, pointed);
3594 lua_pushboolean(L, success);
3598 // EnvRef:dig_node(pos)
3599 // pos = {x=num, y=num, z=num}
3600 static int l_dig_node(lua_State *L)
3602 EnvRef *o = checkobject(L, 1);
3603 ServerEnvironment *env = o->m_env;
3604 if(env == NULL) return 0;
3605 v3s16 pos = read_v3s16(L, 2);
3607 // Don't attempt to load non-loaded area as of now
3608 MapNode n = env->getMap().getNodeNoEx(pos);
3609 if(n.getContent() == CONTENT_IGNORE){
3610 lua_pushboolean(L, false);
3613 // Dig it out with a NULL digger (appears in Lua as a
3614 // non-functional ObjectRef)
3615 bool success = scriptapi_node_on_dig(L, pos, n, NULL);
3616 lua_pushboolean(L, success);
3620 // EnvRef:punch_node(pos)
3621 // pos = {x=num, y=num, z=num}
3622 static int l_punch_node(lua_State *L)
3624 EnvRef *o = checkobject(L, 1);
3625 ServerEnvironment *env = o->m_env;
3626 if(env == NULL) return 0;
3627 v3s16 pos = read_v3s16(L, 2);
3629 // Don't attempt to load non-loaded area as of now
3630 MapNode n = env->getMap().getNodeNoEx(pos);
3631 if(n.getContent() == CONTENT_IGNORE){
3632 lua_pushboolean(L, false);
3635 // Punch it with a NULL puncher (appears in Lua as a non-functional
3637 bool success = scriptapi_node_on_punch(L, pos, n, NULL);
3638 lua_pushboolean(L, success);
3642 // EnvRef:get_meta(pos)
3643 static int l_get_meta(lua_State *L)
3645 //infostream<<"EnvRef::l_get_meta()"<<std::endl;
3646 EnvRef *o = checkobject(L, 1);
3647 ServerEnvironment *env = o->m_env;
3648 if(env == NULL) return 0;
3650 v3s16 p = read_v3s16(L, 2);
3651 NodeMetaRef::create(L, p, env);
3655 // EnvRef:get_node_timer(pos)
3656 static int l_get_node_timer(lua_State *L)
3658 EnvRef *o = checkobject(L, 1);
3659 ServerEnvironment *env = o->m_env;
3660 if(env == NULL) return 0;
3662 v3s16 p = read_v3s16(L, 2);
3663 NodeTimerRef::create(L, p, env);
3667 // EnvRef:add_entity(pos, entityname) -> ObjectRef or nil
3668 // pos = {x=num, y=num, z=num}
3669 static int l_add_entity(lua_State *L)
3671 //infostream<<"EnvRef::l_add_entity()"<<std::endl;
3672 EnvRef *o = checkobject(L, 1);
3673 ServerEnvironment *env = o->m_env;
3674 if(env == NULL) return 0;
3676 v3f pos = checkFloatPos(L, 2);
3678 const char *name = luaL_checkstring(L, 3);
3680 ServerActiveObject *obj = new LuaEntitySAO(env, pos, name, "");
3681 int objectid = env->addActiveObject(obj);
3682 // If failed to add, return nothing (reads as nil)
3686 objectref_get_or_create(L, obj);
3690 // EnvRef:add_item(pos, itemstack or itemstring or table) -> ObjectRef or nil
3691 // pos = {x=num, y=num, z=num}
3692 static int l_add_item(lua_State *L)
3694 //infostream<<"EnvRef::l_add_item()"<<std::endl;
3695 EnvRef *o = checkobject(L, 1);
3696 ServerEnvironment *env = o->m_env;
3697 if(env == NULL) return 0;
3699 v3f pos = checkFloatPos(L, 2);
3701 ItemStack item = read_item(L, 3);
3702 if(item.empty() || !item.isKnown(get_server(L)->idef()))
3704 // Use minetest.spawn_item to spawn a __builtin:item
3705 lua_getglobal(L, "minetest");
3706 lua_getfield(L, -1, "spawn_item");
3707 if(lua_isnil(L, -1))
3709 lua_pushvalue(L, 2);
3710 lua_pushstring(L, item.getItemString().c_str());
3711 if(lua_pcall(L, 2, 1, 0))
3712 script_error(L, "error: %s", lua_tostring(L, -1));
3714 /*lua_pushvalue(L, 1);
3715 lua_pushstring(L, "__builtin:item");
3716 lua_pushstring(L, item.getItemString().c_str());
3717 return l_add_entity(L);*/
3719 ServerActiveObject *obj = createItemSAO(env, pos, item.getItemString());
3720 int objectid = env->addActiveObject(obj);
3721 // If failed to add, return nothing (reads as nil)
3725 objectref_get_or_create(L, obj);
3729 // EnvRef:add_rat(pos)
3730 // pos = {x=num, y=num, z=num}
3731 static int l_add_rat(lua_State *L)
3733 infostream<<"EnvRef::l_add_rat(): C++ mobs have been removed."
3734 <<" Doing nothing."<<std::endl;
3738 // EnvRef:add_firefly(pos)
3739 // pos = {x=num, y=num, z=num}
3740 static int l_add_firefly(lua_State *L)
3742 infostream<<"EnvRef::l_add_firefly(): C++ mobs have been removed."
3743 <<" Doing nothing."<<std::endl;
3747 // EnvRef:get_player_by_name(name)
3748 static int l_get_player_by_name(lua_State *L)
3750 EnvRef *o = checkobject(L, 1);
3751 ServerEnvironment *env = o->m_env;
3752 if(env == NULL) return 0;
3754 const char *name = luaL_checkstring(L, 2);
3755 Player *player = env->getPlayer(name);
3760 PlayerSAO *sao = player->getPlayerSAO();
3765 // Put player on stack
3766 objectref_get_or_create(L, sao);
3770 // EnvRef:get_objects_inside_radius(pos, radius)
3771 static int l_get_objects_inside_radius(lua_State *L)
3773 // Get the table insert function
3774 lua_getglobal(L, "table");
3775 lua_getfield(L, -1, "insert");
3776 int table_insert = lua_gettop(L);
3778 EnvRef *o = checkobject(L, 1);
3779 ServerEnvironment *env = o->m_env;
3780 if(env == NULL) return 0;
3782 v3f pos = checkFloatPos(L, 2);
3783 float radius = luaL_checknumber(L, 3) * BS;
3784 std::set<u16> ids = env->getObjectsInsideRadius(pos, radius);
3786 int table = lua_gettop(L);
3787 for(std::set<u16>::const_iterator
3788 i = ids.begin(); i != ids.end(); i++){
3789 ServerActiveObject *obj = env->getActiveObject(*i);
3790 // Insert object reference into table
3791 lua_pushvalue(L, table_insert);
3792 lua_pushvalue(L, table);
3793 objectref_get_or_create(L, obj);
3794 if(lua_pcall(L, 2, 0, 0))
3795 script_error(L, "error: %s", lua_tostring(L, -1));
3800 // EnvRef:set_timeofday(val)
3802 static int l_set_timeofday(lua_State *L)
3804 EnvRef *o = checkobject(L, 1);
3805 ServerEnvironment *env = o->m_env;
3806 if(env == NULL) return 0;
3808 float timeofday_f = luaL_checknumber(L, 2);
3809 assert(timeofday_f >= 0.0 && timeofday_f <= 1.0);
3810 int timeofday_mh = (int)(timeofday_f * 24000.0);
3811 // This should be set directly in the environment but currently
3812 // such changes aren't immediately sent to the clients, so call
3813 // the server instead.
3814 //env->setTimeOfDay(timeofday_mh);
3815 get_server(L)->setTimeOfDay(timeofday_mh);
3819 // EnvRef:get_timeofday() -> 0...1
3820 static int l_get_timeofday(lua_State *L)
3822 EnvRef *o = checkobject(L, 1);
3823 ServerEnvironment *env = o->m_env;
3824 if(env == NULL) return 0;
3826 int timeofday_mh = env->getTimeOfDay();
3827 float timeofday_f = (float)timeofday_mh / 24000.0;
3828 lua_pushnumber(L, timeofday_f);
3833 // EnvRef:find_node_near(pos, radius, nodenames) -> pos or nil
3834 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
3835 static int l_find_node_near(lua_State *L)
3837 EnvRef *o = checkobject(L, 1);
3838 ServerEnvironment *env = o->m_env;
3839 if(env == NULL) return 0;
3840 INodeDefManager *ndef = get_server(L)->ndef();
3841 v3s16 pos = read_v3s16(L, 2);
3842 int radius = luaL_checkinteger(L, 3);
3843 std::set<content_t> filter;
3844 if(lua_istable(L, 4)){
3847 while(lua_next(L, table) != 0){
3848 // key at index -2 and value at index -1
3849 luaL_checktype(L, -1, LUA_TSTRING);
3850 ndef->getIds(lua_tostring(L, -1), filter);
3851 // removes value, keeps key for next iteration
3854 } else if(lua_isstring(L, 4)){
3855 ndef->getIds(lua_tostring(L, 4), filter);
3858 for(int d=1; d<=radius; d++){
3859 core::list<v3s16> list;
3860 getFacePositions(list, d);
3861 for(core::list<v3s16>::Iterator i = list.begin();
3862 i != list.end(); i++){
3863 v3s16 p = pos + (*i);
3864 content_t c = env->getMap().getNodeNoEx(p).getContent();
3865 if(filter.count(c) != 0){
3874 // EnvRef:find_nodes_in_area(minp, maxp, nodenames) -> list of positions
3875 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
3876 static int l_find_nodes_in_area(lua_State *L)
3878 EnvRef *o = checkobject(L, 1);
3879 ServerEnvironment *env = o->m_env;
3880 if(env == NULL) return 0;
3881 INodeDefManager *ndef = get_server(L)->ndef();
3882 v3s16 minp = read_v3s16(L, 2);
3883 v3s16 maxp = read_v3s16(L, 3);
3884 std::set<content_t> filter;
3885 if(lua_istable(L, 4)){
3888 while(lua_next(L, table) != 0){
3889 // key at index -2 and value at index -1
3890 luaL_checktype(L, -1, LUA_TSTRING);
3891 ndef->getIds(lua_tostring(L, -1), filter);
3892 // removes value, keeps key for next iteration
3895 } else if(lua_isstring(L, 4)){
3896 ndef->getIds(lua_tostring(L, 4), filter);
3899 // Get the table insert function
3900 lua_getglobal(L, "table");
3901 lua_getfield(L, -1, "insert");
3902 int table_insert = lua_gettop(L);
3905 int table = lua_gettop(L);
3906 for(s16 x=minp.X; x<=maxp.X; x++)
3907 for(s16 y=minp.Y; y<=maxp.Y; y++)
3908 for(s16 z=minp.Z; z<=maxp.Z; z++)
3911 content_t c = env->getMap().getNodeNoEx(p).getContent();
3912 if(filter.count(c) != 0){
3913 lua_pushvalue(L, table_insert);
3914 lua_pushvalue(L, table);
3916 if(lua_pcall(L, 2, 0, 0))
3917 script_error(L, "error: %s", lua_tostring(L, -1));
3923 // EnvRef:get_perlin(seeddiff, octaves, persistence, scale)
3924 // returns world-specific PerlinNoise
3925 static int l_get_perlin(lua_State *L)
3927 EnvRef *o = checkobject(L, 1);
3928 ServerEnvironment *env = o->m_env;
3929 if(env == NULL) return 0;
3931 int seeddiff = luaL_checkint(L, 2);
3932 int octaves = luaL_checkint(L, 3);
3933 double persistence = luaL_checknumber(L, 4);
3934 double scale = luaL_checknumber(L, 5);
3936 LuaPerlinNoise *n = new LuaPerlinNoise(seeddiff + int(env->getServerMap().getSeed()), octaves, persistence, scale);
3937 *(void **)(lua_newuserdata(L, sizeof(void *))) = n;
3938 luaL_getmetatable(L, "PerlinNoise");
3939 lua_setmetatable(L, -2);
3943 // EnvRef:clear_objects()
3944 // clear all objects in the environment
3945 static int l_clear_objects(lua_State *L)
3947 EnvRef *o = checkobject(L, 1);
3948 o->m_env->clearAllObjects();
3953 EnvRef(ServerEnvironment *env):
3956 //infostream<<"EnvRef created"<<std::endl;
3961 //infostream<<"EnvRef destructing"<<std::endl;
3964 // Creates an EnvRef and leaves it on top of stack
3965 // Not callable from Lua; all references are created on the C side.
3966 static void create(lua_State *L, ServerEnvironment *env)
3968 EnvRef *o = new EnvRef(env);
3969 //infostream<<"EnvRef::create: o="<<o<<std::endl;
3970 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
3971 luaL_getmetatable(L, className);
3972 lua_setmetatable(L, -2);
3975 static void set_null(lua_State *L)
3977 EnvRef *o = checkobject(L, -1);
3981 static void Register(lua_State *L)
3984 int methodtable = lua_gettop(L);
3985 luaL_newmetatable(L, className);
3986 int metatable = lua_gettop(L);
3988 lua_pushliteral(L, "__metatable");
3989 lua_pushvalue(L, methodtable);
3990 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
3992 lua_pushliteral(L, "__index");
3993 lua_pushvalue(L, methodtable);
3994 lua_settable(L, metatable);
3996 lua_pushliteral(L, "__gc");
3997 lua_pushcfunction(L, gc_object);
3998 lua_settable(L, metatable);
4000 lua_pop(L, 1); // drop metatable
4002 luaL_openlib(L, 0, methods, 0); // fill methodtable
4003 lua_pop(L, 1); // drop methodtable
4005 // Cannot be created from Lua
4006 //lua_register(L, className, create_object);
4009 const char EnvRef::className[] = "EnvRef";
4010 const luaL_reg EnvRef::methods[] = {
4011 method(EnvRef, set_node),
4012 method(EnvRef, add_node),
4013 method(EnvRef, remove_node),
4014 method(EnvRef, get_node),
4015 method(EnvRef, get_node_or_nil),
4016 method(EnvRef, get_node_light),
4017 method(EnvRef, place_node),
4018 method(EnvRef, dig_node),
4019 method(EnvRef, punch_node),
4020 method(EnvRef, add_entity),
4021 method(EnvRef, add_item),
4022 method(EnvRef, add_rat),
4023 method(EnvRef, add_firefly),
4024 method(EnvRef, get_meta),
4025 method(EnvRef, get_node_timer),
4026 method(EnvRef, get_player_by_name),
4027 method(EnvRef, get_objects_inside_radius),
4028 method(EnvRef, set_timeofday),
4029 method(EnvRef, get_timeofday),
4030 method(EnvRef, find_node_near),
4031 method(EnvRef, find_nodes_in_area),
4032 method(EnvRef, get_perlin),
4033 method(EnvRef, clear_objects),
4042 class LuaPseudoRandom
4045 PseudoRandom m_pseudo;
4047 static const char className[];
4048 static const luaL_reg methods[];
4050 // Exported functions
4052 // garbage collector
4053 static int gc_object(lua_State *L)
4055 LuaPseudoRandom *o = *(LuaPseudoRandom **)(lua_touserdata(L, 1));
4060 // next(self, min=0, max=32767) -> get next value
4061 static int l_next(lua_State *L)
4063 LuaPseudoRandom *o = checkobject(L, 1);
4066 lua_settop(L, 3); // Fill 2 and 3 with nil if they don't exist
4067 if(!lua_isnil(L, 2))
4068 min = luaL_checkinteger(L, 2);
4069 if(!lua_isnil(L, 3))
4070 max = luaL_checkinteger(L, 3);
4072 errorstream<<"PseudoRandom.next(): max="<<max<<" min="<<min<<std::endl;
4073 throw LuaError(L, "PseudoRandom.next(): max < min");
4075 if(max - min != 32767 && max - min > 32767/5)
4076 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.");
4077 PseudoRandom &pseudo = o->m_pseudo;
4078 int val = pseudo.next();
4079 val = (val % (max-min+1)) + min;
4080 lua_pushinteger(L, val);
4085 LuaPseudoRandom(int seed):
4094 const PseudoRandom& getItem() const
4098 PseudoRandom& getItem()
4103 // LuaPseudoRandom(seed)
4104 // Creates an LuaPseudoRandom and leaves it on top of stack
4105 static int create_object(lua_State *L)
4107 int seed = luaL_checknumber(L, 1);
4108 LuaPseudoRandom *o = new LuaPseudoRandom(seed);
4109 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
4110 luaL_getmetatable(L, className);
4111 lua_setmetatable(L, -2);
4115 static LuaPseudoRandom* checkobject(lua_State *L, int narg)
4117 luaL_checktype(L, narg, LUA_TUSERDATA);
4118 void *ud = luaL_checkudata(L, narg, className);
4119 if(!ud) luaL_typerror(L, narg, className);
4120 return *(LuaPseudoRandom**)ud; // unbox pointer
4123 static void Register(lua_State *L)
4126 int methodtable = lua_gettop(L);
4127 luaL_newmetatable(L, className);
4128 int metatable = lua_gettop(L);
4130 lua_pushliteral(L, "__metatable");
4131 lua_pushvalue(L, methodtable);
4132 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
4134 lua_pushliteral(L, "__index");
4135 lua_pushvalue(L, methodtable);
4136 lua_settable(L, metatable);
4138 lua_pushliteral(L, "__gc");
4139 lua_pushcfunction(L, gc_object);
4140 lua_settable(L, metatable);
4142 lua_pop(L, 1); // drop metatable
4144 luaL_openlib(L, 0, methods, 0); // fill methodtable
4145 lua_pop(L, 1); // drop methodtable
4147 // Can be created from Lua (LuaPseudoRandom(seed))
4148 lua_register(L, className, create_object);
4151 const char LuaPseudoRandom::className[] = "PseudoRandom";
4152 const luaL_reg LuaPseudoRandom::methods[] = {
4153 method(LuaPseudoRandom, next),
4163 class LuaABM : public ActiveBlockModifier
4169 std::set<std::string> m_trigger_contents;
4170 std::set<std::string> m_required_neighbors;
4171 float m_trigger_interval;
4172 u32 m_trigger_chance;
4174 LuaABM(lua_State *L, int id,
4175 const std::set<std::string> &trigger_contents,
4176 const std::set<std::string> &required_neighbors,
4177 float trigger_interval, u32 trigger_chance):
4180 m_trigger_contents(trigger_contents),
4181 m_required_neighbors(required_neighbors),
4182 m_trigger_interval(trigger_interval),
4183 m_trigger_chance(trigger_chance)
4186 virtual std::set<std::string> getTriggerContents()
4188 return m_trigger_contents;
4190 virtual std::set<std::string> getRequiredNeighbors()
4192 return m_required_neighbors;
4194 virtual float getTriggerInterval()
4196 return m_trigger_interval;
4198 virtual u32 getTriggerChance()
4200 return m_trigger_chance;
4202 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
4203 u32 active_object_count, u32 active_object_count_wider)
4205 lua_State *L = m_lua;
4208 assert(lua_checkstack(L, 20));
4209 StackUnroller stack_unroller(L);
4211 // Get minetest.registered_abms
4212 lua_getglobal(L, "minetest");
4213 lua_getfield(L, -1, "registered_abms");
4214 luaL_checktype(L, -1, LUA_TTABLE);
4215 int registered_abms = lua_gettop(L);
4217 // Get minetest.registered_abms[m_id]
4218 lua_pushnumber(L, m_id);
4219 lua_gettable(L, registered_abms);
4220 if(lua_isnil(L, -1))
4224 luaL_checktype(L, -1, LUA_TTABLE);
4225 lua_getfield(L, -1, "action");
4226 luaL_checktype(L, -1, LUA_TFUNCTION);
4228 pushnode(L, n, env->getGameDef()->ndef());
4229 lua_pushnumber(L, active_object_count);
4230 lua_pushnumber(L, active_object_count_wider);
4231 if(lua_pcall(L, 4, 0, 0))
4232 script_error(L, "error: %s", lua_tostring(L, -1));
4240 static void read_server_sound_params(lua_State *L, int index,
4241 ServerSoundParams ¶ms)
4244 index = lua_gettop(L) + 1 + index;
4246 params = ServerSoundParams();
4247 if(lua_istable(L, index)){
4248 getfloatfield(L, index, "gain", params.gain);
4249 getstringfield(L, index, "to_player", params.to_player);
4250 lua_getfield(L, index, "pos");
4251 if(!lua_isnil(L, -1)){
4252 v3f p = read_v3f(L, -1)*BS;
4254 params.type = ServerSoundParams::SSP_POSITIONAL;
4257 lua_getfield(L, index, "object");
4258 if(!lua_isnil(L, -1)){
4259 ObjectRef *ref = ObjectRef::checkobject(L, -1);
4260 ServerActiveObject *sao = ObjectRef::getobject(ref);
4262 params.object = sao->getId();
4263 params.type = ServerSoundParams::SSP_OBJECT;
4267 params.max_hear_distance = BS*getfloatfield_default(L, index,
4268 "max_hear_distance", params.max_hear_distance/BS);
4269 getboolfield(L, index, "loop", params.loop);
4278 // Writes a line to dstream
4279 static int l_debug(lua_State *L)
4281 std::string text = lua_tostring(L, 1);
4282 dstream << text << std::endl;
4286 // log([level,] text)
4287 // Writes a line to the logger.
4288 // The one-argument version logs to infostream.
4289 // The two-argument version accept a log level: error, action, info, or verbose.
4290 static int l_log(lua_State *L)
4293 LogMessageLevel level = LMT_INFO;
4294 if(lua_isnone(L, 2))
4296 text = lua_tostring(L, 1);
4300 std::string levelname = lua_tostring(L, 1);
4301 text = lua_tostring(L, 2);
4302 if(levelname == "error")
4304 else if(levelname == "action")
4306 else if(levelname == "verbose")
4307 level = LMT_VERBOSE;
4309 log_printline(level, text);
4313 // request_shutdown()
4314 static int l_request_shutdown(lua_State *L)
4316 get_server(L)->requestShutdown();
4320 // get_server_status()
4321 static int l_get_server_status(lua_State *L)
4323 lua_pushstring(L, wide_to_narrow(get_server(L)->getStatusString()).c_str());
4327 // register_item_raw({lots of stuff})
4328 static int l_register_item_raw(lua_State *L)
4330 luaL_checktype(L, 1, LUA_TTABLE);
4333 // Get the writable item and node definition managers from the server
4334 IWritableItemDefManager *idef =
4335 get_server(L)->getWritableItemDefManager();
4336 IWritableNodeDefManager *ndef =
4337 get_server(L)->getWritableNodeDefManager();
4339 // Check if name is defined
4341 lua_getfield(L, table, "name");
4342 if(lua_isstring(L, -1)){
4343 name = lua_tostring(L, -1);
4344 verbosestream<<"register_item_raw: "<<name<<std::endl;
4346 throw LuaError(L, "register_item_raw: name is not defined or not a string");
4349 // Check if on_use is defined
4352 // Set a distinctive default value to check if this is set
4353 def.node_placement_prediction = "__default";
4355 // Read the item definition
4356 def = read_item_definition(L, table, def);
4358 // Default to having client-side placement prediction for nodes
4359 // ("" in item definition sets it off)
4360 if(def.node_placement_prediction == "__default"){
4361 if(def.type == ITEM_NODE)
4362 def.node_placement_prediction = name;
4364 def.node_placement_prediction = "";
4367 // Register item definition
4368 idef->registerItem(def);
4370 // Read the node definition (content features) and register it
4371 if(def.type == ITEM_NODE)
4373 ContentFeatures f = read_content_features(L, table);
4374 ndef->set(f.name, f);
4377 return 0; /* number of results */
4380 // register_alias_raw(name, convert_to_name)
4381 static int l_register_alias_raw(lua_State *L)
4383 std::string name = luaL_checkstring(L, 1);
4384 std::string convert_to = luaL_checkstring(L, 2);
4386 // Get the writable item definition manager from the server
4387 IWritableItemDefManager *idef =
4388 get_server(L)->getWritableItemDefManager();
4390 idef->registerAlias(name, convert_to);
4392 return 0; /* number of results */
4395 // helper for register_craft
4396 static bool read_craft_recipe_shaped(lua_State *L, int index,
4397 int &width, std::vector<std::string> &recipe)
4400 index = lua_gettop(L) + 1 + index;
4402 if(!lua_istable(L, index))
4407 while(lua_next(L, index) != 0){
4409 // key at index -2 and value at index -1
4410 if(!lua_istable(L, -1))
4412 int table2 = lua_gettop(L);
4414 while(lua_next(L, table2) != 0){
4415 // key at index -2 and value at index -1
4416 if(!lua_isstring(L, -1))
4418 recipe.push_back(lua_tostring(L, -1));
4419 // removes value, keeps key for next iteration
4426 if(colcount != width)
4429 // removes value, keeps key for next iteration
4436 // helper for register_craft
4437 static bool read_craft_recipe_shapeless(lua_State *L, int index,
4438 std::vector<std::string> &recipe)
4441 index = lua_gettop(L) + 1 + index;
4443 if(!lua_istable(L, index))
4447 while(lua_next(L, index) != 0){
4448 // key at index -2 and value at index -1
4449 if(!lua_isstring(L, -1))
4451 recipe.push_back(lua_tostring(L, -1));
4452 // removes value, keeps key for next iteration
4458 // helper for register_craft
4459 static bool read_craft_replacements(lua_State *L, int index,
4460 CraftReplacements &replacements)
4463 index = lua_gettop(L) + 1 + index;
4465 if(!lua_istable(L, index))
4469 while(lua_next(L, index) != 0){
4470 // key at index -2 and value at index -1
4471 if(!lua_istable(L, -1))
4473 lua_rawgeti(L, -1, 1);
4474 if(!lua_isstring(L, -1))
4476 std::string replace_from = lua_tostring(L, -1);
4478 lua_rawgeti(L, -1, 2);
4479 if(!lua_isstring(L, -1))
4481 std::string replace_to = lua_tostring(L, -1);
4483 replacements.pairs.push_back(
4484 std::make_pair(replace_from, replace_to));
4485 // removes value, keeps key for next iteration
4490 // register_craft({output=item, recipe={{item00,item10},{item01,item11}})
4491 static int l_register_craft(lua_State *L)
4493 //infostream<<"register_craft"<<std::endl;
4494 luaL_checktype(L, 1, LUA_TTABLE);
4497 // Get the writable craft definition manager from the server
4498 IWritableCraftDefManager *craftdef =
4499 get_server(L)->getWritableCraftDefManager();
4501 std::string type = getstringfield_default(L, table, "type", "shaped");
4504 CraftDefinitionShaped
4506 if(type == "shaped"){
4507 std::string output = getstringfield_default(L, table, "output", "");
4509 throw LuaError(L, "Crafting definition is missing an output");
4512 std::vector<std::string> recipe;
4513 lua_getfield(L, table, "recipe");
4514 if(lua_isnil(L, -1))
4515 throw LuaError(L, "Crafting definition is missing a recipe"
4516 " (output=\"" + output + "\")");
4517 if(!read_craft_recipe_shaped(L, -1, width, recipe))
4518 throw LuaError(L, "Invalid crafting recipe"
4519 " (output=\"" + output + "\")");
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 " (output=\"" + output + "\")");
4530 CraftDefinition *def = new CraftDefinitionShaped(
4531 output, width, recipe, replacements);
4532 craftdef->registerCraft(def);
4535 CraftDefinitionShapeless
4537 else if(type == "shapeless"){
4538 std::string output = getstringfield_default(L, table, "output", "");
4540 throw LuaError(L, "Crafting definition (shapeless)"
4541 " is missing an output");
4543 std::vector<std::string> recipe;
4544 lua_getfield(L, table, "recipe");
4545 if(lua_isnil(L, -1))
4546 throw LuaError(L, "Crafting definition (shapeless)"
4547 " is missing a recipe"
4548 " (output=\"" + output + "\")");
4549 if(!read_craft_recipe_shapeless(L, -1, recipe))
4550 throw LuaError(L, "Invalid crafting recipe"
4551 " (output=\"" + output + "\")");
4553 CraftReplacements replacements;
4554 lua_getfield(L, table, "replacements");
4555 if(!lua_isnil(L, -1))
4557 if(!read_craft_replacements(L, -1, replacements))
4558 throw LuaError(L, "Invalid replacements"
4559 " (output=\"" + output + "\")");
4562 CraftDefinition *def = new CraftDefinitionShapeless(
4563 output, recipe, replacements);
4564 craftdef->registerCraft(def);
4567 CraftDefinitionToolRepair
4569 else if(type == "toolrepair"){
4570 float additional_wear = getfloatfield_default(L, table,
4571 "additional_wear", 0.0);
4573 CraftDefinition *def = new CraftDefinitionToolRepair(
4575 craftdef->registerCraft(def);
4578 CraftDefinitionCooking
4580 else if(type == "cooking"){
4581 std::string output = getstringfield_default(L, table, "output", "");
4583 throw LuaError(L, "Crafting definition (cooking)"
4584 " is missing an output");
4586 std::string recipe = getstringfield_default(L, table, "recipe", "");
4588 throw LuaError(L, "Crafting definition (cooking)"
4589 " is missing a recipe"
4590 " (output=\"" + output + "\")");
4592 float cooktime = getfloatfield_default(L, table, "cooktime", 3.0);
4594 CraftReplacements replacements;
4595 lua_getfield(L, table, "replacements");
4596 if(!lua_isnil(L, -1))
4598 if(!read_craft_replacements(L, -1, replacements))
4599 throw LuaError(L, "Invalid replacements"
4600 " (cooking output=\"" + output + "\")");
4603 CraftDefinition *def = new CraftDefinitionCooking(
4604 output, recipe, cooktime, replacements);
4605 craftdef->registerCraft(def);
4610 else if(type == "fuel"){
4611 std::string recipe = getstringfield_default(L, table, "recipe", "");
4613 throw LuaError(L, "Crafting definition (fuel)"
4614 " is missing a recipe");
4616 float burntime = getfloatfield_default(L, table, "burntime", 1.0);
4618 CraftReplacements replacements;
4619 lua_getfield(L, table, "replacements");
4620 if(!lua_isnil(L, -1))
4622 if(!read_craft_replacements(L, -1, replacements))
4623 throw LuaError(L, "Invalid replacements"
4624 " (fuel recipe=\"" + recipe + "\")");
4627 CraftDefinition *def = new CraftDefinitionFuel(
4628 recipe, burntime, replacements);
4629 craftdef->registerCraft(def);
4633 throw LuaError(L, "Unknown crafting definition type: \"" + type + "\"");
4637 return 0; /* number of results */
4640 // setting_set(name, value)
4641 static int l_setting_set(lua_State *L)
4643 const char *name = luaL_checkstring(L, 1);
4644 const char *value = luaL_checkstring(L, 2);
4645 g_settings->set(name, value);
4649 // setting_get(name)
4650 static int l_setting_get(lua_State *L)
4652 const char *name = luaL_checkstring(L, 1);
4654 std::string value = g_settings->get(name);
4655 lua_pushstring(L, value.c_str());
4656 } catch(SettingNotFoundException &e){
4662 // setting_getbool(name)
4663 static int l_setting_getbool(lua_State *L)
4665 const char *name = luaL_checkstring(L, 1);
4667 bool value = g_settings->getBool(name);
4668 lua_pushboolean(L, value);
4669 } catch(SettingNotFoundException &e){
4675 // chat_send_all(text)
4676 static int l_chat_send_all(lua_State *L)
4678 const char *text = luaL_checkstring(L, 1);
4679 // Get server from registry
4680 Server *server = get_server(L);
4682 server->notifyPlayers(narrow_to_wide(text));
4686 // chat_send_player(name, text)
4687 static int l_chat_send_player(lua_State *L)
4689 const char *name = luaL_checkstring(L, 1);
4690 const char *text = luaL_checkstring(L, 2);
4691 // Get server from registry
4692 Server *server = get_server(L);
4694 server->notifyPlayer(name, narrow_to_wide(text));
4698 // get_player_privs(name, text)
4699 static int l_get_player_privs(lua_State *L)
4701 const char *name = luaL_checkstring(L, 1);
4702 // Get server from registry
4703 Server *server = get_server(L);
4706 int table = lua_gettop(L);
4707 std::set<std::string> privs_s = server->getPlayerEffectivePrivs(name);
4708 for(std::set<std::string>::const_iterator
4709 i = privs_s.begin(); i != privs_s.end(); i++){
4710 lua_pushboolean(L, true);
4711 lua_setfield(L, table, i->c_str());
4713 lua_pushvalue(L, table);
4718 static int l_get_ban_list(lua_State *L)
4720 lua_pushstring(L, get_server(L)->getBanDescription("").c_str());
4724 // get_ban_description()
4725 static int l_get_ban_description(lua_State *L)
4727 const char * ip_or_name = luaL_checkstring(L, 1);
4728 lua_pushstring(L, get_server(L)->getBanDescription(std::string(ip_or_name)).c_str());
4733 static int l_ban_player(lua_State *L)
4735 const char * name = luaL_checkstring(L, 1);
4736 Player *player = get_env(L)->getPlayer(name);
4739 lua_pushboolean(L, false); // no such player
4744 Address addr = get_server(L)->getPeerAddress(get_env(L)->getPlayer(name)->peer_id);
4745 std::string ip_str = addr.serializeString();
4746 get_server(L)->setIpBanned(ip_str, name);
4748 catch(con::PeerNotFoundException) // unlikely
4750 dstream << __FUNCTION_NAME << ": peer was not found" << std::endl;
4751 lua_pushboolean(L, false); // error
4754 lua_pushboolean(L, true);
4758 // unban_player_or_ip()
4759 static int l_unban_player_of_ip(lua_State *L)
4761 const char * ip_or_name = luaL_checkstring(L, 1);
4762 get_server(L)->unsetIpBanned(ip_or_name);
4763 lua_pushboolean(L, true);
4767 // get_inventory(location)
4768 static int l_get_inventory(lua_State *L)
4770 InventoryLocation loc;
4772 std::string type = checkstringfield(L, 1, "type");
4773 if(type == "player"){
4774 std::string name = checkstringfield(L, 1, "name");
4775 loc.setPlayer(name);
4776 } else if(type == "node"){
4777 lua_getfield(L, 1, "pos");
4778 v3s16 pos = check_v3s16(L, -1);
4779 loc.setNodeMeta(pos);
4780 } else if(type == "detached"){
4781 std::string name = checkstringfield(L, 1, "name");
4782 loc.setDetached(name);
4785 if(get_server(L)->getInventory(loc) != NULL)
4786 InvRef::create(L, loc);
4792 // create_detached_inventory_raw(name)
4793 static int l_create_detached_inventory_raw(lua_State *L)
4795 const char *name = luaL_checkstring(L, 1);
4796 if(get_server(L)->createDetachedInventory(name) != NULL){
4797 InventoryLocation loc;
4798 loc.setDetached(name);
4799 InvRef::create(L, loc);
4806 // get_dig_params(groups, tool_capabilities[, time_from_last_punch])
4807 static int l_get_dig_params(lua_State *L)
4809 std::map<std::string, int> groups;
4810 read_groups(L, 1, groups);
4811 ToolCapabilities tp = read_tool_capabilities(L, 2);
4812 if(lua_isnoneornil(L, 3))
4813 push_dig_params(L, getDigParams(groups, &tp));
4815 push_dig_params(L, getDigParams(groups, &tp,
4816 luaL_checknumber(L, 3)));
4820 // get_hit_params(groups, tool_capabilities[, time_from_last_punch])
4821 static int l_get_hit_params(lua_State *L)
4823 std::map<std::string, int> groups;
4824 read_groups(L, 1, groups);
4825 ToolCapabilities tp = read_tool_capabilities(L, 2);
4826 if(lua_isnoneornil(L, 3))
4827 push_hit_params(L, getHitParams(groups, &tp));
4829 push_hit_params(L, getHitParams(groups, &tp,
4830 luaL_checknumber(L, 3)));
4834 // get_current_modname()
4835 static int l_get_current_modname(lua_State *L)
4837 lua_getfield(L, LUA_REGISTRYINDEX, "minetest_current_modname");
4841 // get_modpath(modname)
4842 static int l_get_modpath(lua_State *L)
4844 std::string modname = luaL_checkstring(L, 1);
4846 if(modname == "__builtin"){
4847 std::string path = get_server(L)->getBuiltinLuaPath();
4848 lua_pushstring(L, path.c_str());
4851 const ModSpec *mod = get_server(L)->getModSpec(modname);
4856 lua_pushstring(L, mod->path.c_str());
4861 // the returned list is sorted alphabetically for you
4862 static int l_get_modnames(lua_State *L)
4864 // Get a list of mods
4865 core::list<std::string> mods_unsorted, mods_sorted;
4866 get_server(L)->getModNames(mods_unsorted);
4868 // Take unsorted items from mods_unsorted and sort them into
4869 // mods_sorted; not great performance but the number of mods on a
4870 // server will likely be small.
4871 for(core::list<std::string>::Iterator i = mods_unsorted.begin();
4872 i != mods_unsorted.end(); i++)
4875 for(core::list<std::string>::Iterator x = mods_sorted.begin();
4876 x != mods_unsorted.end(); x++)
4878 // I doubt anybody using Minetest will be using
4879 // anything not ASCII based :)
4880 if((*i).compare(*x) <= 0)
4882 mods_sorted.insert_before(x, *i);
4888 mods_sorted.push_back(*i);
4891 // Get the table insertion function from Lua.
4892 lua_getglobal(L, "table");
4893 lua_getfield(L, -1, "insert");
4894 int insertion_func = lua_gettop(L);
4896 // Package them up for Lua
4898 int new_table = lua_gettop(L);
4899 core::list<std::string>::Iterator i = mods_sorted.begin();
4900 while(i != mods_sorted.end())
4902 lua_pushvalue(L, insertion_func);
4903 lua_pushvalue(L, new_table);
4904 lua_pushstring(L, (*i).c_str());
4905 if(lua_pcall(L, 2, 0, 0) != 0)
4907 script_error(L, "error: %s", lua_tostring(L, -1));
4915 static int l_get_worldpath(lua_State *L)
4917 std::string worldpath = get_server(L)->getWorldPath();
4918 lua_pushstring(L, worldpath.c_str());
4922 // sound_play(spec, parameters)
4923 static int l_sound_play(lua_State *L)
4925 SimpleSoundSpec spec;
4926 read_soundspec(L, 1, spec);
4927 ServerSoundParams params;
4928 read_server_sound_params(L, 2, params);
4929 s32 handle = get_server(L)->playSound(spec, params);
4930 lua_pushinteger(L, handle);
4934 // sound_stop(handle)
4935 static int l_sound_stop(lua_State *L)
4937 int handle = luaL_checkinteger(L, 1);
4938 get_server(L)->stopSound(handle);
4942 // is_singleplayer()
4943 static int l_is_singleplayer(lua_State *L)
4945 lua_pushboolean(L, get_server(L)->isSingleplayer());
4949 // get_password_hash(name, raw_password)
4950 static int l_get_password_hash(lua_State *L)
4952 std::string name = luaL_checkstring(L, 1);
4953 std::string raw_password = luaL_checkstring(L, 2);
4954 std::string hash = translatePassword(name,
4955 narrow_to_wide(raw_password));
4956 lua_pushstring(L, hash.c_str());
4960 // notify_authentication_modified(name)
4961 static int l_notify_authentication_modified(lua_State *L)
4963 std::string name = "";
4964 if(lua_isstring(L, 1))
4965 name = lua_tostring(L, 1);
4966 get_server(L)->reportPrivsModified(name);
4970 // get_craft_result(input)
4971 static int l_get_craft_result(lua_State *L)
4974 std::string method_s = getstringfield_default(L, input_i, "method", "normal");
4975 enum CraftMethod method = (CraftMethod)getenumfield(L, input_i, "method",
4976 es_CraftMethod, CRAFT_METHOD_NORMAL);
4978 lua_getfield(L, input_i, "width");
4979 if(lua_isnumber(L, -1))
4980 width = luaL_checkinteger(L, -1);
4982 lua_getfield(L, input_i, "items");
4983 std::vector<ItemStack> items = read_items(L, -1);
4984 lua_pop(L, 1); // items
4986 IGameDef *gdef = get_server(L);
4987 ICraftDefManager *cdef = gdef->cdef();
4988 CraftInput input(method, width, items);
4990 bool got = cdef->getCraftResult(input, output, true, gdef);
4991 lua_newtable(L); // output table
4994 item.deSerialize(output.item, gdef->idef());
4995 LuaItemStack::create(L, item);
4996 lua_setfield(L, -2, "item");
4997 setintfield(L, -1, "time", output.time);
4999 LuaItemStack::create(L, ItemStack());
5000 lua_setfield(L, -2, "item");
5001 setintfield(L, -1, "time", 0);
5003 lua_newtable(L); // decremented input table
5004 lua_pushstring(L, method_s.c_str());
5005 lua_setfield(L, -2, "method");
5006 lua_pushinteger(L, width);
5007 lua_setfield(L, -2, "width");
5008 push_items(L, input.items);
5009 lua_setfield(L, -2, "items");
5013 // get_craft_recipe(result item)
5014 static int l_get_craft_recipe(lua_State *L)
5019 std::string o_item = luaL_checkstring(L,input_i);
5021 IGameDef *gdef = get_server(L);
5022 ICraftDefManager *cdef = gdef->cdef();
5024 CraftOutput output(o_item,0);
5025 bool got = cdef->getCraftRecipe(input, output, gdef);
5026 lua_newtable(L); // output table
5029 for(std::vector<ItemStack>::const_iterator
5030 i = input.items.begin();
5031 i != input.items.end(); i++, k++)
5037 sprintf(tmp,"%d",k);
5038 lua_pushstring(L,tmp);
5039 lua_pushstring(L,i->name.c_str());
5040 lua_settable(L, -3);
5042 lua_setfield(L, -2, "items");
5043 setintfield(L, -1, "width", input.width);
5044 switch (input.method) {
5045 case CRAFT_METHOD_NORMAL:
5046 lua_pushstring(L,"normal");
5048 case CRAFT_METHOD_COOKING:
5049 lua_pushstring(L,"cooking");
5051 case CRAFT_METHOD_FUEL:
5052 lua_pushstring(L,"fuel");
5055 lua_pushstring(L,"unknown");
5057 lua_setfield(L, -2, "type");
5060 lua_setfield(L, -2, "items");
5061 setintfield(L, -1, "width", 0);
5066 // rollback_get_last_node_actor(p, range, seconds) -> actor, p, seconds
5067 static int l_rollback_get_last_node_actor(lua_State *L)
5069 v3s16 p = read_v3s16(L, 1);
5070 int range = luaL_checknumber(L, 2);
5071 int seconds = luaL_checknumber(L, 3);
5072 Server *server = get_server(L);
5073 IRollbackManager *rollback = server->getRollbackManager();
5075 int act_seconds = 0;
5076 std::string actor = rollback->getLastNodeActor(p, range, seconds, &act_p, &act_seconds);
5077 lua_pushstring(L, actor.c_str());
5078 push_v3s16(L, act_p);
5079 lua_pushnumber(L, act_seconds);
5083 // rollback_revert_actions_by(actor, seconds) -> bool, log messages
5084 static int l_rollback_revert_actions_by(lua_State *L)
5086 std::string actor = luaL_checkstring(L, 1);
5087 int seconds = luaL_checknumber(L, 2);
5088 Server *server = get_server(L);
5089 IRollbackManager *rollback = server->getRollbackManager();
5090 std::list<RollbackAction> actions = rollback->getRevertActions(actor, seconds);
5091 std::list<std::string> log;
5092 bool success = server->rollbackRevertActions(actions, &log);
5093 // Push boolean result
5094 lua_pushboolean(L, success);
5095 // Get the table insert function and push the log table
5096 lua_getglobal(L, "table");
5097 lua_getfield(L, -1, "insert");
5098 int table_insert = lua_gettop(L);
5100 int table = lua_gettop(L);
5101 for(std::list<std::string>::const_iterator i = log.begin();
5102 i != log.end(); i++)
5104 lua_pushvalue(L, table_insert);
5105 lua_pushvalue(L, table);
5106 lua_pushstring(L, i->c_str());
5107 if(lua_pcall(L, 2, 0, 0))
5108 script_error(L, "error: %s", lua_tostring(L, -1));
5110 lua_remove(L, -2); // Remove table
5111 lua_remove(L, -2); // Remove insert
5115 static const struct luaL_Reg minetest_f [] = {
5118 {"request_shutdown", l_request_shutdown},
5119 {"get_server_status", l_get_server_status},
5120 {"register_item_raw", l_register_item_raw},
5121 {"register_alias_raw", l_register_alias_raw},
5122 {"register_craft", l_register_craft},
5123 {"setting_set", l_setting_set},
5124 {"setting_get", l_setting_get},
5125 {"setting_getbool", l_setting_getbool},
5126 {"chat_send_all", l_chat_send_all},
5127 {"chat_send_player", l_chat_send_player},
5128 {"get_player_privs", l_get_player_privs},
5129 {"get_ban_list", l_get_ban_list},
5130 {"get_ban_description", l_get_ban_description},
5131 {"ban_player", l_ban_player},
5132 {"unban_player_or_ip", l_unban_player_of_ip},
5133 {"get_inventory", l_get_inventory},
5134 {"create_detached_inventory_raw", l_create_detached_inventory_raw},
5135 {"get_dig_params", l_get_dig_params},
5136 {"get_hit_params", l_get_hit_params},
5137 {"get_current_modname", l_get_current_modname},
5138 {"get_modpath", l_get_modpath},
5139 {"get_modnames", l_get_modnames},
5140 {"get_worldpath", l_get_worldpath},
5141 {"sound_play", l_sound_play},
5142 {"sound_stop", l_sound_stop},
5143 {"is_singleplayer", l_is_singleplayer},
5144 {"get_password_hash", l_get_password_hash},
5145 {"notify_authentication_modified", l_notify_authentication_modified},
5146 {"get_craft_result", l_get_craft_result},
5147 {"get_craft_recipe", l_get_craft_recipe},
5148 {"rollback_get_last_node_actor", l_rollback_get_last_node_actor},
5149 {"rollback_revert_actions_by", l_rollback_revert_actions_by},
5154 Main export function
5157 void scriptapi_export(lua_State *L, Server *server)
5160 assert(lua_checkstack(L, 20));
5161 verbosestream<<"scriptapi_export()"<<std::endl;
5162 StackUnroller stack_unroller(L);
5164 // Store server as light userdata in registry
5165 lua_pushlightuserdata(L, server);
5166 lua_setfield(L, LUA_REGISTRYINDEX, "minetest_server");
5168 // Register global functions in table minetest
5170 luaL_register(L, NULL, minetest_f);
5171 lua_setglobal(L, "minetest");
5173 // Get the main minetest table
5174 lua_getglobal(L, "minetest");
5176 // Add tables to minetest
5178 lua_setfield(L, -2, "object_refs");
5180 lua_setfield(L, -2, "luaentities");
5182 // Register wrappers
5183 LuaItemStack::Register(L);
5184 InvRef::Register(L);
5185 NodeMetaRef::Register(L);
5186 NodeTimerRef::Register(L);
5187 ObjectRef::Register(L);
5188 EnvRef::Register(L);
5189 LuaPseudoRandom::Register(L);
5190 LuaPerlinNoise::Register(L);
5193 bool scriptapi_loadmod(lua_State *L, const std::string &scriptpath,
5194 const std::string &modname)
5196 ModNameStorer modnamestorer(L, modname);
5198 if(!string_allowed(modname, "abcdefghijklmnopqrstuvwxyz"
5200 errorstream<<"Error loading mod \""<<modname
5201 <<"\": modname does not follow naming conventions: "
5202 <<"Only chararacters [a-z0-9_] are allowed."<<std::endl;
5206 bool success = false;
5209 success = script_load(L, scriptpath.c_str());
5212 errorstream<<"Error loading mod \""<<modname
5213 <<"\": "<<e.what()<<std::endl;
5219 void scriptapi_add_environment(lua_State *L, ServerEnvironment *env)
5222 assert(lua_checkstack(L, 20));
5223 verbosestream<<"scriptapi_add_environment"<<std::endl;
5224 StackUnroller stack_unroller(L);
5226 // Create EnvRef on stack
5227 EnvRef::create(L, env);
5228 int envref = lua_gettop(L);
5230 // minetest.env = envref
5231 lua_getglobal(L, "minetest");
5232 luaL_checktype(L, -1, LUA_TTABLE);
5233 lua_pushvalue(L, envref);
5234 lua_setfield(L, -2, "env");
5236 // Store environment as light userdata in registry
5237 lua_pushlightuserdata(L, env);
5238 lua_setfield(L, LUA_REGISTRYINDEX, "minetest_env");
5241 Add ActiveBlockModifiers to environment
5244 // Get minetest.registered_abms
5245 lua_getglobal(L, "minetest");
5246 lua_getfield(L, -1, "registered_abms");
5247 luaL_checktype(L, -1, LUA_TTABLE);
5248 int registered_abms = lua_gettop(L);
5250 if(lua_istable(L, registered_abms)){
5251 int table = lua_gettop(L);
5253 while(lua_next(L, table) != 0){
5254 // key at index -2 and value at index -1
5255 int id = lua_tonumber(L, -2);
5256 int current_abm = lua_gettop(L);
5258 std::set<std::string> trigger_contents;
5259 lua_getfield(L, current_abm, "nodenames");
5260 if(lua_istable(L, -1)){
5261 int table = lua_gettop(L);
5263 while(lua_next(L, table) != 0){
5264 // key at index -2 and value at index -1
5265 luaL_checktype(L, -1, LUA_TSTRING);
5266 trigger_contents.insert(lua_tostring(L, -1));
5267 // removes value, keeps key for next iteration
5270 } else if(lua_isstring(L, -1)){
5271 trigger_contents.insert(lua_tostring(L, -1));
5275 std::set<std::string> required_neighbors;
5276 lua_getfield(L, current_abm, "neighbors");
5277 if(lua_istable(L, -1)){
5278 int table = lua_gettop(L);
5280 while(lua_next(L, table) != 0){
5281 // key at index -2 and value at index -1
5282 luaL_checktype(L, -1, LUA_TSTRING);
5283 required_neighbors.insert(lua_tostring(L, -1));
5284 // removes value, keeps key for next iteration
5287 } else if(lua_isstring(L, -1)){
5288 required_neighbors.insert(lua_tostring(L, -1));
5292 float trigger_interval = 10.0;
5293 getfloatfield(L, current_abm, "interval", trigger_interval);
5295 int trigger_chance = 50;
5296 getintfield(L, current_abm, "chance", trigger_chance);
5298 LuaABM *abm = new LuaABM(L, id, trigger_contents,
5299 required_neighbors, trigger_interval, trigger_chance);
5301 env->addActiveBlockModifier(abm);
5303 // removes value, keeps key for next iteration
5311 // Dump stack top with the dump2 function
5312 static void dump2(lua_State *L, const char *name)
5314 // Dump object (debug)
5315 lua_getglobal(L, "dump2");
5316 luaL_checktype(L, -1, LUA_TFUNCTION);
5317 lua_pushvalue(L, -2); // Get previous stack top as first parameter
5318 lua_pushstring(L, name);
5319 if(lua_pcall(L, 2, 0, 0))
5320 script_error(L, "error: %s", lua_tostring(L, -1));
5328 void scriptapi_add_object_reference(lua_State *L, ServerActiveObject *cobj)
5331 assert(lua_checkstack(L, 20));
5332 //infostream<<"scriptapi_add_object_reference: id="<<cobj->getId()<<std::endl;
5333 StackUnroller stack_unroller(L);
5335 // Create object on stack
5336 ObjectRef::create(L, cobj); // Puts ObjectRef (as userdata) on stack
5337 int object = lua_gettop(L);
5339 // Get minetest.object_refs table
5340 lua_getglobal(L, "minetest");
5341 lua_getfield(L, -1, "object_refs");
5342 luaL_checktype(L, -1, LUA_TTABLE);
5343 int objectstable = lua_gettop(L);
5345 // object_refs[id] = object
5346 lua_pushnumber(L, cobj->getId()); // Push id
5347 lua_pushvalue(L, object); // Copy object to top of stack
5348 lua_settable(L, objectstable);
5351 void scriptapi_rm_object_reference(lua_State *L, ServerActiveObject *cobj)
5354 assert(lua_checkstack(L, 20));
5355 //infostream<<"scriptapi_rm_object_reference: id="<<cobj->getId()<<std::endl;
5356 StackUnroller stack_unroller(L);
5358 // Get minetest.object_refs table
5359 lua_getglobal(L, "minetest");
5360 lua_getfield(L, -1, "object_refs");
5361 luaL_checktype(L, -1, LUA_TTABLE);
5362 int objectstable = lua_gettop(L);
5364 // Get object_refs[id]
5365 lua_pushnumber(L, cobj->getId()); // Push id
5366 lua_gettable(L, objectstable);
5367 // Set object reference to NULL
5368 ObjectRef::set_null(L);
5369 lua_pop(L, 1); // pop object
5371 // Set object_refs[id] = nil
5372 lua_pushnumber(L, cobj->getId()); // Push id
5374 lua_settable(L, objectstable);
5381 // What scriptapi_run_callbacks does with the return values of callbacks.
5382 // Regardless of the mode, if only one callback is defined,
5383 // its return value is the total return value.
5384 // Modes only affect the case where 0 or >= 2 callbacks are defined.
5385 enum RunCallbacksMode
5387 // Returns the return value of the first callback
5388 // Returns nil if list of callbacks is empty
5389 RUN_CALLBACKS_MODE_FIRST,
5390 // Returns the return value of the last callback
5391 // Returns nil if list of callbacks is empty
5392 RUN_CALLBACKS_MODE_LAST,
5393 // If any callback returns a false value, the first such is returned
5394 // Otherwise, the first callback's return value (trueish) is returned
5395 // Returns true if list of callbacks is empty
5396 RUN_CALLBACKS_MODE_AND,
5397 // Like above, but stops calling callbacks (short circuit)
5398 // after seeing the first false value
5399 RUN_CALLBACKS_MODE_AND_SC,
5400 // If any callback returns a true value, the first such is returned
5401 // Otherwise, the first callback's return value (falseish) is returned
5402 // Returns false if list of callbacks is empty
5403 RUN_CALLBACKS_MODE_OR,
5404 // Like above, but stops calling callbacks (short circuit)
5405 // after seeing the first true value
5406 RUN_CALLBACKS_MODE_OR_SC,
5407 // Note: "a true value" and "a false value" refer to values that
5408 // are converted by lua_toboolean to true or false, respectively.
5411 // Push the list of callbacks (a lua table).
5412 // Then push nargs arguments.
5413 // Then call this function, which
5414 // - runs the callbacks
5415 // - removes the table and arguments from the lua stack
5416 // - pushes the return value, computed depending on mode
5417 static void scriptapi_run_callbacks(lua_State *L, int nargs,
5418 RunCallbacksMode mode)
5420 // Insert the return value into the lua stack, below the table
5421 assert(lua_gettop(L) >= nargs + 1);
5423 lua_insert(L, -(nargs + 1) - 1);
5424 // Stack now looks like this:
5425 // ... <return value = nil> <table> <arg#1> <arg#2> ... <arg#n>
5427 int rv = lua_gettop(L) - nargs - 1;
5429 int arg = table + 1;
5431 luaL_checktype(L, table, LUA_TTABLE);
5435 bool first_loop = true;
5436 while(lua_next(L, table) != 0){
5437 // key at index -2 and value at index -1
5438 luaL_checktype(L, -1, LUA_TFUNCTION);
5440 for(int i = 0; i < nargs; i++)
5441 lua_pushvalue(L, arg+i);
5442 if(lua_pcall(L, nargs, 1, 0))
5443 script_error(L, "error: %s", lua_tostring(L, -1));
5445 // Move return value to designated space in stack
5448 // Result of first callback is always moved
5452 // Otherwise, what happens depends on the mode
5453 if(mode == RUN_CALLBACKS_MODE_FIRST)
5455 else if(mode == RUN_CALLBACKS_MODE_LAST)
5457 else if(mode == RUN_CALLBACKS_MODE_AND ||
5458 mode == RUN_CALLBACKS_MODE_AND_SC){
5459 if(lua_toboolean(L, rv) == true &&
5460 lua_toboolean(L, -1) == false)
5465 else if(mode == RUN_CALLBACKS_MODE_OR ||
5466 mode == RUN_CALLBACKS_MODE_OR_SC){
5467 if(lua_toboolean(L, rv) == false &&
5468 lua_toboolean(L, -1) == true)
5477 // Handle short circuit modes
5478 if(mode == RUN_CALLBACKS_MODE_AND_SC &&
5479 lua_toboolean(L, rv) == false)
5481 else if(mode == RUN_CALLBACKS_MODE_OR_SC &&
5482 lua_toboolean(L, rv) == true)
5485 // value removed, keep key for next iteration
5488 // Remove stuff from stack, leaving only the return value
5491 // Fix return value in case no callbacks were called
5493 if(mode == RUN_CALLBACKS_MODE_AND ||
5494 mode == RUN_CALLBACKS_MODE_AND_SC){
5496 lua_pushboolean(L, true);
5498 else if(mode == RUN_CALLBACKS_MODE_OR ||
5499 mode == RUN_CALLBACKS_MODE_OR_SC){
5501 lua_pushboolean(L, false);
5506 bool scriptapi_on_chat_message(lua_State *L, const std::string &name,
5507 const std::string &message)
5510 assert(lua_checkstack(L, 20));
5511 StackUnroller stack_unroller(L);
5513 // Get minetest.registered_on_chat_messages
5514 lua_getglobal(L, "minetest");
5515 lua_getfield(L, -1, "registered_on_chat_messages");
5517 lua_pushstring(L, name.c_str());
5518 lua_pushstring(L, message.c_str());
5519 scriptapi_run_callbacks(L, 2, RUN_CALLBACKS_MODE_OR_SC);
5520 bool ate = lua_toboolean(L, -1);
5524 void scriptapi_on_newplayer(lua_State *L, ServerActiveObject *player)
5527 assert(lua_checkstack(L, 20));
5528 StackUnroller stack_unroller(L);
5530 // Get minetest.registered_on_newplayers
5531 lua_getglobal(L, "minetest");
5532 lua_getfield(L, -1, "registered_on_newplayers");
5534 objectref_get_or_create(L, player);
5535 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
5538 void scriptapi_on_dieplayer(lua_State *L, ServerActiveObject *player)
5541 assert(lua_checkstack(L, 20));
5542 StackUnroller stack_unroller(L);
5544 // Get minetest.registered_on_dieplayers
5545 lua_getglobal(L, "minetest");
5546 lua_getfield(L, -1, "registered_on_dieplayers");
5548 objectref_get_or_create(L, player);
5549 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
5552 bool scriptapi_on_respawnplayer(lua_State *L, ServerActiveObject *player)
5555 assert(lua_checkstack(L, 20));
5556 StackUnroller stack_unroller(L);
5558 // Get minetest.registered_on_respawnplayers
5559 lua_getglobal(L, "minetest");
5560 lua_getfield(L, -1, "registered_on_respawnplayers");
5562 objectref_get_or_create(L, player);
5563 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_OR);
5564 bool positioning_handled_by_some = lua_toboolean(L, -1);
5565 return positioning_handled_by_some;
5568 void scriptapi_on_joinplayer(lua_State *L, ServerActiveObject *player)
5571 assert(lua_checkstack(L, 20));
5572 StackUnroller stack_unroller(L);
5574 // Get minetest.registered_on_joinplayers
5575 lua_getglobal(L, "minetest");
5576 lua_getfield(L, -1, "registered_on_joinplayers");
5578 objectref_get_or_create(L, player);
5579 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
5582 void scriptapi_on_leaveplayer(lua_State *L, ServerActiveObject *player)
5585 assert(lua_checkstack(L, 20));
5586 StackUnroller stack_unroller(L);
5588 // Get minetest.registered_on_leaveplayers
5589 lua_getglobal(L, "minetest");
5590 lua_getfield(L, -1, "registered_on_leaveplayers");
5592 objectref_get_or_create(L, player);
5593 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
5596 static void get_auth_handler(lua_State *L)
5598 lua_getglobal(L, "minetest");
5599 lua_getfield(L, -1, "registered_auth_handler");
5600 if(lua_isnil(L, -1)){
5602 lua_getfield(L, -1, "builtin_auth_handler");
5604 if(lua_type(L, -1) != LUA_TTABLE)
5605 throw LuaError(L, "Authentication handler table not valid");
5608 bool scriptapi_get_auth(lua_State *L, const std::string &playername,
5609 std::string *dst_password, std::set<std::string> *dst_privs)
5612 assert(lua_checkstack(L, 20));
5613 StackUnroller stack_unroller(L);
5615 get_auth_handler(L);
5616 lua_getfield(L, -1, "get_auth");
5617 if(lua_type(L, -1) != LUA_TFUNCTION)
5618 throw LuaError(L, "Authentication handler missing get_auth");
5619 lua_pushstring(L, playername.c_str());
5620 if(lua_pcall(L, 1, 1, 0))
5621 script_error(L, "error: %s", lua_tostring(L, -1));
5623 // nil = login not allowed
5624 if(lua_isnil(L, -1))
5626 luaL_checktype(L, -1, LUA_TTABLE);
5628 std::string password;
5629 bool found = getstringfield(L, -1, "password", password);
5631 throw LuaError(L, "Authentication handler didn't return password");
5633 *dst_password = password;
5635 lua_getfield(L, -1, "privileges");
5636 if(!lua_istable(L, -1))
5638 "Authentication handler didn't return privilege table");
5640 read_privileges(L, -1, *dst_privs);
5646 void scriptapi_create_auth(lua_State *L, const std::string &playername,
5647 const std::string &password)
5650 assert(lua_checkstack(L, 20));
5651 StackUnroller stack_unroller(L);
5653 get_auth_handler(L);
5654 lua_getfield(L, -1, "create_auth");
5655 if(lua_type(L, -1) != LUA_TFUNCTION)
5656 throw LuaError(L, "Authentication handler missing create_auth");
5657 lua_pushstring(L, playername.c_str());
5658 lua_pushstring(L, password.c_str());
5659 if(lua_pcall(L, 2, 0, 0))
5660 script_error(L, "error: %s", lua_tostring(L, -1));
5663 bool scriptapi_set_password(lua_State *L, const std::string &playername,
5664 const std::string &password)
5667 assert(lua_checkstack(L, 20));
5668 StackUnroller stack_unroller(L);
5670 get_auth_handler(L);
5671 lua_getfield(L, -1, "set_password");
5672 if(lua_type(L, -1) != LUA_TFUNCTION)
5673 throw LuaError(L, "Authentication handler missing set_password");
5674 lua_pushstring(L, playername.c_str());
5675 lua_pushstring(L, password.c_str());
5676 if(lua_pcall(L, 2, 1, 0))
5677 script_error(L, "error: %s", lua_tostring(L, -1));
5678 return lua_toboolean(L, -1);
5685 void scriptapi_on_player_receive_fields(lua_State *L,
5686 ServerActiveObject *player,
5687 const std::string &formname,
5688 const std::map<std::string, std::string> &fields)
5691 assert(lua_checkstack(L, 20));
5692 StackUnroller stack_unroller(L);
5694 // Get minetest.registered_on_chat_messages
5695 lua_getglobal(L, "minetest");
5696 lua_getfield(L, -1, "registered_on_player_receive_fields");
5699 objectref_get_or_create(L, player);
5701 lua_pushstring(L, formname.c_str());
5704 for(std::map<std::string, std::string>::const_iterator
5705 i = fields.begin(); i != fields.end(); i++){
5706 const std::string &name = i->first;
5707 const std::string &value = i->second;
5708 lua_pushstring(L, name.c_str());
5709 lua_pushlstring(L, value.c_str(), value.size());
5710 lua_settable(L, -3);
5712 scriptapi_run_callbacks(L, 3, RUN_CALLBACKS_MODE_OR_SC);
5716 item callbacks and node callbacks
5719 // Retrieves minetest.registered_items[name][callbackname]
5720 // If that is nil or on error, return false and stack is unchanged
5721 // If that is a function, returns true and pushes the
5722 // function onto the stack
5723 // If minetest.registered_items[name] doesn't exist, minetest.nodedef_default
5724 // is tried instead so unknown items can still be manipulated to some degree
5725 static bool get_item_callback(lua_State *L,
5726 const char *name, const char *callbackname)
5728 lua_getglobal(L, "minetest");
5729 lua_getfield(L, -1, "registered_items");
5731 luaL_checktype(L, -1, LUA_TTABLE);
5732 lua_getfield(L, -1, name);
5734 // Should be a table
5735 if(lua_type(L, -1) != LUA_TTABLE)
5737 // Report error and clean up
5738 errorstream<<"Item \""<<name<<"\" not defined"<<std::endl;
5741 // Try minetest.nodedef_default instead
5742 lua_getglobal(L, "minetest");
5743 lua_getfield(L, -1, "nodedef_default");
5745 luaL_checktype(L, -1, LUA_TTABLE);
5747 lua_getfield(L, -1, callbackname);
5749 // Should be a function or nil
5750 if(lua_type(L, -1) == LUA_TFUNCTION)
5754 else if(lua_isnil(L, -1))
5761 errorstream<<"Item \""<<name<<"\" callback \""
5762 <<callbackname<<" is not a function"<<std::endl;
5768 bool scriptapi_item_on_drop(lua_State *L, ItemStack &item,
5769 ServerActiveObject *dropper, v3f pos)
5772 assert(lua_checkstack(L, 20));
5773 StackUnroller stack_unroller(L);
5775 // Push callback function on stack
5776 if(!get_item_callback(L, item.name.c_str(), "on_drop"))
5780 LuaItemStack::create(L, item);
5781 objectref_get_or_create(L, dropper);
5782 pushFloatPos(L, pos);
5783 if(lua_pcall(L, 3, 1, 0))
5784 script_error(L, "error: %s", lua_tostring(L, -1));
5785 if(!lua_isnil(L, -1))
5786 item = read_item(L, -1);
5790 bool scriptapi_item_on_place(lua_State *L, ItemStack &item,
5791 ServerActiveObject *placer, const PointedThing &pointed)
5794 assert(lua_checkstack(L, 20));
5795 StackUnroller stack_unroller(L);
5797 // Push callback function on stack
5798 if(!get_item_callback(L, item.name.c_str(), "on_place"))
5802 LuaItemStack::create(L, item);
5803 objectref_get_or_create(L, placer);
5804 push_pointed_thing(L, pointed);
5805 if(lua_pcall(L, 3, 1, 0))
5806 script_error(L, "error: %s", lua_tostring(L, -1));
5807 if(!lua_isnil(L, -1))
5808 item = read_item(L, -1);
5812 bool scriptapi_item_on_use(lua_State *L, ItemStack &item,
5813 ServerActiveObject *user, const PointedThing &pointed)
5816 assert(lua_checkstack(L, 20));
5817 StackUnroller stack_unroller(L);
5819 // Push callback function on stack
5820 if(!get_item_callback(L, item.name.c_str(), "on_use"))
5824 LuaItemStack::create(L, item);
5825 objectref_get_or_create(L, user);
5826 push_pointed_thing(L, pointed);
5827 if(lua_pcall(L, 3, 1, 0))
5828 script_error(L, "error: %s", lua_tostring(L, -1));
5829 if(!lua_isnil(L, -1))
5830 item = read_item(L, -1);
5834 bool scriptapi_node_on_punch(lua_State *L, v3s16 p, MapNode node,
5835 ServerActiveObject *puncher)
5838 assert(lua_checkstack(L, 20));
5839 StackUnroller stack_unroller(L);
5841 INodeDefManager *ndef = get_server(L)->ndef();
5843 // Push callback function on stack
5844 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_punch"))
5849 pushnode(L, node, ndef);
5850 objectref_get_or_create(L, puncher);
5851 if(lua_pcall(L, 3, 0, 0))
5852 script_error(L, "error: %s", lua_tostring(L, -1));
5856 bool scriptapi_node_on_dig(lua_State *L, v3s16 p, MapNode node,
5857 ServerActiveObject *digger)
5860 assert(lua_checkstack(L, 20));
5861 StackUnroller stack_unroller(L);
5863 INodeDefManager *ndef = get_server(L)->ndef();
5865 // Push callback function on stack
5866 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_dig"))
5871 pushnode(L, node, ndef);
5872 objectref_get_or_create(L, digger);
5873 if(lua_pcall(L, 3, 0, 0))
5874 script_error(L, "error: %s", lua_tostring(L, -1));
5878 void scriptapi_node_on_construct(lua_State *L, v3s16 p, MapNode node)
5881 assert(lua_checkstack(L, 20));
5882 StackUnroller stack_unroller(L);
5884 INodeDefManager *ndef = get_server(L)->ndef();
5886 // Push callback function on stack
5887 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_construct"))
5892 if(lua_pcall(L, 1, 0, 0))
5893 script_error(L, "error: %s", lua_tostring(L, -1));
5896 void scriptapi_node_on_destruct(lua_State *L, v3s16 p, MapNode node)
5899 assert(lua_checkstack(L, 20));
5900 StackUnroller stack_unroller(L);
5902 INodeDefManager *ndef = get_server(L)->ndef();
5904 // Push callback function on stack
5905 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_destruct"))
5910 if(lua_pcall(L, 1, 0, 0))
5911 script_error(L, "error: %s", lua_tostring(L, -1));
5914 void scriptapi_node_after_destruct(lua_State *L, v3s16 p, MapNode node)
5917 assert(lua_checkstack(L, 20));
5918 StackUnroller stack_unroller(L);
5920 INodeDefManager *ndef = get_server(L)->ndef();
5922 // Push callback function on stack
5923 if(!get_item_callback(L, ndef->get(node).name.c_str(), "after_destruct"))
5928 pushnode(L, node, ndef);
5929 if(lua_pcall(L, 2, 0, 0))
5930 script_error(L, "error: %s", lua_tostring(L, -1));
5933 bool scriptapi_node_on_timer(lua_State *L, v3s16 p, MapNode node, f32 dtime)
5936 assert(lua_checkstack(L, 20));
5937 StackUnroller stack_unroller(L);
5939 INodeDefManager *ndef = get_server(L)->ndef();
5941 // Push callback function on stack
5942 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_timer"))
5947 lua_pushnumber(L,dtime);
5948 if(lua_pcall(L, 2, 1, 0))
5949 script_error(L, "error: %s", lua_tostring(L, -1));
5950 if(lua_isboolean(L,-1) && lua_toboolean(L,-1) == true)
5956 void scriptapi_node_on_receive_fields(lua_State *L, v3s16 p,
5957 const std::string &formname,
5958 const std::map<std::string, std::string> &fields,
5959 ServerActiveObject *sender)
5962 assert(lua_checkstack(L, 20));
5963 StackUnroller stack_unroller(L);
5965 INodeDefManager *ndef = get_server(L)->ndef();
5967 // If node doesn't exist, we don't know what callback to call
5968 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
5969 if(node.getContent() == CONTENT_IGNORE)
5972 // Push callback function on stack
5973 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_receive_fields"))
5980 lua_pushstring(L, formname.c_str());
5983 for(std::map<std::string, std::string>::const_iterator
5984 i = fields.begin(); i != fields.end(); i++){
5985 const std::string &name = i->first;
5986 const std::string &value = i->second;
5987 lua_pushstring(L, name.c_str());
5988 lua_pushlstring(L, value.c_str(), value.size());
5989 lua_settable(L, -3);
5992 objectref_get_or_create(L, sender);
5993 if(lua_pcall(L, 4, 0, 0))
5994 script_error(L, "error: %s", lua_tostring(L, -1));
5998 Node metadata inventory callbacks
6001 // Return number of accepted items to be moved
6002 int scriptapi_nodemeta_inventory_allow_move(lua_State *L, v3s16 p,
6003 const std::string &from_list, int from_index,
6004 const std::string &to_list, int to_index,
6005 int count, ServerActiveObject *player)
6008 assert(lua_checkstack(L, 20));
6009 StackUnroller stack_unroller(L);
6011 INodeDefManager *ndef = get_server(L)->ndef();
6013 // If node doesn't exist, we don't know what callback to call
6014 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6015 if(node.getContent() == CONTENT_IGNORE)
6018 // Push callback function on stack
6019 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6020 "allow_metadata_inventory_move"))
6023 // function(pos, from_list, from_index, to_list, to_index, count, player)
6027 lua_pushstring(L, from_list.c_str());
6029 lua_pushinteger(L, from_index + 1);
6031 lua_pushstring(L, to_list.c_str());
6033 lua_pushinteger(L, to_index + 1);
6035 lua_pushinteger(L, count);
6037 objectref_get_or_create(L, player);
6038 if(lua_pcall(L, 7, 1, 0))
6039 script_error(L, "error: %s", lua_tostring(L, -1));
6040 if(!lua_isnumber(L, -1))
6041 throw LuaError(L, "allow_metadata_inventory_move should return a number");
6042 return luaL_checkinteger(L, -1);
6045 // Return number of accepted items to be put
6046 int scriptapi_nodemeta_inventory_allow_put(lua_State *L, v3s16 p,
6047 const std::string &listname, int index, ItemStack &stack,
6048 ServerActiveObject *player)
6051 assert(lua_checkstack(L, 20));
6052 StackUnroller stack_unroller(L);
6054 INodeDefManager *ndef = get_server(L)->ndef();
6056 // If node doesn't exist, we don't know what callback to call
6057 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6058 if(node.getContent() == CONTENT_IGNORE)
6061 // Push callback function on stack
6062 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6063 "allow_metadata_inventory_put"))
6066 // Call function(pos, listname, index, stack, player)
6070 lua_pushstring(L, listname.c_str());
6072 lua_pushinteger(L, index + 1);
6074 LuaItemStack::create(L, stack);
6076 objectref_get_or_create(L, player);
6077 if(lua_pcall(L, 5, 1, 0))
6078 script_error(L, "error: %s", lua_tostring(L, -1));
6079 if(!lua_isnumber(L, -1))
6080 throw LuaError(L, "allow_metadata_inventory_put should return a number");
6081 return luaL_checkinteger(L, -1);
6084 // Return number of accepted items to be taken
6085 int scriptapi_nodemeta_inventory_allow_take(lua_State *L, v3s16 p,
6086 const std::string &listname, int index, ItemStack &stack,
6087 ServerActiveObject *player)
6090 assert(lua_checkstack(L, 20));
6091 StackUnroller stack_unroller(L);
6093 INodeDefManager *ndef = get_server(L)->ndef();
6095 // If node doesn't exist, we don't know what callback to call
6096 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6097 if(node.getContent() == CONTENT_IGNORE)
6100 // Push callback function on stack
6101 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6102 "allow_metadata_inventory_take"))
6105 // Call function(pos, listname, index, count, player)
6109 lua_pushstring(L, listname.c_str());
6111 lua_pushinteger(L, index + 1);
6113 LuaItemStack::create(L, stack);
6115 objectref_get_or_create(L, player);
6116 if(lua_pcall(L, 5, 1, 0))
6117 script_error(L, "error: %s", lua_tostring(L, -1));
6118 if(!lua_isnumber(L, -1))
6119 throw LuaError(L, "allow_metadata_inventory_take should return a number");
6120 return luaL_checkinteger(L, -1);
6123 // Report moved items
6124 void scriptapi_nodemeta_inventory_on_move(lua_State *L, v3s16 p,
6125 const std::string &from_list, int from_index,
6126 const std::string &to_list, int to_index,
6127 int count, ServerActiveObject *player)
6130 assert(lua_checkstack(L, 20));
6131 StackUnroller stack_unroller(L);
6133 INodeDefManager *ndef = get_server(L)->ndef();
6135 // If node doesn't exist, we don't know what callback to call
6136 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6137 if(node.getContent() == CONTENT_IGNORE)
6140 // Push callback function on stack
6141 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6142 "on_metadata_inventory_move"))
6145 // function(pos, from_list, from_index, to_list, to_index, count, player)
6149 lua_pushstring(L, from_list.c_str());
6151 lua_pushinteger(L, from_index + 1);
6153 lua_pushstring(L, to_list.c_str());
6155 lua_pushinteger(L, to_index + 1);
6157 lua_pushinteger(L, count);
6159 objectref_get_or_create(L, player);
6160 if(lua_pcall(L, 7, 0, 0))
6161 script_error(L, "error: %s", lua_tostring(L, -1));
6165 void scriptapi_nodemeta_inventory_on_put(lua_State *L, v3s16 p,
6166 const std::string &listname, int index, ItemStack &stack,
6167 ServerActiveObject *player)
6170 assert(lua_checkstack(L, 20));
6171 StackUnroller stack_unroller(L);
6173 INodeDefManager *ndef = get_server(L)->ndef();
6175 // If node doesn't exist, we don't know what callback to call
6176 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6177 if(node.getContent() == CONTENT_IGNORE)
6180 // Push callback function on stack
6181 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6182 "on_metadata_inventory_put"))
6185 // Call function(pos, listname, index, stack, player)
6189 lua_pushstring(L, listname.c_str());
6191 lua_pushinteger(L, index + 1);
6193 LuaItemStack::create(L, stack);
6195 objectref_get_or_create(L, player);
6196 if(lua_pcall(L, 5, 0, 0))
6197 script_error(L, "error: %s", lua_tostring(L, -1));
6200 // Report taken items
6201 void scriptapi_nodemeta_inventory_on_take(lua_State *L, v3s16 p,
6202 const std::string &listname, int index, ItemStack &stack,
6203 ServerActiveObject *player)
6206 assert(lua_checkstack(L, 20));
6207 StackUnroller stack_unroller(L);
6209 INodeDefManager *ndef = get_server(L)->ndef();
6211 // If node doesn't exist, we don't know what callback to call
6212 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6213 if(node.getContent() == CONTENT_IGNORE)
6216 // Push callback function on stack
6217 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6218 "on_metadata_inventory_take"))
6221 // Call function(pos, listname, index, stack, player)
6225 lua_pushstring(L, listname.c_str());
6227 lua_pushinteger(L, index + 1);
6229 LuaItemStack::create(L, stack);
6231 objectref_get_or_create(L, player);
6232 if(lua_pcall(L, 5, 0, 0))
6233 script_error(L, "error: %s", lua_tostring(L, -1));
6237 Detached inventory callbacks
6240 // Retrieves minetest.detached_inventories[name][callbackname]
6241 // If that is nil or on error, return false and stack is unchanged
6242 // If that is a function, returns true and pushes the
6243 // function onto the stack
6244 static bool get_detached_inventory_callback(lua_State *L,
6245 const std::string &name, const char *callbackname)
6247 lua_getglobal(L, "minetest");
6248 lua_getfield(L, -1, "detached_inventories");
6250 luaL_checktype(L, -1, LUA_TTABLE);
6251 lua_getfield(L, -1, name.c_str());
6253 // Should be a table
6254 if(lua_type(L, -1) != LUA_TTABLE)
6256 errorstream<<"Item \""<<name<<"\" not defined"<<std::endl;
6260 lua_getfield(L, -1, callbackname);
6262 // Should be a function or nil
6263 if(lua_type(L, -1) == LUA_TFUNCTION)
6267 else if(lua_isnil(L, -1))
6274 errorstream<<"Detached inventory \""<<name<<"\" callback \""
6275 <<callbackname<<"\" is not a function"<<std::endl;
6281 // Return number of accepted items to be moved
6282 int scriptapi_detached_inventory_allow_move(lua_State *L,
6283 const std::string &name,
6284 const std::string &from_list, int from_index,
6285 const std::string &to_list, int to_index,
6286 int count, ServerActiveObject *player)
6289 assert(lua_checkstack(L, 20));
6290 StackUnroller stack_unroller(L);
6292 // Push callback function on stack
6293 if(!get_detached_inventory_callback(L, name, "allow_move"))
6296 // function(inv, from_list, from_index, to_list, to_index, count, player)
6298 InventoryLocation loc;
6299 loc.setDetached(name);
6300 InvRef::create(L, loc);
6302 lua_pushstring(L, from_list.c_str());
6304 lua_pushinteger(L, from_index + 1);
6306 lua_pushstring(L, to_list.c_str());
6308 lua_pushinteger(L, to_index + 1);
6310 lua_pushinteger(L, count);
6312 objectref_get_or_create(L, player);
6313 if(lua_pcall(L, 7, 1, 0))
6314 script_error(L, "error: %s", lua_tostring(L, -1));
6315 if(!lua_isnumber(L, -1))
6316 throw LuaError(L, "allow_move should return a number");
6317 return luaL_checkinteger(L, -1);
6320 // Return number of accepted items to be put
6321 int scriptapi_detached_inventory_allow_put(lua_State *L,
6322 const std::string &name,
6323 const std::string &listname, int index, ItemStack &stack,
6324 ServerActiveObject *player)
6327 assert(lua_checkstack(L, 20));
6328 StackUnroller stack_unroller(L);
6330 // Push callback function on stack
6331 if(!get_detached_inventory_callback(L, name, "allow_put"))
6332 return stack.count; // All will be accepted
6334 // Call function(inv, listname, index, stack, player)
6336 InventoryLocation loc;
6337 loc.setDetached(name);
6338 InvRef::create(L, loc);
6340 lua_pushstring(L, listname.c_str());
6342 lua_pushinteger(L, index + 1);
6344 LuaItemStack::create(L, stack);
6346 objectref_get_or_create(L, player);
6347 if(lua_pcall(L, 5, 1, 0))
6348 script_error(L, "error: %s", lua_tostring(L, -1));
6349 if(!lua_isnumber(L, -1))
6350 throw LuaError(L, "allow_put should return a number");
6351 return luaL_checkinteger(L, -1);
6354 // Return number of accepted items to be taken
6355 int scriptapi_detached_inventory_allow_take(lua_State *L,
6356 const std::string &name,
6357 const std::string &listname, int index, ItemStack &stack,
6358 ServerActiveObject *player)
6361 assert(lua_checkstack(L, 20));
6362 StackUnroller stack_unroller(L);
6364 // Push callback function on stack
6365 if(!get_detached_inventory_callback(L, name, "allow_take"))
6366 return stack.count; // All will be accepted
6368 // Call function(inv, listname, index, stack, player)
6370 InventoryLocation loc;
6371 loc.setDetached(name);
6372 InvRef::create(L, loc);
6374 lua_pushstring(L, listname.c_str());
6376 lua_pushinteger(L, index + 1);
6378 LuaItemStack::create(L, stack);
6380 objectref_get_or_create(L, player);
6381 if(lua_pcall(L, 5, 1, 0))
6382 script_error(L, "error: %s", lua_tostring(L, -1));
6383 if(!lua_isnumber(L, -1))
6384 throw LuaError(L, "allow_take should return a number");
6385 return luaL_checkinteger(L, -1);
6388 // Report moved items
6389 void scriptapi_detached_inventory_on_move(lua_State *L,
6390 const std::string &name,
6391 const std::string &from_list, int from_index,
6392 const std::string &to_list, int to_index,
6393 int count, ServerActiveObject *player)
6396 assert(lua_checkstack(L, 20));
6397 StackUnroller stack_unroller(L);
6399 // Push callback function on stack
6400 if(!get_detached_inventory_callback(L, name, "on_move"))
6403 // function(inv, from_list, from_index, to_list, to_index, count, player)
6405 InventoryLocation loc;
6406 loc.setDetached(name);
6407 InvRef::create(L, loc);
6409 lua_pushstring(L, from_list.c_str());
6411 lua_pushinteger(L, from_index + 1);
6413 lua_pushstring(L, to_list.c_str());
6415 lua_pushinteger(L, to_index + 1);
6417 lua_pushinteger(L, count);
6419 objectref_get_or_create(L, player);
6420 if(lua_pcall(L, 7, 0, 0))
6421 script_error(L, "error: %s", lua_tostring(L, -1));
6425 void scriptapi_detached_inventory_on_put(lua_State *L,
6426 const std::string &name,
6427 const std::string &listname, int index, ItemStack &stack,
6428 ServerActiveObject *player)
6431 assert(lua_checkstack(L, 20));
6432 StackUnroller stack_unroller(L);
6434 // Push callback function on stack
6435 if(!get_detached_inventory_callback(L, name, "on_put"))
6438 // Call function(inv, listname, index, stack, player)
6440 InventoryLocation loc;
6441 loc.setDetached(name);
6442 InvRef::create(L, loc);
6444 lua_pushstring(L, listname.c_str());
6446 lua_pushinteger(L, index + 1);
6448 LuaItemStack::create(L, stack);
6450 objectref_get_or_create(L, player);
6451 if(lua_pcall(L, 5, 0, 0))
6452 script_error(L, "error: %s", lua_tostring(L, -1));
6455 // Report taken items
6456 void scriptapi_detached_inventory_on_take(lua_State *L,
6457 const std::string &name,
6458 const std::string &listname, int index, ItemStack &stack,
6459 ServerActiveObject *player)
6462 assert(lua_checkstack(L, 20));
6463 StackUnroller stack_unroller(L);
6465 // Push callback function on stack
6466 if(!get_detached_inventory_callback(L, name, "on_take"))
6469 // Call function(inv, listname, index, stack, player)
6471 InventoryLocation loc;
6472 loc.setDetached(name);
6473 InvRef::create(L, loc);
6475 lua_pushstring(L, listname.c_str());
6477 lua_pushinteger(L, index + 1);
6479 LuaItemStack::create(L, stack);
6481 objectref_get_or_create(L, player);
6482 if(lua_pcall(L, 5, 0, 0))
6483 script_error(L, "error: %s", lua_tostring(L, -1));
6490 void scriptapi_environment_step(lua_State *L, float dtime)
6493 assert(lua_checkstack(L, 20));
6494 //infostream<<"scriptapi_environment_step"<<std::endl;
6495 StackUnroller stack_unroller(L);
6497 // Get minetest.registered_globalsteps
6498 lua_getglobal(L, "minetest");
6499 lua_getfield(L, -1, "registered_globalsteps");
6501 lua_pushnumber(L, dtime);
6502 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
6505 void scriptapi_environment_on_generated(lua_State *L, v3s16 minp, v3s16 maxp,
6509 assert(lua_checkstack(L, 20));
6510 //infostream<<"scriptapi_environment_on_generated"<<std::endl;
6511 StackUnroller stack_unroller(L);
6513 // Get minetest.registered_on_generateds
6514 lua_getglobal(L, "minetest");
6515 lua_getfield(L, -1, "registered_on_generateds");
6517 push_v3s16(L, minp);
6518 push_v3s16(L, maxp);
6519 lua_pushnumber(L, blockseed);
6520 scriptapi_run_callbacks(L, 3, RUN_CALLBACKS_MODE_FIRST);
6527 bool scriptapi_luaentity_add(lua_State *L, u16 id, const char *name)
6530 assert(lua_checkstack(L, 20));
6531 verbosestream<<"scriptapi_luaentity_add: id="<<id<<" name=\""
6532 <<name<<"\""<<std::endl;
6533 StackUnroller stack_unroller(L);
6535 // Get minetest.registered_entities[name]
6536 lua_getglobal(L, "minetest");
6537 lua_getfield(L, -1, "registered_entities");
6538 luaL_checktype(L, -1, LUA_TTABLE);
6539 lua_pushstring(L, name);
6540 lua_gettable(L, -2);
6541 // Should be a table, which we will use as a prototype
6542 //luaL_checktype(L, -1, LUA_TTABLE);
6543 if(lua_type(L, -1) != LUA_TTABLE){
6544 errorstream<<"LuaEntity name \""<<name<<"\" not defined"<<std::endl;
6547 int prototype_table = lua_gettop(L);
6548 //dump2(L, "prototype_table");
6550 // Create entity object
6552 int object = lua_gettop(L);
6554 // Set object metatable
6555 lua_pushvalue(L, prototype_table);
6556 lua_setmetatable(L, -2);
6558 // Add object reference
6559 // This should be userdata with metatable ObjectRef
6560 objectref_get(L, id);
6561 luaL_checktype(L, -1, LUA_TUSERDATA);
6562 if(!luaL_checkudata(L, -1, "ObjectRef"))
6563 luaL_typerror(L, -1, "ObjectRef");
6564 lua_setfield(L, -2, "object");
6566 // minetest.luaentities[id] = object
6567 lua_getglobal(L, "minetest");
6568 lua_getfield(L, -1, "luaentities");
6569 luaL_checktype(L, -1, LUA_TTABLE);
6570 lua_pushnumber(L, id); // Push id
6571 lua_pushvalue(L, object); // Copy object to top of stack
6572 lua_settable(L, -3);
6577 void scriptapi_luaentity_activate(lua_State *L, u16 id,
6578 const std::string &staticdata, u32 dtime_s)
6581 assert(lua_checkstack(L, 20));
6582 verbosestream<<"scriptapi_luaentity_activate: id="<<id<<std::endl;
6583 StackUnroller stack_unroller(L);
6585 // Get minetest.luaentities[id]
6586 luaentity_get(L, id);
6587 int object = lua_gettop(L);
6589 // Get on_activate function
6590 lua_pushvalue(L, object);
6591 lua_getfield(L, -1, "on_activate");
6592 if(!lua_isnil(L, -1)){
6593 luaL_checktype(L, -1, LUA_TFUNCTION);
6594 lua_pushvalue(L, object); // self
6595 lua_pushlstring(L, staticdata.c_str(), staticdata.size());
6596 lua_pushinteger(L, dtime_s);
6597 // Call with 3 arguments, 0 results
6598 if(lua_pcall(L, 3, 0, 0))
6599 script_error(L, "error running function on_activate: %s\n",
6600 lua_tostring(L, -1));
6604 void scriptapi_luaentity_rm(lua_State *L, u16 id)
6607 assert(lua_checkstack(L, 20));
6608 verbosestream<<"scriptapi_luaentity_rm: id="<<id<<std::endl;
6610 // Get minetest.luaentities table
6611 lua_getglobal(L, "minetest");
6612 lua_getfield(L, -1, "luaentities");
6613 luaL_checktype(L, -1, LUA_TTABLE);
6614 int objectstable = lua_gettop(L);
6616 // Set luaentities[id] = nil
6617 lua_pushnumber(L, id); // Push id
6619 lua_settable(L, objectstable);
6621 lua_pop(L, 2); // pop luaentities, minetest
6624 std::string scriptapi_luaentity_get_staticdata(lua_State *L, u16 id)
6627 assert(lua_checkstack(L, 20));
6628 //infostream<<"scriptapi_luaentity_get_staticdata: id="<<id<<std::endl;
6629 StackUnroller stack_unroller(L);
6631 // Get minetest.luaentities[id]
6632 luaentity_get(L, id);
6633 int object = lua_gettop(L);
6635 // Get get_staticdata function
6636 lua_pushvalue(L, object);
6637 lua_getfield(L, -1, "get_staticdata");
6638 if(lua_isnil(L, -1))
6641 luaL_checktype(L, -1, LUA_TFUNCTION);
6642 lua_pushvalue(L, object); // self
6643 // Call with 1 arguments, 1 results
6644 if(lua_pcall(L, 1, 1, 0))
6645 script_error(L, "error running function get_staticdata: %s\n",
6646 lua_tostring(L, -1));
6649 const char *s = lua_tolstring(L, -1, &len);
6650 return std::string(s, len);
6653 void scriptapi_luaentity_get_properties(lua_State *L, u16 id,
6654 ObjectProperties *prop)
6657 assert(lua_checkstack(L, 20));
6658 //infostream<<"scriptapi_luaentity_get_properties: id="<<id<<std::endl;
6659 StackUnroller stack_unroller(L);
6661 // Get minetest.luaentities[id]
6662 luaentity_get(L, id);
6663 //int object = lua_gettop(L);
6665 // Set default values that differ from ObjectProperties defaults
6670 prop->hp_max = getintfield_default(L, -1, "hp_max", 10);
6672 getboolfield(L, -1, "physical", prop->physical);
6674 getfloatfield(L, -1, "weight", prop->weight);
6676 lua_getfield(L, -1, "collisionbox");
6677 if(lua_istable(L, -1))
6678 prop->collisionbox = read_aabb3f(L, -1, 1.0);
6681 getstringfield(L, -1, "visual", prop->visual);
6683 getstringfield(L, -1, "mesh", prop->mesh);
6685 // Deprecated: read object properties directly
6686 read_object_properties(L, -1, prop);
6688 // Read initial_properties
6689 lua_getfield(L, -1, "initial_properties");
6690 read_object_properties(L, -1, prop);
6694 void scriptapi_luaentity_step(lua_State *L, u16 id, float dtime)
6697 assert(lua_checkstack(L, 20));
6698 //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
6699 StackUnroller stack_unroller(L);
6701 // Get minetest.luaentities[id]
6702 luaentity_get(L, id);
6703 int object = lua_gettop(L);
6704 // State: object is at top of stack
6705 // Get step function
6706 lua_getfield(L, -1, "on_step");
6707 if(lua_isnil(L, -1))
6709 luaL_checktype(L, -1, LUA_TFUNCTION);
6710 lua_pushvalue(L, object); // self
6711 lua_pushnumber(L, dtime); // dtime
6712 // Call with 2 arguments, 0 results
6713 if(lua_pcall(L, 2, 0, 0))
6714 script_error(L, "error running function 'on_step': %s\n", lua_tostring(L, -1));
6717 // Calls entity:on_punch(ObjectRef puncher, time_from_last_punch,
6718 // tool_capabilities, direction)
6719 void scriptapi_luaentity_punch(lua_State *L, u16 id,
6720 ServerActiveObject *puncher, float time_from_last_punch,
6721 const ToolCapabilities *toolcap, v3f dir)
6724 assert(lua_checkstack(L, 20));
6725 //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
6726 StackUnroller stack_unroller(L);
6728 // Get minetest.luaentities[id]
6729 luaentity_get(L, id);
6730 int object = lua_gettop(L);
6731 // State: object is at top of stack
6733 lua_getfield(L, -1, "on_punch");
6734 if(lua_isnil(L, -1))
6736 luaL_checktype(L, -1, LUA_TFUNCTION);
6737 lua_pushvalue(L, object); // self
6738 objectref_get_or_create(L, puncher); // Clicker reference
6739 lua_pushnumber(L, time_from_last_punch);
6740 push_tool_capabilities(L, *toolcap);
6742 // Call with 5 arguments, 0 results
6743 if(lua_pcall(L, 5, 0, 0))
6744 script_error(L, "error running function 'on_punch': %s\n", lua_tostring(L, -1));
6747 // Calls entity:on_rightclick(ObjectRef clicker)
6748 void scriptapi_luaentity_rightclick(lua_State *L, u16 id,
6749 ServerActiveObject *clicker)
6752 assert(lua_checkstack(L, 20));
6753 //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
6754 StackUnroller stack_unroller(L);
6756 // Get minetest.luaentities[id]
6757 luaentity_get(L, id);
6758 int object = lua_gettop(L);
6759 // State: object is at top of stack
6761 lua_getfield(L, -1, "on_rightclick");
6762 if(lua_isnil(L, -1))
6764 luaL_checktype(L, -1, LUA_TFUNCTION);
6765 lua_pushvalue(L, object); // self
6766 objectref_get_or_create(L, clicker); // Clicker reference
6767 // Call with 2 arguments, 0 results
6768 if(lua_pcall(L, 2, 0, 0))
6769 script_error(L, "error running function 'on_rightclick': %s\n", lua_tostring(L, -1));