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 General Public License as published by
7 the Free Software Foundation; either version 2 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 General Public License for more details.
15 You should have received a copy of the GNU 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"
48 #include "daynightratio.h"
49 #include "noise.h" // PseudoRandom for LuaPseudoRandom
51 static void stackDump(lua_State *L, std::ostream &o)
54 int top = lua_gettop(L);
55 for (i = 1; i <= top; i++) { /* repeat for each level */
56 int t = lua_type(L, i);
59 case LUA_TSTRING: /* strings */
60 o<<"\""<<lua_tostring(L, i)<<"\"";
63 case LUA_TBOOLEAN: /* booleans */
64 o<<(lua_toboolean(L, i) ? "true" : "false");
67 case LUA_TNUMBER: /* numbers */ {
69 snprintf(buf, 10, "%g", lua_tonumber(L, i));
73 default: /* other values */
74 o<<lua_typename(L, t);
83 static void realitycheck(lua_State *L)
85 int top = lua_gettop(L);
87 dstream<<"Stack is over 30:"<<std::endl;
88 stackDump(L, dstream);
89 script_error(L, "Stack is over 30 (reality check)");
99 StackUnroller(lua_State *L):
103 m_original_top = lua_gettop(m_lua); // store stack height
107 lua_settop(m_lua, m_original_top); // restore stack height
116 ModNameStorer(lua_State *L_, const std::string modname):
119 // Store current modname in registry
120 lua_pushstring(L, modname.c_str());
121 lua_setfield(L, LUA_REGISTRYINDEX, "minetest_current_modname");
125 // Clear current modname in registry
127 lua_setfield(L, LUA_REGISTRYINDEX, "minetest_current_modname");
132 Getters for stuff in main tables
135 static Server* get_server(lua_State *L)
137 // Get server from registry
138 lua_getfield(L, LUA_REGISTRYINDEX, "minetest_server");
139 Server *server = (Server*)lua_touserdata(L, -1);
144 static ServerEnvironment* get_env(lua_State *L)
146 // Get environment from registry
147 lua_getfield(L, LUA_REGISTRYINDEX, "minetest_env");
148 ServerEnvironment *env = (ServerEnvironment*)lua_touserdata(L, -1);
153 static void objectref_get(lua_State *L, u16 id)
155 // Get minetest.object_refs[i]
156 lua_getglobal(L, "minetest");
157 lua_getfield(L, -1, "object_refs");
158 luaL_checktype(L, -1, LUA_TTABLE);
159 lua_pushnumber(L, id);
161 lua_remove(L, -2); // object_refs
162 lua_remove(L, -2); // minetest
165 static void luaentity_get(lua_State *L, u16 id)
167 // Get minetest.luaentities[i]
168 lua_getglobal(L, "minetest");
169 lua_getfield(L, -1, "luaentities");
170 luaL_checktype(L, -1, LUA_TTABLE);
171 lua_pushnumber(L, id);
173 lua_remove(L, -2); // luaentities
174 lua_remove(L, -2); // minetest
181 static bool getstringfield(lua_State *L, int table,
182 const char *fieldname, std::string &result)
184 lua_getfield(L, table, fieldname);
186 if(lua_isstring(L, -1)){
188 const char *ptr = lua_tolstring(L, -1, &len);
189 result.assign(ptr, len);
196 static bool getintfield(lua_State *L, int table,
197 const char *fieldname, int &result)
199 lua_getfield(L, table, fieldname);
201 if(lua_isnumber(L, -1)){
202 result = lua_tonumber(L, -1);
209 static bool getfloatfield(lua_State *L, int table,
210 const char *fieldname, float &result)
212 lua_getfield(L, table, fieldname);
214 if(lua_isnumber(L, -1)){
215 result = lua_tonumber(L, -1);
222 static bool getboolfield(lua_State *L, int table,
223 const char *fieldname, bool &result)
225 lua_getfield(L, table, fieldname);
227 if(lua_isboolean(L, -1)){
228 result = lua_toboolean(L, -1);
235 static std::string checkstringfield(lua_State *L, int table,
236 const char *fieldname)
238 lua_getfield(L, table, fieldname);
239 std::string s = luaL_checkstring(L, -1);
244 static std::string getstringfield_default(lua_State *L, int table,
245 const char *fieldname, const std::string &default_)
247 std::string result = default_;
248 getstringfield(L, table, fieldname, result);
252 static int getintfield_default(lua_State *L, int table,
253 const char *fieldname, int default_)
255 int result = default_;
256 getintfield(L, table, fieldname, result);
260 static float getfloatfield_default(lua_State *L, int table,
261 const char *fieldname, float default_)
263 float result = default_;
264 getfloatfield(L, table, fieldname, result);
268 static bool getboolfield_default(lua_State *L, int table,
269 const char *fieldname, bool default_)
271 bool result = default_;
272 getboolfield(L, table, fieldname, result);
282 static bool string_to_enum(const EnumString *spec, int &result,
283 const std::string &str)
285 const EnumString *esp = spec;
287 if(str == std::string(esp->str)){
296 /*static bool enum_to_string(const EnumString *spec, std::string &result,
299 const EnumString *esp = spec;
310 static int getenumfield(lua_State *L, int table,
311 const char *fieldname, const EnumString *spec, int default_)
313 int result = default_;
314 string_to_enum(spec, result,
315 getstringfield_default(L, table, fieldname, ""));
319 static void setintfield(lua_State *L, int table,
320 const char *fieldname, int value)
322 lua_pushinteger(L, value);
325 lua_setfield(L, table, fieldname);
328 static void setfloatfield(lua_State *L, int table,
329 const char *fieldname, float value)
331 lua_pushnumber(L, value);
334 lua_setfield(L, table, fieldname);
337 static void setboolfield(lua_State *L, int table,
338 const char *fieldname, bool value)
340 lua_pushboolean(L, value);
343 lua_setfield(L, table, fieldname);
346 static void warn_if_field_exists(lua_State *L, int table,
347 const char *fieldname, const std::string &message)
349 lua_getfield(L, table, fieldname);
350 if(!lua_isnil(L, -1)){
351 infostream<<script_get_backtrace(L)<<std::endl;
352 infostream<<"WARNING: field \""<<fieldname<<"\": "
353 <<message<<std::endl;
359 EnumString definitions
362 struct EnumString es_ItemType[] =
366 {ITEM_CRAFT, "craft"},
371 struct EnumString es_DrawType[] =
373 {NDT_NORMAL, "normal"},
374 {NDT_AIRLIKE, "airlike"},
375 {NDT_LIQUID, "liquid"},
376 {NDT_FLOWINGLIQUID, "flowingliquid"},
377 {NDT_GLASSLIKE, "glasslike"},
378 {NDT_ALLFACES, "allfaces"},
379 {NDT_ALLFACES_OPTIONAL, "allfaces_optional"},
380 {NDT_TORCHLIKE, "torchlike"},
381 {NDT_SIGNLIKE, "signlike"},
382 {NDT_PLANTLIKE, "plantlike"},
383 {NDT_FENCELIKE, "fencelike"},
384 {NDT_RAILLIKE, "raillike"},
388 struct EnumString es_ContentParamType[] =
391 {CPT_LIGHT, "light"},
395 struct EnumString es_ContentParamType2[] =
399 {CPT2_FLOWINGLIQUID, "flowingliquid"},
400 {CPT2_FACEDIR, "facedir"},
401 {CPT2_WALLMOUNTED, "wallmounted"},
405 struct EnumString es_LiquidType[] =
407 {LIQUID_NONE, "none"},
408 {LIQUID_FLOWING, "flowing"},
409 {LIQUID_SOURCE, "source"},
413 struct EnumString es_NodeBoxType[] =
415 {NODEBOX_REGULAR, "regular"},
416 {NODEBOX_FIXED, "fixed"},
417 {NODEBOX_WALLMOUNTED, "wallmounted"},
421 struct EnumString es_CraftMethod[] =
423 {CRAFT_METHOD_NORMAL, "normal"},
424 {CRAFT_METHOD_COOKING, "cooking"},
425 {CRAFT_METHOD_FUEL, "fuel"},
430 C struct <-> Lua table converter functions
433 static void push_v3f(lua_State *L, v3f p)
436 lua_pushnumber(L, p.X);
437 lua_setfield(L, -2, "x");
438 lua_pushnumber(L, p.Y);
439 lua_setfield(L, -2, "y");
440 lua_pushnumber(L, p.Z);
441 lua_setfield(L, -2, "z");
444 static v2s16 read_v2s16(lua_State *L, int index)
447 luaL_checktype(L, index, LUA_TTABLE);
448 lua_getfield(L, index, "x");
449 p.X = lua_tonumber(L, -1);
451 lua_getfield(L, index, "y");
452 p.Y = lua_tonumber(L, -1);
457 static v2f read_v2f(lua_State *L, int index)
460 luaL_checktype(L, index, LUA_TTABLE);
461 lua_getfield(L, index, "x");
462 p.X = lua_tonumber(L, -1);
464 lua_getfield(L, index, "y");
465 p.Y = lua_tonumber(L, -1);
470 static v3f read_v3f(lua_State *L, int index)
473 luaL_checktype(L, index, LUA_TTABLE);
474 lua_getfield(L, index, "x");
475 pos.X = lua_tonumber(L, -1);
477 lua_getfield(L, index, "y");
478 pos.Y = lua_tonumber(L, -1);
480 lua_getfield(L, index, "z");
481 pos.Z = lua_tonumber(L, -1);
486 static v3f check_v3f(lua_State *L, int index)
489 luaL_checktype(L, index, LUA_TTABLE);
490 lua_getfield(L, index, "x");
491 pos.X = luaL_checknumber(L, -1);
493 lua_getfield(L, index, "y");
494 pos.Y = luaL_checknumber(L, -1);
496 lua_getfield(L, index, "z");
497 pos.Z = luaL_checknumber(L, -1);
502 static void pushFloatPos(lua_State *L, v3f p)
508 static v3f checkFloatPos(lua_State *L, int index)
510 return check_v3f(L, index) * BS;
513 static void push_v3s16(lua_State *L, v3s16 p)
516 lua_pushnumber(L, p.X);
517 lua_setfield(L, -2, "x");
518 lua_pushnumber(L, p.Y);
519 lua_setfield(L, -2, "y");
520 lua_pushnumber(L, p.Z);
521 lua_setfield(L, -2, "z");
524 static v3s16 read_v3s16(lua_State *L, int index)
526 // Correct rounding at <0
527 v3f pf = read_v3f(L, index);
528 return floatToInt(pf, 1.0);
531 static v3s16 check_v3s16(lua_State *L, int index)
533 // Correct rounding at <0
534 v3f pf = check_v3f(L, index);
535 return floatToInt(pf, 1.0);
538 static void pushnode(lua_State *L, const MapNode &n, INodeDefManager *ndef)
541 lua_pushstring(L, ndef->get(n).name.c_str());
542 lua_setfield(L, -2, "name");
543 lua_pushnumber(L, n.getParam1());
544 lua_setfield(L, -2, "param1");
545 lua_pushnumber(L, n.getParam2());
546 lua_setfield(L, -2, "param2");
549 static MapNode readnode(lua_State *L, int index, INodeDefManager *ndef)
551 lua_getfield(L, index, "name");
552 const char *name = luaL_checkstring(L, -1);
555 lua_getfield(L, index, "param1");
559 param1 = lua_tonumber(L, -1);
562 lua_getfield(L, index, "param2");
566 param2 = lua_tonumber(L, -1);
568 return MapNode(ndef, name, param1, param2);
571 static video::SColor readARGB8(lua_State *L, int index)
574 luaL_checktype(L, index, LUA_TTABLE);
575 lua_getfield(L, index, "a");
576 if(lua_isnumber(L, -1))
577 color.setAlpha(lua_tonumber(L, -1));
579 lua_getfield(L, index, "r");
580 color.setRed(lua_tonumber(L, -1));
582 lua_getfield(L, index, "g");
583 color.setGreen(lua_tonumber(L, -1));
585 lua_getfield(L, index, "b");
586 color.setBlue(lua_tonumber(L, -1));
591 static core::aabbox3d<f32> read_aabbox3df32(lua_State *L, int index, f32 scale)
593 core::aabbox3d<f32> box;
594 if(lua_istable(L, -1)){
595 lua_rawgeti(L, -1, 1);
596 box.MinEdge.X = lua_tonumber(L, -1) * scale;
598 lua_rawgeti(L, -1, 2);
599 box.MinEdge.Y = lua_tonumber(L, -1) * scale;
601 lua_rawgeti(L, -1, 3);
602 box.MinEdge.Z = lua_tonumber(L, -1) * scale;
604 lua_rawgeti(L, -1, 4);
605 box.MaxEdge.X = lua_tonumber(L, -1) * scale;
607 lua_rawgeti(L, -1, 5);
608 box.MaxEdge.Y = lua_tonumber(L, -1) * scale;
610 lua_rawgeti(L, -1, 6);
611 box.MaxEdge.Z = lua_tonumber(L, -1) * scale;
622 static MaterialProperties read_material_properties(
623 lua_State *L, int table)
625 MaterialProperties prop;
626 prop.diggability = (Diggability)getenumfield(L, -1, "diggability",
627 es_Diggability, DIGGABLE_NORMAL);
628 getfloatfield(L, -1, "constant_time", prop.constant_time);
629 getfloatfield(L, -1, "weight", prop.weight);
630 getfloatfield(L, -1, "crackiness", prop.crackiness);
631 getfloatfield(L, -1, "crumbliness", prop.crumbliness);
632 getfloatfield(L, -1, "cuttability", prop.cuttability);
633 getfloatfield(L, -1, "flammability", prop.flammability);
641 static void read_groups(lua_State *L, int index,
642 std::map<std::string, int> &result)
648 while(lua_next(L, index) != 0){
649 // key at index -2 and value at index -1
650 std::string name = luaL_checkstring(L, -2);
651 int rating = luaL_checkinteger(L, -1);
652 result[name] = rating;
653 // removes value, keeps key for next iteration
661 static void read_privileges(lua_State *L, int index,
662 std::set<std::string> &result)
668 while(lua_next(L, index) != 0){
669 // key at index -2 and value at index -1
670 std::string key = luaL_checkstring(L, -2);
671 bool value = lua_toboolean(L, -1);
674 // removes value, keeps key for next iteration
683 static ToolCapabilities read_tool_capabilities(
684 lua_State *L, int table)
686 ToolCapabilities toolcap;
687 getfloatfield(L, table, "full_punch_interval", toolcap.full_punch_interval);
688 getintfield(L, table, "max_drop_level", toolcap.max_drop_level);
689 lua_getfield(L, table, "groupcaps");
690 if(lua_istable(L, -1)){
691 int table_groupcaps = lua_gettop(L);
693 while(lua_next(L, table_groupcaps) != 0){
694 // key at index -2 and value at index -1
695 std::string groupname = luaL_checkstring(L, -2);
696 if(lua_istable(L, -1)){
697 int table_groupcap = lua_gettop(L);
698 // This will be created
699 ToolGroupCap groupcap;
700 // Read simple parameters
701 getintfield(L, table_groupcap, "maxlevel", groupcap.maxlevel);
702 getintfield(L, table_groupcap, "uses", groupcap.uses);
703 // DEPRECATED: maxwear
705 if(getfloatfield(L, table_groupcap, "maxwear", maxwear)){
707 groupcap.uses = 1.0/maxwear;
710 infostream<<script_get_backtrace(L)<<std::endl;
711 infostream<<"WARNING: field \"maxwear\" is deprecated; "
712 <<"should replace with uses=1/maxwear"<<std::endl;
714 // Read "times" table
715 lua_getfield(L, table_groupcap, "times");
716 if(lua_istable(L, -1)){
717 int table_times = lua_gettop(L);
719 while(lua_next(L, table_times) != 0){
720 // key at index -2 and value at index -1
721 int rating = luaL_checkinteger(L, -2);
722 float time = luaL_checknumber(L, -1);
723 groupcap.times[rating] = time;
724 // removes value, keeps key for next iteration
729 // Insert groupcap into toolcap
730 toolcap.groupcaps[groupname] = groupcap;
732 // removes value, keeps key for next iteration
740 static void set_tool_capabilities(lua_State *L, int table,
741 const ToolCapabilities &toolcap)
743 setfloatfield(L, table, "full_punch_interval", toolcap.full_punch_interval);
744 setintfield(L, table, "max_drop_level", toolcap.max_drop_level);
745 // Create groupcaps table
748 for(std::map<std::string, ToolGroupCap>::const_iterator
749 i = toolcap.groupcaps.begin(); i != toolcap.groupcaps.end(); i++){
750 // Create groupcap table
752 const std::string &name = i->first;
753 const ToolGroupCap &groupcap = i->second;
754 // Create subtable "times"
756 for(std::map<int, float>::const_iterator
757 i = groupcap.times.begin(); i != groupcap.times.end(); i++){
758 int rating = i->first;
759 float time = i->second;
760 lua_pushinteger(L, rating);
761 lua_pushnumber(L, time);
764 // Set subtable "times"
765 lua_setfield(L, -2, "times");
766 // Set simple parameters
767 setintfield(L, -1, "maxlevel", groupcap.maxlevel);
768 setintfield(L, -1, "uses", groupcap.uses);
769 // Insert groupcap table into groupcaps table
770 lua_setfield(L, -2, name.c_str());
772 // Set groupcaps table
773 lua_setfield(L, -2, "groupcaps");
776 static void push_tool_capabilities(lua_State *L,
777 const ToolCapabilities &prop)
780 set_tool_capabilities(L, -1, prop);
787 static void set_dig_params(lua_State *L, int table,
788 const DigParams ¶ms)
790 setboolfield(L, table, "diggable", params.diggable);
791 setfloatfield(L, table, "time", params.time);
792 setintfield(L, table, "wear", params.wear);
795 static void push_dig_params(lua_State *L,
796 const DigParams ¶ms)
799 set_dig_params(L, -1, params);
806 static void set_hit_params(lua_State *L, int table,
807 const HitParams ¶ms)
809 setintfield(L, table, "hp", params.hp);
810 setintfield(L, table, "wear", params.wear);
813 static void push_hit_params(lua_State *L,
814 const HitParams ¶ms)
817 set_hit_params(L, -1, params);
824 static void push_pointed_thing(lua_State *L, const PointedThing& pointed)
827 if(pointed.type == POINTEDTHING_NODE)
829 lua_pushstring(L, "node");
830 lua_setfield(L, -2, "type");
831 push_v3s16(L, pointed.node_undersurface);
832 lua_setfield(L, -2, "under");
833 push_v3s16(L, pointed.node_abovesurface);
834 lua_setfield(L, -2, "above");
836 else if(pointed.type == POINTEDTHING_OBJECT)
838 lua_pushstring(L, "object");
839 lua_setfield(L, -2, "type");
840 objectref_get(L, pointed.object_id);
841 lua_setfield(L, -2, "ref");
845 lua_pushstring(L, "nothing");
846 lua_setfield(L, -2, "type");
854 static void read_soundspec(lua_State *L, int index, SimpleSoundSpec &spec)
857 index = lua_gettop(L) + 1 + index;
858 if(lua_isnil(L, index)){
859 } else if(lua_istable(L, index)){
860 getstringfield(L, index, "name", spec.name);
861 getfloatfield(L, index, "gain", spec.gain);
862 } else if(lua_isstring(L, index)){
863 spec.name = lua_tostring(L, index);
871 static void read_object_properties(lua_State *L, int index,
872 ObjectProperties *prop)
875 index = lua_gettop(L) + 1 + index;
876 if(!lua_istable(L, index))
879 prop->hp_max = getintfield_default(L, -1, "hp_max", 10);
881 getboolfield(L, -1, "physical", prop->physical);
883 getfloatfield(L, -1, "weight", prop->weight);
885 lua_getfield(L, -1, "collisionbox");
886 if(lua_istable(L, -1))
887 prop->collisionbox = read_aabbox3df32(L, -1, 1.0);
890 getstringfield(L, -1, "visual", prop->visual);
892 lua_getfield(L, -1, "visual_size");
893 if(lua_istable(L, -1))
894 prop->visual_size = read_v2f(L, -1);
897 lua_getfield(L, -1, "textures");
898 if(lua_istable(L, -1)){
899 prop->textures.clear();
900 int table = lua_gettop(L);
902 while(lua_next(L, table) != 0){
903 // key at index -2 and value at index -1
904 if(lua_isstring(L, -1))
905 prop->textures.push_back(lua_tostring(L, -1));
907 prop->textures.push_back("");
908 // removes value, keeps key for next iteration
914 lua_getfield(L, -1, "spritediv");
915 if(lua_istable(L, -1))
916 prop->spritediv = read_v2s16(L, -1);
919 lua_getfield(L, -1, "initial_sprite_basepos");
920 if(lua_istable(L, -1))
921 prop->initial_sprite_basepos = read_v2s16(L, -1);
924 getboolfield(L, -1, "is_visible", prop->is_visible);
925 getboolfield(L, -1, "makes_footstep_sound", prop->makes_footstep_sound);
926 getfloatfield(L, -1, "automatic_rotate", prop->automatic_rotate);
933 static ItemDefinition read_item_definition(lua_State *L, int index)
936 index = lua_gettop(L) + 1 + index;
938 // Read the item definition
941 def.type = (ItemType)getenumfield(L, index, "type",
942 es_ItemType, ITEM_NONE);
943 getstringfield(L, index, "name", def.name);
944 getstringfield(L, index, "description", def.description);
945 getstringfield(L, index, "inventory_image", def.inventory_image);
946 getstringfield(L, index, "wield_image", def.wield_image);
948 lua_getfield(L, index, "wield_scale");
949 if(lua_istable(L, -1)){
950 def.wield_scale = check_v3f(L, -1);
954 def.stack_max = getintfield_default(L, index, "stack_max", def.stack_max);
955 if(def.stack_max == 0)
958 lua_getfield(L, index, "on_use");
959 def.usable = lua_isfunction(L, -1);
962 getboolfield(L, index, "liquids_pointable", def.liquids_pointable);
964 warn_if_field_exists(L, index, "tool_digging_properties",
965 "deprecated: use tool_capabilities");
967 lua_getfield(L, index, "tool_capabilities");
968 if(lua_istable(L, -1)){
969 def.tool_capabilities = new ToolCapabilities(
970 read_tool_capabilities(L, -1));
973 // If name is "" (hand), ensure there are ToolCapabilities
974 // because it will be looked up there whenever any other item has
975 // no ToolCapabilities
976 if(def.name == "" && def.tool_capabilities == NULL){
977 def.tool_capabilities = new ToolCapabilities();
980 lua_getfield(L, index, "groups");
981 read_groups(L, -1, def.groups);
991 static ContentFeatures read_content_features(lua_State *L, int index)
994 index = lua_gettop(L) + 1 + index;
998 getstringfield(L, index, "name", f.name);
1001 lua_getfield(L, index, "groups");
1002 read_groups(L, -1, f.groups);
1005 /* Visual definition */
1007 f.drawtype = (NodeDrawType)getenumfield(L, index, "drawtype", es_DrawType,
1009 getfloatfield(L, index, "visual_scale", f.visual_scale);
1011 lua_getfield(L, index, "tile_images");
1012 if(lua_istable(L, -1)){
1013 int table = lua_gettop(L);
1016 while(lua_next(L, table) != 0){
1017 // key at index -2 and value at index -1
1018 if(lua_isstring(L, -1))
1019 f.tname_tiles[i] = lua_tostring(L, -1);
1021 f.tname_tiles[i] = "";
1022 // removes value, keeps key for next iteration
1030 // Copy last value to all remaining textures
1032 std::string lastname = f.tname_tiles[i-1];
1034 f.tname_tiles[i] = lastname;
1041 lua_getfield(L, index, "special_materials");
1042 if(lua_istable(L, -1)){
1043 int table = lua_gettop(L);
1046 while(lua_next(L, table) != 0){
1047 // key at index -2 and value at index -1
1048 int smtable = lua_gettop(L);
1049 std::string tname = getstringfield_default(
1050 L, smtable, "image", "");
1051 bool backface_culling = getboolfield_default(
1052 L, smtable, "backface_culling", true);
1053 MaterialSpec mspec(tname, backface_culling);
1054 f.mspec_special[i] = mspec;
1055 // removes value, keeps key for next iteration
1066 f.alpha = getintfield_default(L, index, "alpha", 255);
1070 lua_getfield(L, index, "post_effect_color");
1071 if(!lua_isnil(L, -1))
1072 f.post_effect_color = readARGB8(L, -1);
1075 f.param_type = (ContentParamType)getenumfield(L, index, "paramtype",
1076 es_ContentParamType, CPT_NONE);
1077 f.param_type_2 = (ContentParamType2)getenumfield(L, index, "paramtype2",
1078 es_ContentParamType2, CPT2_NONE);
1080 // Warn about some deprecated fields
1081 warn_if_field_exists(L, index, "wall_mounted",
1082 "deprecated: use paramtype2 = 'wallmounted'");
1083 warn_if_field_exists(L, index, "light_propagates",
1084 "deprecated: determined from paramtype");
1085 warn_if_field_exists(L, index, "dug_item",
1086 "deprecated: use 'drop' field");
1087 warn_if_field_exists(L, index, "extra_dug_item",
1088 "deprecated: use 'drop' field");
1089 warn_if_field_exists(L, index, "extra_dug_item_rarity",
1090 "deprecated: use 'drop' field");
1091 warn_if_field_exists(L, index, "metadata_name",
1092 "deprecated: use on_add and metadata callbacks");
1094 // True for all ground-like things like stone and mud, false for eg. trees
1095 getboolfield(L, index, "is_ground_content", f.is_ground_content);
1096 f.light_propagates = (f.param_type == CPT_LIGHT);
1097 getboolfield(L, index, "sunlight_propagates", f.sunlight_propagates);
1098 // This is used for collision detection.
1099 // Also for general solidness queries.
1100 getboolfield(L, index, "walkable", f.walkable);
1101 // Player can point to these
1102 getboolfield(L, index, "pointable", f.pointable);
1103 // Player can dig these
1104 getboolfield(L, index, "diggable", f.diggable);
1105 // Player can climb these
1106 getboolfield(L, index, "climbable", f.climbable);
1107 // Player can build on these
1108 getboolfield(L, index, "buildable_to", f.buildable_to);
1109 // Whether the node is non-liquid, source liquid or flowing liquid
1110 f.liquid_type = (LiquidType)getenumfield(L, index, "liquidtype",
1111 es_LiquidType, LIQUID_NONE);
1112 // If the content is liquid, this is the flowing version of the liquid.
1113 getstringfield(L, index, "liquid_alternative_flowing",
1114 f.liquid_alternative_flowing);
1115 // If the content is liquid, this is the source version of the liquid.
1116 getstringfield(L, index, "liquid_alternative_source",
1117 f.liquid_alternative_source);
1118 // Viscosity for fluid flow, ranging from 1 to 7, with
1119 // 1 giving almost instantaneous propagation and 7 being
1120 // the slowest possible
1121 f.liquid_viscosity = getintfield_default(L, index,
1122 "liquid_viscosity", f.liquid_viscosity);
1123 // Amount of light the node emits
1124 f.light_source = getintfield_default(L, index,
1125 "light_source", f.light_source);
1126 f.damage_per_second = getintfield_default(L, index,
1127 "damage_per_second", f.damage_per_second);
1129 lua_getfield(L, index, "selection_box");
1130 if(lua_istable(L, -1)){
1131 f.selection_box.type = (NodeBoxType)getenumfield(L, -1, "type",
1132 es_NodeBoxType, NODEBOX_REGULAR);
1134 lua_getfield(L, -1, "fixed");
1135 if(lua_istable(L, -1))
1136 f.selection_box.fixed = read_aabbox3df32(L, -1, BS);
1139 lua_getfield(L, -1, "wall_top");
1140 if(lua_istable(L, -1))
1141 f.selection_box.wall_top = read_aabbox3df32(L, -1, BS);
1144 lua_getfield(L, -1, "wall_bottom");
1145 if(lua_istable(L, -1))
1146 f.selection_box.wall_bottom = read_aabbox3df32(L, -1, BS);
1149 lua_getfield(L, -1, "wall_side");
1150 if(lua_istable(L, -1))
1151 f.selection_box.wall_side = read_aabbox3df32(L, -1, BS);
1156 // Set to true if paramtype used to be 'facedir_simple'
1157 getboolfield(L, index, "legacy_facedir_simple", f.legacy_facedir_simple);
1158 // Set to true if wall_mounted used to be set to true
1159 getboolfield(L, index, "legacy_wallmounted", f.legacy_wallmounted);
1162 lua_getfield(L, index, "sounds");
1163 if(lua_istable(L, -1)){
1164 lua_getfield(L, -1, "footstep");
1165 read_soundspec(L, -1, f.sound_footstep);
1167 lua_getfield(L, -1, "dig");
1168 read_soundspec(L, -1, f.sound_dig);
1170 lua_getfield(L, -1, "dug");
1171 read_soundspec(L, -1, f.sound_dug);
1183 static ItemStack read_item(lua_State *L, int index);
1184 static std::vector<ItemStack> read_items(lua_State *L, int index);
1185 // creates a table of ItemStacks
1186 static void push_items(lua_State *L, const std::vector<ItemStack> &items);
1188 static void inventory_set_list_from_lua(Inventory *inv, const char *name,
1189 lua_State *L, int tableindex, int forcesize=-1)
1192 tableindex = lua_gettop(L) + 1 + tableindex;
1193 // If nil, delete list
1194 if(lua_isnil(L, tableindex)){
1195 inv->deleteList(name);
1198 // Otherwise set list
1199 std::vector<ItemStack> items = read_items(L, tableindex);
1200 int listsize = (forcesize != -1) ? forcesize : items.size();
1201 InventoryList *invlist = inv->addList(name, listsize);
1203 for(std::vector<ItemStack>::const_iterator
1204 i = items.begin(); i != items.end(); i++){
1205 if(forcesize != -1 && index == forcesize)
1207 invlist->changeItem(index, *i);
1210 while(forcesize != -1 && index < forcesize){
1211 invlist->deleteItem(index);
1216 static void inventory_get_list_to_lua(Inventory *inv, const char *name,
1219 InventoryList *invlist = inv->getList(name);
1220 if(invlist == NULL){
1224 std::vector<ItemStack> items;
1225 for(u32 i=0; i<invlist->getSize(); i++)
1226 items.push_back(invlist->getItem(i));
1227 push_items(L, items);
1231 Helpful macros for userdata classes
1234 #define method(class, name) {#name, class::l_##name}
1245 static const char className[];
1246 static const luaL_reg methods[];
1248 // Exported functions
1250 // garbage collector
1251 static int gc_object(lua_State *L)
1253 LuaItemStack *o = *(LuaItemStack **)(lua_touserdata(L, 1));
1258 // is_empty(self) -> true/false
1259 static int l_is_empty(lua_State *L)
1261 LuaItemStack *o = checkobject(L, 1);
1262 ItemStack &item = o->m_stack;
1263 lua_pushboolean(L, item.empty());
1267 // get_name(self) -> string
1268 static int l_get_name(lua_State *L)
1270 LuaItemStack *o = checkobject(L, 1);
1271 ItemStack &item = o->m_stack;
1272 lua_pushstring(L, item.name.c_str());
1276 // get_count(self) -> number
1277 static int l_get_count(lua_State *L)
1279 LuaItemStack *o = checkobject(L, 1);
1280 ItemStack &item = o->m_stack;
1281 lua_pushinteger(L, item.count);
1285 // get_wear(self) -> number
1286 static int l_get_wear(lua_State *L)
1288 LuaItemStack *o = checkobject(L, 1);
1289 ItemStack &item = o->m_stack;
1290 lua_pushinteger(L, item.wear);
1294 // get_metadata(self) -> string
1295 static int l_get_metadata(lua_State *L)
1297 LuaItemStack *o = checkobject(L, 1);
1298 ItemStack &item = o->m_stack;
1299 lua_pushlstring(L, item.metadata.c_str(), item.metadata.size());
1303 // clear(self) -> true
1304 static int l_clear(lua_State *L)
1306 LuaItemStack *o = checkobject(L, 1);
1308 lua_pushboolean(L, true);
1312 // replace(self, itemstack or itemstring or table or nil) -> true
1313 static int l_replace(lua_State *L)
1315 LuaItemStack *o = checkobject(L, 1);
1316 o->m_stack = read_item(L, 2);
1317 lua_pushboolean(L, true);
1321 // to_string(self) -> string
1322 static int l_to_string(lua_State *L)
1324 LuaItemStack *o = checkobject(L, 1);
1325 std::string itemstring = o->m_stack.getItemString();
1326 lua_pushstring(L, itemstring.c_str());
1330 // to_table(self) -> table or nil
1331 static int l_to_table(lua_State *L)
1333 LuaItemStack *o = checkobject(L, 1);
1334 const ItemStack &item = o->m_stack;
1342 lua_pushstring(L, item.name.c_str());
1343 lua_setfield(L, -2, "name");
1344 lua_pushinteger(L, item.count);
1345 lua_setfield(L, -2, "count");
1346 lua_pushinteger(L, item.wear);
1347 lua_setfield(L, -2, "wear");
1348 lua_pushlstring(L, item.metadata.c_str(), item.metadata.size());
1349 lua_setfield(L, -2, "metadata");
1354 // get_stack_max(self) -> number
1355 static int l_get_stack_max(lua_State *L)
1357 LuaItemStack *o = checkobject(L, 1);
1358 ItemStack &item = o->m_stack;
1359 lua_pushinteger(L, item.getStackMax(get_server(L)->idef()));
1363 // get_free_space(self) -> number
1364 static int l_get_free_space(lua_State *L)
1366 LuaItemStack *o = checkobject(L, 1);
1367 ItemStack &item = o->m_stack;
1368 lua_pushinteger(L, item.freeSpace(get_server(L)->idef()));
1372 // is_known(self) -> true/false
1373 // Checks if the item is defined.
1374 static int l_is_known(lua_State *L)
1376 LuaItemStack *o = checkobject(L, 1);
1377 ItemStack &item = o->m_stack;
1378 bool is_known = item.isKnown(get_server(L)->idef());
1379 lua_pushboolean(L, is_known);
1383 // get_definition(self) -> table
1384 // Returns the item definition table from minetest.registered_items,
1385 // or a fallback one (name="unknown")
1386 static int l_get_definition(lua_State *L)
1388 LuaItemStack *o = checkobject(L, 1);
1389 ItemStack &item = o->m_stack;
1391 // Get minetest.registered_items[name]
1392 lua_getglobal(L, "minetest");
1393 lua_getfield(L, -1, "registered_items");
1394 luaL_checktype(L, -1, LUA_TTABLE);
1395 lua_getfield(L, -1, item.name.c_str());
1396 if(lua_isnil(L, -1))
1399 lua_getfield(L, -1, "unknown");
1404 // get_tool_capabilities(self) -> table
1405 // Returns the effective tool digging properties.
1406 // Returns those of the hand ("") if this item has none associated.
1407 static int l_get_tool_capabilities(lua_State *L)
1409 LuaItemStack *o = checkobject(L, 1);
1410 ItemStack &item = o->m_stack;
1411 const ToolCapabilities &prop =
1412 item.getToolCapabilities(get_server(L)->idef());
1413 push_tool_capabilities(L, prop);
1417 // add_wear(self, amount) -> true/false
1418 // The range for "amount" is [0,65535]. Wear is only added if the item
1419 // is a tool. Adding wear might destroy the item.
1420 // Returns true if the item is (or was) a tool.
1421 static int l_add_wear(lua_State *L)
1423 LuaItemStack *o = checkobject(L, 1);
1424 ItemStack &item = o->m_stack;
1425 int amount = lua_tointeger(L, 2);
1426 bool result = item.addWear(amount, get_server(L)->idef());
1427 lua_pushboolean(L, result);
1431 // add_item(self, itemstack or itemstring or table or nil) -> itemstack
1432 // Returns leftover item stack
1433 static int l_add_item(lua_State *L)
1435 LuaItemStack *o = checkobject(L, 1);
1436 ItemStack &item = o->m_stack;
1437 ItemStack newitem = read_item(L, 2);
1438 ItemStack leftover = item.addItem(newitem, get_server(L)->idef());
1439 create(L, leftover);
1443 // item_fits(self, itemstack or itemstring or table or nil) -> true/false, itemstack
1444 // First return value is true iff the new item fits fully into the stack
1445 // Second return value is the would-be-left-over item stack
1446 static int l_item_fits(lua_State *L)
1448 LuaItemStack *o = checkobject(L, 1);
1449 ItemStack &item = o->m_stack;
1450 ItemStack newitem = read_item(L, 2);
1452 bool fits = item.itemFits(newitem, &restitem, get_server(L)->idef());
1453 lua_pushboolean(L, fits); // first return value
1454 create(L, restitem); // second return value
1458 // take_item(self, takecount=1) -> itemstack
1459 static int l_take_item(lua_State *L)
1461 LuaItemStack *o = checkobject(L, 1);
1462 ItemStack &item = o->m_stack;
1464 if(!lua_isnone(L, 2))
1465 takecount = luaL_checkinteger(L, 2);
1466 ItemStack taken = item.takeItem(takecount);
1471 // peek_item(self, peekcount=1) -> itemstack
1472 static int l_peek_item(lua_State *L)
1474 LuaItemStack *o = checkobject(L, 1);
1475 ItemStack &item = o->m_stack;
1477 if(!lua_isnone(L, 2))
1478 peekcount = lua_tointeger(L, 2);
1479 ItemStack peekaboo = item.peekItem(peekcount);
1480 create(L, peekaboo);
1485 LuaItemStack(const ItemStack &item):
1494 const ItemStack& getItem() const
1498 ItemStack& getItem()
1503 // LuaItemStack(itemstack or itemstring or table or nil)
1504 // Creates an LuaItemStack and leaves it on top of stack
1505 static int create_object(lua_State *L)
1507 ItemStack item = read_item(L, 1);
1508 LuaItemStack *o = new LuaItemStack(item);
1509 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
1510 luaL_getmetatable(L, className);
1511 lua_setmetatable(L, -2);
1514 // Not callable from Lua
1515 static int create(lua_State *L, const ItemStack &item)
1517 LuaItemStack *o = new LuaItemStack(item);
1518 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
1519 luaL_getmetatable(L, className);
1520 lua_setmetatable(L, -2);
1524 static LuaItemStack* checkobject(lua_State *L, int narg)
1526 luaL_checktype(L, narg, LUA_TUSERDATA);
1527 void *ud = luaL_checkudata(L, narg, className);
1528 if(!ud) luaL_typerror(L, narg, className);
1529 return *(LuaItemStack**)ud; // unbox pointer
1532 static void Register(lua_State *L)
1535 int methodtable = lua_gettop(L);
1536 luaL_newmetatable(L, className);
1537 int metatable = lua_gettop(L);
1539 lua_pushliteral(L, "__metatable");
1540 lua_pushvalue(L, methodtable);
1541 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
1543 lua_pushliteral(L, "__index");
1544 lua_pushvalue(L, methodtable);
1545 lua_settable(L, metatable);
1547 lua_pushliteral(L, "__gc");
1548 lua_pushcfunction(L, gc_object);
1549 lua_settable(L, metatable);
1551 lua_pop(L, 1); // drop metatable
1553 luaL_openlib(L, 0, methods, 0); // fill methodtable
1554 lua_pop(L, 1); // drop methodtable
1556 // Can be created from Lua (LuaItemStack(itemstack or itemstring or table or nil))
1557 lua_register(L, className, create_object);
1560 const char LuaItemStack::className[] = "ItemStack";
1561 const luaL_reg LuaItemStack::methods[] = {
1562 method(LuaItemStack, is_empty),
1563 method(LuaItemStack, get_name),
1564 method(LuaItemStack, get_count),
1565 method(LuaItemStack, get_wear),
1566 method(LuaItemStack, get_metadata),
1567 method(LuaItemStack, clear),
1568 method(LuaItemStack, replace),
1569 method(LuaItemStack, to_string),
1570 method(LuaItemStack, to_table),
1571 method(LuaItemStack, get_stack_max),
1572 method(LuaItemStack, get_free_space),
1573 method(LuaItemStack, is_known),
1574 method(LuaItemStack, get_definition),
1575 method(LuaItemStack, get_tool_capabilities),
1576 method(LuaItemStack, add_wear),
1577 method(LuaItemStack, add_item),
1578 method(LuaItemStack, item_fits),
1579 method(LuaItemStack, take_item),
1580 method(LuaItemStack, peek_item),
1584 static ItemStack read_item(lua_State *L, int index)
1587 index = lua_gettop(L) + 1 + index;
1589 if(lua_isnil(L, index))
1593 else if(lua_isuserdata(L, index))
1595 // Convert from LuaItemStack
1596 LuaItemStack *o = LuaItemStack::checkobject(L, index);
1597 return o->getItem();
1599 else if(lua_isstring(L, index))
1601 // Convert from itemstring
1602 std::string itemstring = lua_tostring(L, index);
1603 IItemDefManager *idef = get_server(L)->idef();
1607 item.deSerialize(itemstring, idef);
1610 catch(SerializationError &e)
1612 infostream<<"WARNING: unable to create item from itemstring"
1613 <<": "<<itemstring<<std::endl;
1617 else if(lua_istable(L, index))
1619 // Convert from table
1620 IItemDefManager *idef = get_server(L)->idef();
1621 std::string name = getstringfield_default(L, index, "name", "");
1622 int count = getintfield_default(L, index, "count", 1);
1623 int wear = getintfield_default(L, index, "wear", 0);
1624 std::string metadata = getstringfield_default(L, index, "metadata", "");
1625 return ItemStack(name, count, wear, metadata, idef);
1629 throw LuaError(L, "Expecting itemstack, itemstring, table or nil");
1633 static std::vector<ItemStack> read_items(lua_State *L, int index)
1636 index = lua_gettop(L) + 1 + index;
1638 std::vector<ItemStack> items;
1639 luaL_checktype(L, index, LUA_TTABLE);
1641 while(lua_next(L, index) != 0){
1642 // key at index -2 and value at index -1
1643 items.push_back(read_item(L, -1));
1644 // removes value, keeps key for next iteration
1650 // creates a table of ItemStacks
1651 static void push_items(lua_State *L, const std::vector<ItemStack> &items)
1653 // Get the table insert function
1654 lua_getglobal(L, "table");
1655 lua_getfield(L, -1, "insert");
1656 int table_insert = lua_gettop(L);
1657 // Create and fill table
1659 int table = lua_gettop(L);
1660 for(u32 i=0; i<items.size(); i++){
1661 ItemStack item = items[i];
1662 lua_pushvalue(L, table_insert);
1663 lua_pushvalue(L, table);
1664 LuaItemStack::create(L, item);
1665 if(lua_pcall(L, 2, 0, 0))
1666 script_error(L, "error: %s", lua_tostring(L, -1));
1668 lua_remove(L, -2); // Remove table
1669 lua_remove(L, -2); // Remove insert
1679 InventoryLocation m_loc;
1681 static const char className[];
1682 static const luaL_reg methods[];
1684 static InvRef *checkobject(lua_State *L, int narg)
1686 luaL_checktype(L, narg, LUA_TUSERDATA);
1687 void *ud = luaL_checkudata(L, narg, className);
1688 if(!ud) luaL_typerror(L, narg, className);
1689 return *(InvRef**)ud; // unbox pointer
1692 static Inventory* getinv(lua_State *L, InvRef *ref)
1694 return get_server(L)->getInventory(ref->m_loc);
1697 static InventoryList* getlist(lua_State *L, InvRef *ref,
1698 const char *listname)
1700 Inventory *inv = getinv(L, ref);
1703 return inv->getList(listname);
1706 static void reportInventoryChange(lua_State *L, InvRef *ref)
1708 // Inform other things that the inventory has changed
1709 get_server(L)->setInventoryModified(ref->m_loc);
1712 // Exported functions
1714 // garbage collector
1715 static int gc_object(lua_State *L) {
1716 InvRef *o = *(InvRef **)(lua_touserdata(L, 1));
1721 // get_size(self, listname)
1722 static int l_get_size(lua_State *L)
1724 InvRef *ref = checkobject(L, 1);
1725 const char *listname = luaL_checkstring(L, 2);
1726 InventoryList *list = getlist(L, ref, listname);
1728 lua_pushinteger(L, list->getSize());
1730 lua_pushinteger(L, 0);
1735 // set_size(self, listname, size)
1736 static int l_set_size(lua_State *L)
1738 InvRef *ref = checkobject(L, 1);
1739 const char *listname = luaL_checkstring(L, 2);
1740 int newsize = luaL_checknumber(L, 3);
1741 Inventory *inv = getinv(L, ref);
1743 inv->deleteList(listname);
1744 reportInventoryChange(L, ref);
1747 InventoryList *list = inv->getList(listname);
1749 list->setSize(newsize);
1751 list = inv->addList(listname, newsize);
1753 reportInventoryChange(L, ref);
1757 // get_stack(self, listname, i) -> itemstack
1758 static int l_get_stack(lua_State *L)
1760 InvRef *ref = checkobject(L, 1);
1761 const char *listname = luaL_checkstring(L, 2);
1762 int i = luaL_checknumber(L, 3) - 1;
1763 InventoryList *list = getlist(L, ref, listname);
1765 if(list != NULL && i >= 0 && i < (int) list->getSize())
1766 item = list->getItem(i);
1767 LuaItemStack::create(L, item);
1771 // set_stack(self, listname, i, stack) -> true/false
1772 static int l_set_stack(lua_State *L)
1774 InvRef *ref = checkobject(L, 1);
1775 const char *listname = luaL_checkstring(L, 2);
1776 int i = luaL_checknumber(L, 3) - 1;
1777 ItemStack newitem = read_item(L, 4);
1778 InventoryList *list = getlist(L, ref, listname);
1779 if(list != NULL && i >= 0 && i < (int) list->getSize()){
1780 list->changeItem(i, newitem);
1781 reportInventoryChange(L, ref);
1782 lua_pushboolean(L, true);
1784 lua_pushboolean(L, false);
1789 // get_list(self, listname) -> list or nil
1790 static int l_get_list(lua_State *L)
1792 InvRef *ref = checkobject(L, 1);
1793 const char *listname = luaL_checkstring(L, 2);
1794 Inventory *inv = getinv(L, ref);
1795 inventory_get_list_to_lua(inv, listname, L);
1799 // set_list(self, listname, list)
1800 static int l_set_list(lua_State *L)
1802 InvRef *ref = checkobject(L, 1);
1803 const char *listname = luaL_checkstring(L, 2);
1804 Inventory *inv = getinv(L, ref);
1805 InventoryList *list = inv->getList(listname);
1807 inventory_set_list_from_lua(inv, listname, L, 3,
1810 inventory_set_list_from_lua(inv, listname, L, 3);
1811 reportInventoryChange(L, ref);
1815 // add_item(self, listname, itemstack or itemstring or table or nil) -> itemstack
1816 // Returns the leftover stack
1817 static int l_add_item(lua_State *L)
1819 InvRef *ref = checkobject(L, 1);
1820 const char *listname = luaL_checkstring(L, 2);
1821 ItemStack item = read_item(L, 3);
1822 InventoryList *list = getlist(L, ref, listname);
1824 ItemStack leftover = list->addItem(item);
1825 if(leftover.count != item.count)
1826 reportInventoryChange(L, ref);
1827 LuaItemStack::create(L, leftover);
1829 LuaItemStack::create(L, item);
1834 // room_for_item(self, listname, itemstack or itemstring or table or nil) -> true/false
1835 // Returns true if the item completely fits into the list
1836 static int l_room_for_item(lua_State *L)
1838 InvRef *ref = checkobject(L, 1);
1839 const char *listname = luaL_checkstring(L, 2);
1840 ItemStack item = read_item(L, 3);
1841 InventoryList *list = getlist(L, ref, listname);
1843 lua_pushboolean(L, list->roomForItem(item));
1845 lua_pushboolean(L, false);
1850 // contains_item(self, listname, itemstack or itemstring or table or nil) -> true/false
1851 // Returns true if the list contains the given count of the given item name
1852 static int l_contains_item(lua_State *L)
1854 InvRef *ref = checkobject(L, 1);
1855 const char *listname = luaL_checkstring(L, 2);
1856 ItemStack item = read_item(L, 3);
1857 InventoryList *list = getlist(L, ref, listname);
1859 lua_pushboolean(L, list->containsItem(item));
1861 lua_pushboolean(L, false);
1866 // remove_item(self, listname, itemstack or itemstring or table or nil) -> itemstack
1867 // Returns the items that were actually removed
1868 static int l_remove_item(lua_State *L)
1870 InvRef *ref = checkobject(L, 1);
1871 const char *listname = luaL_checkstring(L, 2);
1872 ItemStack item = read_item(L, 3);
1873 InventoryList *list = getlist(L, ref, listname);
1875 ItemStack removed = list->removeItem(item);
1876 if(!removed.empty())
1877 reportInventoryChange(L, ref);
1878 LuaItemStack::create(L, removed);
1880 LuaItemStack::create(L, ItemStack());
1886 InvRef(const InventoryLocation &loc):
1895 // Creates an InvRef and leaves it on top of stack
1896 // Not callable from Lua; all references are created on the C side.
1897 static void create(lua_State *L, const InventoryLocation &loc)
1899 InvRef *o = new InvRef(loc);
1900 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
1901 luaL_getmetatable(L, className);
1902 lua_setmetatable(L, -2);
1904 static void createPlayer(lua_State *L, Player *player)
1906 InventoryLocation loc;
1907 loc.setPlayer(player->getName());
1910 static void createNodeMeta(lua_State *L, v3s16 p)
1912 InventoryLocation loc;
1917 static void Register(lua_State *L)
1920 int methodtable = lua_gettop(L);
1921 luaL_newmetatable(L, className);
1922 int metatable = lua_gettop(L);
1924 lua_pushliteral(L, "__metatable");
1925 lua_pushvalue(L, methodtable);
1926 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
1928 lua_pushliteral(L, "__index");
1929 lua_pushvalue(L, methodtable);
1930 lua_settable(L, metatable);
1932 lua_pushliteral(L, "__gc");
1933 lua_pushcfunction(L, gc_object);
1934 lua_settable(L, metatable);
1936 lua_pop(L, 1); // drop metatable
1938 luaL_openlib(L, 0, methods, 0); // fill methodtable
1939 lua_pop(L, 1); // drop methodtable
1941 // Cannot be created from Lua
1942 //lua_register(L, className, create_object);
1945 const char InvRef::className[] = "InvRef";
1946 const luaL_reg InvRef::methods[] = {
1947 method(InvRef, get_size),
1948 method(InvRef, set_size),
1949 method(InvRef, get_stack),
1950 method(InvRef, set_stack),
1951 method(InvRef, get_list),
1952 method(InvRef, set_list),
1953 method(InvRef, add_item),
1954 method(InvRef, room_for_item),
1955 method(InvRef, contains_item),
1956 method(InvRef, remove_item),
1968 ServerEnvironment *m_env;
1970 static const char className[];
1971 static const luaL_reg methods[];
1973 static NodeMetaRef *checkobject(lua_State *L, int narg)
1975 luaL_checktype(L, narg, LUA_TUSERDATA);
1976 void *ud = luaL_checkudata(L, narg, className);
1977 if(!ud) luaL_typerror(L, narg, className);
1978 return *(NodeMetaRef**)ud; // unbox pointer
1981 static NodeMetadata* getmeta(NodeMetaRef *ref, bool auto_create)
1983 NodeMetadata *meta = ref->m_env->getMap().getNodeMetadata(ref->m_p);
1984 if(meta == NULL && auto_create)
1986 meta = new NodeMetadata(ref->m_env->getGameDef());
1987 ref->m_env->getMap().setNodeMetadata(ref->m_p, meta);
1992 static void reportMetadataChange(NodeMetaRef *ref)
1994 // Inform other things that the metadata has changed
1995 v3s16 blockpos = getNodeBlockPos(ref->m_p);
1997 event.type = MEET_BLOCK_NODE_METADATA_CHANGED;
1999 ref->m_env->getMap().dispatchEvent(&event);
2000 // Set the block to be saved
2001 MapBlock *block = ref->m_env->getMap().getBlockNoCreateNoEx(blockpos);
2003 block->raiseModified(MOD_STATE_WRITE_NEEDED,
2004 "NodeMetaRef::reportMetadataChange");
2007 // Exported functions
2009 // garbage collector
2010 static int gc_object(lua_State *L) {
2011 NodeMetaRef *o = *(NodeMetaRef **)(lua_touserdata(L, 1));
2016 // get_string(self, name)
2017 static int l_get_string(lua_State *L)
2019 NodeMetaRef *ref = checkobject(L, 1);
2020 std::string name = luaL_checkstring(L, 2);
2022 NodeMetadata *meta = getmeta(ref, false);
2024 lua_pushlstring(L, "", 0);
2027 std::string str = meta->getString(name);
2028 lua_pushlstring(L, str.c_str(), str.size());
2032 // set_string(self, name, var)
2033 static int l_set_string(lua_State *L)
2035 NodeMetaRef *ref = checkobject(L, 1);
2036 std::string name = luaL_checkstring(L, 2);
2038 const char *s = lua_tolstring(L, 3, &len);
2039 std::string str(s, len);
2041 NodeMetadata *meta = getmeta(ref, !str.empty());
2042 if(meta == NULL || str == meta->getString(name))
2044 meta->setString(name, str);
2045 reportMetadataChange(ref);
2049 // get_int(self, name)
2050 static int l_get_int(lua_State *L)
2052 NodeMetaRef *ref = checkobject(L, 1);
2053 std::string name = lua_tostring(L, 2);
2055 NodeMetadata *meta = getmeta(ref, false);
2057 lua_pushnumber(L, 0);
2060 std::string str = meta->getString(name);
2061 lua_pushnumber(L, stoi(str));
2065 // set_int(self, name, var)
2066 static int l_set_int(lua_State *L)
2068 NodeMetaRef *ref = checkobject(L, 1);
2069 std::string name = lua_tostring(L, 2);
2070 int a = lua_tointeger(L, 3);
2071 std::string str = itos(a);
2073 NodeMetadata *meta = getmeta(ref, true);
2074 if(meta == NULL || str == meta->getString(name))
2076 meta->setString(name, str);
2077 reportMetadataChange(ref);
2081 // get_float(self, name)
2082 static int l_get_float(lua_State *L)
2084 NodeMetaRef *ref = checkobject(L, 1);
2085 std::string name = lua_tostring(L, 2);
2087 NodeMetadata *meta = getmeta(ref, false);
2089 lua_pushnumber(L, 0);
2092 std::string str = meta->getString(name);
2093 lua_pushnumber(L, stof(str));
2097 // set_float(self, name, var)
2098 static int l_set_float(lua_State *L)
2100 NodeMetaRef *ref = checkobject(L, 1);
2101 std::string name = lua_tostring(L, 2);
2102 float a = lua_tonumber(L, 3);
2103 std::string str = ftos(a);
2105 NodeMetadata *meta = getmeta(ref, true);
2106 if(meta == NULL || str == meta->getString(name))
2108 meta->setString(name, str);
2109 reportMetadataChange(ref);
2113 // get_inventory(self)
2114 static int l_get_inventory(lua_State *L)
2116 NodeMetaRef *ref = checkobject(L, 1);
2117 getmeta(ref, true); // try to ensure the metadata exists
2118 InvRef::createNodeMeta(L, ref->m_p);
2123 static int l_to_table(lua_State *L)
2125 NodeMetaRef *ref = checkobject(L, 1);
2127 NodeMetadata *meta = getmeta(ref, true);
2136 std::map<std::string, std::string> fields = meta->getStrings();
2137 for(std::map<std::string, std::string>::const_iterator
2138 i = fields.begin(); i != fields.end(); i++){
2139 const std::string &name = i->first;
2140 const std::string &value = i->second;
2141 lua_pushlstring(L, name.c_str(), name.size());
2142 lua_pushlstring(L, value.c_str(), value.size());
2143 lua_settable(L, -3);
2146 lua_setfield(L, -2, "fields");
2149 Inventory *inv = meta->getInventory();
2151 std::vector<const InventoryList*> lists = inv->getLists();
2152 for(std::vector<const InventoryList*>::const_iterator
2153 i = lists.begin(); i != lists.end(); i++){
2154 inventory_get_list_to_lua(inv, (*i)->getName().c_str(), L);
2155 lua_setfield(L, -2, (*i)->getName().c_str());
2158 lua_setfield(L, -2, "inventory");
2162 // from_table(self, table)
2163 static int l_from_table(lua_State *L)
2165 NodeMetaRef *ref = checkobject(L, 1);
2168 if(lua_isnil(L, base)){
2170 ref->m_env->getMap().removeNodeMetadata(ref->m_p);
2171 lua_pushboolean(L, true);
2175 // Has metadata; clear old one first
2176 ref->m_env->getMap().removeNodeMetadata(ref->m_p);
2177 // Create new metadata
2178 NodeMetadata *meta = getmeta(ref, true);
2180 lua_getfield(L, base, "fields");
2181 int fieldstable = lua_gettop(L);
2183 while(lua_next(L, fieldstable) != 0){
2184 // key at index -2 and value at index -1
2185 std::string name = lua_tostring(L, -2);
2187 const char *cs = lua_tolstring(L, -1, &cl);
2188 std::string value(cs, cl);
2189 meta->setString(name, value);
2190 lua_pop(L, 1); // removes value, keeps key for next iteration
2193 Inventory *inv = meta->getInventory();
2194 lua_getfield(L, base, "inventory");
2195 int inventorytable = lua_gettop(L);
2197 while(lua_next(L, inventorytable) != 0){
2198 // key at index -2 and value at index -1
2199 std::string name = lua_tostring(L, -2);
2200 inventory_set_list_from_lua(inv, name.c_str(), L, -1);
2201 lua_pop(L, 1); // removes value, keeps key for next iteration
2203 reportMetadataChange(ref);
2204 lua_pushboolean(L, true);
2209 NodeMetaRef(v3s16 p, ServerEnvironment *env):
2219 // Creates an NodeMetaRef and leaves it on top of stack
2220 // Not callable from Lua; all references are created on the C side.
2221 static void create(lua_State *L, v3s16 p, ServerEnvironment *env)
2223 NodeMetaRef *o = new NodeMetaRef(p, env);
2224 //infostream<<"NodeMetaRef::create: o="<<o<<std::endl;
2225 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
2226 luaL_getmetatable(L, className);
2227 lua_setmetatable(L, -2);
2230 static void Register(lua_State *L)
2233 int methodtable = lua_gettop(L);
2234 luaL_newmetatable(L, className);
2235 int metatable = lua_gettop(L);
2237 lua_pushliteral(L, "__metatable");
2238 lua_pushvalue(L, methodtable);
2239 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
2241 lua_pushliteral(L, "__index");
2242 lua_pushvalue(L, methodtable);
2243 lua_settable(L, metatable);
2245 lua_pushliteral(L, "__gc");
2246 lua_pushcfunction(L, gc_object);
2247 lua_settable(L, metatable);
2249 lua_pop(L, 1); // drop metatable
2251 luaL_openlib(L, 0, methods, 0); // fill methodtable
2252 lua_pop(L, 1); // drop methodtable
2254 // Cannot be created from Lua
2255 //lua_register(L, className, create_object);
2258 const char NodeMetaRef::className[] = "NodeMetaRef";
2259 const luaL_reg NodeMetaRef::methods[] = {
2260 method(NodeMetaRef, get_string),
2261 method(NodeMetaRef, set_string),
2262 method(NodeMetaRef, get_int),
2263 method(NodeMetaRef, set_int),
2264 method(NodeMetaRef, get_float),
2265 method(NodeMetaRef, set_float),
2266 method(NodeMetaRef, get_inventory),
2267 method(NodeMetaRef, to_table),
2268 method(NodeMetaRef, from_table),
2279 ServerActiveObject *m_object;
2281 static const char className[];
2282 static const luaL_reg methods[];
2284 static ObjectRef *checkobject(lua_State *L, int narg)
2286 luaL_checktype(L, narg, LUA_TUSERDATA);
2287 void *ud = luaL_checkudata(L, narg, className);
2288 if(!ud) luaL_typerror(L, narg, className);
2289 return *(ObjectRef**)ud; // unbox pointer
2292 static ServerActiveObject* getobject(ObjectRef *ref)
2294 ServerActiveObject *co = ref->m_object;
2298 static LuaEntitySAO* getluaobject(ObjectRef *ref)
2300 ServerActiveObject *obj = getobject(ref);
2303 if(obj->getType() != ACTIVEOBJECT_TYPE_LUAENTITY)
2305 return (LuaEntitySAO*)obj;
2308 static PlayerSAO* getplayersao(ObjectRef *ref)
2310 ServerActiveObject *obj = getobject(ref);
2313 if(obj->getType() != ACTIVEOBJECT_TYPE_PLAYER)
2315 return (PlayerSAO*)obj;
2318 static Player* getplayer(ObjectRef *ref)
2320 PlayerSAO *playersao = getplayersao(ref);
2321 if(playersao == NULL)
2323 return playersao->getPlayer();
2326 // Exported functions
2328 // garbage collector
2329 static int gc_object(lua_State *L) {
2330 ObjectRef *o = *(ObjectRef **)(lua_touserdata(L, 1));
2331 //infostream<<"ObjectRef::gc_object: o="<<o<<std::endl;
2337 static int l_remove(lua_State *L)
2339 ObjectRef *ref = checkobject(L, 1);
2340 ServerActiveObject *co = getobject(ref);
2341 if(co == NULL) return 0;
2342 verbosestream<<"ObjectRef::l_remove(): id="<<co->getId()<<std::endl;
2343 co->m_removed = true;
2348 // returns: {x=num, y=num, z=num}
2349 static int l_getpos(lua_State *L)
2351 ObjectRef *ref = checkobject(L, 1);
2352 ServerActiveObject *co = getobject(ref);
2353 if(co == NULL) return 0;
2354 v3f pos = co->getBasePosition() / BS;
2356 lua_pushnumber(L, pos.X);
2357 lua_setfield(L, -2, "x");
2358 lua_pushnumber(L, pos.Y);
2359 lua_setfield(L, -2, "y");
2360 lua_pushnumber(L, pos.Z);
2361 lua_setfield(L, -2, "z");
2365 // setpos(self, pos)
2366 static int l_setpos(lua_State *L)
2368 ObjectRef *ref = checkobject(L, 1);
2369 //LuaEntitySAO *co = getluaobject(ref);
2370 ServerActiveObject *co = getobject(ref);
2371 if(co == NULL) return 0;
2373 v3f pos = checkFloatPos(L, 2);
2379 // moveto(self, pos, continuous=false)
2380 static int l_moveto(lua_State *L)
2382 ObjectRef *ref = checkobject(L, 1);
2383 //LuaEntitySAO *co = getluaobject(ref);
2384 ServerActiveObject *co = getobject(ref);
2385 if(co == NULL) return 0;
2387 v3f pos = checkFloatPos(L, 2);
2389 bool continuous = lua_toboolean(L, 3);
2391 co->moveTo(pos, continuous);
2395 // punch(self, puncher, tool_capabilities, direction, time_from_last_punch)
2396 static int l_punch(lua_State *L)
2398 ObjectRef *ref = checkobject(L, 1);
2399 ObjectRef *puncher_ref = checkobject(L, 2);
2400 ServerActiveObject *co = getobject(ref);
2401 ServerActiveObject *puncher = getobject(puncher_ref);
2402 if(co == NULL) return 0;
2403 if(puncher == NULL) return 0;
2404 ToolCapabilities toolcap = read_tool_capabilities(L, 3);
2405 v3f dir = read_v3f(L, 4);
2406 float time_from_last_punch = 1000000;
2407 if(lua_isnumber(L, 5))
2408 time_from_last_punch = lua_tonumber(L, 5);
2410 puncher->punch(dir, &toolcap, puncher, time_from_last_punch);
2414 // right_click(self, clicker); clicker = an another ObjectRef
2415 static int l_right_click(lua_State *L)
2417 ObjectRef *ref = checkobject(L, 1);
2418 ObjectRef *ref2 = checkobject(L, 2);
2419 ServerActiveObject *co = getobject(ref);
2420 ServerActiveObject *co2 = getobject(ref2);
2421 if(co == NULL) return 0;
2422 if(co2 == NULL) return 0;
2424 co->rightClick(co2);
2429 // hp = number of hitpoints (2 * number of hearts)
2431 static int l_set_hp(lua_State *L)
2433 ObjectRef *ref = checkobject(L, 1);
2434 luaL_checknumber(L, 2);
2435 ServerActiveObject *co = getobject(ref);
2436 if(co == NULL) return 0;
2437 int hp = lua_tonumber(L, 2);
2438 /*infostream<<"ObjectRef::l_set_hp(): id="<<co->getId()
2439 <<" hp="<<hp<<std::endl;*/
2447 // returns: number of hitpoints (2 * number of hearts)
2448 // 0 if not applicable to this type of object
2449 static int l_get_hp(lua_State *L)
2451 ObjectRef *ref = checkobject(L, 1);
2452 ServerActiveObject *co = getobject(ref);
2453 if(co == NULL) return 0;
2454 int hp = co->getHP();
2455 /*infostream<<"ObjectRef::l_get_hp(): id="<<co->getId()
2456 <<" hp="<<hp<<std::endl;*/
2458 lua_pushnumber(L, hp);
2462 // get_inventory(self)
2463 static int l_get_inventory(lua_State *L)
2465 ObjectRef *ref = checkobject(L, 1);
2466 ServerActiveObject *co = getobject(ref);
2467 if(co == NULL) return 0;
2469 InventoryLocation loc = co->getInventoryLocation();
2470 if(get_server(L)->getInventory(loc) != NULL)
2471 InvRef::create(L, loc);
2477 // get_wield_list(self)
2478 static int l_get_wield_list(lua_State *L)
2480 ObjectRef *ref = checkobject(L, 1);
2481 ServerActiveObject *co = getobject(ref);
2482 if(co == NULL) return 0;
2484 lua_pushstring(L, co->getWieldList().c_str());
2488 // get_wield_index(self)
2489 static int l_get_wield_index(lua_State *L)
2491 ObjectRef *ref = checkobject(L, 1);
2492 ServerActiveObject *co = getobject(ref);
2493 if(co == NULL) return 0;
2495 lua_pushinteger(L, co->getWieldIndex() + 1);
2499 // get_wielded_item(self)
2500 static int l_get_wielded_item(lua_State *L)
2502 ObjectRef *ref = checkobject(L, 1);
2503 ServerActiveObject *co = getobject(ref);
2504 if(co == NULL) return 0;
2506 LuaItemStack::create(L, co->getWieldedItem());
2510 // set_wielded_item(self, itemstack or itemstring or table or nil)
2511 static int l_set_wielded_item(lua_State *L)
2513 ObjectRef *ref = checkobject(L, 1);
2514 ServerActiveObject *co = getobject(ref);
2515 if(co == NULL) return 0;
2517 ItemStack item = read_item(L, 2);
2518 bool success = co->setWieldedItem(item);
2519 lua_pushboolean(L, success);
2523 // set_armor_groups(self, groups)
2524 static int l_set_armor_groups(lua_State *L)
2526 ObjectRef *ref = checkobject(L, 1);
2527 ServerActiveObject *co = getobject(ref);
2528 if(co == NULL) return 0;
2530 ItemGroupList groups;
2531 read_groups(L, 2, groups);
2532 co->setArmorGroups(groups);
2536 // set_properties(self, properties)
2537 static int l_set_properties(lua_State *L)
2539 ObjectRef *ref = checkobject(L, 1);
2540 ServerActiveObject *co = getobject(ref);
2541 if(co == NULL) return 0;
2542 ObjectProperties *prop = co->accessObjectProperties();
2545 read_object_properties(L, 2, prop);
2546 co->notifyObjectPropertiesModified();
2550 /* LuaEntitySAO-only */
2552 // setvelocity(self, {x=num, y=num, z=num})
2553 static int l_setvelocity(lua_State *L)
2555 ObjectRef *ref = checkobject(L, 1);
2556 LuaEntitySAO *co = getluaobject(ref);
2557 if(co == NULL) return 0;
2558 v3f pos = checkFloatPos(L, 2);
2560 co->setVelocity(pos);
2564 // getvelocity(self)
2565 static int l_getvelocity(lua_State *L)
2567 ObjectRef *ref = checkobject(L, 1);
2568 LuaEntitySAO *co = getluaobject(ref);
2569 if(co == NULL) return 0;
2571 v3f v = co->getVelocity();
2576 // setacceleration(self, {x=num, y=num, z=num})
2577 static int l_setacceleration(lua_State *L)
2579 ObjectRef *ref = checkobject(L, 1);
2580 LuaEntitySAO *co = getluaobject(ref);
2581 if(co == NULL) return 0;
2583 v3f pos = checkFloatPos(L, 2);
2585 co->setAcceleration(pos);
2589 // getacceleration(self)
2590 static int l_getacceleration(lua_State *L)
2592 ObjectRef *ref = checkobject(L, 1);
2593 LuaEntitySAO *co = getluaobject(ref);
2594 if(co == NULL) return 0;
2596 v3f v = co->getAcceleration();
2601 // setyaw(self, radians)
2602 static int l_setyaw(lua_State *L)
2604 ObjectRef *ref = checkobject(L, 1);
2605 LuaEntitySAO *co = getluaobject(ref);
2606 if(co == NULL) return 0;
2607 float yaw = luaL_checknumber(L, 2) * core::RADTODEG;
2614 static int l_getyaw(lua_State *L)
2616 ObjectRef *ref = checkobject(L, 1);
2617 LuaEntitySAO *co = getluaobject(ref);
2618 if(co == NULL) return 0;
2620 float yaw = co->getYaw() * core::DEGTORAD;
2621 lua_pushnumber(L, yaw);
2625 // settexturemod(self, mod)
2626 static int l_settexturemod(lua_State *L)
2628 ObjectRef *ref = checkobject(L, 1);
2629 LuaEntitySAO *co = getluaobject(ref);
2630 if(co == NULL) return 0;
2632 std::string mod = luaL_checkstring(L, 2);
2633 co->setTextureMod(mod);
2637 // setsprite(self, p={x=0,y=0}, num_frames=1, framelength=0.2,
2638 // select_horiz_by_yawpitch=false)
2639 static int l_setsprite(lua_State *L)
2641 ObjectRef *ref = checkobject(L, 1);
2642 LuaEntitySAO *co = getluaobject(ref);
2643 if(co == NULL) return 0;
2646 if(!lua_isnil(L, 2))
2647 p = read_v2s16(L, 2);
2649 if(!lua_isnil(L, 3))
2650 num_frames = lua_tonumber(L, 3);
2651 float framelength = 0.2;
2652 if(!lua_isnil(L, 4))
2653 framelength = lua_tonumber(L, 4);
2654 bool select_horiz_by_yawpitch = false;
2655 if(!lua_isnil(L, 5))
2656 select_horiz_by_yawpitch = lua_toboolean(L, 5);
2657 co->setSprite(p, num_frames, framelength, select_horiz_by_yawpitch);
2662 // get_entity_name(self)
2663 static int l_get_entity_name(lua_State *L)
2665 ObjectRef *ref = checkobject(L, 1);
2666 LuaEntitySAO *co = getluaobject(ref);
2667 if(co == NULL) return 0;
2669 std::string name = co->getName();
2670 lua_pushstring(L, name.c_str());
2674 // get_luaentity(self)
2675 static int l_get_luaentity(lua_State *L)
2677 ObjectRef *ref = checkobject(L, 1);
2678 LuaEntitySAO *co = getluaobject(ref);
2679 if(co == NULL) return 0;
2681 luaentity_get(L, co->getId());
2687 // get_player_name(self)
2688 static int l_get_player_name(lua_State *L)
2690 ObjectRef *ref = checkobject(L, 1);
2691 Player *player = getplayer(ref);
2697 lua_pushstring(L, player->getName());
2701 // get_look_dir(self)
2702 static int l_get_look_dir(lua_State *L)
2704 ObjectRef *ref = checkobject(L, 1);
2705 Player *player = getplayer(ref);
2706 if(player == NULL) return 0;
2708 float pitch = player->getRadPitch();
2709 float yaw = player->getRadYaw();
2710 v3f v(cos(pitch)*cos(yaw), sin(pitch), cos(pitch)*sin(yaw));
2715 // get_look_pitch(self)
2716 static int l_get_look_pitch(lua_State *L)
2718 ObjectRef *ref = checkobject(L, 1);
2719 Player *player = getplayer(ref);
2720 if(player == NULL) return 0;
2722 lua_pushnumber(L, player->getRadPitch());
2726 // get_look_yaw(self)
2727 static int l_get_look_yaw(lua_State *L)
2729 ObjectRef *ref = checkobject(L, 1);
2730 Player *player = getplayer(ref);
2731 if(player == NULL) return 0;
2733 lua_pushnumber(L, player->getRadYaw());
2738 ObjectRef(ServerActiveObject *object):
2741 //infostream<<"ObjectRef created for id="<<m_object->getId()<<std::endl;
2747 infostream<<"ObjectRef destructing for id="
2748 <<m_object->getId()<<std::endl;
2750 infostream<<"ObjectRef destructing for id=unknown"<<std::endl;*/
2753 // Creates an ObjectRef and leaves it on top of stack
2754 // Not callable from Lua; all references are created on the C side.
2755 static void create(lua_State *L, ServerActiveObject *object)
2757 ObjectRef *o = new ObjectRef(object);
2758 //infostream<<"ObjectRef::create: o="<<o<<std::endl;
2759 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
2760 luaL_getmetatable(L, className);
2761 lua_setmetatable(L, -2);
2764 static void set_null(lua_State *L)
2766 ObjectRef *o = checkobject(L, -1);
2770 static void Register(lua_State *L)
2773 int methodtable = lua_gettop(L);
2774 luaL_newmetatable(L, className);
2775 int metatable = lua_gettop(L);
2777 lua_pushliteral(L, "__metatable");
2778 lua_pushvalue(L, methodtable);
2779 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
2781 lua_pushliteral(L, "__index");
2782 lua_pushvalue(L, methodtable);
2783 lua_settable(L, metatable);
2785 lua_pushliteral(L, "__gc");
2786 lua_pushcfunction(L, gc_object);
2787 lua_settable(L, metatable);
2789 lua_pop(L, 1); // drop metatable
2791 luaL_openlib(L, 0, methods, 0); // fill methodtable
2792 lua_pop(L, 1); // drop methodtable
2794 // Cannot be created from Lua
2795 //lua_register(L, className, create_object);
2798 const char ObjectRef::className[] = "ObjectRef";
2799 const luaL_reg ObjectRef::methods[] = {
2800 // ServerActiveObject
2801 method(ObjectRef, remove),
2802 method(ObjectRef, getpos),
2803 method(ObjectRef, setpos),
2804 method(ObjectRef, moveto),
2805 method(ObjectRef, punch),
2806 method(ObjectRef, right_click),
2807 method(ObjectRef, set_hp),
2808 method(ObjectRef, get_hp),
2809 method(ObjectRef, get_inventory),
2810 method(ObjectRef, get_wield_list),
2811 method(ObjectRef, get_wield_index),
2812 method(ObjectRef, get_wielded_item),
2813 method(ObjectRef, set_wielded_item),
2814 method(ObjectRef, set_armor_groups),
2815 method(ObjectRef, set_properties),
2816 // LuaEntitySAO-only
2817 method(ObjectRef, setvelocity),
2818 method(ObjectRef, getvelocity),
2819 method(ObjectRef, setacceleration),
2820 method(ObjectRef, getacceleration),
2821 method(ObjectRef, setyaw),
2822 method(ObjectRef, getyaw),
2823 method(ObjectRef, settexturemod),
2824 method(ObjectRef, setsprite),
2825 method(ObjectRef, get_entity_name),
2826 method(ObjectRef, get_luaentity),
2828 method(ObjectRef, get_player_name),
2829 method(ObjectRef, get_look_dir),
2830 method(ObjectRef, get_look_pitch),
2831 method(ObjectRef, get_look_yaw),
2835 // Creates a new anonymous reference if id=0
2836 static void objectref_get_or_create(lua_State *L,
2837 ServerActiveObject *cobj)
2839 if(cobj->getId() == 0){
2840 ObjectRef::create(L, cobj);
2842 objectref_get(L, cobj->getId());
2851 class LuaPerlinNoise
2858 static const char className[];
2859 static const luaL_reg methods[];
2861 // Exported functions
2863 // garbage collector
2864 static int gc_object(lua_State *L)
2866 LuaPerlinNoise *o = *(LuaPerlinNoise **)(lua_touserdata(L, 1));
2871 static int l_get2d(lua_State *L)
2873 LuaPerlinNoise *o = checkobject(L, 1);
2874 v2f pos2d = read_v2f(L,2);
2875 lua_Number val = noise2d_perlin(pos2d.X/o->scale, pos2d.Y/o->scale, o->seed, o->octaves, o->persistence);
2876 lua_pushnumber(L, val);
2879 static int l_get3d(lua_State *L)
2881 LuaPerlinNoise *o = checkobject(L, 1);
2882 v3f pos3d = read_v3f(L,2);
2883 lua_Number val = noise3d_perlin(pos3d.X/o->scale, pos3d.Y/o->scale, pos3d.Z/o->scale, o->seed, o->octaves, o->persistence);
2884 lua_pushnumber(L, val);
2889 LuaPerlinNoise(int a_seed, int a_octaves, double a_persistence,
2893 persistence(a_persistence),
2902 // LuaPerlinNoise(seed, octaves, persistence, scale)
2903 // Creates an LuaPerlinNoise and leaves it on top of stack
2904 static int create_object(lua_State *L)
2906 int seed = luaL_checkint(L, 1);
2907 int octaves = luaL_checkint(L, 2);
2908 double persistence = luaL_checknumber(L, 3);
2909 double scale = luaL_checknumber(L, 4);
2910 LuaPerlinNoise *o = new LuaPerlinNoise(seed, octaves, persistence, scale);
2911 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
2912 luaL_getmetatable(L, className);
2913 lua_setmetatable(L, -2);
2917 static LuaPerlinNoise* checkobject(lua_State *L, int narg)
2919 luaL_checktype(L, narg, LUA_TUSERDATA);
2920 void *ud = luaL_checkudata(L, narg, className);
2921 if(!ud) luaL_typerror(L, narg, className);
2922 return *(LuaPerlinNoise**)ud; // unbox pointer
2925 static void Register(lua_State *L)
2928 int methodtable = lua_gettop(L);
2929 luaL_newmetatable(L, className);
2930 int metatable = lua_gettop(L);
2932 lua_pushliteral(L, "__metatable");
2933 lua_pushvalue(L, methodtable);
2934 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
2936 lua_pushliteral(L, "__index");
2937 lua_pushvalue(L, methodtable);
2938 lua_settable(L, metatable);
2940 lua_pushliteral(L, "__gc");
2941 lua_pushcfunction(L, gc_object);
2942 lua_settable(L, metatable);
2944 lua_pop(L, 1); // drop metatable
2946 luaL_openlib(L, 0, methods, 0); // fill methodtable
2947 lua_pop(L, 1); // drop methodtable
2949 // Can be created from Lua (PerlinNoise(seed, octaves, persistence)
2950 lua_register(L, className, create_object);
2953 const char LuaPerlinNoise::className[] = "PerlinNoise";
2954 const luaL_reg LuaPerlinNoise::methods[] = {
2955 method(LuaPerlinNoise, get2d),
2956 method(LuaPerlinNoise, get3d),
2967 ServerEnvironment *m_env;
2969 static const char className[];
2970 static const luaL_reg methods[];
2972 static int gc_object(lua_State *L) {
2973 EnvRef *o = *(EnvRef **)(lua_touserdata(L, 1));
2978 static EnvRef *checkobject(lua_State *L, int narg)
2980 luaL_checktype(L, narg, LUA_TUSERDATA);
2981 void *ud = luaL_checkudata(L, narg, className);
2982 if(!ud) luaL_typerror(L, narg, className);
2983 return *(EnvRef**)ud; // unbox pointer
2986 // Exported functions
2988 // EnvRef:set_node(pos, node)
2989 // pos = {x=num, y=num, z=num}
2990 static int l_set_node(lua_State *L)
2992 //infostream<<"EnvRef::l_set_node()"<<std::endl;
2993 EnvRef *o = checkobject(L, 1);
2994 ServerEnvironment *env = o->m_env;
2995 if(env == NULL) return 0;
2997 v3s16 pos = read_v3s16(L, 2);
2999 MapNode n = readnode(L, 3, env->getGameDef()->ndef());
3002 MapNode n_old = env->getMap().getNodeNoEx(pos);
3003 scriptapi_node_on_destruct(L, pos, n_old);
3005 bool succeeded = env->getMap().addNodeWithEvent(pos, n);
3006 lua_pushboolean(L, succeeded);
3009 scriptapi_node_on_construct(L, pos, n);
3013 static int l_add_node(lua_State *L)
3015 return l_set_node(L);
3018 // EnvRef:remove_node(pos)
3019 // pos = {x=num, y=num, z=num}
3020 static int l_remove_node(lua_State *L)
3022 //infostream<<"EnvRef::l_remove_node()"<<std::endl;
3023 EnvRef *o = checkobject(L, 1);
3024 ServerEnvironment *env = o->m_env;
3025 if(env == NULL) return 0;
3027 v3s16 pos = read_v3s16(L, 2);
3030 MapNode n = env->getMap().getNodeNoEx(pos);
3031 scriptapi_node_on_destruct(L, pos, n);
3033 bool succeeded = env->getMap().removeNodeWithEvent(pos);
3034 lua_pushboolean(L, succeeded);
3035 // Air doesn't require constructor
3039 // EnvRef:get_node(pos)
3040 // pos = {x=num, y=num, z=num}
3041 static int l_get_node(lua_State *L)
3043 //infostream<<"EnvRef::l_get_node()"<<std::endl;
3044 EnvRef *o = checkobject(L, 1);
3045 ServerEnvironment *env = o->m_env;
3046 if(env == NULL) return 0;
3048 v3s16 pos = read_v3s16(L, 2);
3050 MapNode n = env->getMap().getNodeNoEx(pos);
3052 pushnode(L, n, env->getGameDef()->ndef());
3056 // EnvRef:get_node_or_nil(pos)
3057 // pos = {x=num, y=num, z=num}
3058 static int l_get_node_or_nil(lua_State *L)
3060 //infostream<<"EnvRef::l_get_node()"<<std::endl;
3061 EnvRef *o = checkobject(L, 1);
3062 ServerEnvironment *env = o->m_env;
3063 if(env == NULL) return 0;
3065 v3s16 pos = read_v3s16(L, 2);
3068 MapNode n = env->getMap().getNode(pos);
3070 pushnode(L, n, env->getGameDef()->ndef());
3072 } catch(InvalidPositionException &e)
3079 // EnvRef:get_node_light(pos, timeofday)
3080 // pos = {x=num, y=num, z=num}
3081 // timeofday: nil = current time, 0 = night, 0.5 = day
3082 static int l_get_node_light(lua_State *L)
3084 EnvRef *o = checkobject(L, 1);
3085 ServerEnvironment *env = o->m_env;
3086 if(env == NULL) return 0;
3088 v3s16 pos = read_v3s16(L, 2);
3089 u32 time_of_day = env->getTimeOfDay();
3090 if(lua_isnumber(L, 3))
3091 time_of_day = 24000.0 * lua_tonumber(L, 3);
3092 time_of_day %= 24000;
3093 u32 dnr = time_to_daynight_ratio(time_of_day);
3094 MapNode n = env->getMap().getNodeNoEx(pos);
3096 MapNode n = env->getMap().getNode(pos);
3097 INodeDefManager *ndef = env->getGameDef()->ndef();
3098 lua_pushinteger(L, n.getLightBlend(dnr, ndef));
3100 } catch(InvalidPositionException &e)
3107 // EnvRef:add_entity(pos, entityname) -> ObjectRef or nil
3108 // pos = {x=num, y=num, z=num}
3109 static int l_add_entity(lua_State *L)
3111 //infostream<<"EnvRef::l_add_entity()"<<std::endl;
3112 EnvRef *o = checkobject(L, 1);
3113 ServerEnvironment *env = o->m_env;
3114 if(env == NULL) return 0;
3116 v3f pos = checkFloatPos(L, 2);
3118 const char *name = luaL_checkstring(L, 3);
3120 ServerActiveObject *obj = new LuaEntitySAO(env, pos, name, "");
3121 int objectid = env->addActiveObject(obj);
3122 // If failed to add, return nothing (reads as nil)
3126 objectref_get_or_create(L, obj);
3130 // EnvRef:add_item(pos, itemstack or itemstring or table) -> ObjectRef or nil
3131 // pos = {x=num, y=num, z=num}
3132 static int l_add_item(lua_State *L)
3134 //infostream<<"EnvRef::l_add_item()"<<std::endl;
3135 EnvRef *o = checkobject(L, 1);
3136 ServerEnvironment *env = o->m_env;
3137 if(env == NULL) return 0;
3139 v3f pos = checkFloatPos(L, 2);
3141 ItemStack item = read_item(L, 3);
3142 if(item.empty() || !item.isKnown(get_server(L)->idef()))
3144 // Use minetest.spawn_item to spawn a __builtin:item
3145 lua_getglobal(L, "minetest");
3146 lua_getfield(L, -1, "spawn_item");
3147 if(lua_isnil(L, -1))
3149 lua_pushvalue(L, 2);
3150 lua_pushstring(L, item.getItemString().c_str());
3151 if(lua_pcall(L, 2, 1, 0))
3152 script_error(L, "error: %s", lua_tostring(L, -1));
3154 /*lua_pushvalue(L, 1);
3155 lua_pushstring(L, "__builtin:item");
3156 lua_pushstring(L, item.getItemString().c_str());
3157 return l_add_entity(L);*/
3159 ServerActiveObject *obj = createItemSAO(env, pos, item.getItemString());
3160 int objectid = env->addActiveObject(obj);
3161 // If failed to add, return nothing (reads as nil)
3165 objectref_get_or_create(L, obj);
3169 // EnvRef:add_rat(pos)
3170 // pos = {x=num, y=num, z=num}
3171 static int l_add_rat(lua_State *L)
3173 infostream<<"EnvRef::l_add_rat(): C++ mobs have been removed."
3174 <<" Doing nothing."<<std::endl;
3178 // EnvRef:add_firefly(pos)
3179 // pos = {x=num, y=num, z=num}
3180 static int l_add_firefly(lua_State *L)
3182 infostream<<"EnvRef::l_add_firefly(): C++ mobs have been removed."
3183 <<" Doing nothing."<<std::endl;
3187 // EnvRef:get_meta(pos)
3188 static int l_get_meta(lua_State *L)
3190 //infostream<<"EnvRef::l_get_meta()"<<std::endl;
3191 EnvRef *o = checkobject(L, 1);
3192 ServerEnvironment *env = o->m_env;
3193 if(env == NULL) return 0;
3195 v3s16 p = read_v3s16(L, 2);
3196 NodeMetaRef::create(L, p, env);
3200 // EnvRef:get_player_by_name(name)
3201 static int l_get_player_by_name(lua_State *L)
3203 EnvRef *o = checkobject(L, 1);
3204 ServerEnvironment *env = o->m_env;
3205 if(env == NULL) return 0;
3207 const char *name = luaL_checkstring(L, 2);
3208 Player *player = env->getPlayer(name);
3213 PlayerSAO *sao = player->getPlayerSAO();
3218 // Put player on stack
3219 objectref_get_or_create(L, sao);
3223 // EnvRef:get_objects_inside_radius(pos, radius)
3224 static int l_get_objects_inside_radius(lua_State *L)
3226 // Get the table insert function
3227 lua_getglobal(L, "table");
3228 lua_getfield(L, -1, "insert");
3229 int table_insert = lua_gettop(L);
3231 EnvRef *o = checkobject(L, 1);
3232 ServerEnvironment *env = o->m_env;
3233 if(env == NULL) return 0;
3235 v3f pos = checkFloatPos(L, 2);
3236 float radius = luaL_checknumber(L, 3) * BS;
3237 std::set<u16> ids = env->getObjectsInsideRadius(pos, radius);
3239 int table = lua_gettop(L);
3240 for(std::set<u16>::const_iterator
3241 i = ids.begin(); i != ids.end(); i++){
3242 ServerActiveObject *obj = env->getActiveObject(*i);
3243 // Insert object reference into table
3244 lua_pushvalue(L, table_insert);
3245 lua_pushvalue(L, table);
3246 objectref_get_or_create(L, obj);
3247 if(lua_pcall(L, 2, 0, 0))
3248 script_error(L, "error: %s", lua_tostring(L, -1));
3253 // EnvRef:set_timeofday(val)
3255 static int l_set_timeofday(lua_State *L)
3257 EnvRef *o = checkobject(L, 1);
3258 ServerEnvironment *env = o->m_env;
3259 if(env == NULL) return 0;
3261 float timeofday_f = luaL_checknumber(L, 2);
3262 assert(timeofday_f >= 0.0 && timeofday_f <= 1.0);
3263 int timeofday_mh = (int)(timeofday_f * 24000.0);
3264 // This should be set directly in the environment but currently
3265 // such changes aren't immediately sent to the clients, so call
3266 // the server instead.
3267 //env->setTimeOfDay(timeofday_mh);
3268 get_server(L)->setTimeOfDay(timeofday_mh);
3272 // EnvRef:get_timeofday() -> 0...1
3273 static int l_get_timeofday(lua_State *L)
3275 EnvRef *o = checkobject(L, 1);
3276 ServerEnvironment *env = o->m_env;
3277 if(env == NULL) return 0;
3279 int timeofday_mh = env->getTimeOfDay();
3280 float timeofday_f = (float)timeofday_mh / 24000.0;
3281 lua_pushnumber(L, timeofday_f);
3286 // EnvRef:find_node_near(pos, radius, nodenames) -> pos or nil
3287 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
3288 static int l_find_node_near(lua_State *L)
3290 EnvRef *o = checkobject(L, 1);
3291 ServerEnvironment *env = o->m_env;
3292 if(env == NULL) return 0;
3293 INodeDefManager *ndef = get_server(L)->ndef();
3294 v3s16 pos = read_v3s16(L, 2);
3295 int radius = luaL_checkinteger(L, 3);
3296 std::set<content_t> filter;
3297 if(lua_istable(L, 4)){
3300 while(lua_next(L, table) != 0){
3301 // key at index -2 and value at index -1
3302 luaL_checktype(L, -1, LUA_TSTRING);
3303 ndef->getIds(lua_tostring(L, -1), filter);
3304 // removes value, keeps key for next iteration
3307 } else if(lua_isstring(L, 4)){
3308 ndef->getIds(lua_tostring(L, 4), filter);
3311 for(int d=1; d<=radius; d++){
3312 core::list<v3s16> list;
3313 getFacePositions(list, d);
3314 for(core::list<v3s16>::Iterator i = list.begin();
3315 i != list.end(); i++){
3316 v3s16 p = pos + (*i);
3317 content_t c = env->getMap().getNodeNoEx(p).getContent();
3318 if(filter.count(c) != 0){
3327 // EnvRef:find_nodes_in_area(minp, maxp, nodenames) -> list of positions
3328 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
3329 static int l_find_nodes_in_area(lua_State *L)
3331 EnvRef *o = checkobject(L, 1);
3332 ServerEnvironment *env = o->m_env;
3333 if(env == NULL) return 0;
3334 INodeDefManager *ndef = get_server(L)->ndef();
3335 v3s16 minp = read_v3s16(L, 2);
3336 v3s16 maxp = read_v3s16(L, 3);
3337 std::set<content_t> filter;
3338 if(lua_istable(L, 4)){
3341 while(lua_next(L, table) != 0){
3342 // key at index -2 and value at index -1
3343 luaL_checktype(L, -1, LUA_TSTRING);
3344 ndef->getIds(lua_tostring(L, -1), filter);
3345 // removes value, keeps key for next iteration
3348 } else if(lua_isstring(L, 4)){
3349 ndef->getIds(lua_tostring(L, 4), filter);
3352 // Get the table insert function
3353 lua_getglobal(L, "table");
3354 lua_getfield(L, -1, "insert");
3355 int table_insert = lua_gettop(L);
3358 int table = lua_gettop(L);
3359 for(s16 x=minp.X; x<=maxp.X; x++)
3360 for(s16 y=minp.Y; y<=maxp.Y; y++)
3361 for(s16 z=minp.Z; z<=maxp.Z; z++)
3364 content_t c = env->getMap().getNodeNoEx(p).getContent();
3365 if(filter.count(c) != 0){
3366 lua_pushvalue(L, table_insert);
3367 lua_pushvalue(L, table);
3369 if(lua_pcall(L, 2, 0, 0))
3370 script_error(L, "error: %s", lua_tostring(L, -1));
3376 // EnvRef:get_perlin(seeddiff, octaves, persistence, scale)
3377 // returns world-specific PerlinNoise
3378 static int l_get_perlin(lua_State *L)
3380 EnvRef *o = checkobject(L, 1);
3381 ServerEnvironment *env = o->m_env;
3382 if(env == NULL) return 0;
3384 int seeddiff = luaL_checkint(L, 2);
3385 int octaves = luaL_checkint(L, 3);
3386 double persistence = luaL_checknumber(L, 4);
3387 double scale = luaL_checknumber(L, 5);
3389 LuaPerlinNoise *n = new LuaPerlinNoise(seeddiff + int(env->getServerMap().getSeed()), octaves, persistence, scale);
3390 *(void **)(lua_newuserdata(L, sizeof(void *))) = n;
3391 luaL_getmetatable(L, "PerlinNoise");
3392 lua_setmetatable(L, -2);
3397 EnvRef(ServerEnvironment *env):
3400 //infostream<<"EnvRef created"<<std::endl;
3405 //infostream<<"EnvRef destructing"<<std::endl;
3408 // Creates an EnvRef and leaves it on top of stack
3409 // Not callable from Lua; all references are created on the C side.
3410 static void create(lua_State *L, ServerEnvironment *env)
3412 EnvRef *o = new EnvRef(env);
3413 //infostream<<"EnvRef::create: o="<<o<<std::endl;
3414 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
3415 luaL_getmetatable(L, className);
3416 lua_setmetatable(L, -2);
3419 static void set_null(lua_State *L)
3421 EnvRef *o = checkobject(L, -1);
3425 static void Register(lua_State *L)
3428 int methodtable = lua_gettop(L);
3429 luaL_newmetatable(L, className);
3430 int metatable = lua_gettop(L);
3432 lua_pushliteral(L, "__metatable");
3433 lua_pushvalue(L, methodtable);
3434 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
3436 lua_pushliteral(L, "__index");
3437 lua_pushvalue(L, methodtable);
3438 lua_settable(L, metatable);
3440 lua_pushliteral(L, "__gc");
3441 lua_pushcfunction(L, gc_object);
3442 lua_settable(L, metatable);
3444 lua_pop(L, 1); // drop metatable
3446 luaL_openlib(L, 0, methods, 0); // fill methodtable
3447 lua_pop(L, 1); // drop methodtable
3449 // Cannot be created from Lua
3450 //lua_register(L, className, create_object);
3453 const char EnvRef::className[] = "EnvRef";
3454 const luaL_reg EnvRef::methods[] = {
3455 method(EnvRef, set_node),
3456 method(EnvRef, add_node),
3457 method(EnvRef, remove_node),
3458 method(EnvRef, get_node),
3459 method(EnvRef, get_node_or_nil),
3460 method(EnvRef, get_node_light),
3461 method(EnvRef, add_entity),
3462 method(EnvRef, add_item),
3463 method(EnvRef, add_rat),
3464 method(EnvRef, add_firefly),
3465 method(EnvRef, get_meta),
3466 method(EnvRef, get_player_by_name),
3467 method(EnvRef, get_objects_inside_radius),
3468 method(EnvRef, set_timeofday),
3469 method(EnvRef, get_timeofday),
3470 method(EnvRef, find_node_near),
3471 method(EnvRef, find_nodes_in_area),
3472 method(EnvRef, get_perlin),
3481 class LuaPseudoRandom
3484 PseudoRandom m_pseudo;
3486 static const char className[];
3487 static const luaL_reg methods[];
3489 // Exported functions
3491 // garbage collector
3492 static int gc_object(lua_State *L)
3494 LuaPseudoRandom *o = *(LuaPseudoRandom **)(lua_touserdata(L, 1));
3499 // next(self, min=0, max=32767) -> get next value
3500 static int l_next(lua_State *L)
3502 LuaPseudoRandom *o = checkobject(L, 1);
3505 lua_settop(L, 3); // Fill 2 and 3 with nil if they don't exist
3506 if(!lua_isnil(L, 2))
3507 min = luaL_checkinteger(L, 2);
3508 if(!lua_isnil(L, 3))
3509 max = luaL_checkinteger(L, 3);
3510 if(max - min != 32767 && max - min > 32767/5)
3511 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.");
3512 PseudoRandom &pseudo = o->m_pseudo;
3513 int val = pseudo.next();
3514 val = (val % (max-min+1)) + min;
3515 lua_pushinteger(L, val);
3520 LuaPseudoRandom(int seed):
3529 const PseudoRandom& getItem() const
3533 PseudoRandom& getItem()
3538 // LuaPseudoRandom(seed)
3539 // Creates an LuaPseudoRandom and leaves it on top of stack
3540 static int create_object(lua_State *L)
3542 int seed = luaL_checknumber(L, 1);
3543 LuaPseudoRandom *o = new LuaPseudoRandom(seed);
3544 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
3545 luaL_getmetatable(L, className);
3546 lua_setmetatable(L, -2);
3550 static LuaPseudoRandom* checkobject(lua_State *L, int narg)
3552 luaL_checktype(L, narg, LUA_TUSERDATA);
3553 void *ud = luaL_checkudata(L, narg, className);
3554 if(!ud) luaL_typerror(L, narg, className);
3555 return *(LuaPseudoRandom**)ud; // unbox pointer
3558 static void Register(lua_State *L)
3561 int methodtable = lua_gettop(L);
3562 luaL_newmetatable(L, className);
3563 int metatable = lua_gettop(L);
3565 lua_pushliteral(L, "__metatable");
3566 lua_pushvalue(L, methodtable);
3567 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
3569 lua_pushliteral(L, "__index");
3570 lua_pushvalue(L, methodtable);
3571 lua_settable(L, metatable);
3573 lua_pushliteral(L, "__gc");
3574 lua_pushcfunction(L, gc_object);
3575 lua_settable(L, metatable);
3577 lua_pop(L, 1); // drop metatable
3579 luaL_openlib(L, 0, methods, 0); // fill methodtable
3580 lua_pop(L, 1); // drop methodtable
3582 // Can be created from Lua (LuaPseudoRandom(seed))
3583 lua_register(L, className, create_object);
3586 const char LuaPseudoRandom::className[] = "PseudoRandom";
3587 const luaL_reg LuaPseudoRandom::methods[] = {
3588 method(LuaPseudoRandom, next),
3598 class LuaABM : public ActiveBlockModifier
3604 std::set<std::string> m_trigger_contents;
3605 std::set<std::string> m_required_neighbors;
3606 float m_trigger_interval;
3607 u32 m_trigger_chance;
3609 LuaABM(lua_State *L, int id,
3610 const std::set<std::string> &trigger_contents,
3611 const std::set<std::string> &required_neighbors,
3612 float trigger_interval, u32 trigger_chance):
3615 m_trigger_contents(trigger_contents),
3616 m_required_neighbors(required_neighbors),
3617 m_trigger_interval(trigger_interval),
3618 m_trigger_chance(trigger_chance)
3621 virtual std::set<std::string> getTriggerContents()
3623 return m_trigger_contents;
3625 virtual std::set<std::string> getRequiredNeighbors()
3627 return m_required_neighbors;
3629 virtual float getTriggerInterval()
3631 return m_trigger_interval;
3633 virtual u32 getTriggerChance()
3635 return m_trigger_chance;
3637 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
3638 u32 active_object_count, u32 active_object_count_wider)
3640 lua_State *L = m_lua;
3643 assert(lua_checkstack(L, 20));
3644 StackUnroller stack_unroller(L);
3646 // Get minetest.registered_abms
3647 lua_getglobal(L, "minetest");
3648 lua_getfield(L, -1, "registered_abms");
3649 luaL_checktype(L, -1, LUA_TTABLE);
3650 int registered_abms = lua_gettop(L);
3652 // Get minetest.registered_abms[m_id]
3653 lua_pushnumber(L, m_id);
3654 lua_gettable(L, registered_abms);
3655 if(lua_isnil(L, -1))
3659 luaL_checktype(L, -1, LUA_TTABLE);
3660 lua_getfield(L, -1, "action");
3661 luaL_checktype(L, -1, LUA_TFUNCTION);
3663 pushnode(L, n, env->getGameDef()->ndef());
3664 lua_pushnumber(L, active_object_count);
3665 lua_pushnumber(L, active_object_count_wider);
3666 if(lua_pcall(L, 4, 0, 0))
3667 script_error(L, "error: %s", lua_tostring(L, -1));
3675 static void read_server_sound_params(lua_State *L, int index,
3676 ServerSoundParams ¶ms)
3679 index = lua_gettop(L) + 1 + index;
3681 params = ServerSoundParams();
3682 if(lua_istable(L, index)){
3683 getfloatfield(L, index, "gain", params.gain);
3684 getstringfield(L, index, "to_player", params.to_player);
3685 lua_getfield(L, index, "pos");
3686 if(!lua_isnil(L, -1)){
3687 v3f p = read_v3f(L, -1)*BS;
3689 params.type = ServerSoundParams::SSP_POSITIONAL;
3692 lua_getfield(L, index, "object");
3693 if(!lua_isnil(L, -1)){
3694 ObjectRef *ref = ObjectRef::checkobject(L, -1);
3695 ServerActiveObject *sao = ObjectRef::getobject(ref);
3697 params.object = sao->getId();
3698 params.type = ServerSoundParams::SSP_OBJECT;
3702 params.max_hear_distance = BS*getfloatfield_default(L, index,
3703 "max_hear_distance", params.max_hear_distance/BS);
3704 getboolfield(L, index, "loop", params.loop);
3713 // Writes a line to dstream
3714 static int l_debug(lua_State *L)
3716 std::string text = lua_tostring(L, 1);
3717 dstream << text << std::endl;
3721 // log([level,] text)
3722 // Writes a line to the logger.
3723 // The one-argument version logs to infostream.
3724 // The two-argument version accept a log level: error, action, info, or verbose.
3725 static int l_log(lua_State *L)
3728 LogMessageLevel level = LMT_INFO;
3729 if(lua_isnone(L, 2))
3731 text = lua_tostring(L, 1);
3735 std::string levelname = lua_tostring(L, 1);
3736 text = lua_tostring(L, 2);
3737 if(levelname == "error")
3739 else if(levelname == "action")
3741 else if(levelname == "verbose")
3742 level = LMT_VERBOSE;
3744 log_printline(level, text);
3748 // register_item_raw({lots of stuff})
3749 static int l_register_item_raw(lua_State *L)
3751 luaL_checktype(L, 1, LUA_TTABLE);
3754 // Get the writable item and node definition managers from the server
3755 IWritableItemDefManager *idef =
3756 get_server(L)->getWritableItemDefManager();
3757 IWritableNodeDefManager *ndef =
3758 get_server(L)->getWritableNodeDefManager();
3760 // Check if name is defined
3761 lua_getfield(L, table, "name");
3762 if(lua_isstring(L, -1)){
3763 std::string name = lua_tostring(L, -1);
3764 verbosestream<<"register_item_raw: "<<name<<std::endl;
3766 throw LuaError(L, "register_item_raw: name is not defined or not a string");
3769 // Check if on_use is defined
3771 // Read the item definition and register it
3772 ItemDefinition def = read_item_definition(L, table);
3773 idef->registerItem(def);
3775 // Read the node definition (content features) and register it
3776 if(def.type == ITEM_NODE)
3778 ContentFeatures f = read_content_features(L, table);
3779 ndef->set(f.name, f);
3782 return 0; /* number of results */
3785 // register_alias_raw(name, convert_to_name)
3786 static int l_register_alias_raw(lua_State *L)
3788 std::string name = luaL_checkstring(L, 1);
3789 std::string convert_to = luaL_checkstring(L, 2);
3791 // Get the writable item definition manager from the server
3792 IWritableItemDefManager *idef =
3793 get_server(L)->getWritableItemDefManager();
3795 idef->registerAlias(name, convert_to);
3797 return 0; /* number of results */
3800 // helper for register_craft
3801 static bool read_craft_recipe_shaped(lua_State *L, int index,
3802 int &width, std::vector<std::string> &recipe)
3805 index = lua_gettop(L) + 1 + index;
3807 if(!lua_istable(L, index))
3812 while(lua_next(L, index) != 0){
3814 // key at index -2 and value at index -1
3815 if(!lua_istable(L, -1))
3817 int table2 = lua_gettop(L);
3819 while(lua_next(L, table2) != 0){
3820 // key at index -2 and value at index -1
3821 if(!lua_isstring(L, -1))
3823 recipe.push_back(lua_tostring(L, -1));
3824 // removes value, keeps key for next iteration
3831 if(colcount != width)
3834 // removes value, keeps key for next iteration
3841 // helper for register_craft
3842 static bool read_craft_recipe_shapeless(lua_State *L, int index,
3843 std::vector<std::string> &recipe)
3846 index = lua_gettop(L) + 1 + index;
3848 if(!lua_istable(L, index))
3852 while(lua_next(L, index) != 0){
3853 // key at index -2 and value at index -1
3854 if(!lua_isstring(L, -1))
3856 recipe.push_back(lua_tostring(L, -1));
3857 // removes value, keeps key for next iteration
3863 // helper for register_craft
3864 static bool read_craft_replacements(lua_State *L, int index,
3865 CraftReplacements &replacements)
3868 index = lua_gettop(L) + 1 + index;
3870 if(!lua_istable(L, index))
3874 while(lua_next(L, index) != 0){
3875 // key at index -2 and value at index -1
3876 if(!lua_istable(L, -1))
3878 lua_rawgeti(L, -1, 1);
3879 if(!lua_isstring(L, -1))
3881 std::string replace_from = lua_tostring(L, -1);
3883 lua_rawgeti(L, -1, 2);
3884 if(!lua_isstring(L, -1))
3886 std::string replace_to = lua_tostring(L, -1);
3888 replacements.pairs.push_back(
3889 std::make_pair(replace_from, replace_to));
3890 // removes value, keeps key for next iteration
3895 // register_craft({output=item, recipe={{item00,item10},{item01,item11}})
3896 static int l_register_craft(lua_State *L)
3898 //infostream<<"register_craft"<<std::endl;
3899 luaL_checktype(L, 1, LUA_TTABLE);
3902 // Get the writable craft definition manager from the server
3903 IWritableCraftDefManager *craftdef =
3904 get_server(L)->getWritableCraftDefManager();
3906 std::string type = getstringfield_default(L, table, "type", "shaped");
3909 CraftDefinitionShaped
3911 if(type == "shaped"){
3912 std::string output = getstringfield_default(L, table, "output", "");
3914 throw LuaError(L, "Crafting definition is missing an output");
3917 std::vector<std::string> recipe;
3918 lua_getfield(L, table, "recipe");
3919 if(lua_isnil(L, -1))
3920 throw LuaError(L, "Crafting definition is missing a recipe"
3921 " (output=\"" + output + "\")");
3922 if(!read_craft_recipe_shaped(L, -1, width, recipe))
3923 throw LuaError(L, "Invalid crafting recipe"
3924 " (output=\"" + output + "\")");
3926 CraftReplacements replacements;
3927 lua_getfield(L, table, "replacements");
3928 if(!lua_isnil(L, -1))
3930 if(!read_craft_replacements(L, -1, replacements))
3931 throw LuaError(L, "Invalid replacements"
3932 " (output=\"" + output + "\")");
3935 CraftDefinition *def = new CraftDefinitionShaped(
3936 output, width, recipe, replacements);
3937 craftdef->registerCraft(def);
3940 CraftDefinitionShapeless
3942 else if(type == "shapeless"){
3943 std::string output = getstringfield_default(L, table, "output", "");
3945 throw LuaError(L, "Crafting definition (shapeless)"
3946 " is missing an output");
3948 std::vector<std::string> recipe;
3949 lua_getfield(L, table, "recipe");
3950 if(lua_isnil(L, -1))
3951 throw LuaError(L, "Crafting definition (shapeless)"
3952 " is missing a recipe"
3953 " (output=\"" + output + "\")");
3954 if(!read_craft_recipe_shapeless(L, -1, recipe))
3955 throw LuaError(L, "Invalid crafting recipe"
3956 " (output=\"" + output + "\")");
3958 CraftReplacements replacements;
3959 lua_getfield(L, table, "replacements");
3960 if(!lua_isnil(L, -1))
3962 if(!read_craft_replacements(L, -1, replacements))
3963 throw LuaError(L, "Invalid replacements"
3964 " (output=\"" + output + "\")");
3967 CraftDefinition *def = new CraftDefinitionShapeless(
3968 output, recipe, replacements);
3969 craftdef->registerCraft(def);
3972 CraftDefinitionToolRepair
3974 else if(type == "toolrepair"){
3975 float additional_wear = getfloatfield_default(L, table,
3976 "additional_wear", 0.0);
3978 CraftDefinition *def = new CraftDefinitionToolRepair(
3980 craftdef->registerCraft(def);
3983 CraftDefinitionCooking
3985 else if(type == "cooking"){
3986 std::string output = getstringfield_default(L, table, "output", "");
3988 throw LuaError(L, "Crafting definition (cooking)"
3989 " is missing an output");
3991 std::string recipe = getstringfield_default(L, table, "recipe", "");
3993 throw LuaError(L, "Crafting definition (cooking)"
3994 " is missing a recipe"
3995 " (output=\"" + output + "\")");
3997 float cooktime = getfloatfield_default(L, table, "cooktime", 3.0);
3999 CraftDefinition *def = new CraftDefinitionCooking(
4000 output, recipe, cooktime);
4001 craftdef->registerCraft(def);
4006 else if(type == "fuel"){
4007 std::string recipe = getstringfield_default(L, table, "recipe", "");
4009 throw LuaError(L, "Crafting definition (fuel)"
4010 " is missing a recipe");
4012 float burntime = getfloatfield_default(L, table, "burntime", 1.0);
4014 CraftDefinition *def = new CraftDefinitionFuel(
4016 craftdef->registerCraft(def);
4020 throw LuaError(L, "Unknown crafting definition type: \"" + type + "\"");
4024 return 0; /* number of results */
4027 // setting_set(name, value)
4028 static int l_setting_set(lua_State *L)
4030 const char *name = luaL_checkstring(L, 1);
4031 const char *value = luaL_checkstring(L, 2);
4032 g_settings->set(name, value);
4036 // setting_get(name)
4037 static int l_setting_get(lua_State *L)
4039 const char *name = luaL_checkstring(L, 1);
4041 std::string value = g_settings->get(name);
4042 lua_pushstring(L, value.c_str());
4043 } catch(SettingNotFoundException &e){
4049 // setting_getbool(name)
4050 static int l_setting_getbool(lua_State *L)
4052 const char *name = luaL_checkstring(L, 1);
4054 bool value = g_settings->getBool(name);
4055 lua_pushboolean(L, value);
4056 } catch(SettingNotFoundException &e){
4062 // chat_send_all(text)
4063 static int l_chat_send_all(lua_State *L)
4065 const char *text = luaL_checkstring(L, 1);
4066 // Get server from registry
4067 Server *server = get_server(L);
4069 server->notifyPlayers(narrow_to_wide(text));
4073 // chat_send_player(name, text)
4074 static int l_chat_send_player(lua_State *L)
4076 const char *name = luaL_checkstring(L, 1);
4077 const char *text = luaL_checkstring(L, 2);
4078 // Get server from registry
4079 Server *server = get_server(L);
4081 server->notifyPlayer(name, narrow_to_wide(text));
4085 // get_player_privs(name, text)
4086 static int l_get_player_privs(lua_State *L)
4088 const char *name = luaL_checkstring(L, 1);
4089 // Get server from registry
4090 Server *server = get_server(L);
4093 int table = lua_gettop(L);
4094 std::set<std::string> privs_s = server->getPlayerEffectivePrivs(name);
4095 for(std::set<std::string>::const_iterator
4096 i = privs_s.begin(); i != privs_s.end(); i++){
4097 lua_pushboolean(L, true);
4098 lua_setfield(L, table, i->c_str());
4100 lua_pushvalue(L, table);
4104 // get_inventory(location)
4105 static int l_get_inventory(lua_State *L)
4107 InventoryLocation loc;
4109 std::string type = checkstringfield(L, 1, "type");
4110 if(type == "player"){
4111 std::string name = checkstringfield(L, 1, "name");
4112 loc.setPlayer(name);
4113 } else if(type == "node"){
4114 lua_getfield(L, 1, "pos");
4115 v3s16 pos = check_v3s16(L, -1);
4116 loc.setNodeMeta(pos);
4119 if(get_server(L)->getInventory(loc) != NULL)
4120 InvRef::create(L, loc);
4126 // get_dig_params(groups, tool_capabilities[, time_from_last_punch])
4127 static int l_get_dig_params(lua_State *L)
4129 std::map<std::string, int> groups;
4130 read_groups(L, 1, groups);
4131 ToolCapabilities tp = read_tool_capabilities(L, 2);
4132 if(lua_isnoneornil(L, 3))
4133 push_dig_params(L, getDigParams(groups, &tp));
4135 push_dig_params(L, getDigParams(groups, &tp,
4136 luaL_checknumber(L, 3)));
4140 // get_hit_params(groups, tool_capabilities[, time_from_last_punch])
4141 static int l_get_hit_params(lua_State *L)
4143 std::map<std::string, int> groups;
4144 read_groups(L, 1, groups);
4145 ToolCapabilities tp = read_tool_capabilities(L, 2);
4146 if(lua_isnoneornil(L, 3))
4147 push_hit_params(L, getHitParams(groups, &tp));
4149 push_hit_params(L, getHitParams(groups, &tp,
4150 luaL_checknumber(L, 3)));
4154 // get_current_modname()
4155 static int l_get_current_modname(lua_State *L)
4157 lua_getfield(L, LUA_REGISTRYINDEX, "minetest_current_modname");
4161 // get_modpath(modname)
4162 static int l_get_modpath(lua_State *L)
4164 std::string modname = luaL_checkstring(L, 1);
4166 if(modname == "__builtin"){
4167 std::string path = get_server(L)->getBuiltinLuaPath();
4168 lua_pushstring(L, path.c_str());
4171 const ModSpec *mod = get_server(L)->getModSpec(modname);
4176 lua_pushstring(L, mod->path.c_str());
4181 static int l_get_worldpath(lua_State *L)
4183 std::string worldpath = get_server(L)->getWorldPath();
4184 lua_pushstring(L, worldpath.c_str());
4188 // sound_play(spec, parameters)
4189 static int l_sound_play(lua_State *L)
4191 SimpleSoundSpec spec;
4192 read_soundspec(L, 1, spec);
4193 ServerSoundParams params;
4194 read_server_sound_params(L, 2, params);
4195 s32 handle = get_server(L)->playSound(spec, params);
4196 lua_pushinteger(L, handle);
4200 // sound_stop(handle)
4201 static int l_sound_stop(lua_State *L)
4203 int handle = luaL_checkinteger(L, 1);
4204 get_server(L)->stopSound(handle);
4208 // is_singleplayer()
4209 static int l_is_singleplayer(lua_State *L)
4211 lua_pushboolean(L, get_server(L)->isSingleplayer());
4215 // get_password_hash(name, raw_password)
4216 static int l_get_password_hash(lua_State *L)
4218 std::string name = luaL_checkstring(L, 1);
4219 std::string raw_password = luaL_checkstring(L, 2);
4220 std::string hash = translatePassword(name,
4221 narrow_to_wide(raw_password));
4222 lua_pushstring(L, hash.c_str());
4226 // notify_authentication_modified(name)
4227 static int l_notify_authentication_modified(lua_State *L)
4229 std::string name = "";
4230 if(lua_isstring(L, 1))
4231 name = lua_tostring(L, 1);
4232 get_server(L)->reportPrivsModified(name);
4236 // get_craft_result(input)
4237 static int l_get_craft_result(lua_State *L)
4240 std::string method_s = getstringfield_default(L, input_i, "method", "normal");
4241 enum CraftMethod method = (CraftMethod)getenumfield(L, input_i, "method",
4242 es_CraftMethod, CRAFT_METHOD_NORMAL);
4244 lua_getfield(L, input_i, "width");
4245 if(lua_isnumber(L, -1))
4246 width = luaL_checkinteger(L, -1);
4248 lua_getfield(L, input_i, "items");
4249 std::vector<ItemStack> items = read_items(L, -1);
4250 lua_pop(L, 1); // items
4252 IGameDef *gdef = get_server(L);
4253 ICraftDefManager *cdef = gdef->cdef();
4254 CraftInput input(method, width, items);
4256 bool got = cdef->getCraftResult(input, output, true, gdef);
4257 lua_newtable(L); // output table
4260 item.deSerialize(output.item, gdef->idef());
4261 LuaItemStack::create(L, item);
4262 lua_setfield(L, -2, "item");
4263 setintfield(L, -1, "time", output.time);
4265 LuaItemStack::create(L, ItemStack());
4266 lua_setfield(L, -2, "item");
4267 setintfield(L, -1, "time", 0);
4269 lua_newtable(L); // decremented input table
4270 lua_pushstring(L, method_s.c_str());
4271 lua_setfield(L, -2, "method");
4272 lua_pushinteger(L, width);
4273 lua_setfield(L, -2, "width");
4274 push_items(L, input.items);
4275 lua_setfield(L, -2, "items");
4279 static const struct luaL_Reg minetest_f [] = {
4282 {"register_item_raw", l_register_item_raw},
4283 {"register_alias_raw", l_register_alias_raw},
4284 {"register_craft", l_register_craft},
4285 {"setting_set", l_setting_set},
4286 {"setting_get", l_setting_get},
4287 {"setting_getbool", l_setting_getbool},
4288 {"chat_send_all", l_chat_send_all},
4289 {"chat_send_player", l_chat_send_player},
4290 {"get_player_privs", l_get_player_privs},
4291 {"get_inventory", l_get_inventory},
4292 {"get_dig_params", l_get_dig_params},
4293 {"get_hit_params", l_get_hit_params},
4294 {"get_current_modname", l_get_current_modname},
4295 {"get_modpath", l_get_modpath},
4296 {"get_worldpath", l_get_worldpath},
4297 {"sound_play", l_sound_play},
4298 {"sound_stop", l_sound_stop},
4299 {"is_singleplayer", l_is_singleplayer},
4300 {"get_password_hash", l_get_password_hash},
4301 {"notify_authentication_modified", l_notify_authentication_modified},
4302 {"get_craft_result", l_get_craft_result},
4307 Main export function
4310 void scriptapi_export(lua_State *L, Server *server)
4313 assert(lua_checkstack(L, 20));
4314 verbosestream<<"scriptapi_export()"<<std::endl;
4315 StackUnroller stack_unroller(L);
4317 // Store server as light userdata in registry
4318 lua_pushlightuserdata(L, server);
4319 lua_setfield(L, LUA_REGISTRYINDEX, "minetest_server");
4321 // Register global functions in table minetest
4323 luaL_register(L, NULL, minetest_f);
4324 lua_setglobal(L, "minetest");
4326 // Get the main minetest table
4327 lua_getglobal(L, "minetest");
4329 // Add tables to minetest
4332 lua_setfield(L, -2, "object_refs");
4334 lua_setfield(L, -2, "luaentities");
4336 // Register wrappers
4337 LuaItemStack::Register(L);
4338 InvRef::Register(L);
4339 NodeMetaRef::Register(L);
4340 ObjectRef::Register(L);
4341 EnvRef::Register(L);
4342 LuaPseudoRandom::Register(L);
4343 LuaPerlinNoise::Register(L);
4346 bool scriptapi_loadmod(lua_State *L, const std::string &scriptpath,
4347 const std::string &modname)
4349 ModNameStorer modnamestorer(L, modname);
4351 if(!string_allowed(modname, "abcdefghijklmnopqrstuvwxyz"
4353 errorstream<<"Error loading mod \""<<modname
4354 <<"\": modname does not follow naming conventions: "
4355 <<"Only chararacters [a-z0-9_] are allowed."<<std::endl;
4359 bool success = false;
4362 success = script_load(L, scriptpath.c_str());
4365 errorstream<<"Error loading mod \""<<modname
4366 <<"\": "<<e.what()<<std::endl;
4372 void scriptapi_add_environment(lua_State *L, ServerEnvironment *env)
4375 assert(lua_checkstack(L, 20));
4376 verbosestream<<"scriptapi_add_environment"<<std::endl;
4377 StackUnroller stack_unroller(L);
4379 // Create EnvRef on stack
4380 EnvRef::create(L, env);
4381 int envref = lua_gettop(L);
4383 // minetest.env = envref
4384 lua_getglobal(L, "minetest");
4385 luaL_checktype(L, -1, LUA_TTABLE);
4386 lua_pushvalue(L, envref);
4387 lua_setfield(L, -2, "env");
4389 // Store environment as light userdata in registry
4390 lua_pushlightuserdata(L, env);
4391 lua_setfield(L, LUA_REGISTRYINDEX, "minetest_env");
4394 Add ActiveBlockModifiers to environment
4397 // Get minetest.registered_abms
4398 lua_getglobal(L, "minetest");
4399 lua_getfield(L, -1, "registered_abms");
4400 luaL_checktype(L, -1, LUA_TTABLE);
4401 int registered_abms = lua_gettop(L);
4403 if(lua_istable(L, registered_abms)){
4404 int table = lua_gettop(L);
4406 while(lua_next(L, table) != 0){
4407 // key at index -2 and value at index -1
4408 int id = lua_tonumber(L, -2);
4409 int current_abm = lua_gettop(L);
4411 std::set<std::string> trigger_contents;
4412 lua_getfield(L, current_abm, "nodenames");
4413 if(lua_istable(L, -1)){
4414 int table = lua_gettop(L);
4416 while(lua_next(L, table) != 0){
4417 // key at index -2 and value at index -1
4418 luaL_checktype(L, -1, LUA_TSTRING);
4419 trigger_contents.insert(lua_tostring(L, -1));
4420 // removes value, keeps key for next iteration
4423 } else if(lua_isstring(L, -1)){
4424 trigger_contents.insert(lua_tostring(L, -1));
4428 std::set<std::string> required_neighbors;
4429 lua_getfield(L, current_abm, "neighbors");
4430 if(lua_istable(L, -1)){
4431 int table = lua_gettop(L);
4433 while(lua_next(L, table) != 0){
4434 // key at index -2 and value at index -1
4435 luaL_checktype(L, -1, LUA_TSTRING);
4436 required_neighbors.insert(lua_tostring(L, -1));
4437 // removes value, keeps key for next iteration
4440 } else if(lua_isstring(L, -1)){
4441 required_neighbors.insert(lua_tostring(L, -1));
4445 float trigger_interval = 10.0;
4446 getfloatfield(L, current_abm, "interval", trigger_interval);
4448 int trigger_chance = 50;
4449 getintfield(L, current_abm, "chance", trigger_chance);
4451 LuaABM *abm = new LuaABM(L, id, trigger_contents,
4452 required_neighbors, trigger_interval, trigger_chance);
4454 env->addActiveBlockModifier(abm);
4456 // removes value, keeps key for next iteration
4464 // Dump stack top with the dump2 function
4465 static void dump2(lua_State *L, const char *name)
4467 // Dump object (debug)
4468 lua_getglobal(L, "dump2");
4469 luaL_checktype(L, -1, LUA_TFUNCTION);
4470 lua_pushvalue(L, -2); // Get previous stack top as first parameter
4471 lua_pushstring(L, name);
4472 if(lua_pcall(L, 2, 0, 0))
4473 script_error(L, "error: %s", lua_tostring(L, -1));
4481 void scriptapi_add_object_reference(lua_State *L, ServerActiveObject *cobj)
4484 assert(lua_checkstack(L, 20));
4485 //infostream<<"scriptapi_add_object_reference: id="<<cobj->getId()<<std::endl;
4486 StackUnroller stack_unroller(L);
4488 // Create object on stack
4489 ObjectRef::create(L, cobj); // Puts ObjectRef (as userdata) on stack
4490 int object = lua_gettop(L);
4492 // Get minetest.object_refs table
4493 lua_getglobal(L, "minetest");
4494 lua_getfield(L, -1, "object_refs");
4495 luaL_checktype(L, -1, LUA_TTABLE);
4496 int objectstable = lua_gettop(L);
4498 // object_refs[id] = object
4499 lua_pushnumber(L, cobj->getId()); // Push id
4500 lua_pushvalue(L, object); // Copy object to top of stack
4501 lua_settable(L, objectstable);
4504 void scriptapi_rm_object_reference(lua_State *L, ServerActiveObject *cobj)
4507 assert(lua_checkstack(L, 20));
4508 //infostream<<"scriptapi_rm_object_reference: id="<<cobj->getId()<<std::endl;
4509 StackUnroller stack_unroller(L);
4511 // Get minetest.object_refs table
4512 lua_getglobal(L, "minetest");
4513 lua_getfield(L, -1, "object_refs");
4514 luaL_checktype(L, -1, LUA_TTABLE);
4515 int objectstable = lua_gettop(L);
4517 // Get object_refs[id]
4518 lua_pushnumber(L, cobj->getId()); // Push id
4519 lua_gettable(L, objectstable);
4520 // Set object reference to NULL
4521 ObjectRef::set_null(L);
4522 lua_pop(L, 1); // pop object
4524 // Set object_refs[id] = nil
4525 lua_pushnumber(L, cobj->getId()); // Push id
4527 lua_settable(L, objectstable);
4534 // What scriptapi_run_callbacks does with the return values of callbacks.
4535 // Regardless of the mode, if only one callback is defined,
4536 // its return value is the total return value.
4537 // Modes only affect the case where 0 or >= 2 callbacks are defined.
4538 enum RunCallbacksMode
4540 // Returns the return value of the first callback
4541 // Returns nil if list of callbacks is empty
4542 RUN_CALLBACKS_MODE_FIRST,
4543 // Returns the return value of the last callback
4544 // Returns nil if list of callbacks is empty
4545 RUN_CALLBACKS_MODE_LAST,
4546 // If any callback returns a false value, the first such is returned
4547 // Otherwise, the first callback's return value (trueish) is returned
4548 // Returns true if list of callbacks is empty
4549 RUN_CALLBACKS_MODE_AND,
4550 // Like above, but stops calling callbacks (short circuit)
4551 // after seeing the first false value
4552 RUN_CALLBACKS_MODE_AND_SC,
4553 // If any callback returns a true value, the first such is returned
4554 // Otherwise, the first callback's return value (falseish) is returned
4555 // Returns false if list of callbacks is empty
4556 RUN_CALLBACKS_MODE_OR,
4557 // Like above, but stops calling callbacks (short circuit)
4558 // after seeing the first true value
4559 RUN_CALLBACKS_MODE_OR_SC,
4560 // Note: "a true value" and "a false value" refer to values that
4561 // are converted by lua_toboolean to true or false, respectively.
4564 // Push the list of callbacks (a lua table).
4565 // Then push nargs arguments.
4566 // Then call this function, which
4567 // - runs the callbacks
4568 // - removes the table and arguments from the lua stack
4569 // - pushes the return value, computed depending on mode
4570 static void scriptapi_run_callbacks(lua_State *L, int nargs,
4571 RunCallbacksMode mode)
4573 // Insert the return value into the lua stack, below the table
4574 assert(lua_gettop(L) >= nargs + 1);
4576 lua_insert(L, -(nargs + 1) - 1);
4577 // Stack now looks like this:
4578 // ... <return value = nil> <table> <arg#1> <arg#2> ... <arg#n>
4580 int rv = lua_gettop(L) - nargs - 1;
4582 int arg = table + 1;
4584 luaL_checktype(L, table, LUA_TTABLE);
4588 bool first_loop = true;
4589 while(lua_next(L, table) != 0){
4590 // key at index -2 and value at index -1
4591 luaL_checktype(L, -1, LUA_TFUNCTION);
4593 for(int i = 0; i < nargs; i++)
4594 lua_pushvalue(L, arg+i);
4595 if(lua_pcall(L, nargs, 1, 0))
4596 script_error(L, "error: %s", lua_tostring(L, -1));
4598 // Move return value to designated space in stack
4601 // Result of first callback is always moved
4605 // Otherwise, what happens depends on the mode
4606 if(mode == RUN_CALLBACKS_MODE_FIRST)
4608 else if(mode == RUN_CALLBACKS_MODE_LAST)
4610 else if(mode == RUN_CALLBACKS_MODE_AND ||
4611 mode == RUN_CALLBACKS_MODE_AND_SC){
4612 if(lua_toboolean(L, rv) == true &&
4613 lua_toboolean(L, -1) == false)
4618 else if(mode == RUN_CALLBACKS_MODE_OR ||
4619 mode == RUN_CALLBACKS_MODE_OR_SC){
4620 if(lua_toboolean(L, rv) == false &&
4621 lua_toboolean(L, -1) == true)
4630 // Handle short circuit modes
4631 if(mode == RUN_CALLBACKS_MODE_AND_SC &&
4632 lua_toboolean(L, rv) == false)
4634 else if(mode == RUN_CALLBACKS_MODE_OR_SC &&
4635 lua_toboolean(L, rv) == true)
4638 // value removed, keep key for next iteration
4641 // Remove stuff from stack, leaving only the return value
4644 // Fix return value in case no callbacks were called
4646 if(mode == RUN_CALLBACKS_MODE_AND ||
4647 mode == RUN_CALLBACKS_MODE_AND_SC){
4649 lua_pushboolean(L, true);
4651 else if(mode == RUN_CALLBACKS_MODE_OR ||
4652 mode == RUN_CALLBACKS_MODE_OR_SC){
4654 lua_pushboolean(L, false);
4659 bool scriptapi_on_chat_message(lua_State *L, const std::string &name,
4660 const std::string &message)
4663 assert(lua_checkstack(L, 20));
4664 StackUnroller stack_unroller(L);
4666 // Get minetest.registered_on_chat_messages
4667 lua_getglobal(L, "minetest");
4668 lua_getfield(L, -1, "registered_on_chat_messages");
4670 lua_pushstring(L, name.c_str());
4671 lua_pushstring(L, message.c_str());
4672 scriptapi_run_callbacks(L, 2, RUN_CALLBACKS_MODE_OR_SC);
4673 bool ate = lua_toboolean(L, -1);
4677 void scriptapi_on_newplayer(lua_State *L, ServerActiveObject *player)
4680 assert(lua_checkstack(L, 20));
4681 StackUnroller stack_unroller(L);
4683 // Get minetest.registered_on_newplayers
4684 lua_getglobal(L, "minetest");
4685 lua_getfield(L, -1, "registered_on_newplayers");
4687 objectref_get_or_create(L, player);
4688 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
4691 void scriptapi_on_dieplayer(lua_State *L, ServerActiveObject *player)
4694 assert(lua_checkstack(L, 20));
4695 StackUnroller stack_unroller(L);
4697 // Get minetest.registered_on_dieplayers
4698 lua_getglobal(L, "minetest");
4699 lua_getfield(L, -1, "registered_on_dieplayers");
4701 objectref_get_or_create(L, player);
4702 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
4705 bool scriptapi_on_respawnplayer(lua_State *L, ServerActiveObject *player)
4708 assert(lua_checkstack(L, 20));
4709 StackUnroller stack_unroller(L);
4711 // Get minetest.registered_on_respawnplayers
4712 lua_getglobal(L, "minetest");
4713 lua_getfield(L, -1, "registered_on_respawnplayers");
4715 objectref_get_or_create(L, player);
4716 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_OR);
4717 bool positioning_handled_by_some = lua_toboolean(L, -1);
4718 return positioning_handled_by_some;
4721 void scriptapi_on_joinplayer(lua_State *L, ServerActiveObject *player)
4724 assert(lua_checkstack(L, 20));
4725 StackUnroller stack_unroller(L);
4727 // Get minetest.registered_on_joinplayers
4728 lua_getglobal(L, "minetest");
4729 lua_getfield(L, -1, "registered_on_joinplayers");
4731 objectref_get_or_create(L, player);
4732 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
4735 void scriptapi_on_leaveplayer(lua_State *L, ServerActiveObject *player)
4738 assert(lua_checkstack(L, 20));
4739 StackUnroller stack_unroller(L);
4741 // Get minetest.registered_on_leaveplayers
4742 lua_getglobal(L, "minetest");
4743 lua_getfield(L, -1, "registered_on_leaveplayers");
4745 objectref_get_or_create(L, player);
4746 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
4749 void scriptapi_get_creative_inventory(lua_State *L, ServerActiveObject *player)
4752 assert(lua_checkstack(L, 20));
4753 StackUnroller stack_unroller(L);
4755 Inventory *inv = player->getInventory();
4758 lua_getglobal(L, "minetest");
4759 lua_getfield(L, -1, "creative_inventory");
4760 luaL_checktype(L, -1, LUA_TTABLE);
4761 inventory_set_list_from_lua(inv, "main", L, -1, PLAYER_INVENTORY_SIZE);
4764 static void get_auth_handler(lua_State *L)
4766 lua_getglobal(L, "minetest");
4767 lua_getfield(L, -1, "registered_auth_handler");
4768 if(lua_isnil(L, -1)){
4770 lua_getfield(L, -1, "builtin_auth_handler");
4772 if(lua_type(L, -1) != LUA_TTABLE)
4773 throw LuaError(L, "Authentication handler table not valid");
4776 bool scriptapi_get_auth(lua_State *L, const std::string &playername,
4777 std::string *dst_password, std::set<std::string> *dst_privs)
4780 assert(lua_checkstack(L, 20));
4781 StackUnroller stack_unroller(L);
4783 get_auth_handler(L);
4784 lua_getfield(L, -1, "get_auth");
4785 if(lua_type(L, -1) != LUA_TFUNCTION)
4786 throw LuaError(L, "Authentication handler missing get_auth");
4787 lua_pushstring(L, playername.c_str());
4788 if(lua_pcall(L, 1, 1, 0))
4789 script_error(L, "error: %s", lua_tostring(L, -1));
4791 // nil = login not allowed
4792 if(lua_isnil(L, -1))
4794 luaL_checktype(L, -1, LUA_TTABLE);
4796 std::string password;
4797 bool found = getstringfield(L, -1, "password", password);
4799 throw LuaError(L, "Authentication handler didn't return password");
4801 *dst_password = password;
4803 lua_getfield(L, -1, "privileges");
4804 if(!lua_istable(L, -1))
4806 "Authentication handler didn't return privilege table");
4808 read_privileges(L, -1, *dst_privs);
4814 void scriptapi_create_auth(lua_State *L, const std::string &playername,
4815 const std::string &password)
4818 assert(lua_checkstack(L, 20));
4819 StackUnroller stack_unroller(L);
4821 get_auth_handler(L);
4822 lua_getfield(L, -1, "create_auth");
4823 if(lua_type(L, -1) != LUA_TFUNCTION)
4824 throw LuaError(L, "Authentication handler missing create_auth");
4825 lua_pushstring(L, playername.c_str());
4826 lua_pushstring(L, password.c_str());
4827 if(lua_pcall(L, 2, 0, 0))
4828 script_error(L, "error: %s", lua_tostring(L, -1));
4831 bool scriptapi_set_password(lua_State *L, const std::string &playername,
4832 const std::string &password)
4835 assert(lua_checkstack(L, 20));
4836 StackUnroller stack_unroller(L);
4838 get_auth_handler(L);
4839 lua_getfield(L, -1, "set_password");
4840 if(lua_type(L, -1) != LUA_TFUNCTION)
4841 throw LuaError(L, "Authentication handler missing set_password");
4842 lua_pushstring(L, playername.c_str());
4843 lua_pushstring(L, password.c_str());
4844 if(lua_pcall(L, 2, 1, 0))
4845 script_error(L, "error: %s", lua_tostring(L, -1));
4846 return lua_toboolean(L, -1);
4850 item callbacks and node callbacks
4853 // Retrieves minetest.registered_items[name][callbackname]
4854 // If that is nil or on error, return false and stack is unchanged
4855 // If that is a function, returns true and pushes the
4856 // function onto the stack
4857 static bool get_item_callback(lua_State *L,
4858 const char *name, const char *callbackname)
4860 lua_getglobal(L, "minetest");
4861 lua_getfield(L, -1, "registered_items");
4863 luaL_checktype(L, -1, LUA_TTABLE);
4864 lua_getfield(L, -1, name);
4866 // Should be a table
4867 if(lua_type(L, -1) != LUA_TTABLE)
4869 errorstream<<"Item \""<<name<<"\" not defined"<<std::endl;
4873 lua_getfield(L, -1, callbackname);
4875 // Should be a function or nil
4876 if(lua_type(L, -1) == LUA_TFUNCTION)
4880 else if(lua_isnil(L, -1))
4887 errorstream<<"Item \""<<name<<"\" callback \""
4888 <<callbackname<<" is not a function"<<std::endl;
4894 bool scriptapi_item_on_drop(lua_State *L, ItemStack &item,
4895 ServerActiveObject *dropper, v3f pos)
4898 assert(lua_checkstack(L, 20));
4899 StackUnroller stack_unroller(L);
4901 // Push callback function on stack
4902 if(!get_item_callback(L, item.name.c_str(), "on_drop"))
4906 LuaItemStack::create(L, item);
4907 objectref_get_or_create(L, dropper);
4908 pushFloatPos(L, pos);
4909 if(lua_pcall(L, 3, 1, 0))
4910 script_error(L, "error: %s", lua_tostring(L, -1));
4911 if(!lua_isnil(L, -1))
4912 item = read_item(L, -1);
4916 bool scriptapi_item_on_place(lua_State *L, ItemStack &item,
4917 ServerActiveObject *placer, const PointedThing &pointed)
4920 assert(lua_checkstack(L, 20));
4921 StackUnroller stack_unroller(L);
4923 // Push callback function on stack
4924 if(!get_item_callback(L, item.name.c_str(), "on_place"))
4928 LuaItemStack::create(L, item);
4929 objectref_get_or_create(L, placer);
4930 push_pointed_thing(L, pointed);
4931 if(lua_pcall(L, 3, 1, 0))
4932 script_error(L, "error: %s", lua_tostring(L, -1));
4933 if(!lua_isnil(L, -1))
4934 item = read_item(L, -1);
4938 bool scriptapi_item_on_use(lua_State *L, ItemStack &item,
4939 ServerActiveObject *user, const PointedThing &pointed)
4942 assert(lua_checkstack(L, 20));
4943 StackUnroller stack_unroller(L);
4945 // Push callback function on stack
4946 if(!get_item_callback(L, item.name.c_str(), "on_use"))
4950 LuaItemStack::create(L, item);
4951 objectref_get_or_create(L, user);
4952 push_pointed_thing(L, pointed);
4953 if(lua_pcall(L, 3, 1, 0))
4954 script_error(L, "error: %s", lua_tostring(L, -1));
4955 if(!lua_isnil(L, -1))
4956 item = read_item(L, -1);
4960 bool scriptapi_node_on_punch(lua_State *L, v3s16 p, MapNode node,
4961 ServerActiveObject *puncher)
4964 assert(lua_checkstack(L, 20));
4965 StackUnroller stack_unroller(L);
4967 INodeDefManager *ndef = get_server(L)->ndef();
4969 // Push callback function on stack
4970 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_punch"))
4975 pushnode(L, node, ndef);
4976 objectref_get_or_create(L, puncher);
4977 if(lua_pcall(L, 3, 0, 0))
4978 script_error(L, "error: %s", lua_tostring(L, -1));
4982 bool scriptapi_node_on_dig(lua_State *L, v3s16 p, MapNode node,
4983 ServerActiveObject *digger)
4986 assert(lua_checkstack(L, 20));
4987 StackUnroller stack_unroller(L);
4989 INodeDefManager *ndef = get_server(L)->ndef();
4991 // Push callback function on stack
4992 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_dig"))
4997 pushnode(L, node, ndef);
4998 objectref_get_or_create(L, digger);
4999 if(lua_pcall(L, 3, 0, 0))
5000 script_error(L, "error: %s", lua_tostring(L, -1));
5004 void scriptapi_node_on_construct(lua_State *L, v3s16 p, MapNode node)
5007 assert(lua_checkstack(L, 20));
5008 StackUnroller stack_unroller(L);
5010 INodeDefManager *ndef = get_server(L)->ndef();
5012 // Push callback function on stack
5013 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_construct"))
5018 if(lua_pcall(L, 1, 0, 0))
5019 script_error(L, "error: %s", lua_tostring(L, -1));
5022 void scriptapi_node_on_destruct(lua_State *L, v3s16 p, MapNode node)
5025 assert(lua_checkstack(L, 20));
5026 StackUnroller stack_unroller(L);
5028 INodeDefManager *ndef = get_server(L)->ndef();
5030 // Push callback function on stack
5031 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_destruct"))
5036 if(lua_pcall(L, 1, 0, 0))
5037 script_error(L, "error: %s", lua_tostring(L, -1));
5040 void scriptapi_node_on_receive_fields(lua_State *L, v3s16 p,
5041 const std::string &formname,
5042 const std::map<std::string, std::string> &fields,
5043 ServerActiveObject *sender)
5046 assert(lua_checkstack(L, 20));
5047 StackUnroller stack_unroller(L);
5049 INodeDefManager *ndef = get_server(L)->ndef();
5051 // If node doesn't exist, we don't know what callback to call
5052 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
5053 if(node.getContent() == CONTENT_IGNORE)
5056 // Push callback function on stack
5057 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_receive_fields"))
5064 lua_pushstring(L, formname.c_str());
5067 for(std::map<std::string, std::string>::const_iterator
5068 i = fields.begin(); i != fields.end(); i++){
5069 const std::string &name = i->first;
5070 const std::string &value = i->second;
5071 lua_pushstring(L, name.c_str());
5072 lua_pushlstring(L, value.c_str(), value.size());
5073 lua_settable(L, -3);
5076 objectref_get_or_create(L, sender);
5077 if(lua_pcall(L, 4, 0, 0))
5078 script_error(L, "error: %s", lua_tostring(L, -1));
5081 void scriptapi_node_on_metadata_inventory_move(lua_State *L, v3s16 p,
5082 const std::string &from_list, int from_index,
5083 const std::string &to_list, int to_index,
5084 int count, ServerActiveObject *player)
5087 assert(lua_checkstack(L, 20));
5088 StackUnroller stack_unroller(L);
5090 INodeDefManager *ndef = get_server(L)->ndef();
5092 // If node doesn't exist, we don't know what callback to call
5093 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
5094 if(node.getContent() == CONTENT_IGNORE)
5097 // Push callback function on stack
5098 if(!get_item_callback(L, ndef->get(node).name.c_str(),
5099 "on_metadata_inventory_move"))
5102 // function(pos, from_list, from_index, to_list, to_index, count, player)
5104 lua_pushstring(L, from_list.c_str());
5105 lua_pushinteger(L, from_index + 1);
5106 lua_pushstring(L, to_list.c_str());
5107 lua_pushinteger(L, to_index + 1);
5108 lua_pushinteger(L, count);
5109 objectref_get_or_create(L, player);
5110 if(lua_pcall(L, 7, 0, 0))
5111 script_error(L, "error: %s", lua_tostring(L, -1));
5114 ItemStack scriptapi_node_on_metadata_inventory_offer(lua_State *L, v3s16 p,
5115 const std::string &listname, int index, ItemStack &stack,
5116 ServerActiveObject *player)
5119 assert(lua_checkstack(L, 20));
5120 StackUnroller stack_unroller(L);
5122 INodeDefManager *ndef = get_server(L)->ndef();
5124 // If node doesn't exist, we don't know what callback to call
5125 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
5126 if(node.getContent() == CONTENT_IGNORE)
5129 // Push callback function on stack
5130 if(!get_item_callback(L, ndef->get(node).name.c_str(),
5131 "on_metadata_inventory_offer"))
5134 // Call function(pos, listname, index, stack, player)
5136 lua_pushstring(L, listname.c_str());
5137 lua_pushinteger(L, index + 1);
5138 LuaItemStack::create(L, stack);
5139 objectref_get_or_create(L, player);
5140 if(lua_pcall(L, 5, 1, 0))
5141 script_error(L, "error: %s", lua_tostring(L, -1));
5142 return read_item(L, -1);
5145 ItemStack scriptapi_node_on_metadata_inventory_take(lua_State *L, v3s16 p,
5146 const std::string &listname, int index, int count,
5147 ServerActiveObject *player)
5150 assert(lua_checkstack(L, 20));
5151 StackUnroller stack_unroller(L);
5153 INodeDefManager *ndef = get_server(L)->ndef();
5155 // If node doesn't exist, we don't know what callback to call
5156 MapNode node = get_env(L)->getMap().getNodeNoEx(p);
5157 if(node.getContent() == CONTENT_IGNORE)
5160 // Push callback function on stack
5161 if(!get_item_callback(L, ndef->get(node).name.c_str(),
5162 "on_metadata_inventory_take"))
5165 // Call function(pos, listname, index, count, player)
5167 lua_pushstring(L, listname.c_str());
5168 lua_pushinteger(L, index + 1);
5169 lua_pushinteger(L, count);
5170 objectref_get_or_create(L, player);
5171 if(lua_pcall(L, 5, 1, 0))
5172 script_error(L, "error: %s", lua_tostring(L, -1));
5173 return read_item(L, -1);
5180 void scriptapi_environment_step(lua_State *L, float dtime)
5183 assert(lua_checkstack(L, 20));
5184 //infostream<<"scriptapi_environment_step"<<std::endl;
5185 StackUnroller stack_unroller(L);
5187 // Get minetest.registered_globalsteps
5188 lua_getglobal(L, "minetest");
5189 lua_getfield(L, -1, "registered_globalsteps");
5191 lua_pushnumber(L, dtime);
5192 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
5195 void scriptapi_environment_on_generated(lua_State *L, v3s16 minp, v3s16 maxp,
5199 assert(lua_checkstack(L, 20));
5200 //infostream<<"scriptapi_environment_on_generated"<<std::endl;
5201 StackUnroller stack_unroller(L);
5203 // Get minetest.registered_on_generateds
5204 lua_getglobal(L, "minetest");
5205 lua_getfield(L, -1, "registered_on_generateds");
5207 push_v3s16(L, minp);
5208 push_v3s16(L, maxp);
5209 lua_pushnumber(L, blockseed);
5210 scriptapi_run_callbacks(L, 3, RUN_CALLBACKS_MODE_FIRST);
5217 bool scriptapi_luaentity_add(lua_State *L, u16 id, const char *name)
5220 assert(lua_checkstack(L, 20));
5221 verbosestream<<"scriptapi_luaentity_add: id="<<id<<" name=\""
5222 <<name<<"\""<<std::endl;
5223 StackUnroller stack_unroller(L);
5225 // Get minetest.registered_entities[name]
5226 lua_getglobal(L, "minetest");
5227 lua_getfield(L, -1, "registered_entities");
5228 luaL_checktype(L, -1, LUA_TTABLE);
5229 lua_pushstring(L, name);
5230 lua_gettable(L, -2);
5231 // Should be a table, which we will use as a prototype
5232 //luaL_checktype(L, -1, LUA_TTABLE);
5233 if(lua_type(L, -1) != LUA_TTABLE){
5234 errorstream<<"LuaEntity name \""<<name<<"\" not defined"<<std::endl;
5237 int prototype_table = lua_gettop(L);
5238 //dump2(L, "prototype_table");
5240 // Create entity object
5242 int object = lua_gettop(L);
5244 // Set object metatable
5245 lua_pushvalue(L, prototype_table);
5246 lua_setmetatable(L, -2);
5248 // Add object reference
5249 // This should be userdata with metatable ObjectRef
5250 objectref_get(L, id);
5251 luaL_checktype(L, -1, LUA_TUSERDATA);
5252 if(!luaL_checkudata(L, -1, "ObjectRef"))
5253 luaL_typerror(L, -1, "ObjectRef");
5254 lua_setfield(L, -2, "object");
5256 // minetest.luaentities[id] = object
5257 lua_getglobal(L, "minetest");
5258 lua_getfield(L, -1, "luaentities");
5259 luaL_checktype(L, -1, LUA_TTABLE);
5260 lua_pushnumber(L, id); // Push id
5261 lua_pushvalue(L, object); // Copy object to top of stack
5262 lua_settable(L, -3);
5267 void scriptapi_luaentity_activate(lua_State *L, u16 id,
5268 const std::string &staticdata)
5271 assert(lua_checkstack(L, 20));
5272 verbosestream<<"scriptapi_luaentity_activate: id="<<id<<std::endl;
5273 StackUnroller stack_unroller(L);
5275 // Get minetest.luaentities[id]
5276 luaentity_get(L, id);
5277 int object = lua_gettop(L);
5279 // Get on_activate function
5280 lua_pushvalue(L, object);
5281 lua_getfield(L, -1, "on_activate");
5282 if(!lua_isnil(L, -1)){
5283 luaL_checktype(L, -1, LUA_TFUNCTION);
5284 lua_pushvalue(L, object); // self
5285 lua_pushlstring(L, staticdata.c_str(), staticdata.size());
5286 // Call with 2 arguments, 0 results
5287 if(lua_pcall(L, 2, 0, 0))
5288 script_error(L, "error running function on_activate: %s\n",
5289 lua_tostring(L, -1));
5293 void scriptapi_luaentity_rm(lua_State *L, u16 id)
5296 assert(lua_checkstack(L, 20));
5297 verbosestream<<"scriptapi_luaentity_rm: id="<<id<<std::endl;
5299 // Get minetest.luaentities table
5300 lua_getglobal(L, "minetest");
5301 lua_getfield(L, -1, "luaentities");
5302 luaL_checktype(L, -1, LUA_TTABLE);
5303 int objectstable = lua_gettop(L);
5305 // Set luaentities[id] = nil
5306 lua_pushnumber(L, id); // Push id
5308 lua_settable(L, objectstable);
5310 lua_pop(L, 2); // pop luaentities, minetest
5313 std::string scriptapi_luaentity_get_staticdata(lua_State *L, u16 id)
5316 assert(lua_checkstack(L, 20));
5317 //infostream<<"scriptapi_luaentity_get_staticdata: id="<<id<<std::endl;
5318 StackUnroller stack_unroller(L);
5320 // Get minetest.luaentities[id]
5321 luaentity_get(L, id);
5322 int object = lua_gettop(L);
5324 // Get get_staticdata function
5325 lua_pushvalue(L, object);
5326 lua_getfield(L, -1, "get_staticdata");
5327 if(lua_isnil(L, -1))
5330 luaL_checktype(L, -1, LUA_TFUNCTION);
5331 lua_pushvalue(L, object); // self
5332 // Call with 1 arguments, 1 results
5333 if(lua_pcall(L, 1, 1, 0))
5334 script_error(L, "error running function get_staticdata: %s\n",
5335 lua_tostring(L, -1));
5338 const char *s = lua_tolstring(L, -1, &len);
5339 return std::string(s, len);
5342 void scriptapi_luaentity_get_properties(lua_State *L, u16 id,
5343 ObjectProperties *prop)
5346 assert(lua_checkstack(L, 20));
5347 //infostream<<"scriptapi_luaentity_get_properties: id="<<id<<std::endl;
5348 StackUnroller stack_unroller(L);
5350 // Get minetest.luaentities[id]
5351 luaentity_get(L, id);
5352 //int object = lua_gettop(L);
5354 // Set default values that differ from ObjectProperties defaults
5357 // Deprecated: read object properties directly
5358 read_object_properties(L, -1, prop);
5360 // Read initial_properties
5361 lua_getfield(L, -1, "initial_properties");
5362 read_object_properties(L, -1, prop);
5366 void scriptapi_luaentity_step(lua_State *L, u16 id, float dtime)
5369 assert(lua_checkstack(L, 20));
5370 //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
5371 StackUnroller stack_unroller(L);
5373 // Get minetest.luaentities[id]
5374 luaentity_get(L, id);
5375 int object = lua_gettop(L);
5376 // State: object is at top of stack
5377 // Get step function
5378 lua_getfield(L, -1, "on_step");
5379 if(lua_isnil(L, -1))
5381 luaL_checktype(L, -1, LUA_TFUNCTION);
5382 lua_pushvalue(L, object); // self
5383 lua_pushnumber(L, dtime); // dtime
5384 // Call with 2 arguments, 0 results
5385 if(lua_pcall(L, 2, 0, 0))
5386 script_error(L, "error running function 'on_step': %s\n", lua_tostring(L, -1));
5389 // Calls entity:on_punch(ObjectRef puncher, time_from_last_punch,
5390 // tool_capabilities, direction)
5391 void scriptapi_luaentity_punch(lua_State *L, u16 id,
5392 ServerActiveObject *puncher, float time_from_last_punch,
5393 const ToolCapabilities *toolcap, v3f dir)
5396 assert(lua_checkstack(L, 20));
5397 //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
5398 StackUnroller stack_unroller(L);
5400 // Get minetest.luaentities[id]
5401 luaentity_get(L, id);
5402 int object = lua_gettop(L);
5403 // State: object is at top of stack
5405 lua_getfield(L, -1, "on_punch");
5406 if(lua_isnil(L, -1))
5408 luaL_checktype(L, -1, LUA_TFUNCTION);
5409 lua_pushvalue(L, object); // self
5410 objectref_get_or_create(L, puncher); // Clicker reference
5411 lua_pushnumber(L, time_from_last_punch);
5412 push_tool_capabilities(L, *toolcap);
5414 // Call with 5 arguments, 0 results
5415 if(lua_pcall(L, 5, 0, 0))
5416 script_error(L, "error running function 'on_punch': %s\n", lua_tostring(L, -1));
5419 // Calls entity:on_rightclick(ObjectRef clicker)
5420 void scriptapi_luaentity_rightclick(lua_State *L, u16 id,
5421 ServerActiveObject *clicker)
5424 assert(lua_checkstack(L, 20));
5425 //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
5426 StackUnroller stack_unroller(L);
5428 // Get minetest.luaentities[id]
5429 luaentity_get(L, id);
5430 int object = lua_gettop(L);
5431 // State: object is at top of stack
5433 lua_getfield(L, -1, "on_rightclick");
5434 if(lua_isnil(L, -1))
5436 luaL_checktype(L, -1, LUA_TFUNCTION);
5437 lua_pushvalue(L, object); // self
5438 objectref_get_or_create(L, clicker); // Clicker reference
5439 // Call with 2 arguments, 0 results
5440 if(lua_pcall(L, 2, 0, 0))
5441 script_error(L, "error running function 'on_rightclick': %s\n", lua_tostring(L, -1));