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"
53 static void stackDump(lua_State *L, std::ostream &o)
56 int top = lua_gettop(L);
57 for (i = 1; i <= top; i++) { /* repeat for each level */
58 int t = lua_type(L, i);
61 case LUA_TSTRING: /* strings */
62 o<<"\""<<lua_tostring(L, i)<<"\"";
65 case LUA_TBOOLEAN: /* booleans */
66 o<<(lua_toboolean(L, i) ? "true" : "false");
69 case LUA_TNUMBER: /* numbers */ {
71 snprintf(buf, 10, "%g", lua_tonumber(L, i));
75 default: /* other values */
76 o<<lua_typename(L, t);
85 static void realitycheck(lua_State *L)
87 int top = lua_gettop(L);
89 dstream<<"Stack is over 30:"<<std::endl;
90 stackDump(L, dstream);
91 script_error(L, "Stack is over 30 (reality check)");
101 StackUnroller(lua_State *L):
105 m_original_top = lua_gettop(m_lua); // store stack height
109 lua_settop(m_lua, m_original_top); // restore stack height
118 ModNameStorer(lua_State *L_, const std::string modname):
121 // Store current modname in registry
122 lua_pushstring(L, modname.c_str());
123 lua_setfield(L, LUA_REGISTRYINDEX, "minetest_current_modname");
127 // Clear current modname in registry
129 lua_setfield(L, LUA_REGISTRYINDEX, "minetest_current_modname");
134 Getters for stuff in main tables
137 static Server* get_server(lua_State *L)
139 // Get server from registry
140 lua_getfield(L, LUA_REGISTRYINDEX, "minetest_server");
141 Server *server = (Server*)lua_touserdata(L, -1);
146 static ServerEnvironment* get_env(lua_State *L)
148 // Get environment from registry
149 lua_getfield(L, LUA_REGISTRYINDEX, "minetest_env");
150 ServerEnvironment *env = (ServerEnvironment*)lua_touserdata(L, -1);
155 static void objectref_get(lua_State *L, u16 id)
157 // Get minetest.object_refs[i]
158 lua_getglobal(L, "minetest");
159 lua_getfield(L, -1, "object_refs");
160 luaL_checktype(L, -1, LUA_TTABLE);
161 lua_pushnumber(L, id);
163 lua_remove(L, -2); // object_refs
164 lua_remove(L, -2); // minetest
167 static void luaentity_get(lua_State *L, u16 id)
169 // Get minetest.luaentities[i]
170 lua_getglobal(L, "minetest");
171 lua_getfield(L, -1, "luaentities");
172 luaL_checktype(L, -1, LUA_TTABLE);
173 lua_pushnumber(L, id);
175 lua_remove(L, -2); // luaentities
176 lua_remove(L, -2); // minetest
183 static bool getstringfield(lua_State *L, int table,
184 const char *fieldname, std::string &result)
186 lua_getfield(L, table, fieldname);
188 if(lua_isstring(L, -1)){
190 const char *ptr = lua_tolstring(L, -1, &len);
191 result.assign(ptr, len);
198 static bool getintfield(lua_State *L, int table,
199 const char *fieldname, int &result)
201 lua_getfield(L, table, fieldname);
203 if(lua_isnumber(L, -1)){
204 result = lua_tonumber(L, -1);
211 static bool getfloatfield(lua_State *L, int table,
212 const char *fieldname, float &result)
214 lua_getfield(L, table, fieldname);
216 if(lua_isnumber(L, -1)){
217 result = lua_tonumber(L, -1);
224 static bool getboolfield(lua_State *L, int table,
225 const char *fieldname, bool &result)
227 lua_getfield(L, table, fieldname);
229 if(lua_isboolean(L, -1)){
230 result = lua_toboolean(L, -1);
237 static std::string checkstringfield(lua_State *L, int table,
238 const char *fieldname)
240 lua_getfield(L, table, fieldname);
241 std::string s = luaL_checkstring(L, -1);
246 static std::string getstringfield_default(lua_State *L, int table,
247 const char *fieldname, const std::string &default_)
249 std::string result = default_;
250 getstringfield(L, table, fieldname, result);
254 static int getintfield_default(lua_State *L, int table,
255 const char *fieldname, int default_)
257 int result = default_;
258 getintfield(L, table, fieldname, result);
262 static float getfloatfield_default(lua_State *L, int table,
263 const char *fieldname, float default_)
265 float result = default_;
266 getfloatfield(L, table, fieldname, result);
270 static bool getboolfield_default(lua_State *L, int table,
271 const char *fieldname, bool default_)
273 bool result = default_;
274 getboolfield(L, table, fieldname, result);
284 static bool string_to_enum(const EnumString *spec, int &result,
285 const std::string &str)
287 const EnumString *esp = spec;
289 if(str == std::string(esp->str)){
298 /*static bool enum_to_string(const EnumString *spec, std::string &result,
301 const EnumString *esp = spec;
312 static int getenumfield(lua_State *L, int table,
313 const char *fieldname, const EnumString *spec, int default_)
315 int result = default_;
316 string_to_enum(spec, result,
317 getstringfield_default(L, table, fieldname, ""));
321 static void setintfield(lua_State *L, int table,
322 const char *fieldname, int value)
324 lua_pushinteger(L, value);
327 lua_setfield(L, table, fieldname);
330 static void setfloatfield(lua_State *L, int table,
331 const char *fieldname, float value)
333 lua_pushnumber(L, value);
336 lua_setfield(L, table, fieldname);
339 static void setboolfield(lua_State *L, int table,
340 const char *fieldname, bool value)
342 lua_pushboolean(L, value);
345 lua_setfield(L, table, fieldname);
348 static void warn_if_field_exists(lua_State *L, int table,
349 const char *fieldname, const std::string &message)
351 lua_getfield(L, table, fieldname);
352 if(!lua_isnil(L, -1)){
353 infostream<<script_get_backtrace(L)<<std::endl;
354 infostream<<"WARNING: field \""<<fieldname<<"\": "
355 <<message<<std::endl;
361 EnumString definitions
364 struct EnumString es_ItemType[] =
368 {ITEM_CRAFT, "craft"},
373 struct EnumString es_DrawType[] =
375 {NDT_NORMAL, "normal"},
376 {NDT_AIRLIKE, "airlike"},
377 {NDT_LIQUID, "liquid"},
378 {NDT_FLOWINGLIQUID, "flowingliquid"},
379 {NDT_GLASSLIKE, "glasslike"},
380 {NDT_ALLFACES, "allfaces"},
381 {NDT_ALLFACES_OPTIONAL, "allfaces_optional"},
382 {NDT_TORCHLIKE, "torchlike"},
383 {NDT_SIGNLIKE, "signlike"},
384 {NDT_PLANTLIKE, "plantlike"},
385 {NDT_FENCELIKE, "fencelike"},
386 {NDT_RAILLIKE, "raillike"},
387 {NDT_NODEBOX, "nodebox"},
391 struct EnumString es_ContentParamType[] =
394 {CPT_LIGHT, "light"},
398 struct EnumString es_ContentParamType2[] =
402 {CPT2_FLOWINGLIQUID, "flowingliquid"},
403 {CPT2_FACEDIR, "facedir"},
404 {CPT2_WALLMOUNTED, "wallmounted"},
408 struct EnumString es_LiquidType[] =
410 {LIQUID_NONE, "none"},
411 {LIQUID_FLOWING, "flowing"},
412 {LIQUID_SOURCE, "source"},
416 struct EnumString es_NodeBoxType[] =
418 {NODEBOX_REGULAR, "regular"},
419 {NODEBOX_FIXED, "fixed"},
420 {NODEBOX_WALLMOUNTED, "wallmounted"},
424 struct EnumString es_CraftMethod[] =
426 {CRAFT_METHOD_NORMAL, "normal"},
427 {CRAFT_METHOD_COOKING, "cooking"},
428 {CRAFT_METHOD_FUEL, "fuel"},
432 struct EnumString es_TileAnimationType[] =
435 {TAT_VERTICAL_FRAMES, "vertical_frames"},
440 C struct <-> Lua table converter functions
443 static void push_v3f(lua_State *L, v3f p)
446 lua_pushnumber(L, p.X);
447 lua_setfield(L, -2, "x");
448 lua_pushnumber(L, p.Y);
449 lua_setfield(L, -2, "y");
450 lua_pushnumber(L, p.Z);
451 lua_setfield(L, -2, "z");
454 static v2s16 read_v2s16(lua_State *L, int index)
457 luaL_checktype(L, index, LUA_TTABLE);
458 lua_getfield(L, index, "x");
459 p.X = lua_tonumber(L, -1);
461 lua_getfield(L, index, "y");
462 p.Y = lua_tonumber(L, -1);
467 static v2f read_v2f(lua_State *L, int index)
470 luaL_checktype(L, index, LUA_TTABLE);
471 lua_getfield(L, index, "x");
472 p.X = lua_tonumber(L, -1);
474 lua_getfield(L, index, "y");
475 p.Y = lua_tonumber(L, -1);
480 static v3f read_v3f(lua_State *L, int index)
483 luaL_checktype(L, index, LUA_TTABLE);
484 lua_getfield(L, index, "x");
485 pos.X = lua_tonumber(L, -1);
487 lua_getfield(L, index, "y");
488 pos.Y = lua_tonumber(L, -1);
490 lua_getfield(L, index, "z");
491 pos.Z = lua_tonumber(L, -1);
496 static v3f check_v3f(lua_State *L, int index)
499 luaL_checktype(L, index, LUA_TTABLE);
500 lua_getfield(L, index, "x");
501 pos.X = luaL_checknumber(L, -1);
503 lua_getfield(L, index, "y");
504 pos.Y = luaL_checknumber(L, -1);
506 lua_getfield(L, index, "z");
507 pos.Z = luaL_checknumber(L, -1);
512 static void pushFloatPos(lua_State *L, v3f p)
518 static v3f checkFloatPos(lua_State *L, int index)
520 return check_v3f(L, index) * BS;
523 static void push_v3s16(lua_State *L, v3s16 p)
526 lua_pushnumber(L, p.X);
527 lua_setfield(L, -2, "x");
528 lua_pushnumber(L, p.Y);
529 lua_setfield(L, -2, "y");
530 lua_pushnumber(L, p.Z);
531 lua_setfield(L, -2, "z");
534 static v3s16 read_v3s16(lua_State *L, int index)
536 // Correct rounding at <0
537 v3f pf = read_v3f(L, index);
538 return floatToInt(pf, 1.0);
541 static v3s16 check_v3s16(lua_State *L, int index)
543 // Correct rounding at <0
544 v3f pf = check_v3f(L, index);
545 return floatToInt(pf, 1.0);
548 static void pushnode(lua_State *L, const MapNode &n, INodeDefManager *ndef)
551 lua_pushstring(L, ndef->get(n).name.c_str());
552 lua_setfield(L, -2, "name");
553 lua_pushnumber(L, n.getParam1());
554 lua_setfield(L, -2, "param1");
555 lua_pushnumber(L, n.getParam2());
556 lua_setfield(L, -2, "param2");
559 static MapNode readnode(lua_State *L, int index, INodeDefManager *ndef)
561 lua_getfield(L, index, "name");
562 const char *name = luaL_checkstring(L, -1);
565 lua_getfield(L, index, "param1");
569 param1 = lua_tonumber(L, -1);
572 lua_getfield(L, index, "param2");
576 param2 = lua_tonumber(L, -1);
578 return MapNode(ndef, name, param1, param2);
581 static video::SColor readARGB8(lua_State *L, int index)
584 luaL_checktype(L, index, LUA_TTABLE);
585 lua_getfield(L, index, "a");
586 if(lua_isnumber(L, -1))
587 color.setAlpha(lua_tonumber(L, -1));
589 lua_getfield(L, index, "r");
590 color.setRed(lua_tonumber(L, -1));
592 lua_getfield(L, index, "g");
593 color.setGreen(lua_tonumber(L, -1));
595 lua_getfield(L, index, "b");
596 color.setBlue(lua_tonumber(L, -1));
601 static aabb3f read_aabb3f(lua_State *L, int index, f32 scale)
604 if(lua_istable(L, index)){
605 lua_rawgeti(L, index, 1);
606 box.MinEdge.X = lua_tonumber(L, -1) * scale;
608 lua_rawgeti(L, index, 2);
609 box.MinEdge.Y = lua_tonumber(L, -1) * scale;
611 lua_rawgeti(L, index, 3);
612 box.MinEdge.Z = lua_tonumber(L, -1) * scale;
614 lua_rawgeti(L, index, 4);
615 box.MaxEdge.X = lua_tonumber(L, -1) * scale;
617 lua_rawgeti(L, index, 5);
618 box.MaxEdge.Y = lua_tonumber(L, -1) * scale;
620 lua_rawgeti(L, index, 6);
621 box.MaxEdge.Z = lua_tonumber(L, -1) * scale;
627 static std::vector<aabb3f> read_aabb3f_vector(lua_State *L, int index, f32 scale)
629 std::vector<aabb3f> boxes;
630 if(lua_istable(L, index)){
631 int n = lua_objlen(L, index);
632 // Check if it's a single box or a list of boxes
633 bool possibly_single_box = (n == 6);
634 for(int i = 1; i <= n && possibly_single_box; i++){
635 lua_rawgeti(L, index, i);
636 if(!lua_isnumber(L, -1))
637 possibly_single_box = false;
640 if(possibly_single_box){
642 boxes.push_back(read_aabb3f(L, index, scale));
644 // Read a list of boxes
645 for(int i = 1; i <= n; i++){
646 lua_rawgeti(L, index, i);
647 boxes.push_back(read_aabb3f(L, -1, scale));
655 static NodeBox read_nodebox(lua_State *L, int index)
658 if(lua_istable(L, -1)){
659 nodebox.type = (NodeBoxType)getenumfield(L, index, "type",
660 es_NodeBoxType, NODEBOX_REGULAR);
662 lua_getfield(L, index, "fixed");
663 if(lua_istable(L, -1))
664 nodebox.fixed = read_aabb3f_vector(L, -1, BS);
667 lua_getfield(L, index, "wall_top");
668 if(lua_istable(L, -1))
669 nodebox.wall_top = read_aabb3f(L, -1, BS);
672 lua_getfield(L, index, "wall_bottom");
673 if(lua_istable(L, -1))
674 nodebox.wall_bottom = read_aabb3f(L, -1, BS);
677 lua_getfield(L, index, "wall_side");
678 if(lua_istable(L, -1))
679 nodebox.wall_side = read_aabb3f(L, -1, BS);
688 static void read_groups(lua_State *L, int index,
689 std::map<std::string, int> &result)
691 if (!lua_istable(L,index))
697 while(lua_next(L, index) != 0){
698 // key at index -2 and value at index -1
699 std::string name = luaL_checkstring(L, -2);
700 int rating = luaL_checkinteger(L, -1);
701 result[name] = rating;
702 // removes value, keeps key for next iteration
710 static void read_privileges(lua_State *L, int index,
711 std::set<std::string> &result)
717 while(lua_next(L, index) != 0){
718 // key at index -2 and value at index -1
719 std::string key = luaL_checkstring(L, -2);
720 bool value = lua_toboolean(L, -1);
723 // removes value, keeps key for next iteration
732 static ToolCapabilities read_tool_capabilities(
733 lua_State *L, int table)
735 ToolCapabilities toolcap;
736 getfloatfield(L, table, "full_punch_interval", toolcap.full_punch_interval);
737 getintfield(L, table, "max_drop_level", toolcap.max_drop_level);
738 lua_getfield(L, table, "groupcaps");
739 if(lua_istable(L, -1)){
740 int table_groupcaps = lua_gettop(L);
742 while(lua_next(L, table_groupcaps) != 0){
743 // key at index -2 and value at index -1
744 std::string groupname = luaL_checkstring(L, -2);
745 if(lua_istable(L, -1)){
746 int table_groupcap = lua_gettop(L);
747 // This will be created
748 ToolGroupCap groupcap;
749 // Read simple parameters
750 getintfield(L, table_groupcap, "maxlevel", groupcap.maxlevel);
751 getintfield(L, table_groupcap, "uses", groupcap.uses);
752 // DEPRECATED: maxwear
754 if(getfloatfield(L, table_groupcap, "maxwear", maxwear)){
756 groupcap.uses = 1.0/maxwear;
759 infostream<<script_get_backtrace(L)<<std::endl;
760 infostream<<"WARNING: field \"maxwear\" is deprecated; "
761 <<"should replace with uses=1/maxwear"<<std::endl;
763 // Read "times" table
764 lua_getfield(L, table_groupcap, "times");
765 if(lua_istable(L, -1)){
766 int table_times = lua_gettop(L);
768 while(lua_next(L, table_times) != 0){
769 // key at index -2 and value at index -1
770 int rating = luaL_checkinteger(L, -2);
771 float time = luaL_checknumber(L, -1);
772 groupcap.times[rating] = time;
773 // removes value, keeps key for next iteration
778 // Insert groupcap into toolcap
779 toolcap.groupcaps[groupname] = groupcap;
781 // removes value, keeps key for next iteration
789 static void set_tool_capabilities(lua_State *L, int table,
790 const ToolCapabilities &toolcap)
792 setfloatfield(L, table, "full_punch_interval", toolcap.full_punch_interval);
793 setintfield(L, table, "max_drop_level", toolcap.max_drop_level);
794 // Create groupcaps table
797 for(std::map<std::string, ToolGroupCap>::const_iterator
798 i = toolcap.groupcaps.begin(); i != toolcap.groupcaps.end(); i++){
799 // Create groupcap table
801 const std::string &name = i->first;
802 const ToolGroupCap &groupcap = i->second;
803 // Create subtable "times"
805 for(std::map<int, float>::const_iterator
806 i = groupcap.times.begin(); i != groupcap.times.end(); i++){
807 int rating = i->first;
808 float time = i->second;
809 lua_pushinteger(L, rating);
810 lua_pushnumber(L, time);
813 // Set subtable "times"
814 lua_setfield(L, -2, "times");
815 // Set simple parameters
816 setintfield(L, -1, "maxlevel", groupcap.maxlevel);
817 setintfield(L, -1, "uses", groupcap.uses);
818 // Insert groupcap table into groupcaps table
819 lua_setfield(L, -2, name.c_str());
821 // Set groupcaps table
822 lua_setfield(L, -2, "groupcaps");
825 static void push_tool_capabilities(lua_State *L,
826 const ToolCapabilities &prop)
829 set_tool_capabilities(L, -1, prop);
836 static void set_dig_params(lua_State *L, int table,
837 const DigParams ¶ms)
839 setboolfield(L, table, "diggable", params.diggable);
840 setfloatfield(L, table, "time", params.time);
841 setintfield(L, table, "wear", params.wear);
844 static void push_dig_params(lua_State *L,
845 const DigParams ¶ms)
848 set_dig_params(L, -1, params);
855 static void set_hit_params(lua_State *L, int table,
856 const HitParams ¶ms)
858 setintfield(L, table, "hp", params.hp);
859 setintfield(L, table, "wear", params.wear);
862 static void push_hit_params(lua_State *L,
863 const HitParams ¶ms)
866 set_hit_params(L, -1, params);
873 static void push_pointed_thing(lua_State *L, const PointedThing& pointed)
876 if(pointed.type == POINTEDTHING_NODE)
878 lua_pushstring(L, "node");
879 lua_setfield(L, -2, "type");
880 push_v3s16(L, pointed.node_undersurface);
881 lua_setfield(L, -2, "under");
882 push_v3s16(L, pointed.node_abovesurface);
883 lua_setfield(L, -2, "above");
885 else if(pointed.type == POINTEDTHING_OBJECT)
887 lua_pushstring(L, "object");
888 lua_setfield(L, -2, "type");
889 objectref_get(L, pointed.object_id);
890 lua_setfield(L, -2, "ref");
894 lua_pushstring(L, "nothing");
895 lua_setfield(L, -2, "type");
903 static void read_soundspec(lua_State *L, int index, SimpleSoundSpec &spec)
906 index = lua_gettop(L) + 1 + index;
907 if(lua_isnil(L, index)){
908 } else if(lua_istable(L, index)){
909 getstringfield(L, index, "name", spec.name);
910 getfloatfield(L, index, "gain", spec.gain);
911 } else if(lua_isstring(L, index)){
912 spec.name = lua_tostring(L, index);
920 static void read_object_properties(lua_State *L, int index,
921 ObjectProperties *prop)
924 index = lua_gettop(L) + 1 + index;
925 if(!lua_istable(L, index))
928 prop->hp_max = getintfield_default(L, -1, "hp_max", 10);
930 getboolfield(L, -1, "physical", prop->physical);
932 getfloatfield(L, -1, "weight", prop->weight);
934 lua_getfield(L, -1, "collisionbox");
935 if(lua_istable(L, -1))
936 prop->collisionbox = read_aabb3f(L, -1, 1.0);
939 getstringfield(L, -1, "visual", prop->visual);
941 getstringfield(L, -1, "mesh", prop->mesh);
943 lua_getfield(L, -1, "visual_size");
944 if(lua_istable(L, -1))
945 prop->visual_size = read_v2f(L, -1);
948 lua_getfield(L, -1, "textures");
949 if(lua_istable(L, -1)){
950 prop->textures.clear();
951 int table = lua_gettop(L);
953 while(lua_next(L, table) != 0){
954 // key at index -2 and value at index -1
955 if(lua_isstring(L, -1))
956 prop->textures.push_back(lua_tostring(L, -1));
958 prop->textures.push_back("");
959 // removes value, keeps key for next iteration
965 lua_getfield(L, -1, "colors");
966 if(lua_istable(L, -1)){
967 prop->colors.clear();
968 int table = lua_gettop(L);
970 while(lua_next(L, table) != 0){
971 // key at index -2 and value at index -1
972 if(lua_isstring(L, -1))
973 prop->colors.push_back(readARGB8(L, -1));
975 prop->colors.push_back(video::SColor(255, 255, 255, 255));
976 // removes value, keeps key for next iteration
982 lua_getfield(L, -1, "spritediv");
983 if(lua_istable(L, -1))
984 prop->spritediv = read_v2s16(L, -1);
987 lua_getfield(L, -1, "initial_sprite_basepos");
988 if(lua_istable(L, -1))
989 prop->initial_sprite_basepos = read_v2s16(L, -1);
992 getboolfield(L, -1, "is_visible", prop->is_visible);
993 getboolfield(L, -1, "makes_footstep_sound", prop->makes_footstep_sound);
994 getfloatfield(L, -1, "automatic_rotate", prop->automatic_rotate);
1001 static ItemDefinition read_item_definition(lua_State *L, int index,
1002 ItemDefinition default_def = ItemDefinition())
1005 index = lua_gettop(L) + 1 + index;
1007 // Read the item definition
1008 ItemDefinition def = default_def;
1010 def.type = (ItemType)getenumfield(L, index, "type",
1011 es_ItemType, ITEM_NONE);
1012 getstringfield(L, index, "name", def.name);
1013 getstringfield(L, index, "description", def.description);
1014 getstringfield(L, index, "inventory_image", def.inventory_image);
1015 getstringfield(L, index, "wield_image", def.wield_image);
1017 lua_getfield(L, index, "wield_scale");
1018 if(lua_istable(L, -1)){
1019 def.wield_scale = check_v3f(L, -1);
1023 def.stack_max = getintfield_default(L, index, "stack_max", def.stack_max);
1024 if(def.stack_max == 0)
1027 lua_getfield(L, index, "on_use");
1028 def.usable = lua_isfunction(L, -1);
1031 getboolfield(L, index, "liquids_pointable", def.liquids_pointable);
1033 warn_if_field_exists(L, index, "tool_digging_properties",
1034 "deprecated: use tool_capabilities");
1036 lua_getfield(L, index, "tool_capabilities");
1037 if(lua_istable(L, -1)){
1038 def.tool_capabilities = new ToolCapabilities(
1039 read_tool_capabilities(L, -1));
1042 // If name is "" (hand), ensure there are ToolCapabilities
1043 // because it will be looked up there whenever any other item has
1044 // no ToolCapabilities
1045 if(def.name == "" && def.tool_capabilities == NULL){
1046 def.tool_capabilities = new ToolCapabilities();
1049 lua_getfield(L, index, "groups");
1050 read_groups(L, -1, def.groups);
1053 // Client shall immediately place this node when player places the item.
1054 // Server will update the precise end result a moment later.
1055 // "" = no prediction
1056 getstringfield(L, index, "node_placement_prediction",
1057 def.node_placement_prediction);
1066 static TileDef read_tiledef(lua_State *L, int index)
1069 index = lua_gettop(L) + 1 + index;
1073 // key at index -2 and value at index
1074 if(lua_isstring(L, index)){
1075 // "default_lava.png"
1076 tiledef.name = lua_tostring(L, index);
1078 else if(lua_istable(L, index))
1080 // {name="default_lava.png", animation={}}
1082 getstringfield(L, index, "name", tiledef.name);
1083 getstringfield(L, index, "image", tiledef.name); // MaterialSpec compat.
1084 tiledef.backface_culling = getboolfield_default(
1085 L, index, "backface_culling", true);
1087 lua_getfield(L, index, "animation");
1088 if(lua_istable(L, -1)){
1089 // {type="vertical_frames", aspect_w=16, aspect_h=16, length=2.0}
1090 tiledef.animation.type = (TileAnimationType)
1091 getenumfield(L, -1, "type", es_TileAnimationType,
1093 tiledef.animation.aspect_w =
1094 getintfield_default(L, -1, "aspect_w", 16);
1095 tiledef.animation.aspect_h =
1096 getintfield_default(L, -1, "aspect_h", 16);
1097 tiledef.animation.length =
1098 getfloatfield_default(L, -1, "length", 1.0);
1110 static ContentFeatures read_content_features(lua_State *L, int index)
1113 index = lua_gettop(L) + 1 + index;
1117 /* Cache existence of some callbacks */
1118 lua_getfield(L, index, "on_construct");
1119 if(!lua_isnil(L, -1)) f.has_on_construct = true;
1121 lua_getfield(L, index, "on_destruct");
1122 if(!lua_isnil(L, -1)) f.has_on_destruct = true;
1124 lua_getfield(L, index, "after_destruct");
1125 if(!lua_isnil(L, -1)) f.has_after_destruct = true;
1129 getstringfield(L, index, "name", f.name);
1132 lua_getfield(L, index, "groups");
1133 read_groups(L, -1, f.groups);
1136 /* Visual definition */
1138 f.drawtype = (NodeDrawType)getenumfield(L, index, "drawtype", es_DrawType,
1140 getfloatfield(L, index, "visual_scale", f.visual_scale);
1143 lua_getfield(L, index, "tiles");
1144 // If nil, try the deprecated name "tile_images" instead
1145 if(lua_isnil(L, -1)){
1147 warn_if_field_exists(L, index, "tile_images",
1148 "Deprecated; new name is \"tiles\".");
1149 lua_getfield(L, index, "tile_images");
1151 if(lua_istable(L, -1)){
1152 int table = lua_gettop(L);
1155 while(lua_next(L, table) != 0){
1156 // Read tiledef from value
1157 f.tiledef[i] = read_tiledef(L, -1);
1158 // removes value, keeps key for next iteration
1166 // Copy last value to all remaining textures
1168 TileDef lasttile = f.tiledef[i-1];
1170 f.tiledef[i] = lasttile;
1177 // special_tiles = {}
1178 lua_getfield(L, index, "special_tiles");
1179 // If nil, try the deprecated name "special_materials" instead
1180 if(lua_isnil(L, -1)){
1182 warn_if_field_exists(L, index, "special_materials",
1183 "Deprecated; new name is \"special_tiles\".");
1184 lua_getfield(L, index, "special_materials");
1186 if(lua_istable(L, -1)){
1187 int table = lua_gettop(L);
1190 while(lua_next(L, table) != 0){
1191 // Read tiledef from value
1192 f.tiledef_special[i] = read_tiledef(L, -1);
1193 // removes value, keeps key for next iteration
1204 f.alpha = getintfield_default(L, index, "alpha", 255);
1208 lua_getfield(L, index, "post_effect_color");
1209 if(!lua_isnil(L, -1))
1210 f.post_effect_color = readARGB8(L, -1);
1213 f.param_type = (ContentParamType)getenumfield(L, index, "paramtype",
1214 es_ContentParamType, CPT_NONE);
1215 f.param_type_2 = (ContentParamType2)getenumfield(L, index, "paramtype2",
1216 es_ContentParamType2, CPT2_NONE);
1218 // Warn about some deprecated fields
1219 warn_if_field_exists(L, index, "wall_mounted",
1220 "deprecated: use paramtype2 = 'wallmounted'");
1221 warn_if_field_exists(L, index, "light_propagates",
1222 "deprecated: determined from paramtype");
1223 warn_if_field_exists(L, index, "dug_item",
1224 "deprecated: use 'drop' field");
1225 warn_if_field_exists(L, index, "extra_dug_item",
1226 "deprecated: use 'drop' field");
1227 warn_if_field_exists(L, index, "extra_dug_item_rarity",
1228 "deprecated: use 'drop' field");
1229 warn_if_field_exists(L, index, "metadata_name",
1230 "deprecated: use on_add and metadata callbacks");
1232 // True for all ground-like things like stone and mud, false for eg. trees
1233 getboolfield(L, index, "is_ground_content", f.is_ground_content);
1234 f.light_propagates = (f.param_type == CPT_LIGHT);
1235 getboolfield(L, index, "sunlight_propagates", f.sunlight_propagates);
1236 // This is used for collision detection.
1237 // Also for general solidness queries.
1238 getboolfield(L, index, "walkable", f.walkable);
1239 // Player can point to these
1240 getboolfield(L, index, "pointable", f.pointable);
1241 // Player can dig these
1242 getboolfield(L, index, "diggable", f.diggable);
1243 // Player can climb these
1244 getboolfield(L, index, "climbable", f.climbable);
1245 // Player can build on these
1246 getboolfield(L, index, "buildable_to", f.buildable_to);
1247 // Whether the node is non-liquid, source liquid or flowing liquid
1248 f.liquid_type = (LiquidType)getenumfield(L, index, "liquidtype",
1249 es_LiquidType, LIQUID_NONE);
1250 // If the content is liquid, this is the flowing version of the liquid.
1251 getstringfield(L, index, "liquid_alternative_flowing",
1252 f.liquid_alternative_flowing);
1253 // If the content is liquid, this is the source version of the liquid.
1254 getstringfield(L, index, "liquid_alternative_source",
1255 f.liquid_alternative_source);
1256 // Viscosity for fluid flow, ranging from 1 to 7, with
1257 // 1 giving almost instantaneous propagation and 7 being
1258 // the slowest possible
1259 f.liquid_viscosity = getintfield_default(L, index,
1260 "liquid_viscosity", f.liquid_viscosity);
1261 getboolfield(L, index, "liquid_renewable", f.liquid_renewable);
1262 // Amount of light the node emits
1263 f.light_source = getintfield_default(L, index,
1264 "light_source", f.light_source);
1265 f.damage_per_second = getintfield_default(L, index,
1266 "damage_per_second", f.damage_per_second);
1268 lua_getfield(L, index, "node_box");
1269 if(lua_istable(L, -1))
1270 f.node_box = read_nodebox(L, -1);
1273 lua_getfield(L, index, "selection_box");
1274 if(lua_istable(L, -1))
1275 f.selection_box = read_nodebox(L, -1);
1278 // Set to true if paramtype used to be 'facedir_simple'
1279 getboolfield(L, index, "legacy_facedir_simple", f.legacy_facedir_simple);
1280 // Set to true if wall_mounted used to be set to true
1281 getboolfield(L, index, "legacy_wallmounted", f.legacy_wallmounted);
1284 lua_getfield(L, index, "sounds");
1285 if(lua_istable(L, -1)){
1286 lua_getfield(L, -1, "footstep");
1287 read_soundspec(L, -1, f.sound_footstep);
1289 lua_getfield(L, -1, "dig");
1290 read_soundspec(L, -1, f.sound_dig);
1292 lua_getfield(L, -1, "dug");
1293 read_soundspec(L, -1, f.sound_dug);
1305 static ItemStack read_item(lua_State *L, int index);
1306 static std::vector<ItemStack> read_items(lua_State *L, int index);
1307 // creates a table of ItemStacks
1308 static void push_items(lua_State *L, const std::vector<ItemStack> &items);
1310 static void inventory_set_list_from_lua(Inventory *inv, const char *name,
1311 lua_State *L, int tableindex, int forcesize=-1)
1314 tableindex = lua_gettop(L) + 1 + tableindex;
1315 // If nil, delete list
1316 if(lua_isnil(L, tableindex)){
1317 inv->deleteList(name);
1320 // Otherwise set list
1321 std::vector<ItemStack> items = read_items(L, tableindex);
1322 int listsize = (forcesize != -1) ? forcesize : items.size();
1323 InventoryList *invlist = inv->addList(name, listsize);
1325 for(std::vector<ItemStack>::const_iterator
1326 i = items.begin(); i != items.end(); i++){
1327 if(forcesize != -1 && index == forcesize)
1329 invlist->changeItem(index, *i);
1332 while(forcesize != -1 && index < forcesize){
1333 invlist->deleteItem(index);
1338 static void inventory_get_list_to_lua(Inventory *inv, const char *name,
1341 InventoryList *invlist = inv->getList(name);
1342 if(invlist == NULL){
1346 std::vector<ItemStack> items;
1347 for(u32 i=0; i<invlist->getSize(); i++)
1348 items.push_back(invlist->getItem(i));
1349 push_items(L, items);
1353 Helpful macros for userdata classes
1356 #define method(class, name) {#name, class::l_##name}
1367 static const char className[];
1368 static const luaL_reg methods[];
1370 // Exported functions
1372 // garbage collector
1373 static int gc_object(lua_State *L)
1375 LuaItemStack *o = *(LuaItemStack **)(lua_touserdata(L, 1));
1380 // is_empty(self) -> true/false
1381 static int l_is_empty(lua_State *L)
1383 LuaItemStack *o = checkobject(L, 1);
1384 ItemStack &item = o->m_stack;
1385 lua_pushboolean(L, item.empty());
1389 // get_name(self) -> string
1390 static int l_get_name(lua_State *L)
1392 LuaItemStack *o = checkobject(L, 1);
1393 ItemStack &item = o->m_stack;
1394 lua_pushstring(L, item.name.c_str());
1398 // get_count(self) -> number
1399 static int l_get_count(lua_State *L)
1401 LuaItemStack *o = checkobject(L, 1);
1402 ItemStack &item = o->m_stack;
1403 lua_pushinteger(L, item.count);
1407 // get_wear(self) -> number
1408 static int l_get_wear(lua_State *L)
1410 LuaItemStack *o = checkobject(L, 1);
1411 ItemStack &item = o->m_stack;
1412 lua_pushinteger(L, item.wear);
1416 // get_metadata(self) -> string
1417 static int l_get_metadata(lua_State *L)
1419 LuaItemStack *o = checkobject(L, 1);
1420 ItemStack &item = o->m_stack;
1421 lua_pushlstring(L, item.metadata.c_str(), item.metadata.size());
1425 // clear(self) -> true
1426 static int l_clear(lua_State *L)
1428 LuaItemStack *o = checkobject(L, 1);
1430 lua_pushboolean(L, true);
1434 // replace(self, itemstack or itemstring or table or nil) -> true
1435 static int l_replace(lua_State *L)
1437 LuaItemStack *o = checkobject(L, 1);
1438 o->m_stack = read_item(L, 2);
1439 lua_pushboolean(L, true);
1443 // to_string(self) -> string
1444 static int l_to_string(lua_State *L)
1446 LuaItemStack *o = checkobject(L, 1);
1447 std::string itemstring = o->m_stack.getItemString();
1448 lua_pushstring(L, itemstring.c_str());
1452 // to_table(self) -> table or nil
1453 static int l_to_table(lua_State *L)
1455 LuaItemStack *o = checkobject(L, 1);
1456 const ItemStack &item = o->m_stack;
1464 lua_pushstring(L, item.name.c_str());
1465 lua_setfield(L, -2, "name");
1466 lua_pushinteger(L, item.count);
1467 lua_setfield(L, -2, "count");
1468 lua_pushinteger(L, item.wear);
1469 lua_setfield(L, -2, "wear");
1470 lua_pushlstring(L, item.metadata.c_str(), item.metadata.size());
1471 lua_setfield(L, -2, "metadata");
1476 // get_stack_max(self) -> number
1477 static int l_get_stack_max(lua_State *L)
1479 LuaItemStack *o = checkobject(L, 1);
1480 ItemStack &item = o->m_stack;
1481 lua_pushinteger(L, item.getStackMax(get_server(L)->idef()));
1485 // get_free_space(self) -> number
1486 static int l_get_free_space(lua_State *L)
1488 LuaItemStack *o = checkobject(L, 1);
1489 ItemStack &item = o->m_stack;
1490 lua_pushinteger(L, item.freeSpace(get_server(L)->idef()));
1494 // is_known(self) -> true/false
1495 // Checks if the item is defined.
1496 static int l_is_known(lua_State *L)
1498 LuaItemStack *o = checkobject(L, 1);
1499 ItemStack &item = o->m_stack;
1500 bool is_known = item.isKnown(get_server(L)->idef());
1501 lua_pushboolean(L, is_known);
1505 // get_definition(self) -> table
1506 // Returns the item definition table from minetest.registered_items,
1507 // or a fallback one (name="unknown")
1508 static int l_get_definition(lua_State *L)
1510 LuaItemStack *o = checkobject(L, 1);
1511 ItemStack &item = o->m_stack;
1513 // Get minetest.registered_items[name]
1514 lua_getglobal(L, "minetest");
1515 lua_getfield(L, -1, "registered_items");
1516 luaL_checktype(L, -1, LUA_TTABLE);
1517 lua_getfield(L, -1, item.name.c_str());
1518 if(lua_isnil(L, -1))
1521 lua_getfield(L, -1, "unknown");
1526 // get_tool_capabilities(self) -> table
1527 // Returns the effective tool digging properties.
1528 // Returns those of the hand ("") if this item has none associated.
1529 static int l_get_tool_capabilities(lua_State *L)
1531 LuaItemStack *o = checkobject(L, 1);
1532 ItemStack &item = o->m_stack;
1533 const ToolCapabilities &prop =
1534 item.getToolCapabilities(get_server(L)->idef());
1535 push_tool_capabilities(L, prop);
1539 // add_wear(self, amount) -> true/false
1540 // The range for "amount" is [0,65535]. Wear is only added if the item
1541 // is a tool. Adding wear might destroy the item.
1542 // Returns true if the item is (or was) a tool.
1543 static int l_add_wear(lua_State *L)
1545 LuaItemStack *o = checkobject(L, 1);
1546 ItemStack &item = o->m_stack;
1547 int amount = lua_tointeger(L, 2);
1548 bool result = item.addWear(amount, get_server(L)->idef());
1549 lua_pushboolean(L, result);
1553 // add_item(self, itemstack or itemstring or table or nil) -> itemstack
1554 // Returns leftover item stack
1555 static int l_add_item(lua_State *L)
1557 LuaItemStack *o = checkobject(L, 1);
1558 ItemStack &item = o->m_stack;
1559 ItemStack newitem = read_item(L, 2);
1560 ItemStack leftover = item.addItem(newitem, get_server(L)->idef());
1561 create(L, leftover);
1565 // item_fits(self, itemstack or itemstring or table or nil) -> true/false, itemstack
1566 // First return value is true iff the new item fits fully into the stack
1567 // Second return value is the would-be-left-over item stack
1568 static int l_item_fits(lua_State *L)
1570 LuaItemStack *o = checkobject(L, 1);
1571 ItemStack &item = o->m_stack;
1572 ItemStack newitem = read_item(L, 2);
1574 bool fits = item.itemFits(newitem, &restitem, get_server(L)->idef());
1575 lua_pushboolean(L, fits); // first return value
1576 create(L, restitem); // second return value
1580 // take_item(self, takecount=1) -> itemstack
1581 static int l_take_item(lua_State *L)
1583 LuaItemStack *o = checkobject(L, 1);
1584 ItemStack &item = o->m_stack;
1586 if(!lua_isnone(L, 2))
1587 takecount = luaL_checkinteger(L, 2);
1588 ItemStack taken = item.takeItem(takecount);
1593 // peek_item(self, peekcount=1) -> itemstack
1594 static int l_peek_item(lua_State *L)
1596 LuaItemStack *o = checkobject(L, 1);
1597 ItemStack &item = o->m_stack;
1599 if(!lua_isnone(L, 2))
1600 peekcount = lua_tointeger(L, 2);
1601 ItemStack peekaboo = item.peekItem(peekcount);
1602 create(L, peekaboo);
1607 LuaItemStack(const ItemStack &item):
1616 const ItemStack& getItem() const
1620 ItemStack& getItem()
1625 // LuaItemStack(itemstack or itemstring or table or nil)
1626 // Creates an LuaItemStack and leaves it on top of stack
1627 static int create_object(lua_State *L)
1629 ItemStack item = read_item(L, 1);
1630 LuaItemStack *o = new LuaItemStack(item);
1631 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
1632 luaL_getmetatable(L, className);
1633 lua_setmetatable(L, -2);
1636 // Not callable from Lua
1637 static int create(lua_State *L, const ItemStack &item)
1639 LuaItemStack *o = new LuaItemStack(item);
1640 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
1641 luaL_getmetatable(L, className);
1642 lua_setmetatable(L, -2);
1646 static LuaItemStack* checkobject(lua_State *L, int narg)
1648 luaL_checktype(L, narg, LUA_TUSERDATA);
1649 void *ud = luaL_checkudata(L, narg, className);
1650 if(!ud) luaL_typerror(L, narg, className);
1651 return *(LuaItemStack**)ud; // unbox pointer
1654 static void Register(lua_State *L)
1657 int methodtable = lua_gettop(L);
1658 luaL_newmetatable(L, className);
1659 int metatable = lua_gettop(L);
1661 lua_pushliteral(L, "__metatable");
1662 lua_pushvalue(L, methodtable);
1663 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
1665 lua_pushliteral(L, "__index");
1666 lua_pushvalue(L, methodtable);
1667 lua_settable(L, metatable);
1669 lua_pushliteral(L, "__gc");
1670 lua_pushcfunction(L, gc_object);
1671 lua_settable(L, metatable);
1673 lua_pop(L, 1); // drop metatable
1675 luaL_openlib(L, 0, methods, 0); // fill methodtable
1676 lua_pop(L, 1); // drop methodtable
1678 // Can be created from Lua (LuaItemStack(itemstack or itemstring or table or nil))
1679 lua_register(L, className, create_object);
1682 const char LuaItemStack::className[] = "ItemStack";
1683 const luaL_reg LuaItemStack::methods[] = {
1684 method(LuaItemStack, is_empty),
1685 method(LuaItemStack, get_name),
1686 method(LuaItemStack, get_count),
1687 method(LuaItemStack, get_wear),
1688 method(LuaItemStack, get_metadata),
1689 method(LuaItemStack, clear),
1690 method(LuaItemStack, replace),
1691 method(LuaItemStack, to_string),
1692 method(LuaItemStack, to_table),
1693 method(LuaItemStack, get_stack_max),
1694 method(LuaItemStack, get_free_space),
1695 method(LuaItemStack, is_known),
1696 method(LuaItemStack, get_definition),
1697 method(LuaItemStack, get_tool_capabilities),
1698 method(LuaItemStack, add_wear),
1699 method(LuaItemStack, add_item),
1700 method(LuaItemStack, item_fits),
1701 method(LuaItemStack, take_item),
1702 method(LuaItemStack, peek_item),
1706 static ItemStack read_item(lua_State *L, int index)
1709 index = lua_gettop(L) + 1 + index;
1711 if(lua_isnil(L, index))
1715 else if(lua_isuserdata(L, index))
1717 // Convert from LuaItemStack
1718 LuaItemStack *o = LuaItemStack::checkobject(L, index);
1719 return o->getItem();
1721 else if(lua_isstring(L, index))
1723 // Convert from itemstring
1724 std::string itemstring = lua_tostring(L, index);
1725 IItemDefManager *idef = get_server(L)->idef();
1729 item.deSerialize(itemstring, idef);
1732 catch(SerializationError &e)
1734 infostream<<"WARNING: unable to create item from itemstring"
1735 <<": "<<itemstring<<std::endl;
1739 else if(lua_istable(L, index))
1741 // Convert from table
1742 IItemDefManager *idef = get_server(L)->idef();
1743 std::string name = getstringfield_default(L, index, "name", "");
1744 int count = getintfield_default(L, index, "count", 1);
1745 int wear = getintfield_default(L, index, "wear", 0);
1746 std::string metadata = getstringfield_default(L, index, "metadata", "");
1747 return ItemStack(name, count, wear, metadata, idef);
1751 throw LuaError(L, "Expecting itemstack, itemstring, table or nil");
1755 static std::vector<ItemStack> read_items(lua_State *L, int index)
1758 index = lua_gettop(L) + 1 + index;
1760 std::vector<ItemStack> items;
1761 luaL_checktype(L, index, LUA_TTABLE);
1763 while(lua_next(L, index) != 0){
1764 // key at index -2 and value at index -1
1765 items.push_back(read_item(L, -1));
1766 // removes value, keeps key for next iteration
1772 // creates a table of ItemStacks
1773 static void push_items(lua_State *L, const std::vector<ItemStack> &items)
1775 // Get the table insert function
1776 lua_getglobal(L, "table");
1777 lua_getfield(L, -1, "insert");
1778 int table_insert = lua_gettop(L);
1779 // Create and fill table
1781 int table = lua_gettop(L);
1782 for(u32 i=0; i<items.size(); i++){
1783 ItemStack item = items[i];
1784 lua_pushvalue(L, table_insert);
1785 lua_pushvalue(L, table);
1786 LuaItemStack::create(L, item);
1787 if(lua_pcall(L, 2, 0, 0))
1788 script_error(L, "error: %s", lua_tostring(L, -1));
1790 lua_remove(L, -2); // Remove table
1791 lua_remove(L, -2); // Remove insert
1801 InventoryLocation m_loc;
1803 static const char className[];
1804 static const luaL_reg methods[];
1806 static InvRef *checkobject(lua_State *L, int narg)
1808 luaL_checktype(L, narg, LUA_TUSERDATA);
1809 void *ud = luaL_checkudata(L, narg, className);
1810 if(!ud) luaL_typerror(L, narg, className);
1811 return *(InvRef**)ud; // unbox pointer
1814 static Inventory* getinv(lua_State *L, InvRef *ref)
1816 return get_server(L)->getInventory(ref->m_loc);
1819 static InventoryList* getlist(lua_State *L, InvRef *ref,
1820 const char *listname)
1822 Inventory *inv = getinv(L, ref);
1825 return inv->getList(listname);
1828 static void reportInventoryChange(lua_State *L, InvRef *ref)
1830 // Inform other things that the inventory has changed
1831 get_server(L)->setInventoryModified(ref->m_loc);
1834 // Exported functions
1836 // garbage collector
1837 static int gc_object(lua_State *L) {
1838 InvRef *o = *(InvRef **)(lua_touserdata(L, 1));
1843 // is_empty(self, listname) -> true/false
1844 static int l_is_empty(lua_State *L)
1846 InvRef *ref = checkobject(L, 1);
1847 const char *listname = luaL_checkstring(L, 2);
1848 InventoryList *list = getlist(L, ref, listname);
1849 if(list && list->getUsedSlots() > 0){
1850 lua_pushboolean(L, false);
1852 lua_pushboolean(L, true);
1857 // get_size(self, listname)
1858 static int l_get_size(lua_State *L)
1860 InvRef *ref = checkobject(L, 1);
1861 const char *listname = luaL_checkstring(L, 2);
1862 InventoryList *list = getlist(L, ref, listname);
1864 lua_pushinteger(L, list->getSize());
1866 lua_pushinteger(L, 0);
1871 // get_width(self, listname)
1872 static int l_get_width(lua_State *L)
1874 InvRef *ref = checkobject(L, 1);
1875 const char *listname = luaL_checkstring(L, 2);
1876 InventoryList *list = getlist(L, ref, listname);
1878 lua_pushinteger(L, list->getWidth());
1880 lua_pushinteger(L, 0);
1885 // set_size(self, listname, size)
1886 static int l_set_size(lua_State *L)
1888 InvRef *ref = checkobject(L, 1);
1889 const char *listname = luaL_checkstring(L, 2);
1890 int newsize = luaL_checknumber(L, 3);
1891 Inventory *inv = getinv(L, ref);
1893 inv->deleteList(listname);
1894 reportInventoryChange(L, ref);
1897 InventoryList *list = inv->getList(listname);
1899 list->setSize(newsize);
1901 list = inv->addList(listname, newsize);
1903 reportInventoryChange(L, ref);
1907 // set_width(self, listname, size)
1908 static int l_set_width(lua_State *L)
1910 InvRef *ref = checkobject(L, 1);
1911 const char *listname = luaL_checkstring(L, 2);
1912 int newwidth = luaL_checknumber(L, 3);
1913 Inventory *inv = getinv(L, ref);
1914 InventoryList *list = inv->getList(listname);
1916 list->setWidth(newwidth);
1920 reportInventoryChange(L, ref);
1924 // get_stack(self, listname, i) -> itemstack
1925 static int l_get_stack(lua_State *L)
1927 InvRef *ref = checkobject(L, 1);
1928 const char *listname = luaL_checkstring(L, 2);
1929 int i = luaL_checknumber(L, 3) - 1;
1930 InventoryList *list = getlist(L, ref, listname);
1932 if(list != NULL && i >= 0 && i < (int) list->getSize())
1933 item = list->getItem(i);
1934 LuaItemStack::create(L, item);
1938 // set_stack(self, listname, i, stack) -> true/false
1939 static int l_set_stack(lua_State *L)
1941 InvRef *ref = checkobject(L, 1);
1942 const char *listname = luaL_checkstring(L, 2);
1943 int i = luaL_checknumber(L, 3) - 1;
1944 ItemStack newitem = read_item(L, 4);
1945 InventoryList *list = getlist(L, ref, listname);
1946 if(list != NULL && i >= 0 && i < (int) list->getSize()){
1947 list->changeItem(i, newitem);
1948 reportInventoryChange(L, ref);
1949 lua_pushboolean(L, true);
1951 lua_pushboolean(L, false);
1956 // get_list(self, listname) -> list or nil
1957 static int l_get_list(lua_State *L)
1959 InvRef *ref = checkobject(L, 1);
1960 const char *listname = luaL_checkstring(L, 2);
1961 Inventory *inv = getinv(L, ref);
1962 inventory_get_list_to_lua(inv, listname, L);
1966 // set_list(self, listname, list)
1967 static int l_set_list(lua_State *L)
1969 InvRef *ref = checkobject(L, 1);
1970 const char *listname = luaL_checkstring(L, 2);
1971 Inventory *inv = getinv(L, ref);
1972 InventoryList *list = inv->getList(listname);
1974 inventory_set_list_from_lua(inv, listname, L, 3,
1977 inventory_set_list_from_lua(inv, listname, L, 3);
1978 reportInventoryChange(L, ref);
1982 // add_item(self, listname, itemstack or itemstring or table or nil) -> itemstack
1983 // Returns the leftover stack
1984 static int l_add_item(lua_State *L)
1986 InvRef *ref = checkobject(L, 1);
1987 const char *listname = luaL_checkstring(L, 2);
1988 ItemStack item = read_item(L, 3);
1989 InventoryList *list = getlist(L, ref, listname);
1991 ItemStack leftover = list->addItem(item);
1992 if(leftover.count != item.count)
1993 reportInventoryChange(L, ref);
1994 LuaItemStack::create(L, leftover);
1996 LuaItemStack::create(L, item);
2001 // room_for_item(self, listname, itemstack or itemstring or table or nil) -> true/false
2002 // Returns true if the item completely fits into the list
2003 static int l_room_for_item(lua_State *L)
2005 InvRef *ref = checkobject(L, 1);
2006 const char *listname = luaL_checkstring(L, 2);
2007 ItemStack item = read_item(L, 3);
2008 InventoryList *list = getlist(L, ref, listname);
2010 lua_pushboolean(L, list->roomForItem(item));
2012 lua_pushboolean(L, false);
2017 // contains_item(self, listname, itemstack or itemstring or table or nil) -> true/false
2018 // Returns true if the list contains the given count of the given item name
2019 static int l_contains_item(lua_State *L)
2021 InvRef *ref = checkobject(L, 1);
2022 const char *listname = luaL_checkstring(L, 2);
2023 ItemStack item = read_item(L, 3);
2024 InventoryList *list = getlist(L, ref, listname);
2026 lua_pushboolean(L, list->containsItem(item));
2028 lua_pushboolean(L, false);
2033 // remove_item(self, listname, itemstack or itemstring or table or nil) -> itemstack
2034 // Returns the items that were actually removed
2035 static int l_remove_item(lua_State *L)
2037 InvRef *ref = checkobject(L, 1);
2038 const char *listname = luaL_checkstring(L, 2);
2039 ItemStack item = read_item(L, 3);
2040 InventoryList *list = getlist(L, ref, listname);
2042 ItemStack removed = list->removeItem(item);
2043 if(!removed.empty())
2044 reportInventoryChange(L, ref);
2045 LuaItemStack::create(L, removed);
2047 LuaItemStack::create(L, ItemStack());
2052 // get_location() -> location (like minetest.get_inventory(location))
2053 static int l_get_location(lua_State *L)
2055 InvRef *ref = checkobject(L, 1);
2056 const InventoryLocation &loc = ref->m_loc;
2058 case InventoryLocation::PLAYER:
2060 lua_pushstring(L, "player");
2061 lua_setfield(L, -2, "type");
2062 lua_pushstring(L, loc.name.c_str());
2063 lua_setfield(L, -2, "name");
2065 case InventoryLocation::NODEMETA:
2067 lua_pushstring(L, "nodemeta");
2068 lua_setfield(L, -2, "type");
2069 push_v3s16(L, loc.p);
2070 lua_setfield(L, -2, "name");
2072 case InventoryLocation::DETACHED:
2074 lua_pushstring(L, "detached");
2075 lua_setfield(L, -2, "type");
2076 lua_pushstring(L, loc.name.c_str());
2077 lua_setfield(L, -2, "name");
2079 case InventoryLocation::UNDEFINED:
2080 case InventoryLocation::CURRENT_PLAYER:
2084 lua_pushstring(L, "undefined");
2085 lua_setfield(L, -2, "type");
2090 InvRef(const InventoryLocation &loc):
2099 // Creates an InvRef and leaves it on top of stack
2100 // Not callable from Lua; all references are created on the C side.
2101 static void create(lua_State *L, const InventoryLocation &loc)
2103 InvRef *o = new InvRef(loc);
2104 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
2105 luaL_getmetatable(L, className);
2106 lua_setmetatable(L, -2);
2108 static void createPlayer(lua_State *L, Player *player)
2110 InventoryLocation loc;
2111 loc.setPlayer(player->getName());
2114 static void createNodeMeta(lua_State *L, v3s16 p)
2116 InventoryLocation loc;
2121 static void Register(lua_State *L)
2124 int methodtable = lua_gettop(L);
2125 luaL_newmetatable(L, className);
2126 int metatable = lua_gettop(L);
2128 lua_pushliteral(L, "__metatable");
2129 lua_pushvalue(L, methodtable);
2130 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
2132 lua_pushliteral(L, "__index");
2133 lua_pushvalue(L, methodtable);
2134 lua_settable(L, metatable);
2136 lua_pushliteral(L, "__gc");
2137 lua_pushcfunction(L, gc_object);
2138 lua_settable(L, metatable);
2140 lua_pop(L, 1); // drop metatable
2142 luaL_openlib(L, 0, methods, 0); // fill methodtable
2143 lua_pop(L, 1); // drop methodtable
2145 // Cannot be created from Lua
2146 //lua_register(L, className, create_object);
2149 const char InvRef::className[] = "InvRef";
2150 const luaL_reg InvRef::methods[] = {
2151 method(InvRef, is_empty),
2152 method(InvRef, get_size),
2153 method(InvRef, set_size),
2154 method(InvRef, get_width),
2155 method(InvRef, set_width),
2156 method(InvRef, get_stack),
2157 method(InvRef, set_stack),
2158 method(InvRef, get_list),
2159 method(InvRef, set_list),
2160 method(InvRef, add_item),
2161 method(InvRef, room_for_item),
2162 method(InvRef, contains_item),
2163 method(InvRef, remove_item),
2164 method(InvRef, get_location),
2176 ServerEnvironment *m_env;
2178 static const char className[];
2179 static const luaL_reg methods[];
2181 static NodeMetaRef *checkobject(lua_State *L, int narg)
2183 luaL_checktype(L, narg, LUA_TUSERDATA);
2184 void *ud = luaL_checkudata(L, narg, className);
2185 if(!ud) luaL_typerror(L, narg, className);
2186 return *(NodeMetaRef**)ud; // unbox pointer
2189 static NodeMetadata* getmeta(NodeMetaRef *ref, bool auto_create)
2191 NodeMetadata *meta = ref->m_env->getMap().getNodeMetadata(ref->m_p);
2192 if(meta == NULL && auto_create)
2194 meta = new NodeMetadata(ref->m_env->getGameDef());
2195 ref->m_env->getMap().setNodeMetadata(ref->m_p, meta);
2200 static void reportMetadataChange(NodeMetaRef *ref)
2202 // NOTE: This same code is in rollback_interface.cpp
2203 // Inform other things that the metadata has changed
2204 v3s16 blockpos = getNodeBlockPos(ref->m_p);
2206 event.type = MEET_BLOCK_NODE_METADATA_CHANGED;
2208 ref->m_env->getMap().dispatchEvent(&event);
2209 // Set the block to be saved
2210 MapBlock *block = ref->m_env->getMap().getBlockNoCreateNoEx(blockpos);
2212 block->raiseModified(MOD_STATE_WRITE_NEEDED,
2213 "NodeMetaRef::reportMetadataChange");
2216 // Exported functions
2218 // garbage collector
2219 static int gc_object(lua_State *L) {
2220 NodeMetaRef *o = *(NodeMetaRef **)(lua_touserdata(L, 1));
2225 // get_string(self, name)
2226 static int l_get_string(lua_State *L)
2228 NodeMetaRef *ref = checkobject(L, 1);
2229 std::string name = luaL_checkstring(L, 2);
2231 NodeMetadata *meta = getmeta(ref, false);
2233 lua_pushlstring(L, "", 0);
2236 std::string str = meta->getString(name);
2237 lua_pushlstring(L, str.c_str(), str.size());
2241 // set_string(self, name, var)
2242 static int l_set_string(lua_State *L)
2244 NodeMetaRef *ref = checkobject(L, 1);
2245 std::string name = luaL_checkstring(L, 2);
2247 const char *s = lua_tolstring(L, 3, &len);
2248 std::string str(s, len);
2250 NodeMetadata *meta = getmeta(ref, !str.empty());
2251 if(meta == NULL || str == meta->getString(name))
2253 meta->setString(name, str);
2254 reportMetadataChange(ref);
2258 // get_int(self, name)
2259 static int l_get_int(lua_State *L)
2261 NodeMetaRef *ref = checkobject(L, 1);
2262 std::string name = lua_tostring(L, 2);
2264 NodeMetadata *meta = getmeta(ref, false);
2266 lua_pushnumber(L, 0);
2269 std::string str = meta->getString(name);
2270 lua_pushnumber(L, stoi(str));
2274 // set_int(self, name, var)
2275 static int l_set_int(lua_State *L)
2277 NodeMetaRef *ref = checkobject(L, 1);
2278 std::string name = lua_tostring(L, 2);
2279 int a = lua_tointeger(L, 3);
2280 std::string str = itos(a);
2282 NodeMetadata *meta = getmeta(ref, true);
2283 if(meta == NULL || str == meta->getString(name))
2285 meta->setString(name, str);
2286 reportMetadataChange(ref);
2290 // get_float(self, name)
2291 static int l_get_float(lua_State *L)
2293 NodeMetaRef *ref = checkobject(L, 1);
2294 std::string name = lua_tostring(L, 2);
2296 NodeMetadata *meta = getmeta(ref, false);
2298 lua_pushnumber(L, 0);
2301 std::string str = meta->getString(name);
2302 lua_pushnumber(L, stof(str));
2306 // set_float(self, name, var)
2307 static int l_set_float(lua_State *L)
2309 NodeMetaRef *ref = checkobject(L, 1);
2310 std::string name = lua_tostring(L, 2);
2311 float a = lua_tonumber(L, 3);
2312 std::string str = ftos(a);
2314 NodeMetadata *meta = getmeta(ref, true);
2315 if(meta == NULL || str == meta->getString(name))
2317 meta->setString(name, str);
2318 reportMetadataChange(ref);
2322 // get_inventory(self)
2323 static int l_get_inventory(lua_State *L)
2325 NodeMetaRef *ref = checkobject(L, 1);
2326 getmeta(ref, true); // try to ensure the metadata exists
2327 InvRef::createNodeMeta(L, ref->m_p);
2332 static int l_to_table(lua_State *L)
2334 NodeMetaRef *ref = checkobject(L, 1);
2336 NodeMetadata *meta = getmeta(ref, true);
2345 std::map<std::string, std::string> fields = meta->getStrings();
2346 for(std::map<std::string, std::string>::const_iterator
2347 i = fields.begin(); i != fields.end(); i++){
2348 const std::string &name = i->first;
2349 const std::string &value = i->second;
2350 lua_pushlstring(L, name.c_str(), name.size());
2351 lua_pushlstring(L, value.c_str(), value.size());
2352 lua_settable(L, -3);
2355 lua_setfield(L, -2, "fields");
2358 Inventory *inv = meta->getInventory();
2360 std::vector<const InventoryList*> lists = inv->getLists();
2361 for(std::vector<const InventoryList*>::const_iterator
2362 i = lists.begin(); i != lists.end(); i++){
2363 inventory_get_list_to_lua(inv, (*i)->getName().c_str(), L);
2364 lua_setfield(L, -2, (*i)->getName().c_str());
2367 lua_setfield(L, -2, "inventory");
2371 // from_table(self, table)
2372 static int l_from_table(lua_State *L)
2374 NodeMetaRef *ref = checkobject(L, 1);
2377 if(lua_isnil(L, base)){
2379 ref->m_env->getMap().removeNodeMetadata(ref->m_p);
2380 lua_pushboolean(L, true);
2384 // Has metadata; clear old one first
2385 ref->m_env->getMap().removeNodeMetadata(ref->m_p);
2386 // Create new metadata
2387 NodeMetadata *meta = getmeta(ref, true);
2389 lua_getfield(L, base, "fields");
2390 int fieldstable = lua_gettop(L);
2392 while(lua_next(L, fieldstable) != 0){
2393 // key at index -2 and value at index -1
2394 std::string name = lua_tostring(L, -2);
2396 const char *cs = lua_tolstring(L, -1, &cl);
2397 std::string value(cs, cl);
2398 meta->setString(name, value);
2399 lua_pop(L, 1); // removes value, keeps key for next iteration
2402 Inventory *inv = meta->getInventory();
2403 lua_getfield(L, base, "inventory");
2404 int inventorytable = lua_gettop(L);
2406 while(lua_next(L, inventorytable) != 0){
2407 // key at index -2 and value at index -1
2408 std::string name = lua_tostring(L, -2);
2409 inventory_set_list_from_lua(inv, name.c_str(), L, -1);
2410 lua_pop(L, 1); // removes value, keeps key for next iteration
2412 reportMetadataChange(ref);
2413 lua_pushboolean(L, true);
2418 NodeMetaRef(v3s16 p, ServerEnvironment *env):
2428 // Creates an NodeMetaRef and leaves it on top of stack
2429 // Not callable from Lua; all references are created on the C side.
2430 static void create(lua_State *L, v3s16 p, ServerEnvironment *env)
2432 NodeMetaRef *o = new NodeMetaRef(p, env);
2433 //infostream<<"NodeMetaRef::create: o="<<o<<std::endl;
2434 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
2435 luaL_getmetatable(L, className);
2436 lua_setmetatable(L, -2);
2439 static void Register(lua_State *L)
2442 int methodtable = lua_gettop(L);
2443 luaL_newmetatable(L, className);
2444 int metatable = lua_gettop(L);
2446 lua_pushliteral(L, "__metatable");
2447 lua_pushvalue(L, methodtable);
2448 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
2450 lua_pushliteral(L, "__index");
2451 lua_pushvalue(L, methodtable);
2452 lua_settable(L, metatable);
2454 lua_pushliteral(L, "__gc");
2455 lua_pushcfunction(L, gc_object);
2456 lua_settable(L, metatable);
2458 lua_pop(L, 1); // drop metatable
2460 luaL_openlib(L, 0, methods, 0); // fill methodtable
2461 lua_pop(L, 1); // drop methodtable
2463 // Cannot be created from Lua
2464 //lua_register(L, className, create_object);
2467 const char NodeMetaRef::className[] = "NodeMetaRef";
2468 const luaL_reg NodeMetaRef::methods[] = {
2469 method(NodeMetaRef, get_string),
2470 method(NodeMetaRef, set_string),
2471 method(NodeMetaRef, get_int),
2472 method(NodeMetaRef, set_int),
2473 method(NodeMetaRef, get_float),
2474 method(NodeMetaRef, set_float),
2475 method(NodeMetaRef, get_inventory),
2476 method(NodeMetaRef, to_table),
2477 method(NodeMetaRef, from_table),
2488 ServerActiveObject *m_object;
2490 static const char className[];
2491 static const luaL_reg methods[];
2493 static ObjectRef *checkobject(lua_State *L, int narg)
2495 luaL_checktype(L, narg, LUA_TUSERDATA);
2496 void *ud = luaL_checkudata(L, narg, className);
2497 if(!ud) luaL_typerror(L, narg, className);
2498 return *(ObjectRef**)ud; // unbox pointer
2501 static ServerActiveObject* getobject(ObjectRef *ref)
2503 ServerActiveObject *co = ref->m_object;
2507 static LuaEntitySAO* getluaobject(ObjectRef *ref)
2509 ServerActiveObject *obj = getobject(ref);
2512 if(obj->getType() != ACTIVEOBJECT_TYPE_LUAENTITY)
2514 return (LuaEntitySAO*)obj;
2517 static PlayerSAO* getplayersao(ObjectRef *ref)
2519 ServerActiveObject *obj = getobject(ref);
2522 if(obj->getType() != ACTIVEOBJECT_TYPE_PLAYER)
2524 return (PlayerSAO*)obj;
2527 static Player* getplayer(ObjectRef *ref)
2529 PlayerSAO *playersao = getplayersao(ref);
2530 if(playersao == NULL)
2532 return playersao->getPlayer();
2535 // Exported functions
2537 // garbage collector
2538 static int gc_object(lua_State *L) {
2539 ObjectRef *o = *(ObjectRef **)(lua_touserdata(L, 1));
2540 //infostream<<"ObjectRef::gc_object: o="<<o<<std::endl;
2546 static int l_remove(lua_State *L)
2548 ObjectRef *ref = checkobject(L, 1);
2549 ServerActiveObject *co = getobject(ref);
2550 if(co == NULL) return 0;
2551 verbosestream<<"ObjectRef::l_remove(): id="<<co->getId()<<std::endl;
2552 co->m_removed = true;
2557 // returns: {x=num, y=num, z=num}
2558 static int l_getpos(lua_State *L)
2560 ObjectRef *ref = checkobject(L, 1);
2561 ServerActiveObject *co = getobject(ref);
2562 if(co == NULL) return 0;
2563 v3f pos = co->getBasePosition() / BS;
2565 lua_pushnumber(L, pos.X);
2566 lua_setfield(L, -2, "x");
2567 lua_pushnumber(L, pos.Y);
2568 lua_setfield(L, -2, "y");
2569 lua_pushnumber(L, pos.Z);
2570 lua_setfield(L, -2, "z");
2574 // setpos(self, pos)
2575 static int l_setpos(lua_State *L)
2577 ObjectRef *ref = checkobject(L, 1);
2578 //LuaEntitySAO *co = getluaobject(ref);
2579 ServerActiveObject *co = getobject(ref);
2580 if(co == NULL) return 0;
2582 v3f pos = checkFloatPos(L, 2);
2588 // moveto(self, pos, continuous=false)
2589 static int l_moveto(lua_State *L)
2591 ObjectRef *ref = checkobject(L, 1);
2592 //LuaEntitySAO *co = getluaobject(ref);
2593 ServerActiveObject *co = getobject(ref);
2594 if(co == NULL) return 0;
2596 v3f pos = checkFloatPos(L, 2);
2598 bool continuous = lua_toboolean(L, 3);
2600 co->moveTo(pos, continuous);
2604 // punch(self, puncher, time_from_last_punch, tool_capabilities, dir)
2605 static int l_punch(lua_State *L)
2607 ObjectRef *ref = checkobject(L, 1);
2608 ObjectRef *puncher_ref = checkobject(L, 2);
2609 ServerActiveObject *co = getobject(ref);
2610 ServerActiveObject *puncher = getobject(puncher_ref);
2611 if(co == NULL) return 0;
2612 if(puncher == NULL) return 0;
2614 if(lua_type(L, 5) != LUA_TTABLE)
2615 dir = co->getBasePosition() - puncher->getBasePosition();
2617 dir = read_v3f(L, 5);
2618 float time_from_last_punch = 1000000;
2619 if(lua_isnumber(L, 3))
2620 time_from_last_punch = lua_tonumber(L, 3);
2621 ToolCapabilities toolcap = read_tool_capabilities(L, 4);
2624 co->punch(dir, &toolcap, puncher, time_from_last_punch);
2628 // right_click(self, clicker); clicker = an another ObjectRef
2629 static int l_right_click(lua_State *L)
2631 ObjectRef *ref = checkobject(L, 1);
2632 ObjectRef *ref2 = checkobject(L, 2);
2633 ServerActiveObject *co = getobject(ref);
2634 ServerActiveObject *co2 = getobject(ref2);
2635 if(co == NULL) return 0;
2636 if(co2 == NULL) return 0;
2638 co->rightClick(co2);
2643 // hp = number of hitpoints (2 * number of hearts)
2645 static int l_set_hp(lua_State *L)
2647 ObjectRef *ref = checkobject(L, 1);
2648 luaL_checknumber(L, 2);
2649 ServerActiveObject *co = getobject(ref);
2650 if(co == NULL) return 0;
2651 int hp = lua_tonumber(L, 2);
2652 /*infostream<<"ObjectRef::l_set_hp(): id="<<co->getId()
2653 <<" hp="<<hp<<std::endl;*/
2661 // returns: number of hitpoints (2 * number of hearts)
2662 // 0 if not applicable to this type of object
2663 static int l_get_hp(lua_State *L)
2665 ObjectRef *ref = checkobject(L, 1);
2666 ServerActiveObject *co = getobject(ref);
2669 lua_pushnumber(L, 1);
2672 int hp = co->getHP();
2673 /*infostream<<"ObjectRef::l_get_hp(): id="<<co->getId()
2674 <<" hp="<<hp<<std::endl;*/
2676 lua_pushnumber(L, hp);
2680 // get_inventory(self)
2681 static int l_get_inventory(lua_State *L)
2683 ObjectRef *ref = checkobject(L, 1);
2684 ServerActiveObject *co = getobject(ref);
2685 if(co == NULL) return 0;
2687 InventoryLocation loc = co->getInventoryLocation();
2688 if(get_server(L)->getInventory(loc) != NULL)
2689 InvRef::create(L, loc);
2691 lua_pushnil(L); // An object may have no inventory (nil)
2695 // get_wield_list(self)
2696 static int l_get_wield_list(lua_State *L)
2698 ObjectRef *ref = checkobject(L, 1);
2699 ServerActiveObject *co = getobject(ref);
2700 if(co == NULL) return 0;
2702 lua_pushstring(L, co->getWieldList().c_str());
2706 // get_wield_index(self)
2707 static int l_get_wield_index(lua_State *L)
2709 ObjectRef *ref = checkobject(L, 1);
2710 ServerActiveObject *co = getobject(ref);
2711 if(co == NULL) return 0;
2713 lua_pushinteger(L, co->getWieldIndex() + 1);
2717 // get_wielded_item(self)
2718 static int l_get_wielded_item(lua_State *L)
2720 ObjectRef *ref = checkobject(L, 1);
2721 ServerActiveObject *co = getobject(ref);
2724 LuaItemStack::create(L, ItemStack());
2728 LuaItemStack::create(L, co->getWieldedItem());
2732 // set_wielded_item(self, itemstack or itemstring or table or nil)
2733 static int l_set_wielded_item(lua_State *L)
2735 ObjectRef *ref = checkobject(L, 1);
2736 ServerActiveObject *co = getobject(ref);
2737 if(co == NULL) return 0;
2739 ItemStack item = read_item(L, 2);
2740 bool success = co->setWieldedItem(item);
2741 lua_pushboolean(L, success);
2745 // set_armor_groups(self, groups)
2746 static int l_set_armor_groups(lua_State *L)
2748 ObjectRef *ref = checkobject(L, 1);
2749 ServerActiveObject *co = getobject(ref);
2750 if(co == NULL) return 0;
2752 ItemGroupList groups;
2753 read_groups(L, 2, groups);
2754 co->setArmorGroups(groups);
2758 // set_animation(self, frame_range, frame_speed, frame_blend)
2759 static int l_set_animation(lua_State *L)
2761 ObjectRef *ref = checkobject(L, 1);
2762 ServerActiveObject *co = getobject(ref);
2763 if(co == NULL) return 0;
2765 v2f frames = v2f(1, 1);
2766 if(!lua_isnil(L, 2))
2767 frames = read_v2f(L, 2);
2768 float frame_speed = 15;
2769 if(!lua_isnil(L, 3))
2770 frame_speed = lua_tonumber(L, 3);
2771 float frame_blend = 0;
2772 if(!lua_isnil(L, 4))
2773 frame_blend = lua_tonumber(L, 4);
2774 co->setAnimation(frames, frame_speed, frame_blend);
2778 // set_bone_position(self, std::string bone, v3f position, v3f rotation)
2779 static int l_set_bone_position(lua_State *L)
2781 ObjectRef *ref = checkobject(L, 1);
2782 ServerActiveObject *co = getobject(ref);
2783 if(co == NULL) return 0;
2785 std::string bone = "";
2786 if(!lua_isnil(L, 2))
2787 bone = lua_tostring(L, 2);
2788 v3f position = v3f(0, 0, 0);
2789 if(!lua_isnil(L, 3))
2790 position = read_v3f(L, 3);
2791 v3f rotation = v3f(0, 0, 0);
2792 if(!lua_isnil(L, 4))
2793 rotation = read_v3f(L, 4);
2794 co->setBonePosition(bone, position, rotation);
2798 // set_attach(self, parent, bone, position, rotation)
2799 static int l_set_attach(lua_State *L)
2801 ObjectRef *ref = checkobject(L, 1);
2802 ObjectRef *parent_ref = checkobject(L, 2);
2803 ServerActiveObject *co = getobject(ref);
2804 ServerActiveObject *parent = getobject(parent_ref);
2805 if(co == NULL) return 0;
2806 if(parent == NULL) return 0;
2808 std::string bone = "";
2809 if(!lua_isnil(L, 3))
2810 bone = lua_tostring(L, 3);
2811 v3f position = v3f(0, 0, 0);
2812 if(!lua_isnil(L, 4))
2813 position = read_v3f(L, 4);
2814 v3f rotation = v3f(0, 0, 0);
2815 if(!lua_isnil(L, 5))
2816 rotation = read_v3f(L, 5);
2817 co->setAttachment(parent->getId(), bone, position, rotation);
2822 static int l_set_detach(lua_State *L)
2824 ObjectRef *ref = checkobject(L, 1);
2825 ServerActiveObject *co = getobject(ref);
2826 if(co == NULL) return 0;
2828 co->setAttachment(0, "", v3f(0,0,0), v3f(0,0,0));
2832 // set_properties(self, properties)
2833 static int l_set_properties(lua_State *L)
2835 ObjectRef *ref = checkobject(L, 1);
2836 ServerActiveObject *co = getobject(ref);
2837 if(co == NULL) return 0;
2838 ObjectProperties *prop = co->accessObjectProperties();
2841 read_object_properties(L, 2, prop);
2842 co->notifyObjectPropertiesModified();
2846 /* LuaEntitySAO-only */
2848 // setvelocity(self, {x=num, y=num, z=num})
2849 static int l_setvelocity(lua_State *L)
2851 ObjectRef *ref = checkobject(L, 1);
2852 LuaEntitySAO *co = getluaobject(ref);
2853 if(co == NULL) return 0;
2854 v3f pos = checkFloatPos(L, 2);
2856 co->setVelocity(pos);
2860 // getvelocity(self)
2861 static int l_getvelocity(lua_State *L)
2863 ObjectRef *ref = checkobject(L, 1);
2864 LuaEntitySAO *co = getluaobject(ref);
2865 if(co == NULL) return 0;
2867 v3f v = co->getVelocity();
2872 // setacceleration(self, {x=num, y=num, z=num})
2873 static int l_setacceleration(lua_State *L)
2875 ObjectRef *ref = checkobject(L, 1);
2876 LuaEntitySAO *co = getluaobject(ref);
2877 if(co == NULL) return 0;
2879 v3f pos = checkFloatPos(L, 2);
2881 co->setAcceleration(pos);
2885 // getacceleration(self)
2886 static int l_getacceleration(lua_State *L)
2888 ObjectRef *ref = checkobject(L, 1);
2889 LuaEntitySAO *co = getluaobject(ref);
2890 if(co == NULL) return 0;
2892 v3f v = co->getAcceleration();
2897 // setyaw(self, radians)
2898 static int l_setyaw(lua_State *L)
2900 ObjectRef *ref = checkobject(L, 1);
2901 LuaEntitySAO *co = getluaobject(ref);
2902 if(co == NULL) return 0;
2903 float yaw = luaL_checknumber(L, 2) * core::RADTODEG;
2910 static int l_getyaw(lua_State *L)
2912 ObjectRef *ref = checkobject(L, 1);
2913 LuaEntitySAO *co = getluaobject(ref);
2914 if(co == NULL) return 0;
2916 float yaw = co->getYaw() * core::DEGTORAD;
2917 lua_pushnumber(L, yaw);
2921 // settexturemod(self, mod)
2922 static int l_settexturemod(lua_State *L)
2924 ObjectRef *ref = checkobject(L, 1);
2925 LuaEntitySAO *co = getluaobject(ref);
2926 if(co == NULL) return 0;
2928 std::string mod = luaL_checkstring(L, 2);
2929 co->setTextureMod(mod);
2933 // setsprite(self, p={x=0,y=0}, num_frames=1, framelength=0.2,
2934 // select_horiz_by_yawpitch=false)
2935 static int l_setsprite(lua_State *L)
2937 ObjectRef *ref = checkobject(L, 1);
2938 LuaEntitySAO *co = getluaobject(ref);
2939 if(co == NULL) return 0;
2942 if(!lua_isnil(L, 2))
2943 p = read_v2s16(L, 2);
2945 if(!lua_isnil(L, 3))
2946 num_frames = lua_tonumber(L, 3);
2947 float framelength = 0.2;
2948 if(!lua_isnil(L, 4))
2949 framelength = lua_tonumber(L, 4);
2950 bool select_horiz_by_yawpitch = false;
2951 if(!lua_isnil(L, 5))
2952 select_horiz_by_yawpitch = lua_toboolean(L, 5);
2953 co->setSprite(p, num_frames, framelength, select_horiz_by_yawpitch);
2958 // get_entity_name(self)
2959 static int l_get_entity_name(lua_State *L)
2961 ObjectRef *ref = checkobject(L, 1);
2962 LuaEntitySAO *co = getluaobject(ref);
2963 if(co == NULL) return 0;
2965 std::string name = co->getName();
2966 lua_pushstring(L, name.c_str());
2970 // get_luaentity(self)
2971 static int l_get_luaentity(lua_State *L)
2973 ObjectRef *ref = checkobject(L, 1);
2974 LuaEntitySAO *co = getluaobject(ref);
2975 if(co == NULL) return 0;
2977 luaentity_get(L, co->getId());
2984 static int l_is_player(lua_State *L)
2986 ObjectRef *ref = checkobject(L, 1);
2987 Player *player = getplayer(ref);
2988 lua_pushboolean(L, (player != NULL));
2992 // get_player_name(self)
2993 static int l_get_player_name(lua_State *L)
2995 ObjectRef *ref = checkobject(L, 1);
2996 Player *player = getplayer(ref);
2998 lua_pushlstring(L, "", 0);
3002 lua_pushstring(L, player->getName());
3006 // get_look_dir(self)
3007 static int l_get_look_dir(lua_State *L)
3009 ObjectRef *ref = checkobject(L, 1);
3010 Player *player = getplayer(ref);
3011 if(player == NULL) return 0;
3013 float pitch = player->getRadPitch();
3014 float yaw = player->getRadYaw();
3015 v3f v(cos(pitch)*cos(yaw), sin(pitch), cos(pitch)*sin(yaw));
3020 // get_look_pitch(self)
3021 static int l_get_look_pitch(lua_State *L)
3023 ObjectRef *ref = checkobject(L, 1);
3024 Player *player = getplayer(ref);
3025 if(player == NULL) return 0;
3027 lua_pushnumber(L, player->getRadPitch());
3031 // get_look_yaw(self)
3032 static int l_get_look_yaw(lua_State *L)
3034 ObjectRef *ref = checkobject(L, 1);
3035 Player *player = getplayer(ref);
3036 if(player == NULL) return 0;
3038 lua_pushnumber(L, player->getRadYaw());
3042 // set_inventory_formspec(self, formspec)
3043 static int l_set_inventory_formspec(lua_State *L)
3045 ObjectRef *ref = checkobject(L, 1);
3046 Player *player = getplayer(ref);
3047 if(player == NULL) return 0;
3048 std::string formspec = luaL_checkstring(L, 2);
3050 player->inventory_formspec = formspec;
3051 get_server(L)->reportInventoryFormspecModified(player->getName());
3052 lua_pushboolean(L, true);
3056 // get_inventory_formspec(self) -> formspec
3057 static int l_get_inventory_formspec(lua_State *L)
3059 ObjectRef *ref = checkobject(L, 1);
3060 Player *player = getplayer(ref);
3061 if(player == NULL) return 0;
3063 std::string formspec = player->inventory_formspec;
3064 lua_pushlstring(L, formspec.c_str(), formspec.size());
3068 // get_player_control(self)
3069 static int l_get_player_control(lua_State *L)
3071 ObjectRef *ref = checkobject(L, 1);
3072 Player *player = getplayer(ref);
3074 lua_pushlstring(L, "", 0);
3078 PlayerControl control = player->getPlayerControl();
3080 lua_pushboolean(L, control.up);
3081 lua_setfield(L, -2, "up");
3082 lua_pushboolean(L, control.down);
3083 lua_setfield(L, -2, "down");
3084 lua_pushboolean(L, control.left);
3085 lua_setfield(L, -2, "left");
3086 lua_pushboolean(L, control.right);
3087 lua_setfield(L, -2, "right");
3088 lua_pushboolean(L, control.jump);
3089 lua_setfield(L, -2, "jump");
3090 lua_pushboolean(L, control.aux1);
3091 lua_setfield(L, -2, "aux1");
3092 lua_pushboolean(L, control.sneak);
3093 lua_setfield(L, -2, "sneak");
3094 lua_pushboolean(L, control.LMB);
3095 lua_setfield(L, -2, "LMB");
3096 lua_pushboolean(L, control.RMB);
3097 lua_setfield(L, -2, "RMB");
3101 // get_player_control_bits(self)
3102 static int l_get_player_control_bits(lua_State *L)
3104 ObjectRef *ref = checkobject(L, 1);
3105 Player *player = getplayer(ref);
3107 lua_pushlstring(L, "", 0);
3111 lua_pushnumber(L, player->keyPressed);
3116 ObjectRef(ServerActiveObject *object):
3119 //infostream<<"ObjectRef created for id="<<m_object->getId()<<std::endl;
3125 infostream<<"ObjectRef destructing for id="
3126 <<m_object->getId()<<std::endl;
3128 infostream<<"ObjectRef destructing for id=unknown"<<std::endl;*/
3131 // Creates an ObjectRef and leaves it on top of stack
3132 // Not callable from Lua; all references are created on the C side.
3133 static void create(lua_State *L, ServerActiveObject *object)
3135 ObjectRef *o = new ObjectRef(object);
3136 //infostream<<"ObjectRef::create: o="<<o<<std::endl;
3137 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
3138 luaL_getmetatable(L, className);
3139 lua_setmetatable(L, -2);
3142 static void set_null(lua_State *L)
3144 ObjectRef *o = checkobject(L, -1);
3148 static void Register(lua_State *L)
3151 int methodtable = lua_gettop(L);
3152 luaL_newmetatable(L, className);
3153 int metatable = lua_gettop(L);
3155 lua_pushliteral(L, "__metatable");
3156 lua_pushvalue(L, methodtable);
3157 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
3159 lua_pushliteral(L, "__index");
3160 lua_pushvalue(L, methodtable);
3161 lua_settable(L, metatable);
3163 lua_pushliteral(L, "__gc");
3164 lua_pushcfunction(L, gc_object);
3165 lua_settable(L, metatable);
3167 lua_pop(L, 1); // drop metatable
3169 luaL_openlib(L, 0, methods, 0); // fill methodtable
3170 lua_pop(L, 1); // drop methodtable
3172 // Cannot be created from Lua
3173 //lua_register(L, className, create_object);
3176 const char ObjectRef::className[] = "ObjectRef";
3177 const luaL_reg ObjectRef::methods[] = {
3178 // ServerActiveObject
3179 method(ObjectRef, remove),
3180 method(ObjectRef, getpos),
3181 method(ObjectRef, setpos),
3182 method(ObjectRef, moveto),
3183 method(ObjectRef, punch),
3184 method(ObjectRef, right_click),
3185 method(ObjectRef, set_hp),
3186 method(ObjectRef, get_hp),
3187 method(ObjectRef, get_inventory),
3188 method(ObjectRef, get_wield_list),
3189 method(ObjectRef, get_wield_index),
3190 method(ObjectRef, get_wielded_item),
3191 method(ObjectRef, set_wielded_item),
3192 method(ObjectRef, set_armor_groups),
3193 method(ObjectRef, set_animation),
3194 method(ObjectRef, set_bone_position),
3195 method(ObjectRef, set_attach),
3196 method(ObjectRef, set_detach),
3197 method(ObjectRef, set_properties),
3198 // LuaEntitySAO-only
3199 method(ObjectRef, setvelocity),
3200 method(ObjectRef, getvelocity),
3201 method(ObjectRef, setacceleration),
3202 method(ObjectRef, getacceleration),
3203 method(ObjectRef, setyaw),
3204 method(ObjectRef, getyaw),
3205 method(ObjectRef, settexturemod),
3206 method(ObjectRef, setsprite),
3207 method(ObjectRef, get_entity_name),
3208 method(ObjectRef, get_luaentity),
3210 method(ObjectRef, is_player),
3211 method(ObjectRef, get_player_name),
3212 method(ObjectRef, get_look_dir),
3213 method(ObjectRef, get_look_pitch),
3214 method(ObjectRef, get_look_yaw),
3215 method(ObjectRef, set_inventory_formspec),
3216 method(ObjectRef, get_inventory_formspec),
3217 method(ObjectRef, get_player_control),
3218 method(ObjectRef, get_player_control_bits),
3222 // Creates a new anonymous reference if cobj=NULL or id=0
3223 static void objectref_get_or_create(lua_State *L,
3224 ServerActiveObject *cobj)
3226 if(cobj == NULL || cobj->getId() == 0){
3227 ObjectRef::create(L, cobj);
3229 objectref_get(L, cobj->getId());
3238 class LuaPerlinNoise
3245 static const char className[];
3246 static const luaL_reg methods[];
3248 // Exported functions
3250 // garbage collector
3251 static int gc_object(lua_State *L)
3253 LuaPerlinNoise *o = *(LuaPerlinNoise **)(lua_touserdata(L, 1));
3258 static int l_get2d(lua_State *L)
3260 LuaPerlinNoise *o = checkobject(L, 1);
3261 v2f pos2d = read_v2f(L,2);
3262 lua_Number val = noise2d_perlin(pos2d.X/o->scale, pos2d.Y/o->scale, o->seed, o->octaves, o->persistence);
3263 lua_pushnumber(L, val);
3266 static int l_get3d(lua_State *L)
3268 LuaPerlinNoise *o = checkobject(L, 1);
3269 v3f pos3d = read_v3f(L,2);
3270 lua_Number val = noise3d_perlin(pos3d.X/o->scale, pos3d.Y/o->scale, pos3d.Z/o->scale, o->seed, o->octaves, o->persistence);
3271 lua_pushnumber(L, val);
3276 LuaPerlinNoise(int a_seed, int a_octaves, double a_persistence,
3280 persistence(a_persistence),
3289 // LuaPerlinNoise(seed, octaves, persistence, scale)
3290 // Creates an LuaPerlinNoise and leaves it on top of stack
3291 static int create_object(lua_State *L)
3293 int seed = luaL_checkint(L, 1);
3294 int octaves = luaL_checkint(L, 2);
3295 double persistence = luaL_checknumber(L, 3);
3296 double scale = luaL_checknumber(L, 4);
3297 LuaPerlinNoise *o = new LuaPerlinNoise(seed, octaves, persistence, scale);
3298 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
3299 luaL_getmetatable(L, className);
3300 lua_setmetatable(L, -2);
3304 static LuaPerlinNoise* checkobject(lua_State *L, int narg)
3306 luaL_checktype(L, narg, LUA_TUSERDATA);
3307 void *ud = luaL_checkudata(L, narg, className);
3308 if(!ud) luaL_typerror(L, narg, className);
3309 return *(LuaPerlinNoise**)ud; // unbox pointer
3312 static void Register(lua_State *L)
3315 int methodtable = lua_gettop(L);
3316 luaL_newmetatable(L, className);
3317 int metatable = lua_gettop(L);
3319 lua_pushliteral(L, "__metatable");
3320 lua_pushvalue(L, methodtable);
3321 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
3323 lua_pushliteral(L, "__index");
3324 lua_pushvalue(L, methodtable);
3325 lua_settable(L, metatable);
3327 lua_pushliteral(L, "__gc");
3328 lua_pushcfunction(L, gc_object);
3329 lua_settable(L, metatable);
3331 lua_pop(L, 1); // drop metatable
3333 luaL_openlib(L, 0, methods, 0); // fill methodtable
3334 lua_pop(L, 1); // drop methodtable
3336 // Can be created from Lua (PerlinNoise(seed, octaves, persistence)
3337 lua_register(L, className, create_object);
3340 const char LuaPerlinNoise::className[] = "PerlinNoise";
3341 const luaL_reg LuaPerlinNoise::methods[] = {
3342 method(LuaPerlinNoise, get2d),
3343 method(LuaPerlinNoise, get3d),
3355 ServerEnvironment *m_env;
3357 static const char className[];
3358 static const luaL_reg methods[];
3360 static int gc_object(lua_State *L) {
3361 NodeTimerRef *o = *(NodeTimerRef **)(lua_touserdata(L, 1));
3366 static NodeTimerRef *checkobject(lua_State *L, int narg)
3368 luaL_checktype(L, narg, LUA_TUSERDATA);
3369 void *ud = luaL_checkudata(L, narg, className);
3370 if(!ud) luaL_typerror(L, narg, className);
3371 return *(NodeTimerRef**)ud; // unbox pointer
3374 static int l_set(lua_State *L)
3376 NodeTimerRef *o = checkobject(L, 1);
3377 ServerEnvironment *env = o->m_env;
3378 if(env == NULL) return 0;
3379 f32 t = luaL_checknumber(L,2);
3380 f32 e = luaL_checknumber(L,3);
3381 env->getMap().setNodeTimer(o->m_p,NodeTimer(t,e));
3385 static int l_start(lua_State *L)
3387 NodeTimerRef *o = checkobject(L, 1);
3388 ServerEnvironment *env = o->m_env;
3389 if(env == NULL) return 0;
3390 f32 t = luaL_checknumber(L,2);
3391 env->getMap().setNodeTimer(o->m_p,NodeTimer(t,0));
3395 static int l_stop(lua_State *L)
3397 NodeTimerRef *o = checkobject(L, 1);
3398 ServerEnvironment *env = o->m_env;
3399 if(env == NULL) return 0;
3400 env->getMap().removeNodeTimer(o->m_p);
3404 static int l_is_started(lua_State *L)
3406 NodeTimerRef *o = checkobject(L, 1);
3407 ServerEnvironment *env = o->m_env;
3408 if(env == NULL) return 0;
3410 NodeTimer t = env->getMap().getNodeTimer(o->m_p);
3411 lua_pushboolean(L,(t.timeout != 0));
3415 static int l_get_timeout(lua_State *L)
3417 NodeTimerRef *o = checkobject(L, 1);
3418 ServerEnvironment *env = o->m_env;
3419 if(env == NULL) return 0;
3421 NodeTimer t = env->getMap().getNodeTimer(o->m_p);
3422 lua_pushnumber(L,t.timeout);
3426 static int l_get_elapsed(lua_State *L)
3428 NodeTimerRef *o = checkobject(L, 1);
3429 ServerEnvironment *env = o->m_env;
3430 if(env == NULL) return 0;
3432 NodeTimer t = env->getMap().getNodeTimer(o->m_p);
3433 lua_pushnumber(L,t.elapsed);
3438 NodeTimerRef(v3s16 p, ServerEnvironment *env):
3448 // Creates an NodeTimerRef and leaves it on top of stack
3449 // Not callable from Lua; all references are created on the C side.
3450 static void create(lua_State *L, v3s16 p, ServerEnvironment *env)
3452 NodeTimerRef *o = new NodeTimerRef(p, env);
3453 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
3454 luaL_getmetatable(L, className);
3455 lua_setmetatable(L, -2);
3458 static void set_null(lua_State *L)
3460 NodeTimerRef *o = checkobject(L, -1);
3464 static void Register(lua_State *L)
3467 int methodtable = lua_gettop(L);
3468 luaL_newmetatable(L, className);
3469 int metatable = lua_gettop(L);
3471 lua_pushliteral(L, "__metatable");
3472 lua_pushvalue(L, methodtable);
3473 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
3475 lua_pushliteral(L, "__index");
3476 lua_pushvalue(L, methodtable);
3477 lua_settable(L, metatable);
3479 lua_pushliteral(L, "__gc");
3480 lua_pushcfunction(L, gc_object);
3481 lua_settable(L, metatable);
3483 lua_pop(L, 1); // drop metatable
3485 luaL_openlib(L, 0, methods, 0); // fill methodtable
3486 lua_pop(L, 1); // drop methodtable
3488 // Cannot be created from Lua
3489 //lua_register(L, className, create_object);
3492 const char NodeTimerRef::className[] = "NodeTimerRef";
3493 const luaL_reg NodeTimerRef::methods[] = {
3494 method(NodeTimerRef, start),
3495 method(NodeTimerRef, set),
3496 method(NodeTimerRef, stop),
3497 method(NodeTimerRef, is_started),
3498 method(NodeTimerRef, get_timeout),
3499 method(NodeTimerRef, get_elapsed),
3510 ServerEnvironment *m_env;
3512 static const char className[];
3513 static const luaL_reg methods[];
3515 static int gc_object(lua_State *L) {
3516 EnvRef *o = *(EnvRef **)(lua_touserdata(L, 1));
3521 static EnvRef *checkobject(lua_State *L, int narg)
3523 luaL_checktype(L, narg, LUA_TUSERDATA);
3524 void *ud = luaL_checkudata(L, narg, className);
3525 if(!ud) luaL_typerror(L, narg, className);
3526 return *(EnvRef**)ud; // unbox pointer
3529 // Exported functions
3531 // EnvRef:set_node(pos, node)
3532 // pos = {x=num, y=num, z=num}
3533 static int l_set_node(lua_State *L)
3535 EnvRef *o = checkobject(L, 1);
3536 ServerEnvironment *env = o->m_env;
3537 if(env == NULL) return 0;
3538 INodeDefManager *ndef = env->getGameDef()->ndef();
3540 v3s16 pos = read_v3s16(L, 2);
3541 MapNode n = readnode(L, 3, ndef);
3543 MapNode n_old = env->getMap().getNodeNoEx(pos);
3545 if(ndef->get(n_old).has_on_destruct)
3546 scriptapi_node_on_destruct(L, pos, n_old);
3548 bool succeeded = env->getMap().addNodeWithEvent(pos, n);
3550 // Call post-destructor
3551 if(ndef->get(n_old).has_after_destruct)
3552 scriptapi_node_after_destruct(L, pos, n_old);
3554 if(ndef->get(n).has_on_construct)
3555 scriptapi_node_on_construct(L, pos, n);
3557 lua_pushboolean(L, succeeded);
3561 static int l_add_node(lua_State *L)
3563 return l_set_node(L);
3566 // EnvRef:remove_node(pos)
3567 // pos = {x=num, y=num, z=num}
3568 static int l_remove_node(lua_State *L)
3570 EnvRef *o = checkobject(L, 1);
3571 ServerEnvironment *env = o->m_env;
3572 if(env == NULL) return 0;
3573 INodeDefManager *ndef = env->getGameDef()->ndef();
3575 v3s16 pos = read_v3s16(L, 2);
3577 MapNode n_old = env->getMap().getNodeNoEx(pos);
3579 if(ndef->get(n_old).has_on_destruct)
3580 scriptapi_node_on_destruct(L, pos, n_old);
3582 // This is slightly optimized compared to addNodeWithEvent(air)
3583 bool succeeded = env->getMap().removeNodeWithEvent(pos);
3585 // Call post-destructor
3586 if(ndef->get(n_old).has_after_destruct)
3587 scriptapi_node_after_destruct(L, pos, n_old);
3589 lua_pushboolean(L, succeeded);
3590 // Air doesn't require constructor
3594 // EnvRef:get_node(pos)
3595 // pos = {x=num, y=num, z=num}
3596 static int l_get_node(lua_State *L)
3598 EnvRef *o = checkobject(L, 1);
3599 ServerEnvironment *env = o->m_env;
3600 if(env == NULL) return 0;
3602 v3s16 pos = read_v3s16(L, 2);
3604 MapNode n = env->getMap().getNodeNoEx(pos);
3606 pushnode(L, n, env->getGameDef()->ndef());
3610 // EnvRef:get_node_or_nil(pos)
3611 // pos = {x=num, y=num, z=num}
3612 static int l_get_node_or_nil(lua_State *L)
3614 EnvRef *o = checkobject(L, 1);
3615 ServerEnvironment *env = o->m_env;
3616 if(env == NULL) return 0;
3618 v3s16 pos = read_v3s16(L, 2);
3621 MapNode n = env->getMap().getNode(pos);
3623 pushnode(L, n, env->getGameDef()->ndef());
3625 } catch(InvalidPositionException &e)
3632 // EnvRef:get_node_light(pos, timeofday)
3633 // pos = {x=num, y=num, z=num}
3634 // timeofday: nil = current time, 0 = night, 0.5 = day
3635 static int l_get_node_light(lua_State *L)
3637 EnvRef *o = checkobject(L, 1);
3638 ServerEnvironment *env = o->m_env;
3639 if(env == NULL) return 0;
3641 v3s16 pos = read_v3s16(L, 2);
3642 u32 time_of_day = env->getTimeOfDay();
3643 if(lua_isnumber(L, 3))
3644 time_of_day = 24000.0 * lua_tonumber(L, 3);
3645 time_of_day %= 24000;
3646 u32 dnr = time_to_daynight_ratio(time_of_day, true);
3647 MapNode n = env->getMap().getNodeNoEx(pos);
3649 MapNode n = env->getMap().getNode(pos);
3650 INodeDefManager *ndef = env->getGameDef()->ndef();
3651 lua_pushinteger(L, n.getLightBlend(dnr, ndef));
3653 } catch(InvalidPositionException &e)
3660 // EnvRef:place_node(pos, node)
3661 // pos = {x=num, y=num, z=num}
3662 static int l_place_node(lua_State *L)
3664 EnvRef *o = checkobject(L, 1);
3665 ServerEnvironment *env = o->m_env;
3666 if(env == NULL) return 0;
3667 v3s16 pos = read_v3s16(L, 2);
3668 MapNode n = readnode(L, 3, env->getGameDef()->ndef());
3670 // Don't attempt to load non-loaded area as of now
3671 MapNode n_old = env->getMap().getNodeNoEx(pos);
3672 if(n_old.getContent() == CONTENT_IGNORE){
3673 lua_pushboolean(L, false);
3676 // Create item to place
3677 INodeDefManager *ndef = get_server(L)->ndef();
3678 IItemDefManager *idef = get_server(L)->idef();
3679 ItemStack item(ndef->get(n).name, 1, 0, "", idef);
3680 // Make pointed position
3681 PointedThing pointed;
3682 pointed.type = POINTEDTHING_NODE;
3683 pointed.node_abovesurface = pos;
3684 pointed.node_undersurface = pos + v3s16(0,-1,0);
3685 // Place it with a NULL placer (appears in Lua as a non-functional
3687 bool success = scriptapi_item_on_place(L, item, NULL, pointed);
3688 lua_pushboolean(L, success);
3692 // EnvRef:dig_node(pos)
3693 // pos = {x=num, y=num, z=num}
3694 static int l_dig_node(lua_State *L)
3696 EnvRef *o = checkobject(L, 1);
3697 ServerEnvironment *env = o->m_env;
3698 if(env == NULL) return 0;
3699 v3s16 pos = read_v3s16(L, 2);
3701 // Don't attempt to load non-loaded area as of now
3702 MapNode n = env->getMap().getNodeNoEx(pos);
3703 if(n.getContent() == CONTENT_IGNORE){
3704 lua_pushboolean(L, false);
3707 // Dig it out with a NULL digger (appears in Lua as a
3708 // non-functional ObjectRef)
3709 bool success = scriptapi_node_on_dig(L, pos, n, NULL);
3710 lua_pushboolean(L, success);
3714 // EnvRef:punch_node(pos)
3715 // pos = {x=num, y=num, z=num}
3716 static int l_punch_node(lua_State *L)
3718 EnvRef *o = checkobject(L, 1);
3719 ServerEnvironment *env = o->m_env;
3720 if(env == NULL) return 0;
3721 v3s16 pos = read_v3s16(L, 2);
3723 // Don't attempt to load non-loaded area as of now
3724 MapNode n = env->getMap().getNodeNoEx(pos);
3725 if(n.getContent() == CONTENT_IGNORE){
3726 lua_pushboolean(L, false);
3729 // Punch it with a NULL puncher (appears in Lua as a non-functional
3731 bool success = scriptapi_node_on_punch(L, pos, n, NULL);
3732 lua_pushboolean(L, success);
3736 // EnvRef:get_meta(pos)
3737 static int l_get_meta(lua_State *L)
3739 //infostream<<"EnvRef::l_get_meta()"<<std::endl;
3740 EnvRef *o = checkobject(L, 1);
3741 ServerEnvironment *env = o->m_env;
3742 if(env == NULL) return 0;
3744 v3s16 p = read_v3s16(L, 2);
3745 NodeMetaRef::create(L, p, env);
3749 // EnvRef:get_node_timer(pos)
3750 static int l_get_node_timer(lua_State *L)
3752 EnvRef *o = checkobject(L, 1);
3753 ServerEnvironment *env = o->m_env;
3754 if(env == NULL) return 0;
3756 v3s16 p = read_v3s16(L, 2);
3757 NodeTimerRef::create(L, p, env);
3761 // EnvRef:add_entity(pos, entityname) -> ObjectRef or nil
3762 // pos = {x=num, y=num, z=num}
3763 static int l_add_entity(lua_State *L)
3765 //infostream<<"EnvRef::l_add_entity()"<<std::endl;
3766 EnvRef *o = checkobject(L, 1);
3767 ServerEnvironment *env = o->m_env;
3768 if(env == NULL) return 0;
3770 v3f pos = checkFloatPos(L, 2);
3772 const char *name = luaL_checkstring(L, 3);
3774 ServerActiveObject *obj = new LuaEntitySAO(env, pos, name, "");
3775 int objectid = env->addActiveObject(obj);
3776 // If failed to add, return nothing (reads as nil)
3780 objectref_get_or_create(L, obj);
3784 // EnvRef:add_item(pos, itemstack or itemstring or table) -> ObjectRef or nil
3785 // pos = {x=num, y=num, z=num}
3786 static int l_add_item(lua_State *L)
3788 //infostream<<"EnvRef::l_add_item()"<<std::endl;
3789 EnvRef *o = checkobject(L, 1);
3790 ServerEnvironment *env = o->m_env;
3791 if(env == NULL) return 0;
3793 v3f pos = checkFloatPos(L, 2);
3795 ItemStack item = read_item(L, 3);
3796 if(item.empty() || !item.isKnown(get_server(L)->idef()))
3798 // Use minetest.spawn_item to spawn a __builtin:item
3799 lua_getglobal(L, "minetest");
3800 lua_getfield(L, -1, "spawn_item");
3801 if(lua_isnil(L, -1))
3803 lua_pushvalue(L, 2);
3804 lua_pushstring(L, item.getItemString().c_str());
3805 if(lua_pcall(L, 2, 1, 0))
3806 script_error(L, "error: %s", lua_tostring(L, -1));
3808 /*lua_pushvalue(L, 1);
3809 lua_pushstring(L, "__builtin:item");
3810 lua_pushstring(L, item.getItemString().c_str());
3811 return l_add_entity(L);*/
3813 ServerActiveObject *obj = createItemSAO(env, pos, item.getItemString());
3814 int objectid = env->addActiveObject(obj);
3815 // If failed to add, return nothing (reads as nil)
3819 objectref_get_or_create(L, obj);
3823 // EnvRef:add_rat(pos)
3824 // pos = {x=num, y=num, z=num}
3825 static int l_add_rat(lua_State *L)
3827 infostream<<"EnvRef::l_add_rat(): C++ mobs have been removed."
3828 <<" Doing nothing."<<std::endl;
3832 // EnvRef:add_firefly(pos)
3833 // pos = {x=num, y=num, z=num}
3834 static int l_add_firefly(lua_State *L)
3836 infostream<<"EnvRef::l_add_firefly(): C++ mobs have been removed."
3837 <<" Doing nothing."<<std::endl;
3841 // EnvRef:get_player_by_name(name)
3842 static int l_get_player_by_name(lua_State *L)
3844 EnvRef *o = checkobject(L, 1);
3845 ServerEnvironment *env = o->m_env;
3846 if(env == NULL) return 0;
3848 const char *name = luaL_checkstring(L, 2);
3849 Player *player = env->getPlayer(name);
3854 PlayerSAO *sao = player->getPlayerSAO();
3859 // Put player on stack
3860 objectref_get_or_create(L, sao);
3864 // EnvRef:get_objects_inside_radius(pos, radius)
3865 static int l_get_objects_inside_radius(lua_State *L)
3867 // Get the table insert function
3868 lua_getglobal(L, "table");
3869 lua_getfield(L, -1, "insert");
3870 int table_insert = lua_gettop(L);
3872 EnvRef *o = checkobject(L, 1);
3873 ServerEnvironment *env = o->m_env;
3874 if(env == NULL) return 0;
3876 v3f pos = checkFloatPos(L, 2);
3877 float radius = luaL_checknumber(L, 3) * BS;
3878 std::set<u16> ids = env->getObjectsInsideRadius(pos, radius);
3880 int table = lua_gettop(L);
3881 for(std::set<u16>::const_iterator
3882 i = ids.begin(); i != ids.end(); i++){
3883 ServerActiveObject *obj = env->getActiveObject(*i);
3884 // Insert object reference into table
3885 lua_pushvalue(L, table_insert);
3886 lua_pushvalue(L, table);
3887 objectref_get_or_create(L, obj);
3888 if(lua_pcall(L, 2, 0, 0))
3889 script_error(L, "error: %s", lua_tostring(L, -1));
3894 // EnvRef:set_timeofday(val)
3896 static int l_set_timeofday(lua_State *L)
3898 EnvRef *o = checkobject(L, 1);
3899 ServerEnvironment *env = o->m_env;
3900 if(env == NULL) return 0;
3902 float timeofday_f = luaL_checknumber(L, 2);
3903 assert(timeofday_f >= 0.0 && timeofday_f <= 1.0);
3904 int timeofday_mh = (int)(timeofday_f * 24000.0);
3905 // This should be set directly in the environment but currently
3906 // such changes aren't immediately sent to the clients, so call
3907 // the server instead.
3908 //env->setTimeOfDay(timeofday_mh);
3909 get_server(L)->setTimeOfDay(timeofday_mh);
3913 // EnvRef:get_timeofday() -> 0...1
3914 static int l_get_timeofday(lua_State *L)
3916 EnvRef *o = checkobject(L, 1);
3917 ServerEnvironment *env = o->m_env;
3918 if(env == NULL) return 0;
3920 int timeofday_mh = env->getTimeOfDay();
3921 float timeofday_f = (float)timeofday_mh / 24000.0;
3922 lua_pushnumber(L, timeofday_f);
3927 // EnvRef:find_node_near(pos, radius, nodenames) -> pos or nil
3928 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
3929 static int l_find_node_near(lua_State *L)
3931 EnvRef *o = checkobject(L, 1);
3932 ServerEnvironment *env = o->m_env;
3933 if(env == NULL) return 0;
3934 INodeDefManager *ndef = get_server(L)->ndef();
3935 v3s16 pos = read_v3s16(L, 2);
3936 int radius = luaL_checkinteger(L, 3);
3937 std::set<content_t> filter;
3938 if(lua_istable(L, 4)){
3941 while(lua_next(L, table) != 0){
3942 // key at index -2 and value at index -1
3943 luaL_checktype(L, -1, LUA_TSTRING);
3944 ndef->getIds(lua_tostring(L, -1), filter);
3945 // removes value, keeps key for next iteration
3948 } else if(lua_isstring(L, 4)){
3949 ndef->getIds(lua_tostring(L, 4), filter);
3952 for(int d=1; d<=radius; d++){
3953 core::list<v3s16> list;
3954 getFacePositions(list, d);
3955 for(core::list<v3s16>::Iterator i = list.begin();
3956 i != list.end(); i++){
3957 v3s16 p = pos + (*i);
3958 content_t c = env->getMap().getNodeNoEx(p).getContent();
3959 if(filter.count(c) != 0){
3968 // EnvRef:find_nodes_in_area(minp, maxp, nodenames) -> list of positions
3969 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
3970 static int l_find_nodes_in_area(lua_State *L)
3972 EnvRef *o = checkobject(L, 1);
3973 ServerEnvironment *env = o->m_env;
3974 if(env == NULL) return 0;
3975 INodeDefManager *ndef = get_server(L)->ndef();
3976 v3s16 minp = read_v3s16(L, 2);
3977 v3s16 maxp = read_v3s16(L, 3);
3978 std::set<content_t> filter;
3979 if(lua_istable(L, 4)){
3982 while(lua_next(L, table) != 0){
3983 // key at index -2 and value at index -1
3984 luaL_checktype(L, -1, LUA_TSTRING);
3985 ndef->getIds(lua_tostring(L, -1), filter);
3986 // removes value, keeps key for next iteration
3989 } else if(lua_isstring(L, 4)){
3990 ndef->getIds(lua_tostring(L, 4), filter);
3993 // Get the table insert function
3994 lua_getglobal(L, "table");
3995 lua_getfield(L, -1, "insert");
3996 int table_insert = lua_gettop(L);
3999 int table = lua_gettop(L);
4000 for(s16 x=minp.X; x<=maxp.X; x++)
4001 for(s16 y=minp.Y; y<=maxp.Y; y++)
4002 for(s16 z=minp.Z; z<=maxp.Z; z++)
4005 content_t c = env->getMap().getNodeNoEx(p).getContent();
4006 if(filter.count(c) != 0){
4007 lua_pushvalue(L, table_insert);
4008 lua_pushvalue(L, table);
4010 if(lua_pcall(L, 2, 0, 0))
4011 script_error(L, "error: %s", lua_tostring(L, -1));
4017 // EnvRef:get_perlin(seeddiff, octaves, persistence, scale)
4018 // returns world-specific PerlinNoise
4019 static int l_get_perlin(lua_State *L)
4021 EnvRef *o = checkobject(L, 1);
4022 ServerEnvironment *env = o->m_env;
4023 if(env == NULL) return 0;
4025 int seeddiff = luaL_checkint(L, 2);
4026 int octaves = luaL_checkint(L, 3);
4027 double persistence = luaL_checknumber(L, 4);
4028 double scale = luaL_checknumber(L, 5);
4030 LuaPerlinNoise *n = new LuaPerlinNoise(seeddiff + int(env->getServerMap().getSeed()), octaves, persistence, scale);
4031 *(void **)(lua_newuserdata(L, sizeof(void *))) = n;
4032 luaL_getmetatable(L, "PerlinNoise");
4033 lua_setmetatable(L, -2);
4037 // EnvRef:clear_objects()
4038 // clear all objects in the environment
4039 static int l_clear_objects(lua_State *L)
4041 EnvRef *o = checkobject(L, 1);
4042 o->m_env->clearAllObjects();
4046 static int l_spawn_tree(lua_State *L)
4048 EnvRef *o = checkobject(L, 1);
4049 ServerEnvironment *env = o->m_env;
4050 if(env == NULL) return 0;
4051 v3s16 p0 = read_v3s16(L, 2);
4053 treegen::TreeDef tree_def;
4054 std::string trunk,leaves,fruit;
4055 INodeDefManager *ndef = env->getGameDef()->ndef();
4057 if(lua_istable(L, 3))
4059 getstringfield(L, 3, "axiom", tree_def.initial_axiom);
4060 getstringfield(L, 3, "rules_a", tree_def.rules_a);
4061 getstringfield(L, 3, "rules_b", tree_def.rules_b);
4062 getstringfield(L, 3, "rules_c", tree_def.rules_a);
4063 getstringfield(L, 3, "rules_d", tree_def.rules_b);
4064 getstringfield(L, 3, "trunk", trunk);
4065 tree_def.trunknode=ndef->getId(trunk);
4066 getstringfield(L, 3, "leaves", leaves);
4067 tree_def.leavesnode=ndef->getId(leaves);
4068 getintfield(L, 3, "angle", tree_def.angle);
4069 getintfield(L, 3, "iterations", tree_def.iterations);
4070 getintfield(L, 3, "random_level", tree_def.iterations_random_level);
4071 getboolfield(L, 3, "thin_trunks", tree_def.thin_trunks);
4072 getboolfield(L, 3, "fruit_tree", tree_def.fruit_tree);
4073 if (tree_def.fruit_tree)
4075 getstringfield(L, 3, "fruit", fruit);
4076 tree_def.fruitnode=ndef->getId(fruit);
4081 treegen::spawn_ltree (env, p0, ndef, tree_def);
4086 EnvRef(ServerEnvironment *env):
4089 //infostream<<"EnvRef created"<<std::endl;
4094 //infostream<<"EnvRef destructing"<<std::endl;
4097 // Creates an EnvRef and leaves it on top of stack
4098 // Not callable from Lua; all references are created on the C side.
4099 static void create(lua_State *L, ServerEnvironment *env)
4101 EnvRef *o = new EnvRef(env);
4102 //infostream<<"EnvRef::create: o="<<o<<std::endl;
4103 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
4104 luaL_getmetatable(L, className);
4105 lua_setmetatable(L, -2);
4108 static void set_null(lua_State *L)
4110 EnvRef *o = checkobject(L, -1);
4114 static void Register(lua_State *L)
4117 int methodtable = lua_gettop(L);
4118 luaL_newmetatable(L, className);
4119 int metatable = lua_gettop(L);
4121 lua_pushliteral(L, "__metatable");
4122 lua_pushvalue(L, methodtable);
4123 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
4125 lua_pushliteral(L, "__index");
4126 lua_pushvalue(L, methodtable);
4127 lua_settable(L, metatable);
4129 lua_pushliteral(L, "__gc");
4130 lua_pushcfunction(L, gc_object);
4131 lua_settable(L, metatable);
4133 lua_pop(L, 1); // drop metatable
4135 luaL_openlib(L, 0, methods, 0); // fill methodtable
4136 lua_pop(L, 1); // drop methodtable
4138 // Cannot be created from Lua
4139 //lua_register(L, className, create_object);
4142 const char EnvRef::className[] = "EnvRef";
4143 const luaL_reg EnvRef::methods[] = {
4144 method(EnvRef, set_node),
4145 method(EnvRef, add_node),
4146 method(EnvRef, remove_node),
4147 method(EnvRef, get_node),
4148 method(EnvRef, get_node_or_nil),
4149 method(EnvRef, get_node_light),
4150 method(EnvRef, place_node),
4151 method(EnvRef, dig_node),
4152 method(EnvRef, punch_node),
4153 method(EnvRef, add_entity),
4154 method(EnvRef, add_item),
4155 method(EnvRef, add_rat),
4156 method(EnvRef, add_firefly),
4157 method(EnvRef, get_meta),
4158 method(EnvRef, get_node_timer),
4159 method(EnvRef, get_player_by_name),
4160 method(EnvRef, get_objects_inside_radius),
4161 method(EnvRef, set_timeofday),
4162 method(EnvRef, get_timeofday),
4163 method(EnvRef, find_node_near),
4164 method(EnvRef, find_nodes_in_area),
4165 method(EnvRef, get_perlin),
4166 method(EnvRef, clear_objects),
4167 method(EnvRef, spawn_tree),
4176 class LuaPseudoRandom
4179 PseudoRandom m_pseudo;
4181 static const char className[];
4182 static const luaL_reg methods[];
4184 // Exported functions
4186 // garbage collector
4187 static int gc_object(lua_State *L)
4189 LuaPseudoRandom *o = *(LuaPseudoRandom **)(lua_touserdata(L, 1));
4194 // next(self, min=0, max=32767) -> get next value
4195 static int l_next(lua_State *L)
4197 LuaPseudoRandom *o = checkobject(L, 1);
4200 lua_settop(L, 3); // Fill 2 and 3 with nil if they don't exist
4201 if(!lua_isnil(L, 2))
4202 min = luaL_checkinteger(L, 2);
4203 if(!lua_isnil(L, 3))
4204 max = luaL_checkinteger(L, 3);
4206 errorstream<<"PseudoRandom.next(): max="<<max<<" min="<<min<<std::endl;
4207 throw LuaError(L, "PseudoRandom.next(): max < min");
4209 if(max - min != 32767 && max - min > 32767/5)
4210 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.");
4211 PseudoRandom &pseudo = o->m_pseudo;
4212 int val = pseudo.next();
4213 val = (val % (max-min+1)) + min;
4214 lua_pushinteger(L, val);
4219 LuaPseudoRandom(int seed):
4228 const PseudoRandom& getItem() const
4232 PseudoRandom& getItem()
4237 // LuaPseudoRandom(seed)
4238 // Creates an LuaPseudoRandom and leaves it on top of stack
4239 static int create_object(lua_State *L)
4241 int seed = luaL_checknumber(L, 1);
4242 LuaPseudoRandom *o = new LuaPseudoRandom(seed);
4243 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
4244 luaL_getmetatable(L, className);
4245 lua_setmetatable(L, -2);
4249 static LuaPseudoRandom* checkobject(lua_State *L, int narg)
4251 luaL_checktype(L, narg, LUA_TUSERDATA);
4252 void *ud = luaL_checkudata(L, narg, className);
4253 if(!ud) luaL_typerror(L, narg, className);
4254 return *(LuaPseudoRandom**)ud; // unbox pointer
4257 static void Register(lua_State *L)
4260 int methodtable = lua_gettop(L);
4261 luaL_newmetatable(L, className);
4262 int metatable = lua_gettop(L);
4264 lua_pushliteral(L, "__metatable");
4265 lua_pushvalue(L, methodtable);
4266 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
4268 lua_pushliteral(L, "__index");
4269 lua_pushvalue(L, methodtable);
4270 lua_settable(L, metatable);
4272 lua_pushliteral(L, "__gc");
4273 lua_pushcfunction(L, gc_object);
4274 lua_settable(L, metatable);
4276 lua_pop(L, 1); // drop metatable
4278 luaL_openlib(L, 0, methods, 0); // fill methodtable
4279 lua_pop(L, 1); // drop methodtable
4281 // Can be created from Lua (LuaPseudoRandom(seed))
4282 lua_register(L, className, create_object);
4285 const char LuaPseudoRandom::className[] = "PseudoRandom";
4286 const luaL_reg LuaPseudoRandom::methods[] = {
4287 method(LuaPseudoRandom, next),
4297 class LuaABM : public ActiveBlockModifier
4303 std::set<std::string> m_trigger_contents;
4304 std::set<std::string> m_required_neighbors;
4305 float m_trigger_interval;
4306 u32 m_trigger_chance;
4308 LuaABM(lua_State *L, int id,
4309 const std::set<std::string> &trigger_contents,
4310 const std::set<std::string> &required_neighbors,
4311 float trigger_interval, u32 trigger_chance):
4314 m_trigger_contents(trigger_contents),
4315 m_required_neighbors(required_neighbors),
4316 m_trigger_interval(trigger_interval),
4317 m_trigger_chance(trigger_chance)
4320 virtual std::set<std::string> getTriggerContents()
4322 return m_trigger_contents;
4324 virtual std::set<std::string> getRequiredNeighbors()
4326 return m_required_neighbors;
4328 virtual float getTriggerInterval()
4330 return m_trigger_interval;
4332 virtual u32 getTriggerChance()
4334 return m_trigger_chance;
4336 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
4337 u32 active_object_count, u32 active_object_count_wider)
4339 lua_State *L = m_lua;
4342 assert(lua_checkstack(L, 20));
4343 StackUnroller stack_unroller(L);
4345 // Get minetest.registered_abms
4346 lua_getglobal(L, "minetest");
4347 lua_getfield(L, -1, "registered_abms");
4348 luaL_checktype(L, -1, LUA_TTABLE);
4349 int registered_abms = lua_gettop(L);
4351 // Get minetest.registered_abms[m_id]
4352 lua_pushnumber(L, m_id);
4353 lua_gettable(L, registered_abms);
4354 if(lua_isnil(L, -1))
4358 luaL_checktype(L, -1, LUA_TTABLE);
4359 lua_getfield(L, -1, "action");
4360 luaL_checktype(L, -1, LUA_TFUNCTION);
4362 pushnode(L, n, env->getGameDef()->ndef());
4363 lua_pushnumber(L, active_object_count);
4364 lua_pushnumber(L, active_object_count_wider);
4365 if(lua_pcall(L, 4, 0, 0))
4366 script_error(L, "error: %s", lua_tostring(L, -1));
4374 static void read_server_sound_params(lua_State *L, int index,
4375 ServerSoundParams ¶ms)
4378 index = lua_gettop(L) + 1 + index;
4380 params = ServerSoundParams();
4381 if(lua_istable(L, index)){
4382 getfloatfield(L, index, "gain", params.gain);
4383 getstringfield(L, index, "to_player", params.to_player);
4384 lua_getfield(L, index, "pos");
4385 if(!lua_isnil(L, -1)){
4386 v3f p = read_v3f(L, -1)*BS;
4388 params.type = ServerSoundParams::SSP_POSITIONAL;
4391 lua_getfield(L, index, "object");
4392 if(!lua_isnil(L, -1)){
4393 ObjectRef *ref = ObjectRef::checkobject(L, -1);
4394 ServerActiveObject *sao = ObjectRef::getobject(ref);
4396 params.object = sao->getId();
4397 params.type = ServerSoundParams::SSP_OBJECT;
4401 params.max_hear_distance = BS*getfloatfield_default(L, index,
4402 "max_hear_distance", params.max_hear_distance/BS);
4403 getboolfield(L, index, "loop", params.loop);
4412 // Writes a line to dstream
4413 static int l_debug(lua_State *L)
4415 std::string text = lua_tostring(L, 1);
4416 dstream << text << std::endl;
4420 // log([level,] text)
4421 // Writes a line to the logger.
4422 // The one-argument version logs to infostream.
4423 // The two-argument version accept a log level: error, action, info, or verbose.
4424 static int l_log(lua_State *L)
4427 LogMessageLevel level = LMT_INFO;
4428 if(lua_isnone(L, 2))
4430 text = lua_tostring(L, 1);
4434 std::string levelname = lua_tostring(L, 1);
4435 text = lua_tostring(L, 2);
4436 if(levelname == "error")
4438 else if(levelname == "action")
4440 else if(levelname == "verbose")
4441 level = LMT_VERBOSE;
4443 log_printline(level, text);
4447 // request_shutdown()
4448 static int l_request_shutdown(lua_State *L)
4450 get_server(L)->requestShutdown();
4454 // get_server_status()
4455 static int l_get_server_status(lua_State *L)
4457 lua_pushstring(L, wide_to_narrow(get_server(L)->getStatusString()).c_str());
4461 // register_item_raw({lots of stuff})
4462 static int l_register_item_raw(lua_State *L)
4464 luaL_checktype(L, 1, LUA_TTABLE);
4467 // Get the writable item and node definition managers from the server
4468 IWritableItemDefManager *idef =
4469 get_server(L)->getWritableItemDefManager();
4470 IWritableNodeDefManager *ndef =
4471 get_server(L)->getWritableNodeDefManager();
4473 // Check if name is defined
4475 lua_getfield(L, table, "name");
4476 if(lua_isstring(L, -1)){
4477 name = lua_tostring(L, -1);
4478 verbosestream<<"register_item_raw: "<<name<<std::endl;
4480 throw LuaError(L, "register_item_raw: name is not defined or not a string");
4483 // Check if on_use is defined
4486 // Set a distinctive default value to check if this is set
4487 def.node_placement_prediction = "__default";
4489 // Read the item definition
4490 def = read_item_definition(L, table, def);
4492 // Default to having client-side placement prediction for nodes
4493 // ("" in item definition sets it off)
4494 if(def.node_placement_prediction == "__default"){
4495 if(def.type == ITEM_NODE)
4496 def.node_placement_prediction = name;
4498 def.node_placement_prediction = "";
4501 // Register item definition
4502 idef->registerItem(def);
4504 // Read the node definition (content features) and register it
4505 if(def.type == ITEM_NODE)
4507 ContentFeatures f = read_content_features(L, table);
4508 ndef->set(f.name, f);
4511 return 0; /* number of results */
4514 // register_alias_raw(name, convert_to_name)
4515 static int l_register_alias_raw(lua_State *L)
4517 std::string name = luaL_checkstring(L, 1);
4518 std::string convert_to = luaL_checkstring(L, 2);
4520 // Get the writable item definition manager from the server
4521 IWritableItemDefManager *idef =
4522 get_server(L)->getWritableItemDefManager();
4524 idef->registerAlias(name, convert_to);
4526 return 0; /* number of results */
4529 // helper for register_craft
4530 static bool read_craft_recipe_shaped(lua_State *L, int index,
4531 int &width, std::vector<std::string> &recipe)
4534 index = lua_gettop(L) + 1 + index;
4536 if(!lua_istable(L, index))
4541 while(lua_next(L, index) != 0){
4543 // key at index -2 and value at index -1
4544 if(!lua_istable(L, -1))
4546 int table2 = lua_gettop(L);
4548 while(lua_next(L, table2) != 0){
4549 // key at index -2 and value at index -1
4550 if(!lua_isstring(L, -1))
4552 recipe.push_back(lua_tostring(L, -1));
4553 // removes value, keeps key for next iteration
4560 if(colcount != width)
4563 // removes value, keeps key for next iteration
4570 // helper for register_craft
4571 static bool read_craft_recipe_shapeless(lua_State *L, int index,
4572 std::vector<std::string> &recipe)
4575 index = lua_gettop(L) + 1 + index;
4577 if(!lua_istable(L, index))
4581 while(lua_next(L, index) != 0){
4582 // key at index -2 and value at index -1
4583 if(!lua_isstring(L, -1))
4585 recipe.push_back(lua_tostring(L, -1));
4586 // removes value, keeps key for next iteration
4592 // helper for register_craft
4593 static bool read_craft_replacements(lua_State *L, int index,
4594 CraftReplacements &replacements)
4597 index = lua_gettop(L) + 1 + index;
4599 if(!lua_istable(L, index))
4603 while(lua_next(L, index) != 0){
4604 // key at index -2 and value at index -1
4605 if(!lua_istable(L, -1))
4607 lua_rawgeti(L, -1, 1);
4608 if(!lua_isstring(L, -1))
4610 std::string replace_from = lua_tostring(L, -1);
4612 lua_rawgeti(L, -1, 2);
4613 if(!lua_isstring(L, -1))
4615 std::string replace_to = lua_tostring(L, -1);
4617 replacements.pairs.push_back(
4618 std::make_pair(replace_from, replace_to));
4619 // removes value, keeps key for next iteration
4624 // register_craft({output=item, recipe={{item00,item10},{item01,item11}})
4625 static int l_register_craft(lua_State *L)
4627 //infostream<<"register_craft"<<std::endl;
4628 luaL_checktype(L, 1, LUA_TTABLE);
4631 // Get the writable craft definition manager from the server
4632 IWritableCraftDefManager *craftdef =
4633 get_server(L)->getWritableCraftDefManager();
4635 std::string type = getstringfield_default(L, table, "type", "shaped");
4638 CraftDefinitionShaped
4640 if(type == "shaped"){
4641 std::string output = getstringfield_default(L, table, "output", "");
4643 throw LuaError(L, "Crafting definition is missing an output");
4646 std::vector<std::string> recipe;
4647 lua_getfield(L, table, "recipe");
4648 if(lua_isnil(L, -1))
4649 throw LuaError(L, "Crafting definition is missing a recipe"
4650 " (output=\"" + output + "\")");
4651 if(!read_craft_recipe_shaped(L, -1, width, recipe))
4652 throw LuaError(L, "Invalid crafting recipe"
4653 " (output=\"" + output + "\")");
4655 CraftReplacements replacements;
4656 lua_getfield(L, table, "replacements");
4657 if(!lua_isnil(L, -1))
4659 if(!read_craft_replacements(L, -1, replacements))
4660 throw LuaError(L, "Invalid replacements"
4661 " (output=\"" + output + "\")");
4664 CraftDefinition *def = new CraftDefinitionShaped(
4665 output, width, recipe, replacements);
4666 craftdef->registerCraft(def);
4669 CraftDefinitionShapeless
4671 else if(type == "shapeless"){
4672 std::string output = getstringfield_default(L, table, "output", "");
4674 throw LuaError(L, "Crafting definition (shapeless)"
4675 " is missing an output");
4677 std::vector<std::string> recipe;
4678 lua_getfield(L, table, "recipe");
4679 if(lua_isnil(L, -1))
4680 throw LuaError(L, "Crafting definition (shapeless)"
4681 " is missing a recipe"
4682 " (output=\"" + output + "\")");
4683 if(!read_craft_recipe_shapeless(L, -1, recipe))
4684 throw LuaError(L, "Invalid crafting recipe"
4685 " (output=\"" + output + "\")");
4687 CraftReplacements replacements;
4688 lua_getfield(L, table, "replacements");
4689 if(!lua_isnil(L, -1))
4691 if(!read_craft_replacements(L, -1, replacements))
4692 throw LuaError(L, "Invalid replacements"
4693 " (output=\"" + output + "\")");
4696 CraftDefinition *def = new CraftDefinitionShapeless(
4697 output, recipe, replacements);
4698 craftdef->registerCraft(def);
4701 CraftDefinitionToolRepair
4703 else if(type == "toolrepair"){
4704 float additional_wear = getfloatfield_default(L, table,
4705 "additional_wear", 0.0);
4707 CraftDefinition *def = new CraftDefinitionToolRepair(
4709 craftdef->registerCraft(def);
4712 CraftDefinitionCooking
4714 else if(type == "cooking"){
4715 std::string output = getstringfield_default(L, table, "output", "");
4717 throw LuaError(L, "Crafting definition (cooking)"
4718 " is missing an output");
4720 std::string recipe = getstringfield_default(L, table, "recipe", "");
4722 throw LuaError(L, "Crafting definition (cooking)"
4723 " is missing a recipe"
4724 " (output=\"" + output + "\")");
4726 float cooktime = getfloatfield_default(L, table, "cooktime", 3.0);
4728 CraftReplacements replacements;
4729 lua_getfield(L, table, "replacements");
4730 if(!lua_isnil(L, -1))
4732 if(!read_craft_replacements(L, -1, replacements))
4733 throw LuaError(L, "Invalid replacements"
4734 " (cooking output=\"" + output + "\")");
4737 CraftDefinition *def = new CraftDefinitionCooking(
4738 output, recipe, cooktime, replacements);
4739 craftdef->registerCraft(def);
4744 else if(type == "fuel"){
4745 std::string recipe = getstringfield_default(L, table, "recipe", "");
4747 throw LuaError(L, "Crafting definition (fuel)"
4748 " is missing a recipe");
4750 float burntime = getfloatfield_default(L, table, "burntime", 1.0);
4752 CraftReplacements replacements;
4753 lua_getfield(L, table, "replacements");
4754 if(!lua_isnil(L, -1))
4756 if(!read_craft_replacements(L, -1, replacements))
4757 throw LuaError(L, "Invalid replacements"
4758 " (fuel recipe=\"" + recipe + "\")");
4761 CraftDefinition *def = new CraftDefinitionFuel(
4762 recipe, burntime, replacements);
4763 craftdef->registerCraft(def);
4767 throw LuaError(L, "Unknown crafting definition type: \"" + type + "\"");
4771 return 0; /* number of results */
4774 // setting_set(name, value)
4775 static int l_setting_set(lua_State *L)
4777 const char *name = luaL_checkstring(L, 1);
4778 const char *value = luaL_checkstring(L, 2);
4779 g_settings->set(name, value);
4783 // setting_get(name)
4784 static int l_setting_get(lua_State *L)
4786 const char *name = luaL_checkstring(L, 1);
4788 std::string value = g_settings->get(name);
4789 lua_pushstring(L, value.c_str());
4790 } catch(SettingNotFoundException &e){
4796 // setting_getbool(name)
4797 static int l_setting_getbool(lua_State *L)
4799 const char *name = luaL_checkstring(L, 1);
4801 bool value = g_settings->getBool(name);
4802 lua_pushboolean(L, value);
4803 } catch(SettingNotFoundException &e){
4809 // chat_send_all(text)
4810 static int l_chat_send_all(lua_State *L)
4812 const char *text = luaL_checkstring(L, 1);
4813 // Get server from registry
4814 Server *server = get_server(L);
4816 server->notifyPlayers(narrow_to_wide(text));
4820 // chat_send_player(name, text)
4821 static int l_chat_send_player(lua_State *L)
4823 const char *name = luaL_checkstring(L, 1);
4824 const char *text = luaL_checkstring(L, 2);
4825 // Get server from registry
4826 Server *server = get_server(L);
4828 server->notifyPlayer(name, narrow_to_wide(text));
4832 // get_player_privs(name, text)
4833 static int l_get_player_privs(lua_State *L)
4835 const char *name = luaL_checkstring(L, 1);
4836 // Get server from registry
4837 Server *server = get_server(L);
4840 int table = lua_gettop(L);
4841 std::set<std::string> privs_s = server->getPlayerEffectivePrivs(name);
4842 for(std::set<std::string>::const_iterator
4843 i = privs_s.begin(); i != privs_s.end(); i++){
4844 lua_pushboolean(L, true);
4845 lua_setfield(L, table, i->c_str());
4847 lua_pushvalue(L, table);
4852 static int l_get_ban_list(lua_State *L)
4854 lua_pushstring(L, get_server(L)->getBanDescription("").c_str());
4858 // get_ban_description()
4859 static int l_get_ban_description(lua_State *L)
4861 const char * ip_or_name = luaL_checkstring(L, 1);
4862 lua_pushstring(L, get_server(L)->getBanDescription(std::string(ip_or_name)).c_str());
4867 static int l_ban_player(lua_State *L)
4869 const char * name = luaL_checkstring(L, 1);
4870 Player *player = get_env(L)->getPlayer(name);
4873 lua_pushboolean(L, false); // no such player
4878 Address addr = get_server(L)->getPeerAddress(get_env(L)->getPlayer(name)->peer_id);
4879 std::string ip_str = addr.serializeString();
4880 get_server(L)->setIpBanned(ip_str, name);
4882 catch(con::PeerNotFoundException) // unlikely
4884 dstream << __FUNCTION_NAME << ": peer was not found" << std::endl;
4885 lua_pushboolean(L, false); // error
4888 lua_pushboolean(L, true);
4892 // unban_player_or_ip()
4893 static int l_unban_player_of_ip(lua_State *L)
4895 const char * ip_or_name = luaL_checkstring(L, 1);
4896 get_server(L)->unsetIpBanned(ip_or_name);
4897 lua_pushboolean(L, true);
4901 // get_inventory(location)
4902 static int l_get_inventory(lua_State *L)
4904 InventoryLocation loc;
4906 std::string type = checkstringfield(L, 1, "type");
4907 if(type == "player"){
4908 std::string name = checkstringfield(L, 1, "name");
4909 loc.setPlayer(name);
4910 } else if(type == "node"){
4911 lua_getfield(L, 1, "pos");
4912 v3s16 pos = check_v3s16(L, -1);
4913 loc.setNodeMeta(pos);
4914 } else if(type == "detached"){
4915 std::string name = checkstringfield(L, 1, "name");
4916 loc.setDetached(name);
4919 if(get_server(L)->getInventory(loc) != NULL)
4920 InvRef::create(L, loc);
4926 // create_detached_inventory_raw(name)
4927 static int l_create_detached_inventory_raw(lua_State *L)
4929 const char *name = luaL_checkstring(L, 1);
4930 if(get_server(L)->createDetachedInventory(name) != NULL){
4931 InventoryLocation loc;
4932 loc.setDetached(name);
4933 InvRef::create(L, loc);
4940 // create_detached_formspec_raw(name)
4941 static int l_show_formspec(lua_State *L)
4943 const char *playername = luaL_checkstring(L, 1);
4944 const char *formspec = luaL_checkstring(L, 2);
4946 if(get_server(L)->showFormspec(playername,formspec))
4948 lua_pushboolean(L, true);
4950 lua_pushboolean(L, false);
4955 // get_dig_params(groups, tool_capabilities[, time_from_last_punch])
4956 static int l_get_dig_params(lua_State *L)
4958 std::map<std::string, int> groups;
4959 read_groups(L, 1, groups);
4960 ToolCapabilities tp = read_tool_capabilities(L, 2);
4961 if(lua_isnoneornil(L, 3))
4962 push_dig_params(L, getDigParams(groups, &tp));
4964 push_dig_params(L, getDigParams(groups, &tp,
4965 luaL_checknumber(L, 3)));
4969 // get_hit_params(groups, tool_capabilities[, time_from_last_punch])
4970 static int l_get_hit_params(lua_State *L)
4972 std::map<std::string, int> groups;
4973 read_groups(L, 1, groups);
4974 ToolCapabilities tp = read_tool_capabilities(L, 2);
4975 if(lua_isnoneornil(L, 3))
4976 push_hit_params(L, getHitParams(groups, &tp));
4978 push_hit_params(L, getHitParams(groups, &tp,
4979 luaL_checknumber(L, 3)));
4983 // get_current_modname()
4984 static int l_get_current_modname(lua_State *L)
4986 lua_getfield(L, LUA_REGISTRYINDEX, "minetest_current_modname");
4990 // get_modpath(modname)
4991 static int l_get_modpath(lua_State *L)
4993 std::string modname = luaL_checkstring(L, 1);
4995 if(modname == "__builtin"){
4996 std::string path = get_server(L)->getBuiltinLuaPath();
4997 lua_pushstring(L, path.c_str());
5000 const ModSpec *mod = get_server(L)->getModSpec(modname);
5005 lua_pushstring(L, mod->path.c_str());
5010 // the returned list is sorted alphabetically for you
5011 static int l_get_modnames(lua_State *L)
5013 // Get a list of mods
5014 core::list<std::string> mods_unsorted, mods_sorted;
5015 get_server(L)->getModNames(mods_unsorted);
5017 // Take unsorted items from mods_unsorted and sort them into
5018 // mods_sorted; not great performance but the number of mods on a
5019 // server will likely be small.
5020 for(core::list<std::string>::Iterator i = mods_unsorted.begin();
5021 i != mods_unsorted.end(); i++)
5024 for(core::list<std::string>::Iterator x = mods_sorted.begin();
5025 x != mods_unsorted.end(); x++)
5027 // I doubt anybody using Minetest will be using
5028 // anything not ASCII based :)
5029 if((*i).compare(*x) <= 0)
5031 mods_sorted.insert_before(x, *i);
5037 mods_sorted.push_back(*i);
5040 // Get the table insertion function from Lua.
5041 lua_getglobal(L, "table");
5042 lua_getfield(L, -1, "insert");
5043 int insertion_func = lua_gettop(L);
5045 // Package them up for Lua
5047 int new_table = lua_gettop(L);
5048 core::list<std::string>::Iterator i = mods_sorted.begin();
5049 while(i != mods_sorted.end())
5051 lua_pushvalue(L, insertion_func);
5052 lua_pushvalue(L, new_table);
5053 lua_pushstring(L, (*i).c_str());
5054 if(lua_pcall(L, 2, 0, 0) != 0)
5056 script_error(L, "error: %s", lua_tostring(L, -1));
5064 static int l_get_worldpath(lua_State *L)
5066 std::string worldpath = get_server(L)->getWorldPath();
5067 lua_pushstring(L, worldpath.c_str());
5071 // sound_play(spec, parameters)
5072 static int l_sound_play(lua_State *L)
5074 SimpleSoundSpec spec;
5075 read_soundspec(L, 1, spec);
5076 ServerSoundParams params;
5077 read_server_sound_params(L, 2, params);
5078 s32 handle = get_server(L)->playSound(spec, params);
5079 lua_pushinteger(L, handle);
5083 // sound_stop(handle)
5084 static int l_sound_stop(lua_State *L)
5086 int handle = luaL_checkinteger(L, 1);
5087 get_server(L)->stopSound(handle);
5091 // is_singleplayer()
5092 static int l_is_singleplayer(lua_State *L)
5094 lua_pushboolean(L, get_server(L)->isSingleplayer());
5098 // get_password_hash(name, raw_password)
5099 static int l_get_password_hash(lua_State *L)
5101 std::string name = luaL_checkstring(L, 1);
5102 std::string raw_password = luaL_checkstring(L, 2);
5103 std::string hash = translatePassword(name,
5104 narrow_to_wide(raw_password));
5105 lua_pushstring(L, hash.c_str());
5109 // notify_authentication_modified(name)
5110 static int l_notify_authentication_modified(lua_State *L)
5112 std::string name = "";
5113 if(lua_isstring(L, 1))
5114 name = lua_tostring(L, 1);
5115 get_server(L)->reportPrivsModified(name);
5119 // get_craft_result(input)
5120 static int l_get_craft_result(lua_State *L)
5123 std::string method_s = getstringfield_default(L, input_i, "method", "normal");
5124 enum CraftMethod method = (CraftMethod)getenumfield(L, input_i, "method",
5125 es_CraftMethod, CRAFT_METHOD_NORMAL);
5127 lua_getfield(L, input_i, "width");
5128 if(lua_isnumber(L, -1))
5129 width = luaL_checkinteger(L, -1);
5131 lua_getfield(L, input_i, "items");
5132 std::vector<ItemStack> items = read_items(L, -1);
5133 lua_pop(L, 1); // items
5135 IGameDef *gdef = get_server(L);
5136 ICraftDefManager *cdef = gdef->cdef();
5137 CraftInput input(method, width, items);
5139 bool got = cdef->getCraftResult(input, output, true, gdef);
5140 lua_newtable(L); // output table
5143 item.deSerialize(output.item, gdef->idef());
5144 LuaItemStack::create(L, item);
5145 lua_setfield(L, -2, "item");
5146 setintfield(L, -1, "time", output.time);
5148 LuaItemStack::create(L, ItemStack());
5149 lua_setfield(L, -2, "item");
5150 setintfield(L, -1, "time", 0);
5152 lua_newtable(L); // decremented input table
5153 lua_pushstring(L, method_s.c_str());
5154 lua_setfield(L, -2, "method");
5155 lua_pushinteger(L, width);
5156 lua_setfield(L, -2, "width");
5157 push_items(L, input.items);
5158 lua_setfield(L, -2, "items");
5162 // get_craft_recipe(result item)
5163 static int l_get_craft_recipe(lua_State *L)
5168 std::string o_item = luaL_checkstring(L,input_i);
5170 IGameDef *gdef = get_server(L);
5171 ICraftDefManager *cdef = gdef->cdef();
5173 CraftOutput output(o_item,0);
5174 bool got = cdef->getCraftRecipe(input, output, gdef);
5175 lua_newtable(L); // output table
5178 for(std::vector<ItemStack>::const_iterator
5179 i = input.items.begin();
5180 i != input.items.end(); i++, k++)
5186 sprintf(tmp,"%d",k);
5187 lua_pushstring(L,tmp);
5188 lua_pushstring(L,i->name.c_str());
5189 lua_settable(L, -3);
5191 lua_setfield(L, -2, "items");
5192 setintfield(L, -1, "width", input.width);
5193 switch (input.method) {
5194 case CRAFT_METHOD_NORMAL:
5195 lua_pushstring(L,"normal");
5197 case CRAFT_METHOD_COOKING:
5198 lua_pushstring(L,"cooking");
5200 case CRAFT_METHOD_FUEL:
5201 lua_pushstring(L,"fuel");
5204 lua_pushstring(L,"unknown");
5206 lua_setfield(L, -2, "type");
5209 lua_setfield(L, -2, "items");
5210 setintfield(L, -1, "width", 0);
5215 // rollback_get_last_node_actor(p, range, seconds) -> actor, p, seconds
5216 static int l_rollback_get_last_node_actor(lua_State *L)
5218 v3s16 p = read_v3s16(L, 1);
5219 int range = luaL_checknumber(L, 2);
5220 int seconds = luaL_checknumber(L, 3);
5221 Server *server = get_server(L);
5222 IRollbackManager *rollback = server->getRollbackManager();
5224 int act_seconds = 0;
5225 std::string actor = rollback->getLastNodeActor(p, range, seconds, &act_p, &act_seconds);
5226 lua_pushstring(L, actor.c_str());
5227 push_v3s16(L, act_p);
5228 lua_pushnumber(L, act_seconds);
5232 // rollback_revert_actions_by(actor, seconds) -> bool, log messages
5233 static int l_rollback_revert_actions_by(lua_State *L)
5235 std::string actor = luaL_checkstring(L, 1);
5236 int seconds = luaL_checknumber(L, 2);
5237 Server *server = get_server(L);
5238 IRollbackManager *rollback = server->getRollbackManager();
5239 std::list<RollbackAction> actions = rollback->getRevertActions(actor, seconds);
5240 std::list<std::string> log;
5241 bool success = server->rollbackRevertActions(actions, &log);
5242 // Push boolean result
5243 lua_pushboolean(L, success);
5244 // Get the table insert function and push the log table
5245 lua_getglobal(L, "table");
5246 lua_getfield(L, -1, "insert");
5247 int table_insert = lua_gettop(L);
5249 int table = lua_gettop(L);
5250 for(std::list<std::string>::const_iterator i = log.begin();
5251 i != log.end(); i++)
5253 lua_pushvalue(L, table_insert);
5254 lua_pushvalue(L, table);
5255 lua_pushstring(L, i->c_str());
5256 if(lua_pcall(L, 2, 0, 0))
5257 script_error(L, "error: %s", lua_tostring(L, -1));
5259 lua_remove(L, -2); // Remove table
5260 lua_remove(L, -2); // Remove insert
5264 static const struct luaL_Reg minetest_f [] = {
5267 {"request_shutdown", l_request_shutdown},
5268 {"get_server_status", l_get_server_status},
5269 {"register_item_raw", l_register_item_raw},
5270 {"register_alias_raw", l_register_alias_raw},
5271 {"register_craft", l_register_craft},
5272 {"setting_set", l_setting_set},
5273 {"setting_get", l_setting_get},
5274 {"setting_getbool", l_setting_getbool},
5275 {"chat_send_all", l_chat_send_all},
5276 {"chat_send_player", l_chat_send_player},
5277 {"get_player_privs", l_get_player_privs},
5278 {"get_ban_list", l_get_ban_list},
5279 {"get_ban_description", l_get_ban_description},
5280 {"ban_player", l_ban_player},
5281 {"unban_player_or_ip", l_unban_player_of_ip},
5282 {"get_inventory", l_get_inventory},
5283 {"create_detached_inventory_raw", l_create_detached_inventory_raw},
5284 {"show_formspec", l_show_formspec},
5285 {"get_dig_params", l_get_dig_params},
5286 {"get_hit_params", l_get_hit_params},
5287 {"get_current_modname", l_get_current_modname},
5288 {"get_modpath", l_get_modpath},
5289 {"get_modnames", l_get_modnames},
5290 {"get_worldpath", l_get_worldpath},
5291 {"sound_play", l_sound_play},
5292 {"sound_stop", l_sound_stop},
5293 {"is_singleplayer", l_is_singleplayer},
5294 {"get_password_hash", l_get_password_hash},
5295 {"notify_authentication_modified", l_notify_authentication_modified},
5296 {"get_craft_result", l_get_craft_result},
5297 {"get_craft_recipe", l_get_craft_recipe},
5298 {"rollback_get_last_node_actor", l_rollback_get_last_node_actor},
5299 {"rollback_revert_actions_by", l_rollback_revert_actions_by},
5304 Main export function
5307 void scriptapi_export(lua_State *L, Server *server)
5310 assert(lua_checkstack(L, 20));
5311 verbosestream<<"scriptapi_export()"<<std::endl;
5312 StackUnroller stack_unroller(L);
5314 // Store server as light userdata in registry
5315 lua_pushlightuserdata(L, server);
5316 lua_setfield(L, LUA_REGISTRYINDEX, "minetest_server");
5318 // Register global functions in table minetest
5320 luaL_register(L, NULL, minetest_f);
5321 lua_setglobal(L, "minetest");
5323 // Get the main minetest table
5324 lua_getglobal(L, "minetest");
5326 // Add tables to minetest
5328 lua_setfield(L, -2, "object_refs");
5330 lua_setfield(L, -2, "luaentities");
5332 // Register wrappers
5333 LuaItemStack::Register(L);
5334 InvRef::Register(L);
5335 NodeMetaRef::Register(L);
5336 NodeTimerRef::Register(L);
5337 ObjectRef::Register(L);
5338 EnvRef::Register(L);
5339 LuaPseudoRandom::Register(L);
5340 LuaPerlinNoise::Register(L);
5343 bool scriptapi_loadmod(lua_State *L, const std::string &scriptpath,
5344 const std::string &modname)
5346 ModNameStorer modnamestorer(L, modname);
5348 if(!string_allowed(modname, "abcdefghijklmnopqrstuvwxyz"
5350 errorstream<<"Error loading mod \""<<modname
5351 <<"\": modname does not follow naming conventions: "
5352 <<"Only chararacters [a-z0-9_] are allowed."<<std::endl;
5356 bool success = false;
5359 success = script_load(L, scriptpath.c_str());
5362 errorstream<<"Error loading mod \""<<modname
5363 <<"\": "<<e.what()<<std::endl;
5369 void scriptapi_add_environment(lua_State *L, ServerEnvironment *env)
5372 assert(lua_checkstack(L, 20));
5373 verbosestream<<"scriptapi_add_environment"<<std::endl;
5374 StackUnroller stack_unroller(L);
5376 // Create EnvRef on stack
5377 EnvRef::create(L, env);
5378 int envref = lua_gettop(L);
5380 // minetest.env = envref
5381 lua_getglobal(L, "minetest");
5382 luaL_checktype(L, -1, LUA_TTABLE);
5383 lua_pushvalue(L, envref);
5384 lua_setfield(L, -2, "env");
5386 // Store environment as light userdata in registry
5387 lua_pushlightuserdata(L, env);
5388 lua_setfield(L, LUA_REGISTRYINDEX, "minetest_env");
5391 Add ActiveBlockModifiers to environment
5394 // Get minetest.registered_abms
5395 lua_getglobal(L, "minetest");
5396 lua_getfield(L, -1, "registered_abms");
5397 luaL_checktype(L, -1, LUA_TTABLE);
5398 int registered_abms = lua_gettop(L);
5400 if(lua_istable(L, registered_abms)){
5401 int table = lua_gettop(L);
5403 while(lua_next(L, table) != 0){
5404 // key at index -2 and value at index -1
5405 int id = lua_tonumber(L, -2);
5406 int current_abm = lua_gettop(L);
5408 std::set<std::string> trigger_contents;
5409 lua_getfield(L, current_abm, "nodenames");
5410 if(lua_istable(L, -1)){
5411 int table = lua_gettop(L);
5413 while(lua_next(L, table) != 0){
5414 // key at index -2 and value at index -1
5415 luaL_checktype(L, -1, LUA_TSTRING);
5416 trigger_contents.insert(lua_tostring(L, -1));
5417 // removes value, keeps key for next iteration
5420 } else if(lua_isstring(L, -1)){
5421 trigger_contents.insert(lua_tostring(L, -1));
5425 std::set<std::string> required_neighbors;
5426 lua_getfield(L, current_abm, "neighbors");
5427 if(lua_istable(L, -1)){
5428 int table = lua_gettop(L);
5430 while(lua_next(L, table) != 0){
5431 // key at index -2 and value at index -1
5432 luaL_checktype(L, -1, LUA_TSTRING);
5433 required_neighbors.insert(lua_tostring(L, -1));
5434 // removes value, keeps key for next iteration
5437 } else if(lua_isstring(L, -1)){
5438 required_neighbors.insert(lua_tostring(L, -1));
5442 float trigger_interval = 10.0;
5443 getfloatfield(L, current_abm, "interval", trigger_interval);
5445 int trigger_chance = 50;
5446 getintfield(L, current_abm, "chance", trigger_chance);
5448 LuaABM *abm = new LuaABM(L, id, trigger_contents,
5449 required_neighbors, trigger_interval, trigger_chance);
5451 env->addActiveBlockModifier(abm);
5453 // removes value, keeps key for next iteration
5461 // Dump stack top with the dump2 function
5462 static void dump2(lua_State *L, const char *name)
5464 // Dump object (debug)
5465 lua_getglobal(L, "dump2");
5466 luaL_checktype(L, -1, LUA_TFUNCTION);
5467 lua_pushvalue(L, -2); // Get previous stack top as first parameter
5468 lua_pushstring(L, name);
5469 if(lua_pcall(L, 2, 0, 0))
5470 script_error(L, "error: %s", lua_tostring(L, -1));
5478 void scriptapi_add_object_reference(lua_State *L, ServerActiveObject *cobj)
5481 assert(lua_checkstack(L, 20));
5482 //infostream<<"scriptapi_add_object_reference: id="<<cobj->getId()<<std::endl;
5483 StackUnroller stack_unroller(L);
5485 // Create object on stack
5486 ObjectRef::create(L, cobj); // Puts ObjectRef (as userdata) on stack
5487 int object = lua_gettop(L);
5489 // Get minetest.object_refs table
5490 lua_getglobal(L, "minetest");
5491 lua_getfield(L, -1, "object_refs");
5492 luaL_checktype(L, -1, LUA_TTABLE);
5493 int objectstable = lua_gettop(L);
5495 // object_refs[id] = object
5496 lua_pushnumber(L, cobj->getId()); // Push id
5497 lua_pushvalue(L, object); // Copy object to top of stack
5498 lua_settable(L, objectstable);
5501 void scriptapi_rm_object_reference(lua_State *L, ServerActiveObject *cobj)
5504 assert(lua_checkstack(L, 20));
5505 //infostream<<"scriptapi_rm_object_reference: id="<<cobj->getId()<<std::endl;
5506 StackUnroller stack_unroller(L);
5508 // Get minetest.object_refs table
5509 lua_getglobal(L, "minetest");
5510 lua_getfield(L, -1, "object_refs");
5511 luaL_checktype(L, -1, LUA_TTABLE);
5512 int objectstable = lua_gettop(L);
5514 // Get object_refs[id]
5515 lua_pushnumber(L, cobj->getId()); // Push id
5516 lua_gettable(L, objectstable);
5517 // Set object reference to NULL
5518 ObjectRef::set_null(L);
5519 lua_pop(L, 1); // pop object
5521 // Set object_refs[id] = nil
5522 lua_pushnumber(L, cobj->getId()); // Push id
5524 lua_settable(L, objectstable);
5531 // What scriptapi_run_callbacks does with the return values of callbacks.
5532 // Regardless of the mode, if only one callback is defined,
5533 // its return value is the total return value.
5534 // Modes only affect the case where 0 or >= 2 callbacks are defined.
5535 enum RunCallbacksMode
5537 // Returns the return value of the first callback
5538 // Returns nil if list of callbacks is empty
5539 RUN_CALLBACKS_MODE_FIRST,
5540 // Returns the return value of the last callback
5541 // Returns nil if list of callbacks is empty
5542 RUN_CALLBACKS_MODE_LAST,
5543 // If any callback returns a false value, the first such is returned
5544 // Otherwise, the first callback's return value (trueish) is returned
5545 // Returns true if list of callbacks is empty
5546 RUN_CALLBACKS_MODE_AND,
5547 // Like above, but stops calling callbacks (short circuit)
5548 // after seeing the first false value
5549 RUN_CALLBACKS_MODE_AND_SC,
5550 // If any callback returns a true value, the first such is returned
5551 // Otherwise, the first callback's return value (falseish) is returned
5552 // Returns false if list of callbacks is empty
5553 RUN_CALLBACKS_MODE_OR,
5554 // Like above, but stops calling callbacks (short circuit)
5555 // after seeing the first true value
5556 RUN_CALLBACKS_MODE_OR_SC,
5557 // Note: "a true value" and "a false value" refer to values that
5558 // are converted by lua_toboolean to true or false, respectively.
5561 // Push the list of callbacks (a lua table).
5562 // Then push nargs arguments.
5563 // Then call this function, which
5564 // - runs the callbacks
5565 // - removes the table and arguments from the lua stack
5566 // - pushes the return value, computed depending on mode
5567 static void scriptapi_run_callbacks(lua_State *L, int nargs,
5568 RunCallbacksMode mode)
5570 // Insert the return value into the lua stack, below the table
5571 assert(lua_gettop(L) >= nargs + 1);
5573 lua_insert(L, -(nargs + 1) - 1);
5574 // Stack now looks like this:
5575 // ... <return value = nil> <table> <arg#1> <arg#2> ... <arg#n>
5577 int rv = lua_gettop(L) - nargs - 1;
5579 int arg = table + 1;
5581 luaL_checktype(L, table, LUA_TTABLE);
5585 bool first_loop = true;
5586 while(lua_next(L, table) != 0){
5587 // key at index -2 and value at index -1
5588 luaL_checktype(L, -1, LUA_TFUNCTION);
5590 for(int i = 0; i < nargs; i++)
5591 lua_pushvalue(L, arg+i);
5592 if(lua_pcall(L, nargs, 1, 0))
5593 script_error(L, "error: %s", lua_tostring(L, -1));
5595 // Move return value to designated space in stack
5598 // Result of first callback is always moved
5602 // Otherwise, what happens depends on the mode
5603 if(mode == RUN_CALLBACKS_MODE_FIRST)
5605 else if(mode == RUN_CALLBACKS_MODE_LAST)
5607 else if(mode == RUN_CALLBACKS_MODE_AND ||
5608 mode == RUN_CALLBACKS_MODE_AND_SC){
5609 if(lua_toboolean(L, rv) == true &&
5610 lua_toboolean(L, -1) == false)
5615 else if(mode == RUN_CALLBACKS_MODE_OR ||
5616 mode == RUN_CALLBACKS_MODE_OR_SC){
5617 if(lua_toboolean(L, rv) == false &&
5618 lua_toboolean(L, -1) == true)
5627 // Handle short circuit modes
5628 if(mode == RUN_CALLBACKS_MODE_AND_SC &&
5629 lua_toboolean(L, rv) == false)
5631 else if(mode == RUN_CALLBACKS_MODE_OR_SC &&
5632 lua_toboolean(L, rv) == true)
5635 // value removed, keep key for next iteration
5638 // Remove stuff from stack, leaving only the return value
5641 // Fix return value in case no callbacks were called
5643 if(mode == RUN_CALLBACKS_MODE_AND ||
5644 mode == RUN_CALLBACKS_MODE_AND_SC){
5646 lua_pushboolean(L, true);
5648 else if(mode == RUN_CALLBACKS_MODE_OR ||
5649 mode == RUN_CALLBACKS_MODE_OR_SC){
5651 lua_pushboolean(L, false);
5656 bool scriptapi_on_chat_message(lua_State *L, const std::string &name,
5657 const std::string &message)
5660 assert(lua_checkstack(L, 20));
5661 StackUnroller stack_unroller(L);
5663 // Get minetest.registered_on_chat_messages
5664 lua_getglobal(L, "minetest");
5665 lua_getfield(L, -1, "registered_on_chat_messages");
5667 lua_pushstring(L, name.c_str());
5668 lua_pushstring(L, message.c_str());
5669 scriptapi_run_callbacks(L, 2, RUN_CALLBACKS_MODE_OR_SC);
5670 bool ate = lua_toboolean(L, -1);
5674 void scriptapi_on_shutdown(lua_State *L)
5677 assert(lua_checkstack(L, 20));
5678 StackUnroller stack_unroller(L);
5680 // Get registered shutdown hooks
5681 lua_getglobal(L, "minetest");
5682 lua_getfield(L, -1, "registered_on_shutdown");
5684 scriptapi_run_callbacks(L, 0, RUN_CALLBACKS_MODE_FIRST);
5687 void scriptapi_on_newplayer(lua_State *L, ServerActiveObject *player)
5690 assert(lua_checkstack(L, 20));
5691 StackUnroller stack_unroller(L);
5693 // Get minetest.registered_on_newplayers
5694 lua_getglobal(L, "minetest");
5695 lua_getfield(L, -1, "registered_on_newplayers");
5697 objectref_get_or_create(L, player);
5698 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
5701 void scriptapi_on_dieplayer(lua_State *L, ServerActiveObject *player)
5704 assert(lua_checkstack(L, 20));
5705 StackUnroller stack_unroller(L);
5707 // Get minetest.registered_on_dieplayers
5708 lua_getglobal(L, "minetest");
5709 lua_getfield(L, -1, "registered_on_dieplayers");
5711 objectref_get_or_create(L, player);
5712 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
5715 bool scriptapi_on_respawnplayer(lua_State *L, ServerActiveObject *player)
5718 assert(lua_checkstack(L, 20));
5719 StackUnroller stack_unroller(L);
5721 // Get minetest.registered_on_respawnplayers
5722 lua_getglobal(L, "minetest");
5723 lua_getfield(L, -1, "registered_on_respawnplayers");
5725 objectref_get_or_create(L, player);
5726 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_OR);
5727 bool positioning_handled_by_some = lua_toboolean(L, -1);
5728 return positioning_handled_by_some;
5731 void scriptapi_on_joinplayer(lua_State *L, ServerActiveObject *player)
5734 assert(lua_checkstack(L, 20));
5735 StackUnroller stack_unroller(L);
5737 // Get minetest.registered_on_joinplayers
5738 lua_getglobal(L, "minetest");
5739 lua_getfield(L, -1, "registered_on_joinplayers");
5741 objectref_get_or_create(L, player);
5742 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
5745 void scriptapi_on_leaveplayer(lua_State *L, ServerActiveObject *player)
5748 assert(lua_checkstack(L, 20));
5749 StackUnroller stack_unroller(L);
5751 // Get minetest.registered_on_leaveplayers
5752 lua_getglobal(L, "minetest");
5753 lua_getfield(L, -1, "registered_on_leaveplayers");
5755 objectref_get_or_create(L, player);
5756 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
5759 static void get_auth_handler(lua_State *L)
5761 lua_getglobal(L, "minetest");
5762 lua_getfield(L, -1, "registered_auth_handler");
5763 if(lua_isnil(L, -1)){
5765 lua_getfield(L, -1, "builtin_auth_handler");
5767 if(lua_type(L, -1) != LUA_TTABLE)
5768 throw LuaError(L, "Authentication handler table not valid");
5771 bool scriptapi_get_auth(lua_State *L, const std::string &playername,
5772 std::string *dst_password, std::set<std::string> *dst_privs)
5775 assert(lua_checkstack(L, 20));
5776 StackUnroller stack_unroller(L);
5778 get_auth_handler(L);
5779 lua_getfield(L, -1, "get_auth");
5780 if(lua_type(L, -1) != LUA_TFUNCTION)
5781 throw LuaError(L, "Authentication handler missing get_auth");
5782 lua_pushstring(L, playername.c_str());
5783 if(lua_pcall(L, 1, 1, 0))
5784 script_error(L, "error: %s", lua_tostring(L, -1));
5786 // nil = login not allowed
5787 if(lua_isnil(L, -1))
5789 luaL_checktype(L, -1, LUA_TTABLE);
5791 std::string password;
5792 bool found = getstringfield(L, -1, "password", password);
5794 throw LuaError(L, "Authentication handler didn't return password");
5796 *dst_password = password;
5798 lua_getfield(L, -1, "privileges");
5799 if(!lua_istable(L, -1))
5801 "Authentication handler didn't return privilege table");
5803 read_privileges(L, -1, *dst_privs);
5809 void scriptapi_create_auth(lua_State *L, const std::string &playername,
5810 const std::string &password)
5813 assert(lua_checkstack(L, 20));
5814 StackUnroller stack_unroller(L);
5816 get_auth_handler(L);
5817 lua_getfield(L, -1, "create_auth");
5818 if(lua_type(L, -1) != LUA_TFUNCTION)
5819 throw LuaError(L, "Authentication handler missing create_auth");
5820 lua_pushstring(L, playername.c_str());
5821 lua_pushstring(L, password.c_str());
5822 if(lua_pcall(L, 2, 0, 0))
5823 script_error(L, "error: %s", lua_tostring(L, -1));
5826 bool scriptapi_set_password(lua_State *L, const std::string &playername,
5827 const std::string &password)
5830 assert(lua_checkstack(L, 20));
5831 StackUnroller stack_unroller(L);
5833 get_auth_handler(L);
5834 lua_getfield(L, -1, "set_password");
5835 if(lua_type(L, -1) != LUA_TFUNCTION)
5836 throw LuaError(L, "Authentication handler missing set_password");
5837 lua_pushstring(L, playername.c_str());
5838 lua_pushstring(L, password.c_str());
5839 if(lua_pcall(L, 2, 1, 0))
5840 script_error(L, "error: %s", lua_tostring(L, -1));
5841 return lua_toboolean(L, -1);
5848 void scriptapi_on_player_receive_fields(lua_State *L,
5849 ServerActiveObject *player,
5850 const std::string &formname,
5851 const std::map<std::string, std::string> &fields)
5854 assert(lua_checkstack(L, 20));
5855 StackUnroller stack_unroller(L);
5857 // Get minetest.registered_on_chat_messages
5858 lua_getglobal(L, "minetest");
5859 lua_getfield(L, -1, "registered_on_player_receive_fields");
5862 objectref_get_or_create(L, player);
5864 lua_pushstring(L, formname.c_str());
5867 for(std::map<std::string, std::string>::const_iterator
5868 i = fields.begin(); i != fields.end(); i++){
5869 const std::string &name = i->first;
5870 const std::string &value = i->second;
5871 lua_pushstring(L, name.c_str());
5872 lua_pushlstring(L, value.c_str(), value.size());
5873 lua_settable(L, -3);
5875 scriptapi_run_callbacks(L, 3, RUN_CALLBACKS_MODE_OR_SC);
5879 item callbacks and node callbacks
5882 // Retrieves minetest.registered_items[name][callbackname]
5883 // If that is nil or on error, return false and stack is unchanged
5884 // If that is a function, returns true and pushes the
5885 // function onto the stack
5886 // If minetest.registered_items[name] doesn't exist, minetest.nodedef_default
5887 // is tried instead so unknown items can still be manipulated to some degree
5888 static bool get_item_callback(lua_State *L,
5889 const char *name, const char *callbackname)
5891 lua_getglobal(L, "minetest");
5892 lua_getfield(L, -1, "registered_items");
5894 luaL_checktype(L, -1, LUA_TTABLE);
5895 lua_getfield(L, -1, name);
5897 // Should be a table
5898 if(lua_type(L, -1) != LUA_TTABLE)
5900 // Report error and clean up
5901 errorstream<<"Item \""<<name<<"\" not defined"<<std::endl;
5904 // Try minetest.nodedef_default instead
5905 lua_getglobal(L, "minetest");
5906 lua_getfield(L, -1, "nodedef_default");
5908 luaL_checktype(L, -1, LUA_TTABLE);
5910 lua_getfield(L, -1, callbackname);
5912 // Should be a function or nil
5913 if(lua_type(L, -1) == LUA_TFUNCTION)
5917 else if(lua_isnil(L, -1))
5924 errorstream<<"Item \""<<name<<"\" callback \""
5925 <<callbackname<<" is not a function"<<std::endl;
5931 bool scriptapi_item_on_drop(lua_State *L, ItemStack &item,
5932 ServerActiveObject *dropper, v3f pos)
5935 assert(lua_checkstack(L, 20));
5936 StackUnroller stack_unroller(L);
5938 // Push callback function on stack
5939 if(!get_item_callback(L, item.name.c_str(), "on_drop"))
5943 LuaItemStack::create(L, item);
5944 objectref_get_or_create(L, dropper);
5945 pushFloatPos(L, pos);
5946 if(lua_pcall(L, 3, 1, 0))
5947 script_error(L, "error: %s", lua_tostring(L, -1));
5948 if(!lua_isnil(L, -1))
5949 item = read_item(L, -1);
5953 bool scriptapi_item_on_place(lua_State *L, ItemStack &item,
5954 ServerActiveObject *placer, const PointedThing &pointed)
5957 assert(lua_checkstack(L, 20));
5958 StackUnroller stack_unroller(L);
5960 // Push callback function on stack
5961 if(!get_item_callback(L, item.name.c_str(), "on_place"))
5965 LuaItemStack::create(L, item);
5966 objectref_get_or_create(L, placer);
5967 push_pointed_thing(L, pointed);
5968 if(lua_pcall(L, 3, 1, 0))
5969 script_error(L, "error: %s", lua_tostring(L, -1));
5970 if(!lua_isnil(L, -1))
5971 item = read_item(L, -1);
5975 bool scriptapi_item_on_use(lua_State *L, ItemStack &item,
5976 ServerActiveObject *user, const PointedThing &pointed)
5979 assert(lua_checkstack(L, 20));
5980 StackUnroller stack_unroller(L);
5982 // Push callback function on stack
5983 if(!get_item_callback(L, item.name.c_str(), "on_use"))
5987 LuaItemStack::create(L, item);
5988 objectref_get_or_create(L, user);
5989 push_pointed_thing(L, pointed);
5990 if(lua_pcall(L, 3, 1, 0))
5991 script_error(L, "error: %s", lua_tostring(L, -1));
5992 if(!lua_isnil(L, -1))
5993 item = read_item(L, -1);
5997 bool scriptapi_node_on_punch(lua_State *L, v3s16 p, MapNode node,
5998 ServerActiveObject *puncher)
6001 assert(lua_checkstack(L, 20));
6002 StackUnroller stack_unroller(L);
6004 INodeDefManager *ndef = get_server(L)->ndef();
6006 // Push callback function on stack
6007 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_punch"))
6012 pushnode(L, node, ndef);
6013 objectref_get_or_create(L, puncher);
6014 if(lua_pcall(L, 3, 0, 0))
6015 script_error(L, "error: %s", lua_tostring(L, -1));
6019 bool scriptapi_node_on_dig(lua_State *L, v3s16 p, MapNode node,
6020 ServerActiveObject *digger)
6023 assert(lua_checkstack(L, 20));
6024 StackUnroller stack_unroller(L);
6026 INodeDefManager *ndef = get_server(L)->ndef();
6028 // Push callback function on stack
6029 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_dig"))
6034 pushnode(L, node, ndef);
6035 objectref_get_or_create(L, digger);
6036 if(lua_pcall(L, 3, 0, 0))
6037 script_error(L, "error: %s", lua_tostring(L, -1));
6041 void scriptapi_node_on_construct(lua_State *L, v3s16 p, MapNode node)
6044 assert(lua_checkstack(L, 20));
6045 StackUnroller stack_unroller(L);
6047 INodeDefManager *ndef = get_server(L)->ndef();
6049 // Push callback function on stack
6050 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_construct"))
6055 if(lua_pcall(L, 1, 0, 0))
6056 script_error(L, "error: %s", lua_tostring(L, -1));
6059 void scriptapi_node_on_destruct(lua_State *L, v3s16 p, MapNode node)
6062 assert(lua_checkstack(L, 20));
6063 StackUnroller stack_unroller(L);
6065 INodeDefManager *ndef = get_server(L)->ndef();
6067 // Push callback function on stack
6068 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_destruct"))
6073 if(lua_pcall(L, 1, 0, 0))
6074 script_error(L, "error: %s", lua_tostring(L, -1));
6077 void scriptapi_node_after_destruct(lua_State *L, v3s16 p, MapNode node)
6080 assert(lua_checkstack(L, 20));
6081 StackUnroller stack_unroller(L);
6083 INodeDefManager *ndef = get_server(L)->ndef();
6085 // Push callback function on stack
6086 if(!get_item_callback(L, ndef->get(node).name.c_str(), "after_destruct"))
6091 pushnode(L, node, ndef);
6092 if(lua_pcall(L, 2, 0, 0))
6093 script_error(L, "error: %s", lua_tostring(L, -1));
6096 bool scriptapi_node_on_timer(lua_State *L, v3s16 p, MapNode node, f32 dtime)
6099 assert(lua_checkstack(L, 20));
6100 StackUnroller stack_unroller(L);
6102 INodeDefManager *ndef = get_server(L)->ndef();
6104 // Push callback function on stack
6105 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_timer"))
6110 lua_pushnumber(L,dtime);
6111 if(lua_pcall(L, 2, 1, 0))
6112 script_error(L, "error: %s", lua_tostring(L, -1));
6113 if(lua_isboolean(L,-1) && lua_toboolean(L,-1) == true)
6119 void scriptapi_node_on_receive_fields(lua_State *L, v3s16 p,
6120 const std::string &formname,
6121 const std::map<std::string, std::string> &fields,
6122 ServerActiveObject *sender)
6125 assert(lua_checkstack(L, 20));
6126 StackUnroller stack_unroller(L);
6128 INodeDefManager *ndef = get_server(L)->ndef();
6130 // If node doesn't exist, we don't know what callback to call
6131 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6132 if(node.getContent() == CONTENT_IGNORE)
6135 // Push callback function on stack
6136 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_receive_fields"))
6143 lua_pushstring(L, formname.c_str());
6146 for(std::map<std::string, std::string>::const_iterator
6147 i = fields.begin(); i != fields.end(); i++){
6148 const std::string &name = i->first;
6149 const std::string &value = i->second;
6150 lua_pushstring(L, name.c_str());
6151 lua_pushlstring(L, value.c_str(), value.size());
6152 lua_settable(L, -3);
6155 objectref_get_or_create(L, sender);
6156 if(lua_pcall(L, 4, 0, 0))
6157 script_error(L, "error: %s", lua_tostring(L, -1));
6161 Node metadata inventory callbacks
6164 // Return number of accepted items to be moved
6165 int scriptapi_nodemeta_inventory_allow_move(lua_State *L, v3s16 p,
6166 const std::string &from_list, int from_index,
6167 const std::string &to_list, int to_index,
6168 int count, ServerActiveObject *player)
6171 assert(lua_checkstack(L, 20));
6172 StackUnroller stack_unroller(L);
6174 INodeDefManager *ndef = get_server(L)->ndef();
6176 // If node doesn't exist, we don't know what callback to call
6177 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6178 if(node.getContent() == CONTENT_IGNORE)
6181 // Push callback function on stack
6182 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6183 "allow_metadata_inventory_move"))
6186 // function(pos, from_list, from_index, to_list, to_index, count, player)
6190 lua_pushstring(L, from_list.c_str());
6192 lua_pushinteger(L, from_index + 1);
6194 lua_pushstring(L, to_list.c_str());
6196 lua_pushinteger(L, to_index + 1);
6198 lua_pushinteger(L, count);
6200 objectref_get_or_create(L, player);
6201 if(lua_pcall(L, 7, 1, 0))
6202 script_error(L, "error: %s", lua_tostring(L, -1));
6203 if(!lua_isnumber(L, -1))
6204 throw LuaError(L, "allow_metadata_inventory_move should return a number");
6205 return luaL_checkinteger(L, -1);
6208 // Return number of accepted items to be put
6209 int scriptapi_nodemeta_inventory_allow_put(lua_State *L, v3s16 p,
6210 const std::string &listname, int index, ItemStack &stack,
6211 ServerActiveObject *player)
6214 assert(lua_checkstack(L, 20));
6215 StackUnroller stack_unroller(L);
6217 INodeDefManager *ndef = get_server(L)->ndef();
6219 // If node doesn't exist, we don't know what callback to call
6220 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6221 if(node.getContent() == CONTENT_IGNORE)
6224 // Push callback function on stack
6225 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6226 "allow_metadata_inventory_put"))
6229 // Call function(pos, listname, index, stack, player)
6233 lua_pushstring(L, listname.c_str());
6235 lua_pushinteger(L, index + 1);
6237 LuaItemStack::create(L, stack);
6239 objectref_get_or_create(L, player);
6240 if(lua_pcall(L, 5, 1, 0))
6241 script_error(L, "error: %s", lua_tostring(L, -1));
6242 if(!lua_isnumber(L, -1))
6243 throw LuaError(L, "allow_metadata_inventory_put should return a number");
6244 return luaL_checkinteger(L, -1);
6247 // Return number of accepted items to be taken
6248 int scriptapi_nodemeta_inventory_allow_take(lua_State *L, v3s16 p,
6249 const std::string &listname, int index, ItemStack &stack,
6250 ServerActiveObject *player)
6253 assert(lua_checkstack(L, 20));
6254 StackUnroller stack_unroller(L);
6256 INodeDefManager *ndef = get_server(L)->ndef();
6258 // If node doesn't exist, we don't know what callback to call
6259 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6260 if(node.getContent() == CONTENT_IGNORE)
6263 // Push callback function on stack
6264 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6265 "allow_metadata_inventory_take"))
6268 // Call function(pos, listname, index, count, player)
6272 lua_pushstring(L, listname.c_str());
6274 lua_pushinteger(L, index + 1);
6276 LuaItemStack::create(L, stack);
6278 objectref_get_or_create(L, player);
6279 if(lua_pcall(L, 5, 1, 0))
6280 script_error(L, "error: %s", lua_tostring(L, -1));
6281 if(!lua_isnumber(L, -1))
6282 throw LuaError(L, "allow_metadata_inventory_take should return a number");
6283 return luaL_checkinteger(L, -1);
6286 // Report moved items
6287 void scriptapi_nodemeta_inventory_on_move(lua_State *L, v3s16 p,
6288 const std::string &from_list, int from_index,
6289 const std::string &to_list, int to_index,
6290 int count, ServerActiveObject *player)
6293 assert(lua_checkstack(L, 20));
6294 StackUnroller stack_unroller(L);
6296 INodeDefManager *ndef = get_server(L)->ndef();
6298 // If node doesn't exist, we don't know what callback to call
6299 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6300 if(node.getContent() == CONTENT_IGNORE)
6303 // Push callback function on stack
6304 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6305 "on_metadata_inventory_move"))
6308 // function(pos, from_list, from_index, to_list, to_index, count, player)
6312 lua_pushstring(L, from_list.c_str());
6314 lua_pushinteger(L, from_index + 1);
6316 lua_pushstring(L, to_list.c_str());
6318 lua_pushinteger(L, to_index + 1);
6320 lua_pushinteger(L, count);
6322 objectref_get_or_create(L, player);
6323 if(lua_pcall(L, 7, 0, 0))
6324 script_error(L, "error: %s", lua_tostring(L, -1));
6328 void scriptapi_nodemeta_inventory_on_put(lua_State *L, v3s16 p,
6329 const std::string &listname, int index, ItemStack &stack,
6330 ServerActiveObject *player)
6333 assert(lua_checkstack(L, 20));
6334 StackUnroller stack_unroller(L);
6336 INodeDefManager *ndef = get_server(L)->ndef();
6338 // If node doesn't exist, we don't know what callback to call
6339 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6340 if(node.getContent() == CONTENT_IGNORE)
6343 // Push callback function on stack
6344 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6345 "on_metadata_inventory_put"))
6348 // Call function(pos, listname, index, stack, player)
6352 lua_pushstring(L, listname.c_str());
6354 lua_pushinteger(L, index + 1);
6356 LuaItemStack::create(L, stack);
6358 objectref_get_or_create(L, player);
6359 if(lua_pcall(L, 5, 0, 0))
6360 script_error(L, "error: %s", lua_tostring(L, -1));
6363 // Report taken items
6364 void scriptapi_nodemeta_inventory_on_take(lua_State *L, v3s16 p,
6365 const std::string &listname, int index, ItemStack &stack,
6366 ServerActiveObject *player)
6369 assert(lua_checkstack(L, 20));
6370 StackUnroller stack_unroller(L);
6372 INodeDefManager *ndef = get_server(L)->ndef();
6374 // If node doesn't exist, we don't know what callback to call
6375 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
6376 if(node.getContent() == CONTENT_IGNORE)
6379 // Push callback function on stack
6380 if(!get_item_callback(L, ndef->get(node).name.c_str(),
6381 "on_metadata_inventory_take"))
6384 // Call function(pos, listname, index, stack, player)
6388 lua_pushstring(L, listname.c_str());
6390 lua_pushinteger(L, index + 1);
6392 LuaItemStack::create(L, stack);
6394 objectref_get_or_create(L, player);
6395 if(lua_pcall(L, 5, 0, 0))
6396 script_error(L, "error: %s", lua_tostring(L, -1));
6400 Detached inventory callbacks
6403 // Retrieves minetest.detached_inventories[name][callbackname]
6404 // If that is nil or on error, return false and stack is unchanged
6405 // If that is a function, returns true and pushes the
6406 // function onto the stack
6407 static bool get_detached_inventory_callback(lua_State *L,
6408 const std::string &name, const char *callbackname)
6410 lua_getglobal(L, "minetest");
6411 lua_getfield(L, -1, "detached_inventories");
6413 luaL_checktype(L, -1, LUA_TTABLE);
6414 lua_getfield(L, -1, name.c_str());
6416 // Should be a table
6417 if(lua_type(L, -1) != LUA_TTABLE)
6419 errorstream<<"Item \""<<name<<"\" not defined"<<std::endl;
6423 lua_getfield(L, -1, callbackname);
6425 // Should be a function or nil
6426 if(lua_type(L, -1) == LUA_TFUNCTION)
6430 else if(lua_isnil(L, -1))
6437 errorstream<<"Detached inventory \""<<name<<"\" callback \""
6438 <<callbackname<<"\" is not a function"<<std::endl;
6444 // Return number of accepted items to be moved
6445 int scriptapi_detached_inventory_allow_move(lua_State *L,
6446 const std::string &name,
6447 const std::string &from_list, int from_index,
6448 const std::string &to_list, int to_index,
6449 int count, ServerActiveObject *player)
6452 assert(lua_checkstack(L, 20));
6453 StackUnroller stack_unroller(L);
6455 // Push callback function on stack
6456 if(!get_detached_inventory_callback(L, name, "allow_move"))
6459 // function(inv, from_list, from_index, to_list, to_index, count, player)
6461 InventoryLocation loc;
6462 loc.setDetached(name);
6463 InvRef::create(L, loc);
6465 lua_pushstring(L, from_list.c_str());
6467 lua_pushinteger(L, from_index + 1);
6469 lua_pushstring(L, to_list.c_str());
6471 lua_pushinteger(L, to_index + 1);
6473 lua_pushinteger(L, count);
6475 objectref_get_or_create(L, player);
6476 if(lua_pcall(L, 7, 1, 0))
6477 script_error(L, "error: %s", lua_tostring(L, -1));
6478 if(!lua_isnumber(L, -1))
6479 throw LuaError(L, "allow_move should return a number");
6480 return luaL_checkinteger(L, -1);
6483 // Return number of accepted items to be put
6484 int scriptapi_detached_inventory_allow_put(lua_State *L,
6485 const std::string &name,
6486 const std::string &listname, int index, ItemStack &stack,
6487 ServerActiveObject *player)
6490 assert(lua_checkstack(L, 20));
6491 StackUnroller stack_unroller(L);
6493 // Push callback function on stack
6494 if(!get_detached_inventory_callback(L, name, "allow_put"))
6495 return stack.count; // All will be accepted
6497 // Call function(inv, listname, index, stack, player)
6499 InventoryLocation loc;
6500 loc.setDetached(name);
6501 InvRef::create(L, loc);
6503 lua_pushstring(L, listname.c_str());
6505 lua_pushinteger(L, index + 1);
6507 LuaItemStack::create(L, stack);
6509 objectref_get_or_create(L, player);
6510 if(lua_pcall(L, 5, 1, 0))
6511 script_error(L, "error: %s", lua_tostring(L, -1));
6512 if(!lua_isnumber(L, -1))
6513 throw LuaError(L, "allow_put should return a number");
6514 return luaL_checkinteger(L, -1);
6517 // Return number of accepted items to be taken
6518 int scriptapi_detached_inventory_allow_take(lua_State *L,
6519 const std::string &name,
6520 const std::string &listname, int index, ItemStack &stack,
6521 ServerActiveObject *player)
6524 assert(lua_checkstack(L, 20));
6525 StackUnroller stack_unroller(L);
6527 // Push callback function on stack
6528 if(!get_detached_inventory_callback(L, name, "allow_take"))
6529 return stack.count; // All will be accepted
6531 // Call function(inv, listname, index, stack, player)
6533 InventoryLocation loc;
6534 loc.setDetached(name);
6535 InvRef::create(L, loc);
6537 lua_pushstring(L, listname.c_str());
6539 lua_pushinteger(L, index + 1);
6541 LuaItemStack::create(L, stack);
6543 objectref_get_or_create(L, player);
6544 if(lua_pcall(L, 5, 1, 0))
6545 script_error(L, "error: %s", lua_tostring(L, -1));
6546 if(!lua_isnumber(L, -1))
6547 throw LuaError(L, "allow_take should return a number");
6548 return luaL_checkinteger(L, -1);
6551 // Report moved items
6552 void scriptapi_detached_inventory_on_move(lua_State *L,
6553 const std::string &name,
6554 const std::string &from_list, int from_index,
6555 const std::string &to_list, int to_index,
6556 int count, ServerActiveObject *player)
6559 assert(lua_checkstack(L, 20));
6560 StackUnroller stack_unroller(L);
6562 // Push callback function on stack
6563 if(!get_detached_inventory_callback(L, name, "on_move"))
6566 // function(inv, from_list, from_index, to_list, to_index, count, player)
6568 InventoryLocation loc;
6569 loc.setDetached(name);
6570 InvRef::create(L, loc);
6572 lua_pushstring(L, from_list.c_str());
6574 lua_pushinteger(L, from_index + 1);
6576 lua_pushstring(L, to_list.c_str());
6578 lua_pushinteger(L, to_index + 1);
6580 lua_pushinteger(L, count);
6582 objectref_get_or_create(L, player);
6583 if(lua_pcall(L, 7, 0, 0))
6584 script_error(L, "error: %s", lua_tostring(L, -1));
6588 void scriptapi_detached_inventory_on_put(lua_State *L,
6589 const std::string &name,
6590 const std::string &listname, int index, ItemStack &stack,
6591 ServerActiveObject *player)
6594 assert(lua_checkstack(L, 20));
6595 StackUnroller stack_unroller(L);
6597 // Push callback function on stack
6598 if(!get_detached_inventory_callback(L, name, "on_put"))
6601 // Call function(inv, listname, index, stack, player)
6603 InventoryLocation loc;
6604 loc.setDetached(name);
6605 InvRef::create(L, loc);
6607 lua_pushstring(L, listname.c_str());
6609 lua_pushinteger(L, index + 1);
6611 LuaItemStack::create(L, stack);
6613 objectref_get_or_create(L, player);
6614 if(lua_pcall(L, 5, 0, 0))
6615 script_error(L, "error: %s", lua_tostring(L, -1));
6618 // Report taken items
6619 void scriptapi_detached_inventory_on_take(lua_State *L,
6620 const std::string &name,
6621 const std::string &listname, int index, ItemStack &stack,
6622 ServerActiveObject *player)
6625 assert(lua_checkstack(L, 20));
6626 StackUnroller stack_unroller(L);
6628 // Push callback function on stack
6629 if(!get_detached_inventory_callback(L, name, "on_take"))
6632 // Call function(inv, listname, index, stack, player)
6634 InventoryLocation loc;
6635 loc.setDetached(name);
6636 InvRef::create(L, loc);
6638 lua_pushstring(L, listname.c_str());
6640 lua_pushinteger(L, index + 1);
6642 LuaItemStack::create(L, stack);
6644 objectref_get_or_create(L, player);
6645 if(lua_pcall(L, 5, 0, 0))
6646 script_error(L, "error: %s", lua_tostring(L, -1));
6653 void scriptapi_environment_step(lua_State *L, float dtime)
6656 assert(lua_checkstack(L, 20));
6657 //infostream<<"scriptapi_environment_step"<<std::endl;
6658 StackUnroller stack_unroller(L);
6660 // Get minetest.registered_globalsteps
6661 lua_getglobal(L, "minetest");
6662 lua_getfield(L, -1, "registered_globalsteps");
6664 lua_pushnumber(L, dtime);
6665 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
6668 void scriptapi_environment_on_generated(lua_State *L, v3s16 minp, v3s16 maxp,
6672 assert(lua_checkstack(L, 20));
6673 //infostream<<"scriptapi_environment_on_generated"<<std::endl;
6674 StackUnroller stack_unroller(L);
6676 // Get minetest.registered_on_generateds
6677 lua_getglobal(L, "minetest");
6678 lua_getfield(L, -1, "registered_on_generateds");
6680 push_v3s16(L, minp);
6681 push_v3s16(L, maxp);
6682 lua_pushnumber(L, blockseed);
6683 scriptapi_run_callbacks(L, 3, RUN_CALLBACKS_MODE_FIRST);
6690 bool scriptapi_luaentity_add(lua_State *L, u16 id, const char *name)
6693 assert(lua_checkstack(L, 20));
6694 verbosestream<<"scriptapi_luaentity_add: id="<<id<<" name=\""
6695 <<name<<"\""<<std::endl;
6696 StackUnroller stack_unroller(L);
6698 // Get minetest.registered_entities[name]
6699 lua_getglobal(L, "minetest");
6700 lua_getfield(L, -1, "registered_entities");
6701 luaL_checktype(L, -1, LUA_TTABLE);
6702 lua_pushstring(L, name);
6703 lua_gettable(L, -2);
6704 // Should be a table, which we will use as a prototype
6705 //luaL_checktype(L, -1, LUA_TTABLE);
6706 if(lua_type(L, -1) != LUA_TTABLE){
6707 errorstream<<"LuaEntity name \""<<name<<"\" not defined"<<std::endl;
6710 int prototype_table = lua_gettop(L);
6711 //dump2(L, "prototype_table");
6713 // Create entity object
6715 int object = lua_gettop(L);
6717 // Set object metatable
6718 lua_pushvalue(L, prototype_table);
6719 lua_setmetatable(L, -2);
6721 // Add object reference
6722 // This should be userdata with metatable ObjectRef
6723 objectref_get(L, id);
6724 luaL_checktype(L, -1, LUA_TUSERDATA);
6725 if(!luaL_checkudata(L, -1, "ObjectRef"))
6726 luaL_typerror(L, -1, "ObjectRef");
6727 lua_setfield(L, -2, "object");
6729 // minetest.luaentities[id] = object
6730 lua_getglobal(L, "minetest");
6731 lua_getfield(L, -1, "luaentities");
6732 luaL_checktype(L, -1, LUA_TTABLE);
6733 lua_pushnumber(L, id); // Push id
6734 lua_pushvalue(L, object); // Copy object to top of stack
6735 lua_settable(L, -3);
6740 void scriptapi_luaentity_activate(lua_State *L, u16 id,
6741 const std::string &staticdata, u32 dtime_s)
6744 assert(lua_checkstack(L, 20));
6745 verbosestream<<"scriptapi_luaentity_activate: id="<<id<<std::endl;
6746 StackUnroller stack_unroller(L);
6748 // Get minetest.luaentities[id]
6749 luaentity_get(L, id);
6750 int object = lua_gettop(L);
6752 // Get on_activate function
6753 lua_pushvalue(L, object);
6754 lua_getfield(L, -1, "on_activate");
6755 if(!lua_isnil(L, -1)){
6756 luaL_checktype(L, -1, LUA_TFUNCTION);
6757 lua_pushvalue(L, object); // self
6758 lua_pushlstring(L, staticdata.c_str(), staticdata.size());
6759 lua_pushinteger(L, dtime_s);
6760 // Call with 3 arguments, 0 results
6761 if(lua_pcall(L, 3, 0, 0))
6762 script_error(L, "error running function on_activate: %s\n",
6763 lua_tostring(L, -1));
6767 void scriptapi_luaentity_rm(lua_State *L, u16 id)
6770 assert(lua_checkstack(L, 20));
6771 verbosestream<<"scriptapi_luaentity_rm: id="<<id<<std::endl;
6773 // Get minetest.luaentities table
6774 lua_getglobal(L, "minetest");
6775 lua_getfield(L, -1, "luaentities");
6776 luaL_checktype(L, -1, LUA_TTABLE);
6777 int objectstable = lua_gettop(L);
6779 // Set luaentities[id] = nil
6780 lua_pushnumber(L, id); // Push id
6782 lua_settable(L, objectstable);
6784 lua_pop(L, 2); // pop luaentities, minetest
6787 std::string scriptapi_luaentity_get_staticdata(lua_State *L, u16 id)
6790 assert(lua_checkstack(L, 20));
6791 //infostream<<"scriptapi_luaentity_get_staticdata: id="<<id<<std::endl;
6792 StackUnroller stack_unroller(L);
6794 // Get minetest.luaentities[id]
6795 luaentity_get(L, id);
6796 int object = lua_gettop(L);
6798 // Get get_staticdata function
6799 lua_pushvalue(L, object);
6800 lua_getfield(L, -1, "get_staticdata");
6801 if(lua_isnil(L, -1))
6804 luaL_checktype(L, -1, LUA_TFUNCTION);
6805 lua_pushvalue(L, object); // self
6806 // Call with 1 arguments, 1 results
6807 if(lua_pcall(L, 1, 1, 0))
6808 script_error(L, "error running function get_staticdata: %s\n",
6809 lua_tostring(L, -1));
6812 const char *s = lua_tolstring(L, -1, &len);
6813 return std::string(s, len);
6816 void scriptapi_luaentity_get_properties(lua_State *L, u16 id,
6817 ObjectProperties *prop)
6820 assert(lua_checkstack(L, 20));
6821 //infostream<<"scriptapi_luaentity_get_properties: id="<<id<<std::endl;
6822 StackUnroller stack_unroller(L);
6824 // Get minetest.luaentities[id]
6825 luaentity_get(L, id);
6826 //int object = lua_gettop(L);
6828 // Set default values that differ from ObjectProperties defaults
6833 prop->hp_max = getintfield_default(L, -1, "hp_max", 10);
6835 getboolfield(L, -1, "physical", prop->physical);
6837 getfloatfield(L, -1, "weight", prop->weight);
6839 lua_getfield(L, -1, "collisionbox");
6840 if(lua_istable(L, -1))
6841 prop->collisionbox = read_aabb3f(L, -1, 1.0);
6844 getstringfield(L, -1, "visual", prop->visual);
6846 getstringfield(L, -1, "mesh", prop->mesh);
6848 // Deprecated: read object properties directly
6849 read_object_properties(L, -1, prop);
6851 // Read initial_properties
6852 lua_getfield(L, -1, "initial_properties");
6853 read_object_properties(L, -1, prop);
6857 void scriptapi_luaentity_step(lua_State *L, u16 id, float dtime)
6860 assert(lua_checkstack(L, 20));
6861 //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
6862 StackUnroller stack_unroller(L);
6864 // Get minetest.luaentities[id]
6865 luaentity_get(L, id);
6866 int object = lua_gettop(L);
6867 // State: object is at top of stack
6868 // Get step function
6869 lua_getfield(L, -1, "on_step");
6870 if(lua_isnil(L, -1))
6872 luaL_checktype(L, -1, LUA_TFUNCTION);
6873 lua_pushvalue(L, object); // self
6874 lua_pushnumber(L, dtime); // dtime
6875 // Call with 2 arguments, 0 results
6876 if(lua_pcall(L, 2, 0, 0))
6877 script_error(L, "error running function 'on_step': %s\n", lua_tostring(L, -1));
6880 // Calls entity:on_punch(ObjectRef puncher, time_from_last_punch,
6881 // tool_capabilities, direction)
6882 void scriptapi_luaentity_punch(lua_State *L, u16 id,
6883 ServerActiveObject *puncher, float time_from_last_punch,
6884 const ToolCapabilities *toolcap, v3f dir)
6887 assert(lua_checkstack(L, 20));
6888 //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
6889 StackUnroller stack_unroller(L);
6891 // Get minetest.luaentities[id]
6892 luaentity_get(L, id);
6893 int object = lua_gettop(L);
6894 // State: object is at top of stack
6896 lua_getfield(L, -1, "on_punch");
6897 if(lua_isnil(L, -1))
6899 luaL_checktype(L, -1, LUA_TFUNCTION);
6900 lua_pushvalue(L, object); // self
6901 objectref_get_or_create(L, puncher); // Clicker reference
6902 lua_pushnumber(L, time_from_last_punch);
6903 push_tool_capabilities(L, *toolcap);
6905 // Call with 5 arguments, 0 results
6906 if(lua_pcall(L, 5, 0, 0))
6907 script_error(L, "error running function 'on_punch': %s\n", lua_tostring(L, -1));
6910 // Calls entity:on_rightclick(ObjectRef clicker)
6911 void scriptapi_luaentity_rightclick(lua_State *L, u16 id,
6912 ServerActiveObject *clicker)
6915 assert(lua_checkstack(L, 20));
6916 //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
6917 StackUnroller stack_unroller(L);
6919 // Get minetest.luaentities[id]
6920 luaentity_get(L, id);
6921 int object = lua_gettop(L);
6922 // State: object is at top of stack
6924 lua_getfield(L, -1, "on_rightclick");
6925 if(lua_isnil(L, -1))
6927 luaL_checktype(L, -1, LUA_TFUNCTION);
6928 lua_pushvalue(L, object); // self
6929 objectref_get_or_create(L, clicker); // Clicker reference
6930 // Call with 2 arguments, 0 results
6931 if(lua_pcall(L, 2, 0, 0))
6932 script_error(L, "error running function 'on_rightclick': %s\n", lua_tostring(L, -1));