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 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 #ifndef SCRIPTAPI_HEADER
  21 #define SCRIPTAPI_HEADER
  22
  23 #include "irrlichttypes.h"
  24 #include <string>
  25 #include "mapnode.h"
  26 #include <set>
  27 #include <map>
  28
  29 class Server;
  30 class ServerEnvironment;
  31 class ServerActiveObject;
  32 typedef struct lua_State lua_State;
  33 struct ObjectProperties;
  34 struct ItemStack;
  35 struct PointedThing;
  36 //class IGameDef;
  37 struct ToolCapabilities;
  38
  39 void scriptapi_export(lua_State *L, Server *server);
  40 bool scriptapi_loadmod(lua_State *L, const std::string &scriptpath,
  41                 const std::string &modname);
  42 void scriptapi_add_environment(lua_State *L, ServerEnvironment *env);
  43
  44 void scriptapi_add_object_reference(lua_State *L, ServerActiveObject *cobj);
  45 void scriptapi_rm_object_reference(lua_State *L, ServerActiveObject *cobj);
  46
  47 // Returns true if script handled message
  48 bool scriptapi_on_chat_message(lua_State *L, const std::string &name,
  49                 const std::string &message);
  50
  51 /* environment */
  52 // On environment step
  53 void scriptapi_environment_step(lua_State *L, float dtime);
  54 // After generating a piece of map
  55 void scriptapi_environment_on_generated(lua_State *L, v3s16 minp, v3s16 maxp,
  56                 u32 blockseed);
  57
  58 /* misc */
  59 void scriptapi_on_newplayer(lua_State *L, ServerActiveObject *player);
  60 void scriptapi_on_dieplayer(lua_State *L, ServerActiveObject *player);
  61 bool scriptapi_on_respawnplayer(lua_State *L, ServerActiveObject *player);
  62 void scriptapi_on_joinplayer(lua_State *L, ServerActiveObject *player);
  63 void scriptapi_on_leaveplayer(lua_State *L, ServerActiveObject *player);
  64 void scriptapi_get_creative_inventory(lua_State *L, ServerActiveObject *player);
  65 bool scriptapi_get_auth(lua_State *L, const std::string &playername,
  66                 std::string *dst_password, std::set<std::string> *dst_privs);
  67 void scriptapi_create_auth(lua_State *L, const std::string &playername,
  68                 const std::string &password);
  69 bool scriptapi_set_password(lua_State *L, const std::string &playername,
  70                 const std::string &password);
  71
  72 /* item callbacks */
  73 bool scriptapi_item_on_drop(lua_State *L, ItemStack &item,
  74                 ServerActiveObject *dropper, v3f pos);
  75 bool scriptapi_item_on_place(lua_State *L, ItemStack &item,
  76                 ServerActiveObject *placer, const PointedThing &pointed);
  77 bool scriptapi_item_on_use(lua_State *L, ItemStack &item,
  78                 ServerActiveObject *user, const PointedThing &pointed);
  79
  80 /* node callbacks */
  81 bool scriptapi_node_on_punch(lua_State *L, v3s16 p, MapNode node,
  82                 ServerActiveObject *puncher);
  83 bool scriptapi_node_on_dig(lua_State *L, v3s16 p, MapNode node,
  84                 ServerActiveObject *digger);
  85 // Node constructor
  86 void scriptapi_node_on_construct(lua_State *L, v3s16 p, MapNode node);
  87 // Node destructor
  88 void scriptapi_node_on_destruct(lua_State *L, v3s16 p, MapNode node);
  89 // Node post-destructor
  90 void scriptapi_node_after_destruct(lua_State *L, v3s16 p, MapNode node);
  91 // Called when a metadata form returns values
  92 void scriptapi_node_on_receive_fields(lua_State *L, v3s16 p,
  93                 const std::string &formname,
  94                 const std::map<std::string, std::string> &fields,
  95                 ServerActiveObject *sender);
  96 // Moves items
  97 void scriptapi_node_on_metadata_inventory_move(lua_State *L, v3s16 p,
  98                 const std::string &from_list, int from_index,
  99                 const std::string &to_list, int to_index,
 100                 int count, ServerActiveObject *player);
 101 // Inserts items, returns rejected items
 102 ItemStack scriptapi_node_on_metadata_inventory_offer(lua_State *L, v3s16 p,
 103                 const std::string &listname, int index, ItemStack &stack,
 104                 ServerActiveObject *player);
 105 // Takes items, returns taken items
 106 ItemStack scriptapi_node_on_metadata_inventory_take(lua_State *L, v3s16 p,
 107                 const std::string &listname, int index, int count,
 108                 ServerActiveObject *player);
 109
 110 /* luaentity */
 111 // Returns true if succesfully added into Lua; false otherwise.
 112 bool scriptapi_luaentity_add(lua_State *L, u16 id, const char *name);
 113 void scriptapi_luaentity_activate(lua_State *L, u16 id,
 114                 const std::string &staticdata);
 115 void scriptapi_luaentity_rm(lua_State *L, u16 id);
 116 std::string scriptapi_luaentity_get_staticdata(lua_State *L, u16 id);
 117 void scriptapi_luaentity_get_properties(lua_State *L, u16 id,
 118                 ObjectProperties *prop);
 119 void scriptapi_luaentity_step(lua_State *L, u16 id, float dtime);
 120 void scriptapi_luaentity_punch(lua_State *L, u16 id,
 121                 ServerActiveObject *puncher, float time_from_last_punch,
 122                 const ToolCapabilities *toolcap, v3f dir);
 123 void scriptapi_luaentity_rightclick(lua_State *L, u16 id,
 124                 ServerActiveObject *clicker);
 125
 126 #endif
 127