src/script/cpp_api/s_entity.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #include "cpp_api/s_entity.h"
  21 #include "cpp_api/s_internal.h"
  22 #include "log.h"
  23 #include "object_properties.h"
  24 #include "common/c_converter.h"
  25 #include "common/c_content.h"
  26
  27 bool ScriptApiEntity::luaentity_Add(u16 id, const char *name)
  28 {
  29         SCRIPTAPI_PRECHECKHEADER
  30
  31         verbosestream<<"scriptapi_luaentity_add: id="<<id<<" name=\""
  32                         <<name<<"\""<<std::endl;
  33
  34         // Get minetest.registered_entities[name]
  35         lua_getglobal(L, "minetest");
  36         lua_getfield(L, -1, "registered_entities");
  37         luaL_checktype(L, -1, LUA_TTABLE);
  38         lua_pushstring(L, name);
  39         lua_gettable(L, -2);
  40         // Should be a table, which we will use as a prototype
  41         //luaL_checktype(L, -1, LUA_TTABLE);
  42         if(lua_type(L, -1) != LUA_TTABLE){
  43                 errorstream<<"LuaEntity name \""<<name<<"\" not defined"<<std::endl;
  44                 return false;
  45         }
  46         int prototype_table = lua_gettop(L);
  47         //dump2(L, "prototype_table");
  48
  49         // Create entity object
  50         lua_newtable(L);
  51         int object = lua_gettop(L);
  52
  53         // Set object metatable
  54         lua_pushvalue(L, prototype_table);
  55         lua_setmetatable(L, -2);
  56
  57         // Add object reference
  58         // This should be userdata with metatable ObjectRef
  59         objectrefGet(id);
  60         luaL_checktype(L, -1, LUA_TUSERDATA);
  61         if(!luaL_checkudata(L, -1, "ObjectRef"))
  62                 luaL_typerror(L, -1, "ObjectRef");
  63         lua_setfield(L, -2, "object");
  64
  65         // minetest.luaentities[id] = object
  66         lua_getglobal(L, "minetest");
  67         lua_getfield(L, -1, "luaentities");
  68         luaL_checktype(L, -1, LUA_TTABLE);
  69         lua_pushnumber(L, id); // Push id
  70         lua_pushvalue(L, object); // Copy object to top of stack
  71         lua_settable(L, -3);
  72
  73         return true;
  74 }
  75
  76 void ScriptApiEntity::luaentity_Activate(u16 id,
  77                 const std::string &staticdata, u32 dtime_s)
  78 {
  79         SCRIPTAPI_PRECHECKHEADER
  80
  81         verbosestream<<"scriptapi_luaentity_activate: id="<<id<<std::endl;
  82
  83         // Get minetest.luaentities[id]
  84         luaentity_get(L,id);
  85         int object = lua_gettop(L);
  86
  87         // Get on_activate function
  88         lua_pushvalue(L, object);
  89         lua_getfield(L, -1, "on_activate");
  90         if(!lua_isnil(L, -1)){
  91                 luaL_checktype(L, -1, LUA_TFUNCTION);
  92                 lua_pushvalue(L, object); // self
  93                 lua_pushlstring(L, staticdata.c_str(), staticdata.size());
  94                 lua_pushinteger(L, dtime_s);
  95                 // Call with 3 arguments, 0 results
  96                 if(lua_pcall(L, 3, 0, 0))
  97                         scriptError("error running function on_activate: %s\n",
  98                                         lua_tostring(L, -1));
  99         }
 100 }
 101
 102 void ScriptApiEntity::luaentity_Remove(u16 id)
 103 {
 104         SCRIPTAPI_PRECHECKHEADER
 105
 106         verbosestream<<"scriptapi_luaentity_rm: id="<<id<<std::endl;
 107
 108         // Get minetest.luaentities table
 109         lua_getglobal(L, "minetest");
 110         lua_getfield(L, -1, "luaentities");
 111         luaL_checktype(L, -1, LUA_TTABLE);
 112         int objectstable = lua_gettop(L);
 113
 114         // Set luaentities[id] = nil
 115         lua_pushnumber(L, id); // Push id
 116         lua_pushnil(L);
 117         lua_settable(L, objectstable);
 118
 119         lua_pop(L, 2); // pop luaentities, minetest
 120 }
 121
 122 std::string ScriptApiEntity::luaentity_GetStaticdata(u16 id)
 123 {
 124         SCRIPTAPI_PRECHECKHEADER
 125
 126         //infostream<<"scriptapi_luaentity_get_staticdata: id="<<id<<std::endl;
 127
 128         // Get minetest.luaentities[id]
 129         luaentity_get(L,id);
 130         int object = lua_gettop(L);
 131
 132         // Get get_staticdata function
 133         lua_pushvalue(L, object);
 134         lua_getfield(L, -1, "get_staticdata");
 135         if(lua_isnil(L, -1))
 136                 return "";
 137
 138         luaL_checktype(L, -1, LUA_TFUNCTION);
 139         lua_pushvalue(L, object); // self
 140         // Call with 1 arguments, 1 results
 141         if(lua_pcall(L, 1, 1, 0))
 142                 scriptError("error running function get_staticdata: %s\n",
 143                                 lua_tostring(L, -1));
 144
 145         size_t len=0;
 146         const char *s = lua_tolstring(L, -1, &len);
 147         return std::string(s, len);
 148 }
 149
 150 void ScriptApiEntity::luaentity_GetProperties(u16 id,
 151                 ObjectProperties *prop)
 152 {
 153         SCRIPTAPI_PRECHECKHEADER
 154
 155         //infostream<<"scriptapi_luaentity_get_properties: id="<<id<<std::endl;
 156
 157         // Get minetest.luaentities[id]
 158         luaentity_get(L,id);
 159         //int object = lua_gettop(L);
 160
 161         // Set default values that differ from ObjectProperties defaults
 162         prop->hp_max = 10;
 163
 164         /* Read stuff */
 165
 166         prop->hp_max = getintfield_default(L, -1, "hp_max", 10);
 167
 168         getboolfield(L, -1, "physical", prop->physical);
 169         getboolfield(L, -1, "collide_with_objects", prop->collideWithObjects);
 170
 171         getfloatfield(L, -1, "weight", prop->weight);
 172
 173         lua_getfield(L, -1, "collisionbox");
 174         if(lua_istable(L, -1))
 175                 prop->collisionbox = read_aabb3f(L, -1, 1.0);
 176         lua_pop(L, 1);
 177
 178         getstringfield(L, -1, "visual", prop->visual);
 179
 180         getstringfield(L, -1, "mesh", prop->mesh);
 181
 182         // Deprecated: read object properties directly
 183         read_object_properties(L, -1, prop);
 184
 185         // Read initial_properties
 186         lua_getfield(L, -1, "initial_properties");
 187         read_object_properties(L, -1, prop);
 188         lua_pop(L, 1);
 189 }
 190
 191 void ScriptApiEntity::luaentity_Step(u16 id, float dtime)
 192 {
 193         SCRIPTAPI_PRECHECKHEADER
 194
 195         //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
 196
 197         // Get minetest.luaentities[id]
 198         luaentity_get(L,id);
 199         int object = lua_gettop(L);
 200         // State: object is at top of stack
 201         // Get step function
 202         lua_getfield(L, -1, "on_step");
 203         if(lua_isnil(L, -1))
 204                 return;
 205         luaL_checktype(L, -1, LUA_TFUNCTION);
 206         lua_pushvalue(L, object); // self
 207         lua_pushnumber(L, dtime); // dtime
 208         // Call with 2 arguments, 0 results
 209         if(lua_pcall(L, 2, 0, 0))
 210                 scriptError("error running function 'on_step': %s\n", lua_tostring(L, -1));
 211 }
 212
 213 // Calls entity:on_punch(ObjectRef puncher, time_from_last_punch,
 214 //                       tool_capabilities, direction)
 215 void ScriptApiEntity::luaentity_Punch(u16 id,
 216                 ServerActiveObject *puncher, float time_from_last_punch,
 217                 const ToolCapabilities *toolcap, v3f dir)
 218 {
 219         SCRIPTAPI_PRECHECKHEADER
 220
 221         //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
 222
 223         // Get minetest.luaentities[id]
 224         luaentity_get(L,id);
 225         int object = lua_gettop(L);
 226         // State: object is at top of stack
 227         // Get function
 228         lua_getfield(L, -1, "on_punch");
 229         if(lua_isnil(L, -1))
 230                 return;
 231         luaL_checktype(L, -1, LUA_TFUNCTION);
 232         lua_pushvalue(L, object); // self
 233         objectrefGetOrCreate(puncher); // Clicker reference
 234         lua_pushnumber(L, time_from_last_punch);
 235         push_tool_capabilities(L, *toolcap);
 236         push_v3f(L, dir);
 237         // Call with 5 arguments, 0 results
 238         if(lua_pcall(L, 5, 0, 0))
 239                 scriptError("error running function 'on_punch': %s\n", lua_tostring(L, -1));
 240 }
 241
 242 // Calls entity:on_rightclick(ObjectRef clicker)
 243 void ScriptApiEntity::luaentity_Rightclick(u16 id,
 244                 ServerActiveObject *clicker)
 245 {
 246         SCRIPTAPI_PRECHECKHEADER
 247
 248         //infostream<<"scriptapi_luaentity_step: id="<<id<<std::endl;
 249
 250         // Get minetest.luaentities[id]
 251         luaentity_get(L,id);
 252         int object = lua_gettop(L);
 253         // State: object is at top of stack
 254         // Get function
 255         lua_getfield(L, -1, "on_rightclick");
 256         if(lua_isnil(L, -1))
 257                 return;
 258         luaL_checktype(L, -1, LUA_TFUNCTION);
 259         lua_pushvalue(L, object); // self
 260         objectrefGetOrCreate(clicker); // Clicker reference
 261         // Call with 2 arguments, 0 results
 262         if(lua_pcall(L, 2, 0, 0))
 263                 scriptError("error running function 'on_rightclick': %s\n", lua_tostring(L, -1));
 264 }
 265