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"},
422 C struct <-> Lua table converter functions
425 static void push_v3f(lua_State *L, v3f p)
428 lua_pushnumber(L, p.X);
429 lua_setfield(L, -2, "x");
430 lua_pushnumber(L, p.Y);
431 lua_setfield(L, -2, "y");
432 lua_pushnumber(L, p.Z);
433 lua_setfield(L, -2, "z");
436 static v2s16 read_v2s16(lua_State *L, int index)
439 luaL_checktype(L, index, LUA_TTABLE);
440 lua_getfield(L, index, "x");
441 p.X = lua_tonumber(L, -1);
443 lua_getfield(L, index, "y");
444 p.Y = lua_tonumber(L, -1);
449 static v2f read_v2f(lua_State *L, int index)
452 luaL_checktype(L, index, LUA_TTABLE);
453 lua_getfield(L, index, "x");
454 p.X = lua_tonumber(L, -1);
456 lua_getfield(L, index, "y");
457 p.Y = lua_tonumber(L, -1);
462 static v3f read_v3f(lua_State *L, int index)
465 luaL_checktype(L, index, LUA_TTABLE);
466 lua_getfield(L, index, "x");
467 pos.X = lua_tonumber(L, -1);
469 lua_getfield(L, index, "y");
470 pos.Y = lua_tonumber(L, -1);
472 lua_getfield(L, index, "z");
473 pos.Z = lua_tonumber(L, -1);
478 static v3f check_v3f(lua_State *L, int index)
481 luaL_checktype(L, index, LUA_TTABLE);
482 lua_getfield(L, index, "x");
483 pos.X = luaL_checknumber(L, -1);
485 lua_getfield(L, index, "y");
486 pos.Y = luaL_checknumber(L, -1);
488 lua_getfield(L, index, "z");
489 pos.Z = luaL_checknumber(L, -1);
494 static void pushFloatPos(lua_State *L, v3f p)
500 static v3f checkFloatPos(lua_State *L, int index)
502 return check_v3f(L, index) * BS;
505 static void push_v3s16(lua_State *L, v3s16 p)
508 lua_pushnumber(L, p.X);
509 lua_setfield(L, -2, "x");
510 lua_pushnumber(L, p.Y);
511 lua_setfield(L, -2, "y");
512 lua_pushnumber(L, p.Z);
513 lua_setfield(L, -2, "z");
516 static v3s16 read_v3s16(lua_State *L, int index)
518 // Correct rounding at <0
519 v3f pf = read_v3f(L, index);
520 return floatToInt(pf, 1.0);
523 static v3s16 check_v3s16(lua_State *L, int index)
525 // Correct rounding at <0
526 v3f pf = check_v3f(L, index);
527 return floatToInt(pf, 1.0);
530 static void pushnode(lua_State *L, const MapNode &n, INodeDefManager *ndef)
533 lua_pushstring(L, ndef->get(n).name.c_str());
534 lua_setfield(L, -2, "name");
535 lua_pushnumber(L, n.getParam1());
536 lua_setfield(L, -2, "param1");
537 lua_pushnumber(L, n.getParam2());
538 lua_setfield(L, -2, "param2");
541 static MapNode readnode(lua_State *L, int index, INodeDefManager *ndef)
543 lua_getfield(L, index, "name");
544 const char *name = luaL_checkstring(L, -1);
547 lua_getfield(L, index, "param1");
551 param1 = lua_tonumber(L, -1);
554 lua_getfield(L, index, "param2");
558 param2 = lua_tonumber(L, -1);
560 return MapNode(ndef, name, param1, param2);
563 static video::SColor readARGB8(lua_State *L, int index)
566 luaL_checktype(L, index, LUA_TTABLE);
567 lua_getfield(L, index, "a");
568 if(lua_isnumber(L, -1))
569 color.setAlpha(lua_tonumber(L, -1));
571 lua_getfield(L, index, "r");
572 color.setRed(lua_tonumber(L, -1));
574 lua_getfield(L, index, "g");
575 color.setGreen(lua_tonumber(L, -1));
577 lua_getfield(L, index, "b");
578 color.setBlue(lua_tonumber(L, -1));
583 static core::aabbox3d<f32> read_aabbox3df32(lua_State *L, int index, f32 scale)
585 core::aabbox3d<f32> box;
586 if(lua_istable(L, -1)){
587 lua_rawgeti(L, -1, 1);
588 box.MinEdge.X = lua_tonumber(L, -1) * scale;
590 lua_rawgeti(L, -1, 2);
591 box.MinEdge.Y = lua_tonumber(L, -1) * scale;
593 lua_rawgeti(L, -1, 3);
594 box.MinEdge.Z = lua_tonumber(L, -1) * scale;
596 lua_rawgeti(L, -1, 4);
597 box.MaxEdge.X = lua_tonumber(L, -1) * scale;
599 lua_rawgeti(L, -1, 5);
600 box.MaxEdge.Y = lua_tonumber(L, -1) * scale;
602 lua_rawgeti(L, -1, 6);
603 box.MaxEdge.Z = lua_tonumber(L, -1) * scale;
614 static MaterialProperties read_material_properties(
615 lua_State *L, int table)
617 MaterialProperties prop;
618 prop.diggability = (Diggability)getenumfield(L, -1, "diggability",
619 es_Diggability, DIGGABLE_NORMAL);
620 getfloatfield(L, -1, "constant_time", prop.constant_time);
621 getfloatfield(L, -1, "weight", prop.weight);
622 getfloatfield(L, -1, "crackiness", prop.crackiness);
623 getfloatfield(L, -1, "crumbliness", prop.crumbliness);
624 getfloatfield(L, -1, "cuttability", prop.cuttability);
625 getfloatfield(L, -1, "flammability", prop.flammability);
633 static void read_groups(lua_State *L, int index,
634 std::map<std::string, int> &result)
640 while(lua_next(L, index) != 0){
641 // key at index -2 and value at index -1
642 std::string name = luaL_checkstring(L, -2);
643 int rating = luaL_checkinteger(L, -1);
644 result[name] = rating;
645 // removes value, keeps key for next iteration
653 static void read_privileges(lua_State *L, int index,
654 std::set<std::string> &result)
660 while(lua_next(L, index) != 0){
661 // key at index -2 and value at index -1
662 std::string key = luaL_checkstring(L, -2);
663 bool value = lua_toboolean(L, -1);
666 // removes value, keeps key for next iteration
675 static ToolCapabilities read_tool_capabilities(
676 lua_State *L, int table)
678 ToolCapabilities toolcap;
679 getfloatfield(L, table, "full_punch_interval", toolcap.full_punch_interval);
680 getintfield(L, table, "max_drop_level", toolcap.max_drop_level);
681 lua_getfield(L, table, "groupcaps");
682 if(lua_istable(L, -1)){
683 int table_groupcaps = lua_gettop(L);
685 while(lua_next(L, table_groupcaps) != 0){
686 // key at index -2 and value at index -1
687 std::string groupname = luaL_checkstring(L, -2);
688 if(lua_istable(L, -1)){
689 int table_groupcap = lua_gettop(L);
690 // This will be created
691 ToolGroupCap groupcap;
692 // Read simple parameters
693 getintfield(L, table_groupcap, "maxlevel", groupcap.maxlevel);
694 getintfield(L, table_groupcap, "uses", groupcap.uses);
695 // DEPRECATED: maxwear
697 if(getfloatfield(L, table_groupcap, "maxwear", maxwear)){
699 groupcap.uses = 1.0/maxwear;
702 infostream<<script_get_backtrace(L)<<std::endl;
703 infostream<<"WARNING: field \"maxwear\" is deprecated; "
704 <<"should replace with uses=1/maxwear"<<std::endl;
706 // Read "times" table
707 lua_getfield(L, table_groupcap, "times");
708 if(lua_istable(L, -1)){
709 int table_times = lua_gettop(L);
711 while(lua_next(L, table_times) != 0){
712 // key at index -2 and value at index -1
713 int rating = luaL_checkinteger(L, -2);
714 float time = luaL_checknumber(L, -1);
715 groupcap.times[rating] = time;
716 // removes value, keeps key for next iteration
721 // Insert groupcap into toolcap
722 toolcap.groupcaps[groupname] = groupcap;
724 // removes value, keeps key for next iteration
732 static void set_tool_capabilities(lua_State *L, int table,
733 const ToolCapabilities &toolcap)
735 setfloatfield(L, table, "full_punch_interval", toolcap.full_punch_interval);
736 setintfield(L, table, "max_drop_level", toolcap.max_drop_level);
737 // Create groupcaps table
740 for(std::map<std::string, ToolGroupCap>::const_iterator
741 i = toolcap.groupcaps.begin(); i != toolcap.groupcaps.end(); i++){
742 // Create groupcap table
744 const std::string &name = i->first;
745 const ToolGroupCap &groupcap = i->second;
746 // Create subtable "times"
748 for(std::map<int, float>::const_iterator
749 i = groupcap.times.begin(); i != groupcap.times.end(); i++){
750 int rating = i->first;
751 float time = i->second;
752 lua_pushinteger(L, rating);
753 lua_pushnumber(L, time);
756 // Set subtable "times"
757 lua_setfield(L, -2, "times");
758 // Set simple parameters
759 setintfield(L, -1, "maxlevel", groupcap.maxlevel);
760 setintfield(L, -1, "uses", groupcap.uses);
761 // Insert groupcap table into groupcaps table
762 lua_setfield(L, -2, name.c_str());
764 // Set groupcaps table
765 lua_setfield(L, -2, "groupcaps");
768 static void push_tool_capabilities(lua_State *L,
769 const ToolCapabilities &prop)
772 set_tool_capabilities(L, -1, prop);
779 static void set_dig_params(lua_State *L, int table,
780 const DigParams ¶ms)
782 setboolfield(L, table, "diggable", params.diggable);
783 setfloatfield(L, table, "time", params.time);
784 setintfield(L, table, "wear", params.wear);
787 static void push_dig_params(lua_State *L,
788 const DigParams ¶ms)
791 set_dig_params(L, -1, params);
798 static void set_hit_params(lua_State *L, int table,
799 const HitParams ¶ms)
801 setintfield(L, table, "hp", params.hp);
802 setintfield(L, table, "wear", params.wear);
805 static void push_hit_params(lua_State *L,
806 const HitParams ¶ms)
809 set_hit_params(L, -1, params);
816 static void push_pointed_thing(lua_State *L, const PointedThing& pointed)
819 if(pointed.type == POINTEDTHING_NODE)
821 lua_pushstring(L, "node");
822 lua_setfield(L, -2, "type");
823 push_v3s16(L, pointed.node_undersurface);
824 lua_setfield(L, -2, "under");
825 push_v3s16(L, pointed.node_abovesurface);
826 lua_setfield(L, -2, "above");
828 else if(pointed.type == POINTEDTHING_OBJECT)
830 lua_pushstring(L, "object");
831 lua_setfield(L, -2, "type");
832 objectref_get(L, pointed.object_id);
833 lua_setfield(L, -2, "ref");
837 lua_pushstring(L, "nothing");
838 lua_setfield(L, -2, "type");
846 static void read_soundspec(lua_State *L, int index, SimpleSoundSpec &spec)
849 index = lua_gettop(L) + 1 + index;
850 if(lua_isnil(L, index)){
851 } else if(lua_istable(L, index)){
852 getstringfield(L, index, "name", spec.name);
853 getfloatfield(L, index, "gain", spec.gain);
854 } else if(lua_isstring(L, index)){
855 spec.name = lua_tostring(L, index);
863 static void read_object_properties(lua_State *L, int index,
864 ObjectProperties *prop)
867 index = lua_gettop(L) + 1 + index;
868 if(!lua_istable(L, index))
871 prop->hp_max = getintfield_default(L, -1, "hp_max", 10);
873 getboolfield(L, -1, "physical", prop->physical);
875 getfloatfield(L, -1, "weight", prop->weight);
877 lua_getfield(L, -1, "collisionbox");
878 if(lua_istable(L, -1))
879 prop->collisionbox = read_aabbox3df32(L, -1, 1.0);
882 getstringfield(L, -1, "visual", prop->visual);
884 lua_getfield(L, -1, "visual_size");
885 if(lua_istable(L, -1))
886 prop->visual_size = read_v2f(L, -1);
889 lua_getfield(L, -1, "textures");
890 if(lua_istable(L, -1)){
891 prop->textures.clear();
892 int table = lua_gettop(L);
894 while(lua_next(L, table) != 0){
895 // key at index -2 and value at index -1
896 if(lua_isstring(L, -1))
897 prop->textures.push_back(lua_tostring(L, -1));
899 prop->textures.push_back("");
900 // removes value, keeps key for next iteration
906 lua_getfield(L, -1, "spritediv");
907 if(lua_istable(L, -1))
908 prop->spritediv = read_v2s16(L, -1);
911 lua_getfield(L, -1, "initial_sprite_basepos");
912 if(lua_istable(L, -1))
913 prop->initial_sprite_basepos = read_v2s16(L, -1);
916 getboolfield(L, -1, "is_visible", prop->is_visible);
917 getboolfield(L, -1, "makes_footstep_sound", prop->makes_footstep_sound);
918 getfloatfield(L, -1, "automatic_rotate", prop->automatic_rotate);
925 static ItemDefinition read_item_definition(lua_State *L, int index)
928 index = lua_gettop(L) + 1 + index;
930 // Read the item definition
933 def.type = (ItemType)getenumfield(L, index, "type",
934 es_ItemType, ITEM_NONE);
935 getstringfield(L, index, "name", def.name);
936 getstringfield(L, index, "description", def.description);
937 getstringfield(L, index, "inventory_image", def.inventory_image);
938 getstringfield(L, index, "wield_image", def.wield_image);
940 lua_getfield(L, index, "wield_scale");
941 if(lua_istable(L, -1)){
942 def.wield_scale = check_v3f(L, -1);
946 def.stack_max = getintfield_default(L, index, "stack_max", def.stack_max);
947 if(def.stack_max == 0)
950 lua_getfield(L, index, "on_use");
951 def.usable = lua_isfunction(L, -1);
954 getboolfield(L, index, "liquids_pointable", def.liquids_pointable);
956 warn_if_field_exists(L, index, "tool_digging_properties",
957 "deprecated: use tool_capabilities");
959 lua_getfield(L, index, "tool_capabilities");
960 if(lua_istable(L, -1)){
961 def.tool_capabilities = new ToolCapabilities(
962 read_tool_capabilities(L, -1));
965 // If name is "" (hand), ensure there are ToolCapabilities
966 // because it will be looked up there whenever any other item has
967 // no ToolCapabilities
968 if(def.name == "" && def.tool_capabilities == NULL){
969 def.tool_capabilities = new ToolCapabilities();
972 lua_getfield(L, index, "groups");
973 read_groups(L, -1, def.groups);
983 static ContentFeatures read_content_features(lua_State *L, int index)
986 index = lua_gettop(L) + 1 + index;
990 getstringfield(L, index, "name", f.name);
993 lua_getfield(L, index, "groups");
994 read_groups(L, -1, f.groups);
997 /* Visual definition */
999 f.drawtype = (NodeDrawType)getenumfield(L, index, "drawtype", es_DrawType,
1001 getfloatfield(L, index, "visual_scale", f.visual_scale);
1003 lua_getfield(L, index, "tile_images");
1004 if(lua_istable(L, -1)){
1005 int table = lua_gettop(L);
1008 while(lua_next(L, table) != 0){
1009 // key at index -2 and value at index -1
1010 if(lua_isstring(L, -1))
1011 f.tname_tiles[i] = lua_tostring(L, -1);
1013 f.tname_tiles[i] = "";
1014 // removes value, keeps key for next iteration
1022 // Copy last value to all remaining textures
1024 std::string lastname = f.tname_tiles[i-1];
1026 f.tname_tiles[i] = lastname;
1033 lua_getfield(L, index, "special_materials");
1034 if(lua_istable(L, -1)){
1035 int table = lua_gettop(L);
1038 while(lua_next(L, table) != 0){
1039 // key at index -2 and value at index -1
1040 int smtable = lua_gettop(L);
1041 std::string tname = getstringfield_default(
1042 L, smtable, "image", "");
1043 bool backface_culling = getboolfield_default(
1044 L, smtable, "backface_culling", true);
1045 MaterialSpec mspec(tname, backface_culling);
1046 f.mspec_special[i] = mspec;
1047 // removes value, keeps key for next iteration
1058 f.alpha = getintfield_default(L, index, "alpha", 255);
1062 lua_getfield(L, index, "post_effect_color");
1063 if(!lua_isnil(L, -1))
1064 f.post_effect_color = readARGB8(L, -1);
1067 f.param_type = (ContentParamType)getenumfield(L, index, "paramtype",
1068 es_ContentParamType, CPT_NONE);
1069 f.param_type_2 = (ContentParamType2)getenumfield(L, index, "paramtype2",
1070 es_ContentParamType2, CPT2_NONE);
1072 // Warn about some deprecated fields
1073 warn_if_field_exists(L, index, "wall_mounted",
1074 "deprecated: use paramtype2 = 'wallmounted'");
1075 warn_if_field_exists(L, index, "light_propagates",
1076 "deprecated: determined from paramtype");
1077 warn_if_field_exists(L, index, "dug_item",
1078 "deprecated: use 'drop' field");
1079 warn_if_field_exists(L, index, "extra_dug_item",
1080 "deprecated: use 'drop' field");
1081 warn_if_field_exists(L, index, "extra_dug_item_rarity",
1082 "deprecated: use 'drop' field");
1084 // True for all ground-like things like stone and mud, false for eg. trees
1085 getboolfield(L, index, "is_ground_content", f.is_ground_content);
1086 f.light_propagates = (f.param_type == CPT_LIGHT);
1087 getboolfield(L, index, "sunlight_propagates", f.sunlight_propagates);
1088 // This is used for collision detection.
1089 // Also for general solidness queries.
1090 getboolfield(L, index, "walkable", f.walkable);
1091 // Player can point to these
1092 getboolfield(L, index, "pointable", f.pointable);
1093 // Player can dig these
1094 getboolfield(L, index, "diggable", f.diggable);
1095 // Player can climb these
1096 getboolfield(L, index, "climbable", f.climbable);
1097 // Player can build on these
1098 getboolfield(L, index, "buildable_to", f.buildable_to);
1099 // Metadata name of node (eg. "furnace")
1100 getstringfield(L, index, "metadata_name", f.metadata_name);
1101 // Whether the node is non-liquid, source liquid or flowing liquid
1102 f.liquid_type = (LiquidType)getenumfield(L, index, "liquidtype",
1103 es_LiquidType, LIQUID_NONE);
1104 // If the content is liquid, this is the flowing version of the liquid.
1105 getstringfield(L, index, "liquid_alternative_flowing",
1106 f.liquid_alternative_flowing);
1107 // If the content is liquid, this is the source version of the liquid.
1108 getstringfield(L, index, "liquid_alternative_source",
1109 f.liquid_alternative_source);
1110 // Viscosity for fluid flow, ranging from 1 to 7, with
1111 // 1 giving almost instantaneous propagation and 7 being
1112 // the slowest possible
1113 f.liquid_viscosity = getintfield_default(L, index,
1114 "liquid_viscosity", f.liquid_viscosity);
1115 // Amount of light the node emits
1116 f.light_source = getintfield_default(L, index,
1117 "light_source", f.light_source);
1118 f.damage_per_second = getintfield_default(L, index,
1119 "damage_per_second", f.damage_per_second);
1121 lua_getfield(L, index, "selection_box");
1122 if(lua_istable(L, -1)){
1123 f.selection_box.type = (NodeBoxType)getenumfield(L, -1, "type",
1124 es_NodeBoxType, NODEBOX_REGULAR);
1126 lua_getfield(L, -1, "fixed");
1127 if(lua_istable(L, -1))
1128 f.selection_box.fixed = read_aabbox3df32(L, -1, BS);
1131 lua_getfield(L, -1, "wall_top");
1132 if(lua_istable(L, -1))
1133 f.selection_box.wall_top = read_aabbox3df32(L, -1, BS);
1136 lua_getfield(L, -1, "wall_bottom");
1137 if(lua_istable(L, -1))
1138 f.selection_box.wall_bottom = read_aabbox3df32(L, -1, BS);
1141 lua_getfield(L, -1, "wall_side");
1142 if(lua_istable(L, -1))
1143 f.selection_box.wall_side = read_aabbox3df32(L, -1, BS);
1148 // Set to true if paramtype used to be 'facedir_simple'
1149 getboolfield(L, index, "legacy_facedir_simple", f.legacy_facedir_simple);
1150 // Set to true if wall_mounted used to be set to true
1151 getboolfield(L, index, "legacy_wallmounted", f.legacy_wallmounted);
1154 lua_getfield(L, index, "sounds");
1155 if(lua_istable(L, -1)){
1156 lua_getfield(L, -1, "footstep");
1157 read_soundspec(L, -1, f.sound_footstep);
1159 lua_getfield(L, -1, "dig");
1160 read_soundspec(L, -1, f.sound_dig);
1162 lua_getfield(L, -1, "dug");
1163 read_soundspec(L, -1, f.sound_dug);
1175 static ItemStack read_item(lua_State *L, int index);
1177 static void inventory_set_list_from_lua(Inventory *inv, const char *name,
1178 lua_State *L, int tableindex, int forcesize=-1)
1181 tableindex = lua_gettop(L) + 1 + tableindex;
1182 // If nil, delete list
1183 if(lua_isnil(L, tableindex)){
1184 inv->deleteList(name);
1187 // Otherwise set list
1188 std::vector<ItemStack> items;
1189 luaL_checktype(L, tableindex, LUA_TTABLE);
1191 while(lua_next(L, tableindex) != 0){
1192 // key at index -2 and value at index -1
1193 items.push_back(read_item(L, -1));
1194 // removes value, keeps key for next iteration
1197 int listsize = (forcesize != -1) ? forcesize : items.size();
1198 InventoryList *invlist = inv->addList(name, listsize);
1200 for(std::vector<ItemStack>::const_iterator
1201 i = items.begin(); i != items.end(); i++){
1202 if(forcesize != -1 && index == forcesize)
1204 invlist->changeItem(index, *i);
1207 while(forcesize != -1 && index < forcesize){
1208 invlist->deleteItem(index);
1213 static void inventory_get_list_to_lua(Inventory *inv, const char *name,
1216 InventoryList *invlist = inv->getList(name);
1217 if(invlist == NULL){
1221 // Get the table insert function
1222 lua_getglobal(L, "table");
1223 lua_getfield(L, -1, "insert");
1224 int table_insert = lua_gettop(L);
1225 // Create and fill table
1227 int table = lua_gettop(L);
1228 for(u32 i=0; i<invlist->getSize(); i++){
1229 ItemStack item = invlist->getItem(i);
1230 lua_pushvalue(L, table_insert);
1231 lua_pushvalue(L, table);
1232 lua_pushstring(L, item.getItemString().c_str());
1233 if(lua_pcall(L, 2, 0, 0))
1234 script_error(L, "error: %s", lua_tostring(L, -1));
1239 Helpful macros for userdata classes
1242 #define method(class, name) {#name, class::l_##name}
1253 static const char className[];
1254 static const luaL_reg methods[];
1256 // Exported functions
1258 // garbage collector
1259 static int gc_object(lua_State *L)
1261 LuaItemStack *o = *(LuaItemStack **)(lua_touserdata(L, 1));
1266 // is_empty(self) -> true/false
1267 static int l_is_empty(lua_State *L)
1269 LuaItemStack *o = checkobject(L, 1);
1270 ItemStack &item = o->m_stack;
1271 lua_pushboolean(L, item.empty());
1275 // get_name(self) -> string
1276 static int l_get_name(lua_State *L)
1278 LuaItemStack *o = checkobject(L, 1);
1279 ItemStack &item = o->m_stack;
1280 lua_pushstring(L, item.name.c_str());
1284 // get_count(self) -> number
1285 static int l_get_count(lua_State *L)
1287 LuaItemStack *o = checkobject(L, 1);
1288 ItemStack &item = o->m_stack;
1289 lua_pushinteger(L, item.count);
1293 // get_wear(self) -> number
1294 static int l_get_wear(lua_State *L)
1296 LuaItemStack *o = checkobject(L, 1);
1297 ItemStack &item = o->m_stack;
1298 lua_pushinteger(L, item.wear);
1302 // get_metadata(self) -> string
1303 static int l_get_metadata(lua_State *L)
1305 LuaItemStack *o = checkobject(L, 1);
1306 ItemStack &item = o->m_stack;
1307 lua_pushlstring(L, item.metadata.c_str(), item.metadata.size());
1311 // clear(self) -> true
1312 static int l_clear(lua_State *L)
1314 LuaItemStack *o = checkobject(L, 1);
1316 lua_pushboolean(L, true);
1320 // replace(self, itemstack or itemstring or table or nil) -> true
1321 static int l_replace(lua_State *L)
1323 LuaItemStack *o = checkobject(L, 1);
1324 o->m_stack = read_item(L, 2);
1325 lua_pushboolean(L, true);
1329 // to_string(self) -> string
1330 static int l_to_string(lua_State *L)
1332 LuaItemStack *o = checkobject(L, 1);
1333 std::string itemstring = o->m_stack.getItemString();
1334 lua_pushstring(L, itemstring.c_str());
1338 // to_table(self) -> table or nil
1339 static int l_to_table(lua_State *L)
1341 LuaItemStack *o = checkobject(L, 1);
1342 const ItemStack &item = o->m_stack;
1350 lua_pushstring(L, item.name.c_str());
1351 lua_setfield(L, -2, "name");
1352 lua_pushinteger(L, item.count);
1353 lua_setfield(L, -2, "count");
1354 lua_pushinteger(L, item.wear);
1355 lua_setfield(L, -2, "wear");
1356 lua_pushlstring(L, item.metadata.c_str(), item.metadata.size());
1357 lua_setfield(L, -2, "metadata");
1362 // get_stack_max(self) -> number
1363 static int l_get_stack_max(lua_State *L)
1365 LuaItemStack *o = checkobject(L, 1);
1366 ItemStack &item = o->m_stack;
1367 lua_pushinteger(L, item.getStackMax(get_server(L)->idef()));
1371 // get_free_space(self) -> number
1372 static int l_get_free_space(lua_State *L)
1374 LuaItemStack *o = checkobject(L, 1);
1375 ItemStack &item = o->m_stack;
1376 lua_pushinteger(L, item.freeSpace(get_server(L)->idef()));
1380 // is_known(self) -> true/false
1381 // Checks if the item is defined.
1382 static int l_is_known(lua_State *L)
1384 LuaItemStack *o = checkobject(L, 1);
1385 ItemStack &item = o->m_stack;
1386 bool is_known = item.isKnown(get_server(L)->idef());
1387 lua_pushboolean(L, is_known);
1391 // get_definition(self) -> table
1392 // Returns the item definition table from minetest.registered_items,
1393 // or a fallback one (name="unknown")
1394 static int l_get_definition(lua_State *L)
1396 LuaItemStack *o = checkobject(L, 1);
1397 ItemStack &item = o->m_stack;
1399 // Get minetest.registered_items[name]
1400 lua_getglobal(L, "minetest");
1401 lua_getfield(L, -1, "registered_items");
1402 luaL_checktype(L, -1, LUA_TTABLE);
1403 lua_getfield(L, -1, item.name.c_str());
1404 if(lua_isnil(L, -1))
1407 lua_getfield(L, -1, "unknown");
1412 // get_tool_capabilities(self) -> table
1413 // Returns the effective tool digging properties.
1414 // Returns those of the hand ("") if this item has none associated.
1415 static int l_get_tool_capabilities(lua_State *L)
1417 LuaItemStack *o = checkobject(L, 1);
1418 ItemStack &item = o->m_stack;
1419 const ToolCapabilities &prop =
1420 item.getToolCapabilities(get_server(L)->idef());
1421 push_tool_capabilities(L, prop);
1425 // add_wear(self, amount) -> true/false
1426 // The range for "amount" is [0,65535]. Wear is only added if the item
1427 // is a tool. Adding wear might destroy the item.
1428 // Returns true if the item is (or was) a tool.
1429 static int l_add_wear(lua_State *L)
1431 LuaItemStack *o = checkobject(L, 1);
1432 ItemStack &item = o->m_stack;
1433 int amount = lua_tointeger(L, 2);
1434 bool result = item.addWear(amount, get_server(L)->idef());
1435 lua_pushboolean(L, result);
1439 // add_item(self, itemstack or itemstring or table or nil) -> itemstack
1440 // Returns leftover item stack
1441 static int l_add_item(lua_State *L)
1443 LuaItemStack *o = checkobject(L, 1);
1444 ItemStack &item = o->m_stack;
1445 ItemStack newitem = read_item(L, 2);
1446 ItemStack leftover = item.addItem(newitem, get_server(L)->idef());
1447 create(L, leftover);
1451 // item_fits(self, itemstack or itemstring or table or nil) -> true/false, itemstack
1452 // First return value is true iff the new item fits fully into the stack
1453 // Second return value is the would-be-left-over item stack
1454 static int l_item_fits(lua_State *L)
1456 LuaItemStack *o = checkobject(L, 1);
1457 ItemStack &item = o->m_stack;
1458 ItemStack newitem = read_item(L, 2);
1460 bool fits = item.itemFits(newitem, &restitem, get_server(L)->idef());
1461 lua_pushboolean(L, fits); // first return value
1462 create(L, restitem); // second return value
1466 // take_item(self, takecount=1) -> itemstack
1467 static int l_take_item(lua_State *L)
1469 LuaItemStack *o = checkobject(L, 1);
1470 ItemStack &item = o->m_stack;
1472 if(!lua_isnone(L, 2))
1473 takecount = lua_tointeger(L, 2);
1474 ItemStack taken = item.takeItem(takecount);
1479 // peek_item(self, peekcount=1) -> itemstack
1480 static int l_peek_item(lua_State *L)
1482 LuaItemStack *o = checkobject(L, 1);
1483 ItemStack &item = o->m_stack;
1485 if(!lua_isnone(L, 2))
1486 peekcount = lua_tointeger(L, 2);
1487 ItemStack peekaboo = item.peekItem(peekcount);
1488 create(L, peekaboo);
1493 LuaItemStack(const ItemStack &item):
1502 const ItemStack& getItem() const
1506 ItemStack& getItem()
1511 // LuaItemStack(itemstack or itemstring or table or nil)
1512 // Creates an LuaItemStack and leaves it on top of stack
1513 static int create_object(lua_State *L)
1515 ItemStack item = read_item(L, 1);
1516 LuaItemStack *o = new LuaItemStack(item);
1517 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
1518 luaL_getmetatable(L, className);
1519 lua_setmetatable(L, -2);
1522 // Not callable from Lua
1523 static int create(lua_State *L, const ItemStack &item)
1525 LuaItemStack *o = new LuaItemStack(item);
1526 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
1527 luaL_getmetatable(L, className);
1528 lua_setmetatable(L, -2);
1532 static LuaItemStack* checkobject(lua_State *L, int narg)
1534 luaL_checktype(L, narg, LUA_TUSERDATA);
1535 void *ud = luaL_checkudata(L, narg, className);
1536 if(!ud) luaL_typerror(L, narg, className);
1537 return *(LuaItemStack**)ud; // unbox pointer
1540 static void Register(lua_State *L)
1543 int methodtable = lua_gettop(L);
1544 luaL_newmetatable(L, className);
1545 int metatable = lua_gettop(L);
1547 lua_pushliteral(L, "__metatable");
1548 lua_pushvalue(L, methodtable);
1549 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
1551 lua_pushliteral(L, "__index");
1552 lua_pushvalue(L, methodtable);
1553 lua_settable(L, metatable);
1555 lua_pushliteral(L, "__gc");
1556 lua_pushcfunction(L, gc_object);
1557 lua_settable(L, metatable);
1559 lua_pop(L, 1); // drop metatable
1561 luaL_openlib(L, 0, methods, 0); // fill methodtable
1562 lua_pop(L, 1); // drop methodtable
1564 // Can be created from Lua (LuaItemStack(itemstack or itemstring or table or nil))
1565 lua_register(L, className, create_object);
1568 const char LuaItemStack::className[] = "ItemStack";
1569 const luaL_reg LuaItemStack::methods[] = {
1570 method(LuaItemStack, is_empty),
1571 method(LuaItemStack, get_name),
1572 method(LuaItemStack, get_count),
1573 method(LuaItemStack, get_wear),
1574 method(LuaItemStack, get_metadata),
1575 method(LuaItemStack, clear),
1576 method(LuaItemStack, replace),
1577 method(LuaItemStack, to_string),
1578 method(LuaItemStack, to_table),
1579 method(LuaItemStack, get_stack_max),
1580 method(LuaItemStack, get_free_space),
1581 method(LuaItemStack, is_known),
1582 method(LuaItemStack, get_definition),
1583 method(LuaItemStack, get_tool_capabilities),
1584 method(LuaItemStack, add_wear),
1585 method(LuaItemStack, add_item),
1586 method(LuaItemStack, item_fits),
1587 method(LuaItemStack, take_item),
1588 method(LuaItemStack, peek_item),
1592 static ItemStack read_item(lua_State *L, int index)
1595 index = lua_gettop(L) + 1 + index;
1597 if(lua_isnil(L, index))
1601 else if(lua_isuserdata(L, index))
1603 // Convert from LuaItemStack
1604 LuaItemStack *o = LuaItemStack::checkobject(L, index);
1605 return o->getItem();
1607 else if(lua_isstring(L, index))
1609 // Convert from itemstring
1610 std::string itemstring = lua_tostring(L, index);
1611 IItemDefManager *idef = get_server(L)->idef();
1615 item.deSerialize(itemstring, idef);
1618 catch(SerializationError &e)
1620 infostream<<"WARNING: unable to create item from itemstring"
1621 <<": "<<itemstring<<std::endl;
1625 else if(lua_istable(L, index))
1627 // Convert from table
1628 IItemDefManager *idef = get_server(L)->idef();
1629 std::string name = getstringfield_default(L, index, "name", "");
1630 int count = getintfield_default(L, index, "count", 1);
1631 int wear = getintfield_default(L, index, "wear", 0);
1632 std::string metadata = getstringfield_default(L, index, "metadata", "");
1633 return ItemStack(name, count, wear, metadata, idef);
1637 throw LuaError(L, "Expecting itemstack, itemstring, table or nil");
1648 InventoryLocation m_loc;
1650 static const char className[];
1651 static const luaL_reg methods[];
1653 static InvRef *checkobject(lua_State *L, int narg)
1655 luaL_checktype(L, narg, LUA_TUSERDATA);
1656 void *ud = luaL_checkudata(L, narg, className);
1657 if(!ud) luaL_typerror(L, narg, className);
1658 return *(InvRef**)ud; // unbox pointer
1661 static Inventory* getinv(lua_State *L, InvRef *ref)
1663 return get_server(L)->getInventory(ref->m_loc);
1666 static InventoryList* getlist(lua_State *L, InvRef *ref,
1667 const char *listname)
1669 Inventory *inv = getinv(L, ref);
1672 return inv->getList(listname);
1675 static void reportInventoryChange(lua_State *L, InvRef *ref)
1677 // Inform other things that the inventory has changed
1678 get_server(L)->setInventoryModified(ref->m_loc);
1681 // Exported functions
1683 // garbage collector
1684 static int gc_object(lua_State *L) {
1685 InvRef *o = *(InvRef **)(lua_touserdata(L, 1));
1690 // get_size(self, listname)
1691 static int l_get_size(lua_State *L)
1693 InvRef *ref = checkobject(L, 1);
1694 const char *listname = luaL_checkstring(L, 2);
1695 InventoryList *list = getlist(L, ref, listname);
1697 lua_pushinteger(L, list->getSize());
1699 lua_pushinteger(L, 0);
1704 // set_size(self, listname, size)
1705 static int l_set_size(lua_State *L)
1707 InvRef *ref = checkobject(L, 1);
1708 const char *listname = luaL_checkstring(L, 2);
1709 int newsize = luaL_checknumber(L, 3);
1710 Inventory *inv = getinv(L, ref);
1712 inv->deleteList(listname);
1713 reportInventoryChange(L, ref);
1716 InventoryList *list = inv->getList(listname);
1718 list->setSize(newsize);
1720 list = inv->addList(listname, newsize);
1722 reportInventoryChange(L, ref);
1726 // get_stack(self, listname, i) -> itemstack
1727 static int l_get_stack(lua_State *L)
1729 InvRef *ref = checkobject(L, 1);
1730 const char *listname = luaL_checkstring(L, 2);
1731 int i = luaL_checknumber(L, 3) - 1;
1732 InventoryList *list = getlist(L, ref, listname);
1734 if(list != NULL && i >= 0 && i < (int) list->getSize())
1735 item = list->getItem(i);
1736 LuaItemStack::create(L, item);
1740 // set_stack(self, listname, i, stack) -> true/false
1741 static int l_set_stack(lua_State *L)
1743 InvRef *ref = checkobject(L, 1);
1744 const char *listname = luaL_checkstring(L, 2);
1745 int i = luaL_checknumber(L, 3) - 1;
1746 ItemStack newitem = read_item(L, 4);
1747 InventoryList *list = getlist(L, ref, listname);
1748 if(list != NULL && i >= 0 && i < (int) list->getSize()){
1749 list->changeItem(i, newitem);
1750 reportInventoryChange(L, ref);
1751 lua_pushboolean(L, true);
1753 lua_pushboolean(L, false);
1758 // get_list(self, listname) -> list or nil
1759 static int l_get_list(lua_State *L)
1761 InvRef *ref = checkobject(L, 1);
1762 const char *listname = luaL_checkstring(L, 2);
1763 Inventory *inv = getinv(L, ref);
1764 inventory_get_list_to_lua(inv, listname, L);
1768 // set_list(self, listname, list)
1769 static int l_set_list(lua_State *L)
1771 InvRef *ref = checkobject(L, 1);
1772 const char *listname = luaL_checkstring(L, 2);
1773 Inventory *inv = getinv(L, ref);
1774 InventoryList *list = inv->getList(listname);
1776 inventory_set_list_from_lua(inv, listname, L, 3,
1779 inventory_set_list_from_lua(inv, listname, L, 3);
1780 reportInventoryChange(L, ref);
1784 // add_item(self, listname, itemstack or itemstring or table or nil) -> itemstack
1785 // Returns the leftover stack
1786 static int l_add_item(lua_State *L)
1788 InvRef *ref = checkobject(L, 1);
1789 const char *listname = luaL_checkstring(L, 2);
1790 ItemStack item = read_item(L, 3);
1791 InventoryList *list = getlist(L, ref, listname);
1793 ItemStack leftover = list->addItem(item);
1794 if(leftover.count != item.count)
1795 reportInventoryChange(L, ref);
1796 LuaItemStack::create(L, leftover);
1798 LuaItemStack::create(L, item);
1803 // room_for_item(self, listname, itemstack or itemstring or table or nil) -> true/false
1804 // Returns true if the item completely fits into the list
1805 static int l_room_for_item(lua_State *L)
1807 InvRef *ref = checkobject(L, 1);
1808 const char *listname = luaL_checkstring(L, 2);
1809 ItemStack item = read_item(L, 3);
1810 InventoryList *list = getlist(L, ref, listname);
1812 lua_pushboolean(L, list->roomForItem(item));
1814 lua_pushboolean(L, false);
1819 // contains_item(self, listname, itemstack or itemstring or table or nil) -> true/false
1820 // Returns true if the list contains the given count of the given item name
1821 static int l_contains_item(lua_State *L)
1823 InvRef *ref = checkobject(L, 1);
1824 const char *listname = luaL_checkstring(L, 2);
1825 ItemStack item = read_item(L, 3);
1826 InventoryList *list = getlist(L, ref, listname);
1828 lua_pushboolean(L, list->containsItem(item));
1830 lua_pushboolean(L, false);
1835 // remove_item(self, listname, itemstack or itemstring or table or nil) -> itemstack
1836 // Returns the items that were actually removed
1837 static int l_remove_item(lua_State *L)
1839 InvRef *ref = checkobject(L, 1);
1840 const char *listname = luaL_checkstring(L, 2);
1841 ItemStack item = read_item(L, 3);
1842 InventoryList *list = getlist(L, ref, listname);
1844 ItemStack removed = list->removeItem(item);
1845 if(!removed.empty())
1846 reportInventoryChange(L, ref);
1847 LuaItemStack::create(L, removed);
1849 LuaItemStack::create(L, ItemStack());
1855 InvRef(const InventoryLocation &loc):
1864 // Creates an InvRef and leaves it on top of stack
1865 // Not callable from Lua; all references are created on the C side.
1866 static void create(lua_State *L, const InventoryLocation &loc)
1868 InvRef *o = new InvRef(loc);
1869 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
1870 luaL_getmetatable(L, className);
1871 lua_setmetatable(L, -2);
1873 static void createPlayer(lua_State *L, Player *player)
1875 InventoryLocation loc;
1876 loc.setPlayer(player->getName());
1879 static void createNodeMeta(lua_State *L, v3s16 p)
1881 InventoryLocation loc;
1886 static void Register(lua_State *L)
1889 int methodtable = lua_gettop(L);
1890 luaL_newmetatable(L, className);
1891 int metatable = lua_gettop(L);
1893 lua_pushliteral(L, "__metatable");
1894 lua_pushvalue(L, methodtable);
1895 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
1897 lua_pushliteral(L, "__index");
1898 lua_pushvalue(L, methodtable);
1899 lua_settable(L, metatable);
1901 lua_pushliteral(L, "__gc");
1902 lua_pushcfunction(L, gc_object);
1903 lua_settable(L, metatable);
1905 lua_pop(L, 1); // drop metatable
1907 luaL_openlib(L, 0, methods, 0); // fill methodtable
1908 lua_pop(L, 1); // drop methodtable
1910 // Cannot be created from Lua
1911 //lua_register(L, className, create_object);
1914 const char InvRef::className[] = "InvRef";
1915 const luaL_reg InvRef::methods[] = {
1916 method(InvRef, get_size),
1917 method(InvRef, set_size),
1918 method(InvRef, get_stack),
1919 method(InvRef, set_stack),
1920 method(InvRef, get_list),
1921 method(InvRef, set_list),
1922 method(InvRef, add_item),
1923 method(InvRef, room_for_item),
1924 method(InvRef, contains_item),
1925 method(InvRef, remove_item),
1937 ServerEnvironment *m_env;
1939 static const char className[];
1940 static const luaL_reg methods[];
1942 static NodeMetaRef *checkobject(lua_State *L, int narg)
1944 luaL_checktype(L, narg, LUA_TUSERDATA);
1945 void *ud = luaL_checkudata(L, narg, className);
1946 if(!ud) luaL_typerror(L, narg, className);
1947 return *(NodeMetaRef**)ud; // unbox pointer
1950 static NodeMetadata* getmeta(NodeMetaRef *ref)
1952 NodeMetadata *meta = ref->m_env->getMap().getNodeMetadata(ref->m_p);
1956 /*static IGenericNodeMetadata* getgenericmeta(NodeMetaRef *ref)
1958 NodeMetadata *meta = getmeta(ref);
1961 if(meta->typeId() != NODEMETA_GENERIC)
1963 return (IGenericNodeMetadata*)meta;
1966 static void reportMetadataChange(NodeMetaRef *ref)
1968 // Inform other things that the metadata has changed
1969 v3s16 blockpos = getNodeBlockPos(ref->m_p);
1971 event.type = MEET_BLOCK_NODE_METADATA_CHANGED;
1973 ref->m_env->getMap().dispatchEvent(&event);
1974 // Set the block to be saved
1975 MapBlock *block = ref->m_env->getMap().getBlockNoCreateNoEx(blockpos);
1977 block->raiseModified(MOD_STATE_WRITE_NEEDED,
1978 "NodeMetaRef::reportMetadataChange");
1981 // Exported functions
1983 // garbage collector
1984 static int gc_object(lua_State *L) {
1985 NodeMetaRef *o = *(NodeMetaRef **)(lua_touserdata(L, 1));
1991 static int l_get_type(lua_State *L)
1993 NodeMetaRef *ref = checkobject(L, 1);
1994 NodeMetadata *meta = getmeta(ref);
2000 lua_pushstring(L, meta->typeName());
2004 // allows_text_input(self)
2005 static int l_allows_text_input(lua_State *L)
2007 NodeMetaRef *ref = checkobject(L, 1);
2008 NodeMetadata *meta = getmeta(ref);
2009 if(meta == NULL) return 0;
2011 lua_pushboolean(L, meta->allowsTextInput());
2015 // set_text(self, text)
2016 static int l_set_text(lua_State *L)
2018 NodeMetaRef *ref = checkobject(L, 1);
2019 NodeMetadata *meta = getmeta(ref);
2020 if(meta == NULL) return 0;
2022 std::string text = luaL_checkstring(L, 2);
2023 meta->setText(text);
2024 reportMetadataChange(ref);
2029 static int l_get_text(lua_State *L)
2031 NodeMetaRef *ref = checkobject(L, 1);
2032 NodeMetadata *meta = getmeta(ref);
2033 if(meta == NULL) return 0;
2035 std::string text = meta->getText();
2036 lua_pushstring(L, text.c_str());
2041 static int l_get_owner(lua_State *L)
2043 NodeMetaRef *ref = checkobject(L, 1);
2044 NodeMetadata *meta = getmeta(ref);
2045 if(meta == NULL) return 0;
2047 std::string owner = meta->getOwner();
2048 lua_pushstring(L, owner.c_str());
2052 // set_owner(self, string)
2053 static int l_set_owner(lua_State *L)
2055 NodeMetaRef *ref = checkobject(L, 1);
2056 NodeMetadata *meta = getmeta(ref);
2057 if(meta == NULL) return 0;
2059 std::string owner = luaL_checkstring(L, 2);
2060 meta->setOwner(owner);
2061 reportMetadataChange(ref);
2065 // get_allow_removal(self)
2066 static int l_get_allow_removal(lua_State *L)
2068 NodeMetaRef *ref = checkobject(L, 1);
2069 NodeMetadata *meta = getmeta(ref);
2071 lua_pushboolean(L, true);
2075 lua_pushboolean(L, !meta->nodeRemovalDisabled());
2079 /* IGenericNodeMetadata interface */
2081 // set_infotext(self, text)
2082 static int l_set_infotext(lua_State *L)
2084 NodeMetaRef *ref = checkobject(L, 1);
2085 NodeMetadata *meta = getmeta(ref);
2086 if(meta == NULL) return 0;
2088 std::string text = luaL_checkstring(L, 2);
2089 meta->setInfoText(text);
2090 reportMetadataChange(ref);
2094 // get_inventory(self)
2095 static int l_get_inventory(lua_State *L)
2097 NodeMetaRef *ref = checkobject(L, 1);
2098 NodeMetadata *meta = getmeta(ref);
2099 if(meta == NULL) return 0;
2101 InvRef::createNodeMeta(L, ref->m_p);
2105 // set_inventory_draw_spec(self, text)
2106 static int l_set_inventory_draw_spec(lua_State *L)
2108 NodeMetaRef *ref = checkobject(L, 1);
2109 NodeMetadata *meta = getmeta(ref);
2110 if(meta == NULL) return 0;
2112 std::string text = luaL_checkstring(L, 2);
2113 meta->setInventoryDrawSpec(text);
2114 reportMetadataChange(ref);
2118 // set_allow_text_input(self, text)
2119 static int l_set_allow_text_input(lua_State *L)
2121 NodeMetaRef *ref = checkobject(L, 1);
2122 NodeMetadata *meta = getmeta(ref);
2123 if(meta == NULL) return 0;
2125 bool b = lua_toboolean(L, 2);
2126 meta->setAllowTextInput(b);
2127 reportMetadataChange(ref);
2131 // set_allow_removal(self, text)
2132 static int l_set_allow_removal(lua_State *L)
2134 NodeMetaRef *ref = checkobject(L, 1);
2135 NodeMetadata *meta = getmeta(ref);
2136 if(meta == NULL) return 0;
2138 bool b = lua_toboolean(L, 2);
2139 meta->setRemovalDisabled(!b);
2140 reportMetadataChange(ref);
2144 // set_enforce_owner(self, text)
2145 static int l_set_enforce_owner(lua_State *L)
2147 NodeMetaRef *ref = checkobject(L, 1);
2148 NodeMetadata *meta = getmeta(ref);
2149 if(meta == NULL) return 0;
2151 bool b = lua_toboolean(L, 2);
2152 meta->setEnforceOwner(b);
2153 reportMetadataChange(ref);
2157 // is_inventory_modified(self)
2158 static int l_is_inventory_modified(lua_State *L)
2160 NodeMetaRef *ref = checkobject(L, 1);
2161 NodeMetadata *meta = getmeta(ref);
2162 if(meta == NULL) return 0;
2164 lua_pushboolean(L, meta->isInventoryModified());
2168 // reset_inventory_modified(self)
2169 static int l_reset_inventory_modified(lua_State *L)
2171 NodeMetaRef *ref = checkobject(L, 1);
2172 NodeMetadata *meta = getmeta(ref);
2173 if(meta == NULL) return 0;
2175 meta->resetInventoryModified();
2176 reportMetadataChange(ref);
2180 // is_text_modified(self)
2181 static int l_is_text_modified(lua_State *L)
2183 NodeMetaRef *ref = checkobject(L, 1);
2184 NodeMetadata *meta = getmeta(ref);
2185 if(meta == NULL) return 0;
2187 lua_pushboolean(L, meta->isTextModified());
2191 // reset_text_modified(self)
2192 static int l_reset_text_modified(lua_State *L)
2194 NodeMetaRef *ref = checkobject(L, 1);
2195 NodeMetadata *meta = getmeta(ref);
2196 if(meta == NULL) return 0;
2198 meta->resetTextModified();
2199 reportMetadataChange(ref);
2203 // set_string(self, name, var)
2204 static int l_set_string(lua_State *L)
2206 NodeMetaRef *ref = checkobject(L, 1);
2207 NodeMetadata *meta = getmeta(ref);
2208 if(meta == NULL) return 0;
2210 std::string name = luaL_checkstring(L, 2);
2212 const char *s = lua_tolstring(L, 3, &len);
2213 std::string str(s, len);
2214 meta->setString(name, str);
2215 reportMetadataChange(ref);
2219 // get_string(self, name)
2220 static int l_get_string(lua_State *L)
2222 NodeMetaRef *ref = checkobject(L, 1);
2223 NodeMetadata *meta = getmeta(ref);
2224 if(meta == NULL) return 0;
2226 std::string name = luaL_checkstring(L, 2);
2227 std::string str = meta->getString(name);
2228 lua_pushlstring(L, str.c_str(), str.size());
2233 NodeMetaRef(v3s16 p, ServerEnvironment *env):
2243 // Creates an NodeMetaRef and leaves it on top of stack
2244 // Not callable from Lua; all references are created on the C side.
2245 static void create(lua_State *L, v3s16 p, ServerEnvironment *env)
2247 NodeMetaRef *o = new NodeMetaRef(p, env);
2248 //infostream<<"NodeMetaRef::create: o="<<o<<std::endl;
2249 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
2250 luaL_getmetatable(L, className);
2251 lua_setmetatable(L, -2);
2254 static void Register(lua_State *L)
2257 int methodtable = lua_gettop(L);
2258 luaL_newmetatable(L, className);
2259 int metatable = lua_gettop(L);
2261 lua_pushliteral(L, "__metatable");
2262 lua_pushvalue(L, methodtable);
2263 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
2265 lua_pushliteral(L, "__index");
2266 lua_pushvalue(L, methodtable);
2267 lua_settable(L, metatable);
2269 lua_pushliteral(L, "__gc");
2270 lua_pushcfunction(L, gc_object);
2271 lua_settable(L, metatable);
2273 lua_pop(L, 1); // drop metatable
2275 luaL_openlib(L, 0, methods, 0); // fill methodtable
2276 lua_pop(L, 1); // drop methodtable
2278 // Cannot be created from Lua
2279 //lua_register(L, className, create_object);
2282 const char NodeMetaRef::className[] = "NodeMetaRef";
2283 const luaL_reg NodeMetaRef::methods[] = {
2284 method(NodeMetaRef, get_type),
2285 method(NodeMetaRef, allows_text_input),
2286 method(NodeMetaRef, set_text),
2287 method(NodeMetaRef, get_text),
2288 method(NodeMetaRef, get_owner),
2289 method(NodeMetaRef, set_owner),
2290 method(NodeMetaRef, get_allow_removal),
2291 method(NodeMetaRef, set_infotext),
2292 method(NodeMetaRef, get_inventory),
2293 method(NodeMetaRef, set_inventory_draw_spec),
2294 method(NodeMetaRef, set_allow_text_input),
2295 method(NodeMetaRef, set_allow_removal),
2296 method(NodeMetaRef, set_enforce_owner),
2297 method(NodeMetaRef, is_inventory_modified),
2298 method(NodeMetaRef, reset_inventory_modified),
2299 method(NodeMetaRef, is_text_modified),
2300 method(NodeMetaRef, reset_text_modified),
2301 method(NodeMetaRef, set_string),
2302 method(NodeMetaRef, get_string),
2313 ServerActiveObject *m_object;
2315 static const char className[];
2316 static const luaL_reg methods[];
2318 static ObjectRef *checkobject(lua_State *L, int narg)
2320 luaL_checktype(L, narg, LUA_TUSERDATA);
2321 void *ud = luaL_checkudata(L, narg, className);
2322 if(!ud) luaL_typerror(L, narg, className);
2323 return *(ObjectRef**)ud; // unbox pointer
2326 static ServerActiveObject* getobject(ObjectRef *ref)
2328 ServerActiveObject *co = ref->m_object;
2332 static LuaEntitySAO* getluaobject(ObjectRef *ref)
2334 ServerActiveObject *obj = getobject(ref);
2337 if(obj->getType() != ACTIVEOBJECT_TYPE_LUAENTITY)
2339 return (LuaEntitySAO*)obj;
2342 static PlayerSAO* getplayersao(ObjectRef *ref)
2344 ServerActiveObject *obj = getobject(ref);
2347 if(obj->getType() != ACTIVEOBJECT_TYPE_PLAYER)
2349 return (PlayerSAO*)obj;
2352 static Player* getplayer(ObjectRef *ref)
2354 PlayerSAO *playersao = getplayersao(ref);
2355 if(playersao == NULL)
2357 return playersao->getPlayer();
2360 // Exported functions
2362 // garbage collector
2363 static int gc_object(lua_State *L) {
2364 ObjectRef *o = *(ObjectRef **)(lua_touserdata(L, 1));
2365 //infostream<<"ObjectRef::gc_object: o="<<o<<std::endl;
2371 static int l_remove(lua_State *L)
2373 ObjectRef *ref = checkobject(L, 1);
2374 ServerActiveObject *co = getobject(ref);
2375 if(co == NULL) return 0;
2376 verbosestream<<"ObjectRef::l_remove(): id="<<co->getId()<<std::endl;
2377 co->m_removed = true;
2382 // returns: {x=num, y=num, z=num}
2383 static int l_getpos(lua_State *L)
2385 ObjectRef *ref = checkobject(L, 1);
2386 ServerActiveObject *co = getobject(ref);
2387 if(co == NULL) return 0;
2388 v3f pos = co->getBasePosition() / BS;
2390 lua_pushnumber(L, pos.X);
2391 lua_setfield(L, -2, "x");
2392 lua_pushnumber(L, pos.Y);
2393 lua_setfield(L, -2, "y");
2394 lua_pushnumber(L, pos.Z);
2395 lua_setfield(L, -2, "z");
2399 // setpos(self, pos)
2400 static int l_setpos(lua_State *L)
2402 ObjectRef *ref = checkobject(L, 1);
2403 //LuaEntitySAO *co = getluaobject(ref);
2404 ServerActiveObject *co = getobject(ref);
2405 if(co == NULL) return 0;
2407 v3f pos = checkFloatPos(L, 2);
2413 // moveto(self, pos, continuous=false)
2414 static int l_moveto(lua_State *L)
2416 ObjectRef *ref = checkobject(L, 1);
2417 //LuaEntitySAO *co = getluaobject(ref);
2418 ServerActiveObject *co = getobject(ref);
2419 if(co == NULL) return 0;
2421 v3f pos = checkFloatPos(L, 2);
2423 bool continuous = lua_toboolean(L, 3);
2425 co->moveTo(pos, continuous);
2429 // punch(self, puncher, tool_capabilities, direction, time_from_last_punch)
2430 static int l_punch(lua_State *L)
2432 ObjectRef *ref = checkobject(L, 1);
2433 ObjectRef *puncher_ref = checkobject(L, 2);
2434 ServerActiveObject *co = getobject(ref);
2435 ServerActiveObject *puncher = getobject(puncher_ref);
2436 if(co == NULL) return 0;
2437 if(puncher == NULL) return 0;
2438 ToolCapabilities toolcap = read_tool_capabilities(L, 3);
2439 v3f dir = read_v3f(L, 4);
2440 float time_from_last_punch = 1000000;
2441 if(lua_isnumber(L, 5))
2442 time_from_last_punch = lua_tonumber(L, 5);
2444 puncher->punch(dir, &toolcap, puncher, time_from_last_punch);
2448 // right_click(self, clicker); clicker = an another ObjectRef
2449 static int l_right_click(lua_State *L)
2451 ObjectRef *ref = checkobject(L, 1);
2452 ObjectRef *ref2 = checkobject(L, 2);
2453 ServerActiveObject *co = getobject(ref);
2454 ServerActiveObject *co2 = getobject(ref2);
2455 if(co == NULL) return 0;
2456 if(co2 == NULL) return 0;
2458 co->rightClick(co2);
2463 // hp = number of hitpoints (2 * number of hearts)
2465 static int l_set_hp(lua_State *L)
2467 ObjectRef *ref = checkobject(L, 1);
2468 luaL_checknumber(L, 2);
2469 ServerActiveObject *co = getobject(ref);
2470 if(co == NULL) return 0;
2471 int hp = lua_tonumber(L, 2);
2472 /*infostream<<"ObjectRef::l_set_hp(): id="<<co->getId()
2473 <<" hp="<<hp<<std::endl;*/
2481 // returns: number of hitpoints (2 * number of hearts)
2482 // 0 if not applicable to this type of object
2483 static int l_get_hp(lua_State *L)
2485 ObjectRef *ref = checkobject(L, 1);
2486 ServerActiveObject *co = getobject(ref);
2487 if(co == NULL) return 0;
2488 int hp = co->getHP();
2489 /*infostream<<"ObjectRef::l_get_hp(): id="<<co->getId()
2490 <<" hp="<<hp<<std::endl;*/
2492 lua_pushnumber(L, hp);
2496 // get_inventory(self)
2497 static int l_get_inventory(lua_State *L)
2499 ObjectRef *ref = checkobject(L, 1);
2500 ServerActiveObject *co = getobject(ref);
2501 if(co == NULL) return 0;
2503 InventoryLocation loc = co->getInventoryLocation();
2504 if(get_server(L)->getInventory(loc) != NULL)
2505 InvRef::create(L, loc);
2511 // get_wield_list(self)
2512 static int l_get_wield_list(lua_State *L)
2514 ObjectRef *ref = checkobject(L, 1);
2515 ServerActiveObject *co = getobject(ref);
2516 if(co == NULL) return 0;
2518 lua_pushstring(L, co->getWieldList().c_str());
2522 // get_wield_index(self)
2523 static int l_get_wield_index(lua_State *L)
2525 ObjectRef *ref = checkobject(L, 1);
2526 ServerActiveObject *co = getobject(ref);
2527 if(co == NULL) return 0;
2529 lua_pushinteger(L, co->getWieldIndex() + 1);
2533 // get_wielded_item(self)
2534 static int l_get_wielded_item(lua_State *L)
2536 ObjectRef *ref = checkobject(L, 1);
2537 ServerActiveObject *co = getobject(ref);
2538 if(co == NULL) return 0;
2540 LuaItemStack::create(L, co->getWieldedItem());
2544 // set_wielded_item(self, itemstack or itemstring or table or nil)
2545 static int l_set_wielded_item(lua_State *L)
2547 ObjectRef *ref = checkobject(L, 1);
2548 ServerActiveObject *co = getobject(ref);
2549 if(co == NULL) return 0;
2551 ItemStack item = read_item(L, 2);
2552 bool success = co->setWieldedItem(item);
2553 lua_pushboolean(L, success);
2557 // set_armor_groups(self, groups)
2558 static int l_set_armor_groups(lua_State *L)
2560 ObjectRef *ref = checkobject(L, 1);
2561 ServerActiveObject *co = getobject(ref);
2562 if(co == NULL) return 0;
2564 ItemGroupList groups;
2565 read_groups(L, 2, groups);
2566 co->setArmorGroups(groups);
2570 // set_properties(self, properties)
2571 static int l_set_properties(lua_State *L)
2573 ObjectRef *ref = checkobject(L, 1);
2574 ServerActiveObject *co = getobject(ref);
2575 if(co == NULL) return 0;
2576 ObjectProperties *prop = co->accessObjectProperties();
2579 read_object_properties(L, 2, prop);
2580 co->notifyObjectPropertiesModified();
2584 /* LuaEntitySAO-only */
2586 // setvelocity(self, {x=num, y=num, z=num})
2587 static int l_setvelocity(lua_State *L)
2589 ObjectRef *ref = checkobject(L, 1);
2590 LuaEntitySAO *co = getluaobject(ref);
2591 if(co == NULL) return 0;
2592 v3f pos = checkFloatPos(L, 2);
2594 co->setVelocity(pos);
2598 // getvelocity(self)
2599 static int l_getvelocity(lua_State *L)
2601 ObjectRef *ref = checkobject(L, 1);
2602 LuaEntitySAO *co = getluaobject(ref);
2603 if(co == NULL) return 0;
2605 v3f v = co->getVelocity();
2610 // setacceleration(self, {x=num, y=num, z=num})
2611 static int l_setacceleration(lua_State *L)
2613 ObjectRef *ref = checkobject(L, 1);
2614 LuaEntitySAO *co = getluaobject(ref);
2615 if(co == NULL) return 0;
2617 v3f pos = checkFloatPos(L, 2);
2619 co->setAcceleration(pos);
2623 // getacceleration(self)
2624 static int l_getacceleration(lua_State *L)
2626 ObjectRef *ref = checkobject(L, 1);
2627 LuaEntitySAO *co = getluaobject(ref);
2628 if(co == NULL) return 0;
2630 v3f v = co->getAcceleration();
2635 // setyaw(self, radians)
2636 static int l_setyaw(lua_State *L)
2638 ObjectRef *ref = checkobject(L, 1);
2639 LuaEntitySAO *co = getluaobject(ref);
2640 if(co == NULL) return 0;
2641 float yaw = luaL_checknumber(L, 2) * core::RADTODEG;
2648 static int l_getyaw(lua_State *L)
2650 ObjectRef *ref = checkobject(L, 1);
2651 LuaEntitySAO *co = getluaobject(ref);
2652 if(co == NULL) return 0;
2654 float yaw = co->getYaw() * core::DEGTORAD;
2655 lua_pushnumber(L, yaw);
2659 // settexturemod(self, mod)
2660 static int l_settexturemod(lua_State *L)
2662 ObjectRef *ref = checkobject(L, 1);
2663 LuaEntitySAO *co = getluaobject(ref);
2664 if(co == NULL) return 0;
2666 std::string mod = luaL_checkstring(L, 2);
2667 co->setTextureMod(mod);
2671 // setsprite(self, p={x=0,y=0}, num_frames=1, framelength=0.2,
2672 // select_horiz_by_yawpitch=false)
2673 static int l_setsprite(lua_State *L)
2675 ObjectRef *ref = checkobject(L, 1);
2676 LuaEntitySAO *co = getluaobject(ref);
2677 if(co == NULL) return 0;
2680 if(!lua_isnil(L, 2))
2681 p = read_v2s16(L, 2);
2683 if(!lua_isnil(L, 3))
2684 num_frames = lua_tonumber(L, 3);
2685 float framelength = 0.2;
2686 if(!lua_isnil(L, 4))
2687 framelength = lua_tonumber(L, 4);
2688 bool select_horiz_by_yawpitch = false;
2689 if(!lua_isnil(L, 5))
2690 select_horiz_by_yawpitch = lua_toboolean(L, 5);
2691 co->setSprite(p, num_frames, framelength, select_horiz_by_yawpitch);
2696 // get_entity_name(self)
2697 static int l_get_entity_name(lua_State *L)
2699 ObjectRef *ref = checkobject(L, 1);
2700 LuaEntitySAO *co = getluaobject(ref);
2701 if(co == NULL) return 0;
2703 std::string name = co->getName();
2704 lua_pushstring(L, name.c_str());
2708 // get_luaentity(self)
2709 static int l_get_luaentity(lua_State *L)
2711 ObjectRef *ref = checkobject(L, 1);
2712 LuaEntitySAO *co = getluaobject(ref);
2713 if(co == NULL) return 0;
2715 luaentity_get(L, co->getId());
2721 // get_player_name(self)
2722 static int l_get_player_name(lua_State *L)
2724 ObjectRef *ref = checkobject(L, 1);
2725 Player *player = getplayer(ref);
2731 lua_pushstring(L, player->getName());
2735 // get_look_dir(self)
2736 static int l_get_look_dir(lua_State *L)
2738 ObjectRef *ref = checkobject(L, 1);
2739 Player *player = getplayer(ref);
2740 if(player == NULL) return 0;
2742 float pitch = player->getRadPitch();
2743 float yaw = player->getRadYaw();
2744 v3f v(cos(pitch)*cos(yaw), sin(pitch), cos(pitch)*sin(yaw));
2749 // get_look_pitch(self)
2750 static int l_get_look_pitch(lua_State *L)
2752 ObjectRef *ref = checkobject(L, 1);
2753 Player *player = getplayer(ref);
2754 if(player == NULL) return 0;
2756 lua_pushnumber(L, player->getRadPitch());
2760 // get_look_yaw(self)
2761 static int l_get_look_yaw(lua_State *L)
2763 ObjectRef *ref = checkobject(L, 1);
2764 Player *player = getplayer(ref);
2765 if(player == NULL) return 0;
2767 lua_pushnumber(L, player->getRadYaw());
2772 ObjectRef(ServerActiveObject *object):
2775 //infostream<<"ObjectRef created for id="<<m_object->getId()<<std::endl;
2781 infostream<<"ObjectRef destructing for id="
2782 <<m_object->getId()<<std::endl;
2784 infostream<<"ObjectRef destructing for id=unknown"<<std::endl;*/
2787 // Creates an ObjectRef and leaves it on top of stack
2788 // Not callable from Lua; all references are created on the C side.
2789 static void create(lua_State *L, ServerActiveObject *object)
2791 ObjectRef *o = new ObjectRef(object);
2792 //infostream<<"ObjectRef::create: o="<<o<<std::endl;
2793 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
2794 luaL_getmetatable(L, className);
2795 lua_setmetatable(L, -2);
2798 static void set_null(lua_State *L)
2800 ObjectRef *o = checkobject(L, -1);
2804 static void Register(lua_State *L)
2807 int methodtable = lua_gettop(L);
2808 luaL_newmetatable(L, className);
2809 int metatable = lua_gettop(L);
2811 lua_pushliteral(L, "__metatable");
2812 lua_pushvalue(L, methodtable);
2813 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
2815 lua_pushliteral(L, "__index");
2816 lua_pushvalue(L, methodtable);
2817 lua_settable(L, metatable);
2819 lua_pushliteral(L, "__gc");
2820 lua_pushcfunction(L, gc_object);
2821 lua_settable(L, metatable);
2823 lua_pop(L, 1); // drop metatable
2825 luaL_openlib(L, 0, methods, 0); // fill methodtable
2826 lua_pop(L, 1); // drop methodtable
2828 // Cannot be created from Lua
2829 //lua_register(L, className, create_object);
2832 const char ObjectRef::className[] = "ObjectRef";
2833 const luaL_reg ObjectRef::methods[] = {
2834 // ServerActiveObject
2835 method(ObjectRef, remove),
2836 method(ObjectRef, getpos),
2837 method(ObjectRef, setpos),
2838 method(ObjectRef, moveto),
2839 method(ObjectRef, punch),
2840 method(ObjectRef, right_click),
2841 method(ObjectRef, set_hp),
2842 method(ObjectRef, get_hp),
2843 method(ObjectRef, get_inventory),
2844 method(ObjectRef, get_wield_list),
2845 method(ObjectRef, get_wield_index),
2846 method(ObjectRef, get_wielded_item),
2847 method(ObjectRef, set_wielded_item),
2848 method(ObjectRef, set_armor_groups),
2849 method(ObjectRef, set_properties),
2850 // LuaEntitySAO-only
2851 method(ObjectRef, setvelocity),
2852 method(ObjectRef, getvelocity),
2853 method(ObjectRef, setacceleration),
2854 method(ObjectRef, getacceleration),
2855 method(ObjectRef, setyaw),
2856 method(ObjectRef, getyaw),
2857 method(ObjectRef, settexturemod),
2858 method(ObjectRef, setsprite),
2859 method(ObjectRef, get_entity_name),
2860 method(ObjectRef, get_luaentity),
2862 method(ObjectRef, get_player_name),
2863 method(ObjectRef, get_look_dir),
2864 method(ObjectRef, get_look_pitch),
2865 method(ObjectRef, get_look_yaw),
2869 // Creates a new anonymous reference if id=0
2870 static void objectref_get_or_create(lua_State *L,
2871 ServerActiveObject *cobj)
2873 if(cobj->getId() == 0){
2874 ObjectRef::create(L, cobj);
2876 objectref_get(L, cobj->getId());
2885 class LuaPerlinNoise
2892 static const char className[];
2893 static const luaL_reg methods[];
2895 // Exported functions
2897 // garbage collector
2898 static int gc_object(lua_State *L)
2900 LuaPerlinNoise *o = *(LuaPerlinNoise **)(lua_touserdata(L, 1));
2905 static int l_get2d(lua_State *L)
2907 LuaPerlinNoise *o = checkobject(L, 1);
2908 v2f pos2d = read_v2f(L,2);
2909 lua_Number val = noise2d_perlin(pos2d.X/o->scale, pos2d.Y/o->scale, o->seed, o->octaves, o->persistence);
2910 lua_pushnumber(L, val);
2913 static int l_get3d(lua_State *L)
2915 LuaPerlinNoise *o = checkobject(L, 1);
2916 v3f pos3d = read_v3f(L,2);
2917 lua_Number val = noise3d_perlin(pos3d.X/o->scale, pos3d.Y/o->scale, pos3d.Z/o->scale, o->seed, o->octaves, o->persistence);
2918 lua_pushnumber(L, val);
2923 LuaPerlinNoise(int a_seed, int a_octaves, double a_persistence,
2927 persistence(a_persistence),
2936 // LuaPerlinNoise(seed, octaves, persistence, scale)
2937 // Creates an LuaPerlinNoise and leaves it on top of stack
2938 static int create_object(lua_State *L)
2940 int seed = luaL_checkint(L, 1);
2941 int octaves = luaL_checkint(L, 2);
2942 double persistence = luaL_checknumber(L, 3);
2943 double scale = luaL_checknumber(L, 4);
2944 LuaPerlinNoise *o = new LuaPerlinNoise(seed, octaves, persistence, scale);
2945 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
2946 luaL_getmetatable(L, className);
2947 lua_setmetatable(L, -2);
2951 static LuaPerlinNoise* checkobject(lua_State *L, int narg)
2953 luaL_checktype(L, narg, LUA_TUSERDATA);
2954 void *ud = luaL_checkudata(L, narg, className);
2955 if(!ud) luaL_typerror(L, narg, className);
2956 return *(LuaPerlinNoise**)ud; // unbox pointer
2959 static void Register(lua_State *L)
2962 int methodtable = lua_gettop(L);
2963 luaL_newmetatable(L, className);
2964 int metatable = lua_gettop(L);
2966 lua_pushliteral(L, "__metatable");
2967 lua_pushvalue(L, methodtable);
2968 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
2970 lua_pushliteral(L, "__index");
2971 lua_pushvalue(L, methodtable);
2972 lua_settable(L, metatable);
2974 lua_pushliteral(L, "__gc");
2975 lua_pushcfunction(L, gc_object);
2976 lua_settable(L, metatable);
2978 lua_pop(L, 1); // drop metatable
2980 luaL_openlib(L, 0, methods, 0); // fill methodtable
2981 lua_pop(L, 1); // drop methodtable
2983 // Can be created from Lua (PerlinNoise(seed, octaves, persistence)
2984 lua_register(L, className, create_object);
2987 const char LuaPerlinNoise::className[] = "PerlinNoise";
2988 const luaL_reg LuaPerlinNoise::methods[] = {
2989 method(LuaPerlinNoise, get2d),
2990 method(LuaPerlinNoise, get3d),
3001 ServerEnvironment *m_env;
3003 static const char className[];
3004 static const luaL_reg methods[];
3006 static int gc_object(lua_State *L) {
3007 EnvRef *o = *(EnvRef **)(lua_touserdata(L, 1));
3012 static EnvRef *checkobject(lua_State *L, int narg)
3014 luaL_checktype(L, narg, LUA_TUSERDATA);
3015 void *ud = luaL_checkudata(L, narg, className);
3016 if(!ud) luaL_typerror(L, narg, className);
3017 return *(EnvRef**)ud; // unbox pointer
3020 // Exported functions
3022 // EnvRef:set_node(pos, node)
3023 // pos = {x=num, y=num, z=num}
3024 static int l_set_node(lua_State *L)
3026 //infostream<<"EnvRef::l_set_node()"<<std::endl;
3027 EnvRef *o = checkobject(L, 1);
3028 ServerEnvironment *env = o->m_env;
3029 if(env == NULL) return 0;
3031 v3s16 pos = read_v3s16(L, 2);
3033 MapNode n = readnode(L, 3, env->getGameDef()->ndef());
3035 bool succeeded = env->getMap().addNodeWithEvent(pos, n);
3036 lua_pushboolean(L, succeeded);
3040 static int l_add_node(lua_State *L)
3042 return l_set_node(L);
3045 // EnvRef:remove_node(pos)
3046 // pos = {x=num, y=num, z=num}
3047 static int l_remove_node(lua_State *L)
3049 //infostream<<"EnvRef::l_remove_node()"<<std::endl;
3050 EnvRef *o = checkobject(L, 1);
3051 ServerEnvironment *env = o->m_env;
3052 if(env == NULL) return 0;
3054 v3s16 pos = read_v3s16(L, 2);
3056 bool succeeded = env->getMap().removeNodeWithEvent(pos);
3057 lua_pushboolean(L, succeeded);
3061 // EnvRef:get_node(pos)
3062 // pos = {x=num, y=num, z=num}
3063 static int l_get_node(lua_State *L)
3065 //infostream<<"EnvRef::l_get_node()"<<std::endl;
3066 EnvRef *o = checkobject(L, 1);
3067 ServerEnvironment *env = o->m_env;
3068 if(env == NULL) return 0;
3070 v3s16 pos = read_v3s16(L, 2);
3072 MapNode n = env->getMap().getNodeNoEx(pos);
3074 pushnode(L, n, env->getGameDef()->ndef());
3078 // EnvRef:get_node_or_nil(pos)
3079 // pos = {x=num, y=num, z=num}
3080 static int l_get_node_or_nil(lua_State *L)
3082 //infostream<<"EnvRef::l_get_node()"<<std::endl;
3083 EnvRef *o = checkobject(L, 1);
3084 ServerEnvironment *env = o->m_env;
3085 if(env == NULL) return 0;
3087 v3s16 pos = read_v3s16(L, 2);
3090 MapNode n = env->getMap().getNode(pos);
3092 pushnode(L, n, env->getGameDef()->ndef());
3094 } catch(InvalidPositionException &e)
3101 // EnvRef:get_node_light(pos, timeofday)
3102 // pos = {x=num, y=num, z=num}
3103 // timeofday: nil = current time, 0 = night, 0.5 = day
3104 static int l_get_node_light(lua_State *L)
3106 EnvRef *o = checkobject(L, 1);
3107 ServerEnvironment *env = o->m_env;
3108 if(env == NULL) return 0;
3110 v3s16 pos = read_v3s16(L, 2);
3111 u32 time_of_day = env->getTimeOfDay();
3112 if(lua_isnumber(L, 3))
3113 time_of_day = 24000.0 * lua_tonumber(L, 3);
3114 time_of_day %= 24000;
3115 u32 dnr = time_to_daynight_ratio(time_of_day);
3116 MapNode n = env->getMap().getNodeNoEx(pos);
3118 MapNode n = env->getMap().getNode(pos);
3119 INodeDefManager *ndef = env->getGameDef()->ndef();
3120 lua_pushinteger(L, n.getLightBlend(dnr, ndef));
3122 } catch(InvalidPositionException &e)
3129 // EnvRef:add_entity(pos, entityname) -> ObjectRef or nil
3130 // pos = {x=num, y=num, z=num}
3131 static int l_add_entity(lua_State *L)
3133 //infostream<<"EnvRef::l_add_entity()"<<std::endl;
3134 EnvRef *o = checkobject(L, 1);
3135 ServerEnvironment *env = o->m_env;
3136 if(env == NULL) return 0;
3138 v3f pos = checkFloatPos(L, 2);
3140 const char *name = luaL_checkstring(L, 3);
3142 ServerActiveObject *obj = new LuaEntitySAO(env, pos, name, "");
3143 int objectid = env->addActiveObject(obj);
3144 // If failed to add, return nothing (reads as nil)
3148 objectref_get_or_create(L, obj);
3152 // EnvRef:add_item(pos, itemstack or itemstring or table) -> ObjectRef or nil
3153 // pos = {x=num, y=num, z=num}
3154 static int l_add_item(lua_State *L)
3156 //infostream<<"EnvRef::l_add_item()"<<std::endl;
3157 EnvRef *o = checkobject(L, 1);
3158 ServerEnvironment *env = o->m_env;
3159 if(env == NULL) return 0;
3161 v3f pos = checkFloatPos(L, 2);
3163 ItemStack item = read_item(L, 3);
3164 if(item.empty() || !item.isKnown(get_server(L)->idef()))
3166 // Use minetest.spawn_item to spawn a __builtin:item
3167 lua_getglobal(L, "minetest");
3168 lua_getfield(L, -1, "spawn_item");
3169 if(lua_isnil(L, -1))
3171 lua_pushvalue(L, 2);
3172 lua_pushstring(L, item.getItemString().c_str());
3173 if(lua_pcall(L, 2, 1, 0))
3174 script_error(L, "error: %s", lua_tostring(L, -1));
3176 /*lua_pushvalue(L, 1);
3177 lua_pushstring(L, "__builtin:item");
3178 lua_pushstring(L, item.getItemString().c_str());
3179 return l_add_entity(L);*/
3181 ServerActiveObject *obj = createItemSAO(env, pos, item.getItemString());
3182 int objectid = env->addActiveObject(obj);
3183 // If failed to add, return nothing (reads as nil)
3187 objectref_get_or_create(L, obj);
3191 // EnvRef:add_rat(pos)
3192 // pos = {x=num, y=num, z=num}
3193 static int l_add_rat(lua_State *L)
3195 infostream<<"EnvRef::l_add_rat(): C++ mobs have been removed."
3196 <<" Doing nothing."<<std::endl;
3200 // EnvRef:add_firefly(pos)
3201 // pos = {x=num, y=num, z=num}
3202 static int l_add_firefly(lua_State *L)
3204 infostream<<"EnvRef::l_add_firefly(): C++ mobs have been removed."
3205 <<" Doing nothing."<<std::endl;
3209 // EnvRef:get_meta(pos)
3210 static int l_get_meta(lua_State *L)
3212 //infostream<<"EnvRef::l_get_meta()"<<std::endl;
3213 EnvRef *o = checkobject(L, 1);
3214 ServerEnvironment *env = o->m_env;
3215 if(env == NULL) return 0;
3217 v3s16 p = read_v3s16(L, 2);
3218 NodeMetaRef::create(L, p, env);
3222 // EnvRef:get_player_by_name(name)
3223 static int l_get_player_by_name(lua_State *L)
3225 EnvRef *o = checkobject(L, 1);
3226 ServerEnvironment *env = o->m_env;
3227 if(env == NULL) return 0;
3229 const char *name = luaL_checkstring(L, 2);
3230 Player *player = env->getPlayer(name);
3235 PlayerSAO *sao = player->getPlayerSAO();
3240 // Put player on stack
3241 objectref_get_or_create(L, sao);
3245 // EnvRef:get_objects_inside_radius(pos, radius)
3246 static int l_get_objects_inside_radius(lua_State *L)
3248 // Get the table insert function
3249 lua_getglobal(L, "table");
3250 lua_getfield(L, -1, "insert");
3251 int table_insert = lua_gettop(L);
3253 EnvRef *o = checkobject(L, 1);
3254 ServerEnvironment *env = o->m_env;
3255 if(env == NULL) return 0;
3257 v3f pos = checkFloatPos(L, 2);
3258 float radius = luaL_checknumber(L, 3) * BS;
3259 std::set<u16> ids = env->getObjectsInsideRadius(pos, radius);
3261 int table = lua_gettop(L);
3262 for(std::set<u16>::const_iterator
3263 i = ids.begin(); i != ids.end(); i++){
3264 ServerActiveObject *obj = env->getActiveObject(*i);
3265 // Insert object reference into table
3266 lua_pushvalue(L, table_insert);
3267 lua_pushvalue(L, table);
3268 objectref_get_or_create(L, obj);
3269 if(lua_pcall(L, 2, 0, 0))
3270 script_error(L, "error: %s", lua_tostring(L, -1));
3275 // EnvRef:set_timeofday(val)
3277 static int l_set_timeofday(lua_State *L)
3279 EnvRef *o = checkobject(L, 1);
3280 ServerEnvironment *env = o->m_env;
3281 if(env == NULL) return 0;
3283 float timeofday_f = luaL_checknumber(L, 2);
3284 assert(timeofday_f >= 0.0 && timeofday_f <= 1.0);
3285 int timeofday_mh = (int)(timeofday_f * 24000.0);
3286 // This should be set directly in the environment but currently
3287 // such changes aren't immediately sent to the clients, so call
3288 // the server instead.
3289 //env->setTimeOfDay(timeofday_mh);
3290 get_server(L)->setTimeOfDay(timeofday_mh);
3294 // EnvRef:get_timeofday() -> 0...1
3295 static int l_get_timeofday(lua_State *L)
3297 EnvRef *o = checkobject(L, 1);
3298 ServerEnvironment *env = o->m_env;
3299 if(env == NULL) return 0;
3301 int timeofday_mh = env->getTimeOfDay();
3302 float timeofday_f = (float)timeofday_mh / 24000.0;
3303 lua_pushnumber(L, timeofday_f);
3308 // EnvRef:find_node_near(pos, radius, nodenames) -> pos or nil
3309 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
3310 static int l_find_node_near(lua_State *L)
3312 EnvRef *o = checkobject(L, 1);
3313 ServerEnvironment *env = o->m_env;
3314 if(env == NULL) return 0;
3315 INodeDefManager *ndef = get_server(L)->ndef();
3316 v3s16 pos = read_v3s16(L, 2);
3317 int radius = luaL_checkinteger(L, 3);
3318 std::set<content_t> filter;
3319 if(lua_istable(L, 4)){
3322 while(lua_next(L, table) != 0){
3323 // key at index -2 and value at index -1
3324 luaL_checktype(L, -1, LUA_TSTRING);
3325 ndef->getIds(lua_tostring(L, -1), filter);
3326 // removes value, keeps key for next iteration
3329 } else if(lua_isstring(L, 4)){
3330 ndef->getIds(lua_tostring(L, 4), filter);
3333 for(int d=1; d<=radius; d++){
3334 core::list<v3s16> list;
3335 getFacePositions(list, d);
3336 for(core::list<v3s16>::Iterator i = list.begin();
3337 i != list.end(); i++){
3338 v3s16 p = pos + (*i);
3339 content_t c = env->getMap().getNodeNoEx(p).getContent();
3340 if(filter.count(c) != 0){
3349 // EnvRef:get_perlin(seeddiff, octaves, persistence, scale)
3350 // returns world-specific PerlinNoise
3351 static int l_get_perlin(lua_State *L)
3353 EnvRef *o = checkobject(L, 1);
3354 ServerEnvironment *env = o->m_env;
3355 if(env == NULL) return 0;
3357 int seeddiff = luaL_checkint(L, 2);
3358 int octaves = luaL_checkint(L, 3);
3359 double persistence = luaL_checknumber(L, 4);
3360 double scale = luaL_checknumber(L, 5);
3362 LuaPerlinNoise *n = new LuaPerlinNoise(seeddiff + int(env->getServerMap().getSeed()), octaves, persistence, scale);
3363 *(void **)(lua_newuserdata(L, sizeof(void *))) = n;
3364 luaL_getmetatable(L, "PerlinNoise");
3365 lua_setmetatable(L, -2);
3370 EnvRef(ServerEnvironment *env):
3373 //infostream<<"EnvRef created"<<std::endl;
3378 //infostream<<"EnvRef destructing"<<std::endl;
3381 // Creates an EnvRef and leaves it on top of stack
3382 // Not callable from Lua; all references are created on the C side.
3383 static void create(lua_State *L, ServerEnvironment *env)
3385 EnvRef *o = new EnvRef(env);
3386 //infostream<<"EnvRef::create: o="<<o<<std::endl;
3387 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
3388 luaL_getmetatable(L, className);
3389 lua_setmetatable(L, -2);
3392 static void set_null(lua_State *L)
3394 EnvRef *o = checkobject(L, -1);
3398 static void Register(lua_State *L)
3401 int methodtable = lua_gettop(L);
3402 luaL_newmetatable(L, className);
3403 int metatable = lua_gettop(L);
3405 lua_pushliteral(L, "__metatable");
3406 lua_pushvalue(L, methodtable);
3407 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
3409 lua_pushliteral(L, "__index");
3410 lua_pushvalue(L, methodtable);
3411 lua_settable(L, metatable);
3413 lua_pushliteral(L, "__gc");
3414 lua_pushcfunction(L, gc_object);
3415 lua_settable(L, metatable);
3417 lua_pop(L, 1); // drop metatable
3419 luaL_openlib(L, 0, methods, 0); // fill methodtable
3420 lua_pop(L, 1); // drop methodtable
3422 // Cannot be created from Lua
3423 //lua_register(L, className, create_object);
3426 const char EnvRef::className[] = "EnvRef";
3427 const luaL_reg EnvRef::methods[] = {
3428 method(EnvRef, set_node),
3429 method(EnvRef, add_node),
3430 method(EnvRef, remove_node),
3431 method(EnvRef, get_node),
3432 method(EnvRef, get_node_or_nil),
3433 method(EnvRef, get_node_light),
3434 method(EnvRef, add_entity),
3435 method(EnvRef, add_item),
3436 method(EnvRef, add_rat),
3437 method(EnvRef, add_firefly),
3438 method(EnvRef, get_meta),
3439 method(EnvRef, get_player_by_name),
3440 method(EnvRef, get_objects_inside_radius),
3441 method(EnvRef, set_timeofday),
3442 method(EnvRef, get_timeofday),
3443 method(EnvRef, find_node_near),
3444 method(EnvRef, get_perlin),
3453 class LuaPseudoRandom
3456 PseudoRandom m_pseudo;
3458 static const char className[];
3459 static const luaL_reg methods[];
3461 // Exported functions
3463 // garbage collector
3464 static int gc_object(lua_State *L)
3466 LuaPseudoRandom *o = *(LuaPseudoRandom **)(lua_touserdata(L, 1));
3471 // next(self, min=0, max=32767) -> get next value
3472 static int l_next(lua_State *L)
3474 LuaPseudoRandom *o = checkobject(L, 1);
3477 lua_settop(L, 3); // Fill 2 and 3 with nil if they don't exist
3478 if(!lua_isnil(L, 2))
3479 min = luaL_checkinteger(L, 2);
3480 if(!lua_isnil(L, 3))
3481 max = luaL_checkinteger(L, 3);
3482 if(max - min != 32767 && max - min > 32767/5)
3483 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.");
3484 PseudoRandom &pseudo = o->m_pseudo;
3485 int val = pseudo.next();
3486 val = (val % (max-min+1)) + min;
3487 lua_pushinteger(L, val);
3492 LuaPseudoRandom(int seed):
3501 const PseudoRandom& getItem() const
3505 PseudoRandom& getItem()
3510 // LuaPseudoRandom(seed)
3511 // Creates an LuaPseudoRandom and leaves it on top of stack
3512 static int create_object(lua_State *L)
3514 int seed = luaL_checknumber(L, 1);
3515 LuaPseudoRandom *o = new LuaPseudoRandom(seed);
3516 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
3517 luaL_getmetatable(L, className);
3518 lua_setmetatable(L, -2);
3522 static LuaPseudoRandom* checkobject(lua_State *L, int narg)
3524 luaL_checktype(L, narg, LUA_TUSERDATA);
3525 void *ud = luaL_checkudata(L, narg, className);
3526 if(!ud) luaL_typerror(L, narg, className);
3527 return *(LuaPseudoRandom**)ud; // unbox pointer
3530 static void Register(lua_State *L)
3533 int methodtable = lua_gettop(L);
3534 luaL_newmetatable(L, className);
3535 int metatable = lua_gettop(L);
3537 lua_pushliteral(L, "__metatable");
3538 lua_pushvalue(L, methodtable);
3539 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
3541 lua_pushliteral(L, "__index");
3542 lua_pushvalue(L, methodtable);
3543 lua_settable(L, metatable);
3545 lua_pushliteral(L, "__gc");
3546 lua_pushcfunction(L, gc_object);
3547 lua_settable(L, metatable);
3549 lua_pop(L, 1); // drop metatable
3551 luaL_openlib(L, 0, methods, 0); // fill methodtable
3552 lua_pop(L, 1); // drop methodtable
3554 // Can be created from Lua (LuaPseudoRandom(seed))
3555 lua_register(L, className, create_object);
3558 const char LuaPseudoRandom::className[] = "PseudoRandom";
3559 const luaL_reg LuaPseudoRandom::methods[] = {
3560 method(LuaPseudoRandom, next),
3570 class LuaABM : public ActiveBlockModifier
3576 std::set<std::string> m_trigger_contents;
3577 std::set<std::string> m_required_neighbors;
3578 float m_trigger_interval;
3579 u32 m_trigger_chance;
3581 LuaABM(lua_State *L, int id,
3582 const std::set<std::string> &trigger_contents,
3583 const std::set<std::string> &required_neighbors,
3584 float trigger_interval, u32 trigger_chance):
3587 m_trigger_contents(trigger_contents),
3588 m_required_neighbors(required_neighbors),
3589 m_trigger_interval(trigger_interval),
3590 m_trigger_chance(trigger_chance)
3593 virtual std::set<std::string> getTriggerContents()
3595 return m_trigger_contents;
3597 virtual std::set<std::string> getRequiredNeighbors()
3599 return m_required_neighbors;
3601 virtual float getTriggerInterval()
3603 return m_trigger_interval;
3605 virtual u32 getTriggerChance()
3607 return m_trigger_chance;
3609 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
3610 u32 active_object_count, u32 active_object_count_wider)
3612 lua_State *L = m_lua;
3615 assert(lua_checkstack(L, 20));
3616 StackUnroller stack_unroller(L);
3618 // Get minetest.registered_abms
3619 lua_getglobal(L, "minetest");
3620 lua_getfield(L, -1, "registered_abms");
3621 luaL_checktype(L, -1, LUA_TTABLE);
3622 int registered_abms = lua_gettop(L);
3624 // Get minetest.registered_abms[m_id]
3625 lua_pushnumber(L, m_id);
3626 lua_gettable(L, registered_abms);
3627 if(lua_isnil(L, -1))
3631 luaL_checktype(L, -1, LUA_TTABLE);
3632 lua_getfield(L, -1, "action");
3633 luaL_checktype(L, -1, LUA_TFUNCTION);
3635 pushnode(L, n, env->getGameDef()->ndef());
3636 lua_pushnumber(L, active_object_count);
3637 lua_pushnumber(L, active_object_count_wider);
3638 if(lua_pcall(L, 4, 0, 0))
3639 script_error(L, "error: %s", lua_tostring(L, -1));
3647 static void read_server_sound_params(lua_State *L, int index,
3648 ServerSoundParams ¶ms)
3651 index = lua_gettop(L) + 1 + index;
3653 params = ServerSoundParams();
3654 if(lua_istable(L, index)){
3655 getfloatfield(L, index, "gain", params.gain);
3656 getstringfield(L, index, "to_player", params.to_player);
3657 lua_getfield(L, index, "pos");
3658 if(!lua_isnil(L, -1)){
3659 v3f p = read_v3f(L, -1)*BS;
3661 params.type = ServerSoundParams::SSP_POSITIONAL;
3664 lua_getfield(L, index, "object");
3665 if(!lua_isnil(L, -1)){
3666 ObjectRef *ref = ObjectRef::checkobject(L, -1);
3667 ServerActiveObject *sao = ObjectRef::getobject(ref);
3669 params.object = sao->getId();
3670 params.type = ServerSoundParams::SSP_OBJECT;
3674 params.max_hear_distance = BS*getfloatfield_default(L, index,
3675 "max_hear_distance", params.max_hear_distance/BS);
3676 getboolfield(L, index, "loop", params.loop);
3685 // Writes a line to dstream
3686 static int l_debug(lua_State *L)
3688 std::string text = lua_tostring(L, 1);
3689 dstream << text << std::endl;
3693 // log([level,] text)
3694 // Writes a line to the logger.
3695 // The one-argument version logs to infostream.
3696 // The two-argument version accept a log level: error, action, info, or verbose.
3697 static int l_log(lua_State *L)
3700 LogMessageLevel level = LMT_INFO;
3701 if(lua_isnone(L, 2))
3703 text = lua_tostring(L, 1);
3707 std::string levelname = lua_tostring(L, 1);
3708 text = lua_tostring(L, 2);
3709 if(levelname == "error")
3711 else if(levelname == "action")
3713 else if(levelname == "verbose")
3714 level = LMT_VERBOSE;
3716 log_printline(level, text);
3720 // register_item_raw({lots of stuff})
3721 static int l_register_item_raw(lua_State *L)
3723 luaL_checktype(L, 1, LUA_TTABLE);
3726 // Get the writable item and node definition managers from the server
3727 IWritableItemDefManager *idef =
3728 get_server(L)->getWritableItemDefManager();
3729 IWritableNodeDefManager *ndef =
3730 get_server(L)->getWritableNodeDefManager();
3732 // Check if name is defined
3733 lua_getfield(L, table, "name");
3734 if(lua_isstring(L, -1)){
3735 std::string name = lua_tostring(L, -1);
3736 verbosestream<<"register_item_raw: "<<name<<std::endl;
3738 throw LuaError(L, "register_item_raw: name is not defined or not a string");
3741 // Check if on_use is defined
3743 // Read the item definition and register it
3744 ItemDefinition def = read_item_definition(L, table);
3745 idef->registerItem(def);
3747 // Read the node definition (content features) and register it
3748 if(def.type == ITEM_NODE)
3750 ContentFeatures f = read_content_features(L, table);
3751 ndef->set(f.name, f);
3754 return 0; /* number of results */
3757 // register_alias_raw(name, convert_to_name)
3758 static int l_register_alias_raw(lua_State *L)
3760 std::string name = luaL_checkstring(L, 1);
3761 std::string convert_to = luaL_checkstring(L, 2);
3763 // Get the writable item definition manager from the server
3764 IWritableItemDefManager *idef =
3765 get_server(L)->getWritableItemDefManager();
3767 idef->registerAlias(name, convert_to);
3769 return 0; /* number of results */
3772 // helper for register_craft
3773 static bool read_craft_recipe_shaped(lua_State *L, int index,
3774 int &width, std::vector<std::string> &recipe)
3777 index = lua_gettop(L) + 1 + index;
3779 if(!lua_istable(L, index))
3784 while(lua_next(L, index) != 0){
3786 // key at index -2 and value at index -1
3787 if(!lua_istable(L, -1))
3789 int table2 = lua_gettop(L);
3791 while(lua_next(L, table2) != 0){
3792 // key at index -2 and value at index -1
3793 if(!lua_isstring(L, -1))
3795 recipe.push_back(lua_tostring(L, -1));
3796 // removes value, keeps key for next iteration
3803 if(colcount != width)
3806 // removes value, keeps key for next iteration
3813 // helper for register_craft
3814 static bool read_craft_recipe_shapeless(lua_State *L, int index,
3815 std::vector<std::string> &recipe)
3818 index = lua_gettop(L) + 1 + index;
3820 if(!lua_istable(L, index))
3824 while(lua_next(L, index) != 0){
3825 // key at index -2 and value at index -1
3826 if(!lua_isstring(L, -1))
3828 recipe.push_back(lua_tostring(L, -1));
3829 // removes value, keeps key for next iteration
3835 // helper for register_craft
3836 static bool read_craft_replacements(lua_State *L, int index,
3837 CraftReplacements &replacements)
3840 index = lua_gettop(L) + 1 + index;
3842 if(!lua_istable(L, index))
3846 while(lua_next(L, index) != 0){
3847 // key at index -2 and value at index -1
3848 if(!lua_istable(L, -1))
3850 lua_rawgeti(L, -1, 1);
3851 if(!lua_isstring(L, -1))
3853 std::string replace_from = lua_tostring(L, -1);
3855 lua_rawgeti(L, -1, 2);
3856 if(!lua_isstring(L, -1))
3858 std::string replace_to = lua_tostring(L, -1);
3860 replacements.pairs.push_back(
3861 std::make_pair(replace_from, replace_to));
3862 // removes value, keeps key for next iteration
3867 // register_craft({output=item, recipe={{item00,item10},{item01,item11}})
3868 static int l_register_craft(lua_State *L)
3870 //infostream<<"register_craft"<<std::endl;
3871 luaL_checktype(L, 1, LUA_TTABLE);
3874 // Get the writable craft definition manager from the server
3875 IWritableCraftDefManager *craftdef =
3876 get_server(L)->getWritableCraftDefManager();
3878 std::string type = getstringfield_default(L, table, "type", "shaped");
3881 CraftDefinitionShaped
3883 if(type == "shaped"){
3884 std::string output = getstringfield_default(L, table, "output", "");
3886 throw LuaError(L, "Crafting definition is missing an output");
3889 std::vector<std::string> recipe;
3890 lua_getfield(L, table, "recipe");
3891 if(lua_isnil(L, -1))
3892 throw LuaError(L, "Crafting definition is missing a recipe"
3893 " (output=\"" + output + "\")");
3894 if(!read_craft_recipe_shaped(L, -1, width, recipe))
3895 throw LuaError(L, "Invalid crafting recipe"
3896 " (output=\"" + output + "\")");
3898 CraftReplacements replacements;
3899 lua_getfield(L, table, "replacements");
3900 if(!lua_isnil(L, -1))
3902 if(!read_craft_replacements(L, -1, replacements))
3903 throw LuaError(L, "Invalid replacements"
3904 " (output=\"" + output + "\")");
3907 CraftDefinition *def = new CraftDefinitionShaped(
3908 output, width, recipe, replacements);
3909 craftdef->registerCraft(def);
3912 CraftDefinitionShapeless
3914 else if(type == "shapeless"){
3915 std::string output = getstringfield_default(L, table, "output", "");
3917 throw LuaError(L, "Crafting definition (shapeless)"
3918 " is missing an output");
3920 std::vector<std::string> recipe;
3921 lua_getfield(L, table, "recipe");
3922 if(lua_isnil(L, -1))
3923 throw LuaError(L, "Crafting definition (shapeless)"
3924 " is missing a recipe"
3925 " (output=\"" + output + "\")");
3926 if(!read_craft_recipe_shapeless(L, -1, recipe))
3927 throw LuaError(L, "Invalid crafting recipe"
3928 " (output=\"" + output + "\")");
3930 CraftReplacements replacements;
3931 lua_getfield(L, table, "replacements");
3932 if(!lua_isnil(L, -1))
3934 if(!read_craft_replacements(L, -1, replacements))
3935 throw LuaError(L, "Invalid replacements"
3936 " (output=\"" + output + "\")");
3939 CraftDefinition *def = new CraftDefinitionShapeless(
3940 output, recipe, replacements);
3941 craftdef->registerCraft(def);
3944 CraftDefinitionToolRepair
3946 else if(type == "toolrepair"){
3947 float additional_wear = getfloatfield_default(L, table,
3948 "additional_wear", 0.0);
3950 CraftDefinition *def = new CraftDefinitionToolRepair(
3952 craftdef->registerCraft(def);
3955 CraftDefinitionCooking
3957 else if(type == "cooking"){
3958 std::string output = getstringfield_default(L, table, "output", "");
3960 throw LuaError(L, "Crafting definition (cooking)"
3961 " is missing an output");
3963 std::string recipe = getstringfield_default(L, table, "recipe", "");
3965 throw LuaError(L, "Crafting definition (cooking)"
3966 " is missing a recipe"
3967 " (output=\"" + output + "\")");
3969 float cooktime = getfloatfield_default(L, table, "cooktime", 3.0);
3971 CraftDefinition *def = new CraftDefinitionCooking(
3972 output, recipe, cooktime);
3973 craftdef->registerCraft(def);
3978 else if(type == "fuel"){
3979 std::string recipe = getstringfield_default(L, table, "recipe", "");
3981 throw LuaError(L, "Crafting definition (fuel)"
3982 " is missing a recipe");
3984 float burntime = getfloatfield_default(L, table, "burntime", 1.0);
3986 CraftDefinition *def = new CraftDefinitionFuel(
3988 craftdef->registerCraft(def);
3992 throw LuaError(L, "Unknown crafting definition type: \"" + type + "\"");
3996 return 0; /* number of results */
3999 // setting_set(name, value)
4000 static int l_setting_set(lua_State *L)
4002 const char *name = luaL_checkstring(L, 1);
4003 const char *value = luaL_checkstring(L, 2);
4004 g_settings->set(name, value);
4008 // setting_get(name)
4009 static int l_setting_get(lua_State *L)
4011 const char *name = luaL_checkstring(L, 1);
4013 std::string value = g_settings->get(name);
4014 lua_pushstring(L, value.c_str());
4015 } catch(SettingNotFoundException &e){
4021 // setting_getbool(name)
4022 static int l_setting_getbool(lua_State *L)
4024 const char *name = luaL_checkstring(L, 1);
4026 bool value = g_settings->getBool(name);
4027 lua_pushboolean(L, value);
4028 } catch(SettingNotFoundException &e){
4034 // chat_send_all(text)
4035 static int l_chat_send_all(lua_State *L)
4037 const char *text = luaL_checkstring(L, 1);
4038 // Get server from registry
4039 Server *server = get_server(L);
4041 server->notifyPlayers(narrow_to_wide(text));
4045 // chat_send_player(name, text)
4046 static int l_chat_send_player(lua_State *L)
4048 const char *name = luaL_checkstring(L, 1);
4049 const char *text = luaL_checkstring(L, 2);
4050 // Get server from registry
4051 Server *server = get_server(L);
4053 server->notifyPlayer(name, narrow_to_wide(text));
4057 // get_player_privs(name, text)
4058 static int l_get_player_privs(lua_State *L)
4060 const char *name = luaL_checkstring(L, 1);
4061 // Get server from registry
4062 Server *server = get_server(L);
4065 int table = lua_gettop(L);
4066 std::set<std::string> privs_s = server->getPlayerEffectivePrivs(name);
4067 for(std::set<std::string>::const_iterator
4068 i = privs_s.begin(); i != privs_s.end(); i++){
4069 lua_pushboolean(L, true);
4070 lua_setfield(L, table, i->c_str());
4072 lua_pushvalue(L, table);
4076 // get_inventory(location)
4077 static int l_get_inventory(lua_State *L)
4079 InventoryLocation loc;
4081 std::string type = checkstringfield(L, 1, "type");
4082 if(type == "player"){
4083 std::string name = checkstringfield(L, 1, "name");
4084 loc.setPlayer(name);
4085 } else if(type == "node"){
4086 lua_getfield(L, 1, "pos");
4087 v3s16 pos = check_v3s16(L, -1);
4088 loc.setNodeMeta(pos);
4091 if(get_server(L)->getInventory(loc) != NULL)
4092 InvRef::create(L, loc);
4098 // get_dig_params(groups, tool_capabilities[, time_from_last_punch])
4099 static int l_get_dig_params(lua_State *L)
4101 std::map<std::string, int> groups;
4102 read_groups(L, 1, groups);
4103 ToolCapabilities tp = read_tool_capabilities(L, 2);
4104 if(lua_isnoneornil(L, 3))
4105 push_dig_params(L, getDigParams(groups, &tp));
4107 push_dig_params(L, getDigParams(groups, &tp,
4108 luaL_checknumber(L, 3)));
4112 // get_hit_params(groups, tool_capabilities[, time_from_last_punch])
4113 static int l_get_hit_params(lua_State *L)
4115 std::map<std::string, int> groups;
4116 read_groups(L, 1, groups);
4117 ToolCapabilities tp = read_tool_capabilities(L, 2);
4118 if(lua_isnoneornil(L, 3))
4119 push_hit_params(L, getHitParams(groups, &tp));
4121 push_hit_params(L, getHitParams(groups, &tp,
4122 luaL_checknumber(L, 3)));
4126 // get_current_modname()
4127 static int l_get_current_modname(lua_State *L)
4129 lua_getfield(L, LUA_REGISTRYINDEX, "minetest_current_modname");
4133 // get_modpath(modname)
4134 static int l_get_modpath(lua_State *L)
4136 std::string modname = luaL_checkstring(L, 1);
4138 if(modname == "__builtin"){
4139 std::string path = get_server(L)->getBuiltinLuaPath();
4140 lua_pushstring(L, path.c_str());
4143 const ModSpec *mod = get_server(L)->getModSpec(modname);
4148 lua_pushstring(L, mod->path.c_str());
4153 static int l_get_worldpath(lua_State *L)
4155 std::string worldpath = get_server(L)->getWorldPath();
4156 lua_pushstring(L, worldpath.c_str());
4160 // sound_play(spec, parameters)
4161 static int l_sound_play(lua_State *L)
4163 SimpleSoundSpec spec;
4164 read_soundspec(L, 1, spec);
4165 ServerSoundParams params;
4166 read_server_sound_params(L, 2, params);
4167 s32 handle = get_server(L)->playSound(spec, params);
4168 lua_pushinteger(L, handle);
4172 // sound_stop(handle)
4173 static int l_sound_stop(lua_State *L)
4175 int handle = luaL_checkinteger(L, 1);
4176 get_server(L)->stopSound(handle);
4180 // is_singleplayer()
4181 static int l_is_singleplayer(lua_State *L)
4183 lua_pushboolean(L, get_server(L)->isSingleplayer());
4187 // get_password_hash(name, raw_password)
4188 static int l_get_password_hash(lua_State *L)
4190 std::string name = luaL_checkstring(L, 1);
4191 std::string raw_password = luaL_checkstring(L, 2);
4192 std::string hash = translatePassword(name,
4193 narrow_to_wide(raw_password));
4194 lua_pushstring(L, hash.c_str());
4198 // notify_authentication_modified(name)
4199 static int l_notify_authentication_modified(lua_State *L)
4201 std::string name = "";
4202 if(lua_isstring(L, 1))
4203 name = lua_tostring(L, 1);
4204 get_server(L)->reportPrivsModified(name);
4208 static const struct luaL_Reg minetest_f [] = {
4211 {"register_item_raw", l_register_item_raw},
4212 {"register_alias_raw", l_register_alias_raw},
4213 {"register_craft", l_register_craft},
4214 {"setting_set", l_setting_set},
4215 {"setting_get", l_setting_get},
4216 {"setting_getbool", l_setting_getbool},
4217 {"chat_send_all", l_chat_send_all},
4218 {"chat_send_player", l_chat_send_player},
4219 {"get_player_privs", l_get_player_privs},
4220 {"get_inventory", l_get_inventory},
4221 {"get_dig_params", l_get_dig_params},
4222 {"get_hit_params", l_get_hit_params},
4223 {"get_current_modname", l_get_current_modname},
4224 {"get_modpath", l_get_modpath},
4225 {"get_worldpath", l_get_worldpath},
4226 {"sound_play", l_sound_play},
4227 {"sound_stop", l_sound_stop},
4228 {"is_singleplayer", l_is_singleplayer},
4229 {"get_password_hash", l_get_password_hash},
4230 {"notify_authentication_modified", l_notify_authentication_modified},
4235 Main export function
4238 void scriptapi_export(lua_State *L, Server *server)
4241 assert(lua_checkstack(L, 20));
4242 verbosestream<<"scriptapi_export()"<<std::endl;
4243 StackUnroller stack_unroller(L);
4245 // Store server as light userdata in registry
4246 lua_pushlightuserdata(L, server);
4247 lua_setfield(L, LUA_REGISTRYINDEX, "minetest_server");
4249 // Register global functions in table minetest
4251 luaL_register(L, NULL, minetest_f);
4252 lua_setglobal(L, "minetest");
4254 // Get the main minetest table
4255 lua_getglobal(L, "minetest");
4257 // Add tables to minetest
4260 lua_setfield(L, -2, "object_refs");
4262 lua_setfield(L, -2, "luaentities");
4264 // Register wrappers
4265 LuaItemStack::Register(L);
4266 InvRef::Register(L);
4267 NodeMetaRef::Register(L);
4268 ObjectRef::Register(L);
4269 EnvRef::Register(L);
4270 LuaPseudoRandom::Register(L);
4271 LuaPerlinNoise::Register(L);
4274 bool scriptapi_loadmod(lua_State *L, const std::string &scriptpath,
4275 const std::string &modname)
4277 ModNameStorer modnamestorer(L, modname);
4279 if(!string_allowed(modname, "abcdefghijklmnopqrstuvwxyz"
4281 errorstream<<"Error loading mod \""<<modname
4282 <<"\": modname does not follow naming conventions: "
4283 <<"Only chararacters [a-z0-9_] are allowed."<<std::endl;
4287 bool success = false;
4290 success = script_load(L, scriptpath.c_str());
4293 errorstream<<"Error loading mod \""<<modname
4294 <<"\": "<<e.what()<<std::endl;
4300 void scriptapi_add_environment(lua_State *L, ServerEnvironment *env)
4303 assert(lua_checkstack(L, 20));
4304 verbosestream<<"scriptapi_add_environment"<<std::endl;
4305 StackUnroller stack_unroller(L);
4307 // Create EnvRef on stack
4308 EnvRef::create(L, env);
4309 int envref = lua_gettop(L);
4311 // minetest.env = envref
4312 lua_getglobal(L, "minetest");
4313 luaL_checktype(L, -1, LUA_TTABLE);
4314 lua_pushvalue(L, envref);
4315 lua_setfield(L, -2, "env");
4317 // Store environment as light userdata in registry
4318 lua_pushlightuserdata(L, env);
4319 lua_setfield(L, LUA_REGISTRYINDEX, "minetest_env");
4322 Add ActiveBlockModifiers to environment
4325 // Get minetest.registered_abms
4326 lua_getglobal(L, "minetest");
4327 lua_getfield(L, -1, "registered_abms");
4328 luaL_checktype(L, -1, LUA_TTABLE);
4329 int registered_abms = lua_gettop(L);
4331 if(lua_istable(L, registered_abms)){
4332 int table = lua_gettop(L);
4334 while(lua_next(L, table) != 0){
4335 // key at index -2 and value at index -1
4336 int id = lua_tonumber(L, -2);
4337 int current_abm = lua_gettop(L);
4339 std::set<std::string> trigger_contents;
4340 lua_getfield(L, current_abm, "nodenames");
4341 if(lua_istable(L, -1)){
4342 int table = lua_gettop(L);
4344 while(lua_next(L, table) != 0){
4345 // key at index -2 and value at index -1
4346 luaL_checktype(L, -1, LUA_TSTRING);
4347 trigger_contents.insert(lua_tostring(L, -1));
4348 // removes value, keeps key for next iteration
4351 } else if(lua_isstring(L, -1)){
4352 trigger_contents.insert(lua_tostring(L, -1));
4356 std::set<std::string> required_neighbors;
4357 lua_getfield(L, current_abm, "neighbors");
4358 if(lua_istable(L, -1)){
4359 int table = lua_gettop(L);
4361 while(lua_next(L, table) != 0){
4362 // key at index -2 and value at index -1
4363 luaL_checktype(L, -1, LUA_TSTRING);
4364 required_neighbors.insert(lua_tostring(L, -1));
4365 // removes value, keeps key for next iteration
4368 } else if(lua_isstring(L, -1)){
4369 required_neighbors.insert(lua_tostring(L, -1));
4373 float trigger_interval = 10.0;
4374 getfloatfield(L, current_abm, "interval", trigger_interval);
4376 int trigger_chance = 50;
4377 getintfield(L, current_abm, "chance", trigger_chance);
4379 LuaABM *abm = new LuaABM(L, id, trigger_contents,
4380 required_neighbors, trigger_interval, trigger_chance);
4382 env->addActiveBlockModifier(abm);
4384 // removes value, keeps key for next iteration
4392 // Dump stack top with the dump2 function
4393 static void dump2(lua_State *L, const char *name)
4395 // Dump object (debug)
4396 lua_getglobal(L, "dump2");
4397 luaL_checktype(L, -1, LUA_TFUNCTION);
4398 lua_pushvalue(L, -2); // Get previous stack top as first parameter
4399 lua_pushstring(L, name);
4400 if(lua_pcall(L, 2, 0, 0))
4401 script_error(L, "error: %s", lua_tostring(L, -1));
4409 void scriptapi_add_object_reference(lua_State *L, ServerActiveObject *cobj)
4412 assert(lua_checkstack(L, 20));
4413 //infostream<<"scriptapi_add_object_reference: id="<<cobj->getId()<<std::endl;
4414 StackUnroller stack_unroller(L);
4416 // Create object on stack
4417 ObjectRef::create(L, cobj); // Puts ObjectRef (as userdata) on stack
4418 int object = lua_gettop(L);
4420 // Get minetest.object_refs table
4421 lua_getglobal(L, "minetest");
4422 lua_getfield(L, -1, "object_refs");
4423 luaL_checktype(L, -1, LUA_TTABLE);
4424 int objectstable = lua_gettop(L);
4426 // object_refs[id] = object
4427 lua_pushnumber(L, cobj->getId()); // Push id
4428 lua_pushvalue(L, object); // Copy object to top of stack
4429 lua_settable(L, objectstable);
4432 void scriptapi_rm_object_reference(lua_State *L, ServerActiveObject *cobj)
4435 assert(lua_checkstack(L, 20));
4436 //infostream<<"scriptapi_rm_object_reference: id="<<cobj->getId()<<std::endl;
4437 StackUnroller stack_unroller(L);
4439 // Get minetest.object_refs table
4440 lua_getglobal(L, "minetest");
4441 lua_getfield(L, -1, "object_refs");
4442 luaL_checktype(L, -1, LUA_TTABLE);
4443 int objectstable = lua_gettop(L);
4445 // Get object_refs[id]
4446 lua_pushnumber(L, cobj->getId()); // Push id
4447 lua_gettable(L, objectstable);
4448 // Set object reference to NULL
4449 ObjectRef::set_null(L);
4450 lua_pop(L, 1); // pop object
4452 // Set object_refs[id] = nil
4453 lua_pushnumber(L, cobj->getId()); // Push id
4455 lua_settable(L, objectstable);
4462 // What scriptapi_run_callbacks does with the return values of callbacks.
4463 // Regardless of the mode, if only one callback is defined,
4464 // its return value is the total return value.
4465 // Modes only affect the case where 0 or >= 2 callbacks are defined.
4466 enum RunCallbacksMode
4468 // Returns the return value of the first callback
4469 // Returns nil if list of callbacks is empty
4470 RUN_CALLBACKS_MODE_FIRST,
4471 // Returns the return value of the last callback
4472 // Returns nil if list of callbacks is empty
4473 RUN_CALLBACKS_MODE_LAST,
4474 // If any callback returns a false value, the first such is returned
4475 // Otherwise, the first callback's return value (trueish) is returned
4476 // Returns true if list of callbacks is empty
4477 RUN_CALLBACKS_MODE_AND,
4478 // Like above, but stops calling callbacks (short circuit)
4479 // after seeing the first false value
4480 RUN_CALLBACKS_MODE_AND_SC,
4481 // If any callback returns a true value, the first such is returned
4482 // Otherwise, the first callback's return value (falseish) is returned
4483 // Returns false if list of callbacks is empty
4484 RUN_CALLBACKS_MODE_OR,
4485 // Like above, but stops calling callbacks (short circuit)
4486 // after seeing the first true value
4487 RUN_CALLBACKS_MODE_OR_SC,
4488 // Note: "a true value" and "a false value" refer to values that
4489 // are converted by lua_toboolean to true or false, respectively.
4492 // Push the list of callbacks (a lua table).
4493 // Then push nargs arguments.
4494 // Then call this function, which
4495 // - runs the callbacks
4496 // - removes the table and arguments from the lua stack
4497 // - pushes the return value, computed depending on mode
4498 static void scriptapi_run_callbacks(lua_State *L, int nargs,
4499 RunCallbacksMode mode)
4501 // Insert the return value into the lua stack, below the table
4502 assert(lua_gettop(L) >= nargs + 1);
4504 lua_insert(L, -(nargs + 1) - 1);
4505 // Stack now looks like this:
4506 // ... <return value = nil> <table> <arg#1> <arg#2> ... <arg#n>
4508 int rv = lua_gettop(L) - nargs - 1;
4510 int arg = table + 1;
4512 luaL_checktype(L, table, LUA_TTABLE);
4516 bool first_loop = true;
4517 while(lua_next(L, table) != 0){
4518 // key at index -2 and value at index -1
4519 luaL_checktype(L, -1, LUA_TFUNCTION);
4521 for(int i = 0; i < nargs; i++)
4522 lua_pushvalue(L, arg+i);
4523 if(lua_pcall(L, nargs, 1, 0))
4524 script_error(L, "error: %s", lua_tostring(L, -1));
4526 // Move return value to designated space in stack
4529 // Result of first callback is always moved
4533 // Otherwise, what happens depends on the mode
4534 if(mode == RUN_CALLBACKS_MODE_FIRST)
4536 else if(mode == RUN_CALLBACKS_MODE_LAST)
4538 else if(mode == RUN_CALLBACKS_MODE_AND ||
4539 mode == RUN_CALLBACKS_MODE_AND_SC){
4540 if(lua_toboolean(L, rv) == true &&
4541 lua_toboolean(L, -1) == false)
4546 else if(mode == RUN_CALLBACKS_MODE_OR ||
4547 mode == RUN_CALLBACKS_MODE_OR_SC){
4548 if(lua_toboolean(L, rv) == false &&
4549 lua_toboolean(L, -1) == true)
4558 // Handle short circuit modes
4559 if(mode == RUN_CALLBACKS_MODE_AND_SC &&
4560 lua_toboolean(L, rv) == false)
4562 else if(mode == RUN_CALLBACKS_MODE_OR_SC &&
4563 lua_toboolean(L, rv) == true)
4566 // value removed, keep key for next iteration
4569 // Remove stuff from stack, leaving only the return value
4572 // Fix return value in case no callbacks were called
4574 if(mode == RUN_CALLBACKS_MODE_AND ||
4575 mode == RUN_CALLBACKS_MODE_AND_SC){
4577 lua_pushboolean(L, true);
4579 else if(mode == RUN_CALLBACKS_MODE_OR ||
4580 mode == RUN_CALLBACKS_MODE_OR_SC){
4582 lua_pushboolean(L, false);
4587 bool scriptapi_on_chat_message(lua_State *L, const std::string &name,
4588 const std::string &message)
4591 assert(lua_checkstack(L, 20));
4592 StackUnroller stack_unroller(L);
4594 // Get minetest.registered_on_chat_messages
4595 lua_getglobal(L, "minetest");
4596 lua_getfield(L, -1, "registered_on_chat_messages");
4598 lua_pushstring(L, name.c_str());
4599 lua_pushstring(L, message.c_str());
4600 scriptapi_run_callbacks(L, 2, RUN_CALLBACKS_MODE_OR_SC);
4601 bool ate = lua_toboolean(L, -1);
4605 void scriptapi_on_newplayer(lua_State *L, ServerActiveObject *player)
4608 assert(lua_checkstack(L, 20));
4609 StackUnroller stack_unroller(L);
4611 // Get minetest.registered_on_newplayers
4612 lua_getglobal(L, "minetest");
4613 lua_getfield(L, -1, "registered_on_newplayers");
4615 objectref_get_or_create(L, player);
4616 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
4619 void scriptapi_on_dieplayer(lua_State *L, ServerActiveObject *player)
4622 assert(lua_checkstack(L, 20));
4623 StackUnroller stack_unroller(L);
4625 // Get minetest.registered_on_dieplayers
4626 lua_getglobal(L, "minetest");
4627 lua_getfield(L, -1, "registered_on_dieplayers");
4629 objectref_get_or_create(L, player);
4630 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
4633 bool scriptapi_on_respawnplayer(lua_State *L, ServerActiveObject *player)
4636 assert(lua_checkstack(L, 20));
4637 StackUnroller stack_unroller(L);
4639 // Get minetest.registered_on_respawnplayers
4640 lua_getglobal(L, "minetest");
4641 lua_getfield(L, -1, "registered_on_respawnplayers");
4643 objectref_get_or_create(L, player);
4644 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_OR);
4645 bool positioning_handled_by_some = lua_toboolean(L, -1);
4646 return positioning_handled_by_some;
4649 void scriptapi_on_joinplayer(lua_State *L, ServerActiveObject *player)
4652 assert(lua_checkstack(L, 20));
4653 StackUnroller stack_unroller(L);
4655 // Get minetest.registered_on_joinplayers
4656 lua_getglobal(L, "minetest");
4657 lua_getfield(L, -1, "registered_on_joinplayers");
4659 objectref_get_or_create(L, player);
4660 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
4663 void scriptapi_on_leaveplayer(lua_State *L, ServerActiveObject *player)
4666 assert(lua_checkstack(L, 20));
4667 StackUnroller stack_unroller(L);
4669 // Get minetest.registered_on_leaveplayers
4670 lua_getglobal(L, "minetest");
4671 lua_getfield(L, -1, "registered_on_leaveplayers");
4673 objectref_get_or_create(L, player);
4674 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
4677 void scriptapi_get_creative_inventory(lua_State *L, ServerActiveObject *player)
4680 assert(lua_checkstack(L, 20));
4681 StackUnroller stack_unroller(L);
4683 Inventory *inv = player->getInventory();
4686 lua_getglobal(L, "minetest");
4687 lua_getfield(L, -1, "creative_inventory");
4688 luaL_checktype(L, -1, LUA_TTABLE);
4689 inventory_set_list_from_lua(inv, "main", L, -1, PLAYER_INVENTORY_SIZE);
4692 static void get_auth_handler(lua_State *L)
4694 lua_getglobal(L, "minetest");
4695 lua_getfield(L, -1, "registered_auth_handler");
4696 if(lua_isnil(L, -1)){
4698 lua_getfield(L, -1, "builtin_auth_handler");
4700 if(lua_type(L, -1) != LUA_TTABLE)
4701 throw LuaError(L, "Authentication handler table not valid");
4704 bool scriptapi_get_auth(lua_State *L, const std::string &playername,
4705 std::string *dst_password, std::set<std::string> *dst_privs)
4708 assert(lua_checkstack(L, 20));
4709 StackUnroller stack_unroller(L);
4711 get_auth_handler(L);
4712 lua_getfield(L, -1, "get_auth");
4713 if(lua_type(L, -1) != LUA_TFUNCTION)
4714 throw LuaError(L, "Authentication handler missing get_auth");
4715 lua_pushstring(L, playername.c_str());
4716 if(lua_pcall(L, 1, 1, 0))
4717 script_error(L, "error: %s", lua_tostring(L, -1));
4719 // nil = login not allowed
4720 if(lua_isnil(L, -1))
4722 luaL_checktype(L, -1, LUA_TTABLE);
4724 std::string password;
4725 bool found = getstringfield(L, -1, "password", password);
4727 throw LuaError(L, "Authentication handler didn't return password");
4729 *dst_password = password;
4731 lua_getfield(L, -1, "privileges");
4732 if(!lua_istable(L, -1))
4734 "Authentication handler didn't return privilege table");
4736 read_privileges(L, -1, *dst_privs);
4742 void scriptapi_create_auth(lua_State *L, const std::string &playername,
4743 const std::string &password)
4746 assert(lua_checkstack(L, 20));
4747 StackUnroller stack_unroller(L);
4749 get_auth_handler(L);
4750 lua_getfield(L, -1, "create_auth");
4751 if(lua_type(L, -1) != LUA_TFUNCTION)
4752 throw LuaError(L, "Authentication handler missing create_auth");
4753 lua_pushstring(L, playername.c_str());
4754 lua_pushstring(L, password.c_str());
4755 if(lua_pcall(L, 2, 0, 0))
4756 script_error(L, "error: %s", lua_tostring(L, -1));
4759 bool scriptapi_set_password(lua_State *L, const std::string &playername,
4760 const std::string &password)
4763 assert(lua_checkstack(L, 20));
4764 StackUnroller stack_unroller(L);
4766 get_auth_handler(L);
4767 lua_getfield(L, -1, "set_password");
4768 if(lua_type(L, -1) != LUA_TFUNCTION)
4769 throw LuaError(L, "Authentication handler missing set_password");
4770 lua_pushstring(L, playername.c_str());
4771 lua_pushstring(L, password.c_str());
4772 if(lua_pcall(L, 2, 1, 0))
4773 script_error(L, "error: %s", lua_tostring(L, -1));
4774 return lua_toboolean(L, -1);
4778 item callbacks and node callbacks
4781 // Retrieves minetest.registered_items[name][callbackname]
4782 // If that is nil or on error, return false and stack is unchanged
4783 // If that is a function, returns true and pushes the
4784 // function onto the stack
4785 static bool get_item_callback(lua_State *L,
4786 const char *name, const char *callbackname)
4788 lua_getglobal(L, "minetest");
4789 lua_getfield(L, -1, "registered_items");
4791 luaL_checktype(L, -1, LUA_TTABLE);
4792 lua_getfield(L, -1, name);
4794 // Should be a table
4795 if(lua_type(L, -1) != LUA_TTABLE)
4797 errorstream<<"Item \""<<name<<"\" not defined"<<std::endl;
4801 lua_getfield(L, -1, callbackname);
4803 // Should be a function or nil
4804 if(lua_type(L, -1) == LUA_TFUNCTION)
4808 else if(lua_isnil(L, -1))
4815 errorstream<<"Item \""<<name<<"\" callback \""
4816 <<callbackname<<" is not a function"<<std::endl;
4822 bool scriptapi_item_on_drop(lua_State *L, ItemStack &item,
4823 ServerActiveObject *dropper, v3f pos)
4826 assert(lua_checkstack(L, 20));
4827 StackUnroller stack_unroller(L);
4829 // Push callback function on stack
4830 if(!get_item_callback(L, item.name.c_str(), "on_drop"))
4834 LuaItemStack::create(L, item);
4835 objectref_get_or_create(L, dropper);
4836 pushFloatPos(L, pos);
4837 if(lua_pcall(L, 3, 1, 0))
4838 script_error(L, "error: %s", lua_tostring(L, -1));
4839 if(!lua_isnil(L, -1))
4840 item = read_item(L, -1);
4844 bool scriptapi_item_on_place(lua_State *L, ItemStack &item,
4845 ServerActiveObject *placer, const PointedThing &pointed)
4848 assert(lua_checkstack(L, 20));
4849 StackUnroller stack_unroller(L);
4851 // Push callback function on stack
4852 if(!get_item_callback(L, item.name.c_str(), "on_place"))
4856 LuaItemStack::create(L, item);
4857 objectref_get_or_create(L, placer);
4858 push_pointed_thing(L, pointed);
4859 if(lua_pcall(L, 3, 1, 0))
4860 script_error(L, "error: %s", lua_tostring(L, -1));
4861 if(!lua_isnil(L, -1))
4862 item = read_item(L, -1);
4866 bool scriptapi_item_on_use(lua_State *L, ItemStack &item,
4867 ServerActiveObject *user, const PointedThing &pointed)
4870 assert(lua_checkstack(L, 20));
4871 StackUnroller stack_unroller(L);
4873 // Push callback function on stack
4874 if(!get_item_callback(L, item.name.c_str(), "on_use"))
4878 LuaItemStack::create(L, item);
4879 objectref_get_or_create(L, user);
4880 push_pointed_thing(L, pointed);
4881 if(lua_pcall(L, 3, 1, 0))
4882 script_error(L, "error: %s", lua_tostring(L, -1));
4883 if(!lua_isnil(L, -1))
4884 item = read_item(L, -1);
4888 bool scriptapi_node_on_punch(lua_State *L, v3s16 pos, MapNode node,
4889 ServerActiveObject *puncher)
4892 assert(lua_checkstack(L, 20));
4893 StackUnroller stack_unroller(L);
4895 INodeDefManager *ndef = get_server(L)->ndef();
4897 // Push callback function on stack
4898 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_punch"))
4903 pushnode(L, node, ndef);
4904 objectref_get_or_create(L, puncher);
4905 if(lua_pcall(L, 3, 0, 0))
4906 script_error(L, "error: %s", lua_tostring(L, -1));
4910 bool scriptapi_node_on_dig(lua_State *L, v3s16 pos, MapNode node,
4911 ServerActiveObject *digger)
4914 assert(lua_checkstack(L, 20));
4915 StackUnroller stack_unroller(L);
4917 INodeDefManager *ndef = get_server(L)->ndef();
4919 // Push callback function on stack
4920 if(!get_item_callback(L, ndef->get(node).name.c_str(), "on_dig"))
4925 pushnode(L, node, ndef);
4926 objectref_get_or_create(L, digger);
4927 if(lua_pcall(L, 3, 0, 0))
4928 script_error(L, "error: %s", lua_tostring(L, -1));
4936 void scriptapi_environment_step(lua_State *L, float dtime)
4939 assert(lua_checkstack(L, 20));
4940 //infostream<<"scriptapi_environment_step"<<std::endl;
4941 StackUnroller stack_unroller(L);
4943 // Get minetest.registered_globalsteps
4944 lua_getglobal(L, "minetest");
4945 lua_getfield(L, -1, "registered_globalsteps");
4947 lua_pushnumber(L, dtime);
4948 scriptapi_run_callbacks(L, 1, RUN_CALLBACKS_MODE_FIRST);
4951 void scriptapi_environment_on_generated(lua_State *L, v3s16 minp, v3s16 maxp,
4955 assert(lua_checkstack(L, 20));
4956 //infostream<<"scriptapi_environment_on_generated"<<std::endl;
4957 StackUnroller stack_unroller(L);
4959 // Get minetest.registered_on_generateds
4960 lua_getglobal(L, "minetest");
4961 lua_getfield(L, -1, "registered_on_generateds");
4963 push_v3s16(L, minp);
4964 push_v3s16(L, maxp);
4965 lua_pushnumber(L, blockseed);
4966 scriptapi_run_callbacks(L, 3, RUN_CALLBACKS_MODE_FIRST);
4973 bool scriptapi_luaentity_add(lua_State *L, u16 id, const char *name)
4976 assert(lua_checkstack(L, 20));
4977 verbosestream<<"scriptapi_luaentity_add: id="<<id<<" name=\""
4978 <<name<<"\""<<std::endl;
4979 StackUnroller stack_unroller(L);
4981 // Get minetest.registered_entities[name]
4982 lua_getglobal(L, "minetest");
4983 lua_getfield(L, -1, "registered_entities");
4984 luaL_checktype(L, -1, LUA_TTABLE);
4985 lua_pushstring(L, name);
4986 lua_gettable(L, -2);
4987 // Should be a table, which we will use as a prototype
4988 //luaL_checktype(L, -1, LUA_TTABLE);
4989 if(lua_type(L, -1) != LUA_TTABLE){
4990 errorstream<<"LuaEntity name \""<<name<<"\" not defined"<<std::endl;
4993 int prototype_table = lua_gettop(L);
4994 //dump2(L, "prototype_table");
4996 // Create entity object
4998 int object = lua_gettop(L);
5000 // Set object metatable
5001 lua_pushvalue(L, prototype_table);
5002 lua_setmetatable(L, -2);
5004 // Add object reference
5005 // This should be userdata with metatable ObjectRef
5006 objectref_get(L, id);
5007 luaL_checktype(L, -1, LUA_TUSERDATA);
5008 if(!luaL_checkudata(L, -1, "ObjectRef"))
5009 luaL_typerror(L, -1, "ObjectRef");
5010 lua_setfield(L, -2, "object");
5012 // minetest.luaentities[id] = object
5013 lua_getglobal(L, "minetest");
5014 lua_getfield(L, -1, "luaentities");
5015 luaL_checktype(L, -1, LUA_TTABLE);
5016 lua_pushnumber(L, id); // Push id
5017 lua_pushvalue(L, object); // Copy object to top of stack
5018 lua_settable(L, -3);
5023 void scriptapi_luaentity_activate(lua_State *L, u16 id,
5024 const std::string &staticdata)
5027 assert(lua_checkstack(L, 20));
5028 verbosestream<<"scriptapi_luaentity_activate: id="<<id<<std::endl;
5029 StackUnroller stack_unroller(L);
5031 // Get minetest.luaentities[id]
5032 luaentity_get(L, id);
5033 int object = lua_gettop(L);
5035 // Get on_activate function
5036 lua_pushvalue(L, object);
5037 lua_getfield(L, -1, "on_activate");
5038 if(!lua_isnil(L, -1)){
5039 luaL_checktype(L, -1, LUA_TFUNCTION);
5040 lua_pushvalue(L, object); // self
5041 lua_pushlstring(L, staticdata.c_str(), staticdata.size());
5042 // Call with 2 arguments, 0 results
5043 if(lua_pcall(L, 2, 0, 0))
5044 script_error(L, "error running function on_activate: %s\n",
5045 lua_tostring(L, -1));
5049 void scriptapi_luaentity_rm(lua_State *L, u16 id)
5052 assert(lua_checkstack(L, 20));
5053 verbosestream<<"scriptapi_luaentity_rm: id="<<id<<std::endl;
5055 // Get minetest.luaentities table
5056 lua_getglobal(L, "minetest");
5057 lua_getfield(L, -1, "luaentities");
5058 luaL_checktype(L, -1, LUA_TTABLE);
5059 int objectstable = lua_gettop(L);
5061 // Set luaentities[id] = nil
5062 lua_pushnumber(L, id); // Push id
5064 lua_settable(L, objectstable);
5066 lua_pop(L, 2); // pop luaentities, minetest
5069 std::string scriptapi_luaentity_get_staticdata(lua_State *L, u16 id)
5072 assert(lua_checkstack(L, 20));
5073 //infostream<<"scriptapi_luaentity_get_staticdata: id="<<id<<std::endl;
5074 StackUnroller stack_unroller(L);
5076 // Get minetest.luaentities[id]
5077 luaentity_get(L, id);
5078 int object = lua_gettop(L);
5080 // Get get_staticdata function
5081 lua_pushvalue(L, object);
5082 lua_getfield(L, -1, "get_staticdata");
5083 if(lua_isnil(L, -1))
5086 luaL_checktype(L, -1, LUA_TFUNCTION);
5087 lua_pushvalue(L, object); // self
5088 // Call with 1 arguments, 1 results
5089 if(lua_pcall(L, 1, 1, 0))
5090 script_error(L, "error running function get_staticdata: %s\n",
5091 lua_tostring(L, -1));
5094 const char *s = lua_tolstring(L, -1, &len);
5095 return std::string(s, len);
5098 void scriptapi_luaentity_get_properties(lua_State *L, u16 id,
5099 ObjectProperties *prop)
5102 assert(lua_checkstack(L, 20));
5103 //infostream<<"scriptapi_luaentity_get_properties: id="<<id<<std::endl;
5104 StackUnroller stack_unroller(L);
5106 // Get minetest.luaentities[id]
5107 luaentity_get(L, id);
5108 //int object = lua_gettop(L);
5110 // Set default values that differ from ObjectProperties defaults
5113 // Deprecated: read object properties directly
5114 read_object_properties(L, -1, prop);
5116 // Read initial_properties
5117 lua_getfield(L, -1, "initial_properties");
5118 read_object_properties(L, -1, prop);
5122 void scriptapi_luaentity_step(lua_State *L, u16 id, float dtime)
5125 assert(lua_checkstack(L, 20));
5126 //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
5127 StackUnroller stack_unroller(L);
5129 // Get minetest.luaentities[id]
5130 luaentity_get(L, id);
5131 int object = lua_gettop(L);
5132 // State: object is at top of stack
5133 // Get step function
5134 lua_getfield(L, -1, "on_step");
5135 if(lua_isnil(L, -1))
5137 luaL_checktype(L, -1, LUA_TFUNCTION);
5138 lua_pushvalue(L, object); // self
5139 lua_pushnumber(L, dtime); // dtime
5140 // Call with 2 arguments, 0 results
5141 if(lua_pcall(L, 2, 0, 0))
5142 script_error(L, "error running function 'on_step': %s\n", lua_tostring(L, -1));
5145 // Calls entity:on_punch(ObjectRef puncher, time_from_last_punch,
5146 // tool_capabilities, direction)
5147 void scriptapi_luaentity_punch(lua_State *L, u16 id,
5148 ServerActiveObject *puncher, float time_from_last_punch,
5149 const ToolCapabilities *toolcap, v3f dir)
5152 assert(lua_checkstack(L, 20));
5153 //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
5154 StackUnroller stack_unroller(L);
5156 // Get minetest.luaentities[id]
5157 luaentity_get(L, id);
5158 int object = lua_gettop(L);
5159 // State: object is at top of stack
5161 lua_getfield(L, -1, "on_punch");
5162 if(lua_isnil(L, -1))
5164 luaL_checktype(L, -1, LUA_TFUNCTION);
5165 lua_pushvalue(L, object); // self
5166 objectref_get_or_create(L, puncher); // Clicker reference
5167 lua_pushnumber(L, time_from_last_punch);
5168 push_tool_capabilities(L, *toolcap);
5170 // Call with 5 arguments, 0 results
5171 if(lua_pcall(L, 5, 0, 0))
5172 script_error(L, "error running function 'on_punch': %s\n", lua_tostring(L, -1));
5175 // Calls entity:on_rightclick(ObjectRef clicker)
5176 void scriptapi_luaentity_rightclick(lua_State *L, u16 id,
5177 ServerActiveObject *clicker)
5180 assert(lua_checkstack(L, 20));
5181 //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
5182 StackUnroller stack_unroller(L);
5184 // Get minetest.luaentities[id]
5185 luaentity_get(L, id);
5186 int object = lua_gettop(L);
5187 // State: object is at top of stack
5189 lua_getfield(L, -1, "on_rightclick");
5190 if(lua_isnil(L, -1))
5192 luaL_checktype(L, -1, LUA_TFUNCTION);
5193 lua_pushvalue(L, object); // self
5194 objectref_get_or_create(L, clicker); // Clicker reference
5195 // Call with 2 arguments, 0 results
5196 if(lua_pcall(L, 2, 0, 0))
5197 script_error(L, "error running function 'on_rightclick': %s\n", lua_tostring(L, -1));