src/scriptapi.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2011 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 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.
   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 General Public License for more details.
  14
  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.
  18 */
  19
  20 #ifndef SCRIPTAPI_HEADER
  21 #define SCRIPTAPI_HEADER
  22
  23 #include "irrlichttypes.h"
  24 #include <string>
  25 #include "mapnode.h"
  26 #include <set>
  27
  28 class Server;
  29 class ServerEnvironment;
  30 class ServerActiveObject;
  31 typedef struct lua_State lua_State;
  32 struct ObjectProperties;
  33 struct ItemStack;
  34 struct PointedThing;
  35 //class IGameDef;
  36 struct ToolCapabilities;
  37
  38 void scriptapi_export(lua_State *L, Server *server);
  39 bool scriptapi_loadmod(lua_State *L, const std::string &scriptpath,
  40                 const std::string &modname);
  41 void scriptapi_add_environment(lua_State *L, ServerEnvironment *env);
  42
  43 void scriptapi_add_object_reference(lua_State *L, ServerActiveObject *cobj);
  44 void scriptapi_rm_object_reference(lua_State *L, ServerActiveObject *cobj);
  45
  46 // Returns true if script handled message
  47 bool scriptapi_on_chat_message(lua_State *L, const std::string &name,
  48                 const std::string &message);
  49
  50 /* environment */
  51 // On environment step
  52 void scriptapi_environment_step(lua_State *L, float dtime);
  53 // After generating a piece of map
  54 void scriptapi_environment_on_generated(lua_State *L, v3s16 minp, v3s16 maxp,
  55                 u32 blockseed);
  56
  57 /* misc */
  58 void scriptapi_on_newplayer(lua_State *L, ServerActiveObject *player);
  59 void scriptapi_on_dieplayer(lua_State *L, ServerActiveObject *player);
  60 bool scriptapi_on_respawnplayer(lua_State *L, ServerActiveObject *player);
  61 void scriptapi_on_joinplayer(lua_State *L, ServerActiveObject *player);
  62 void scriptapi_on_leaveplayer(lua_State *L, ServerActiveObject *player);
  63 void scriptapi_get_creative_inventory(lua_State *L, ServerActiveObject *player);
  64 bool scriptapi_get_auth(lua_State *L, const std::string &playername,
  65                 std::string *dst_password, std::set<std::string> *dst_privs);
  66 void scriptapi_create_auth(lua_State *L, const std::string &playername,
  67                 const std::string &password);
  68 bool scriptapi_set_password(lua_State *L, const std::string &playername,
  69                 const std::string &password);
  70
  71 /* item callbacks */
  72 bool scriptapi_item_on_drop(lua_State *L, ItemStack &item,
  73                 ServerActiveObject *dropper, v3f pos);
  74 bool scriptapi_item_on_place(lua_State *L, ItemStack &item,
  75                 ServerActiveObject *placer, const PointedThing &pointed);
  76 bool scriptapi_item_on_use(lua_State *L, ItemStack &item,
  77                 ServerActiveObject *user, const PointedThing &pointed);
  78
  79 /* node callbacks */
  80 bool scriptapi_node_on_punch(lua_State *L, v3s16 p, MapNode node,
  81                 ServerActiveObject *puncher);
  82 bool scriptapi_node_on_dig(lua_State *L, v3s16 p, MapNode node,
  83                 ServerActiveObject *digger);
  84 void scriptapi_node_on_construct(lua_State *L, v3s16 p, MapNode node);
  85 void scriptapi_node_on_destruct(lua_State *L, v3s16 p, MapNode node);
  86
  87 /* luaentity */
  88 // Returns true if succesfully added into Lua; false otherwise.
  89 bool scriptapi_luaentity_add(lua_State *L, u16 id, const char *name);
  90 void scriptapi_luaentity_activate(lua_State *L, u16 id,
  91                 const std::string &staticdata);
  92 void scriptapi_luaentity_rm(lua_State *L, u16 id);
  93 std::string scriptapi_luaentity_get_staticdata(lua_State *L, u16 id);
  94 void scriptapi_luaentity_get_properties(lua_State *L, u16 id,
  95                 ObjectProperties *prop);
  96 void scriptapi_luaentity_step(lua_State *L, u16 id, float dtime);
  97 void scriptapi_luaentity_punch(lua_State *L, u16 id,
  98                 ServerActiveObject *puncher, float time_from_last_punch,
  99                 const ToolCapabilities *toolcap, v3f dir);
 100 void scriptapi_luaentity_rightclick(lua_State *L, u16 id,
 101                 ServerActiveObject *clicker);
 102
 103 #endif
 104