src/script/cpp_api/s_player.h

   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 #pragma once
  21
  22 #include "cpp_api/s_base.h"
  23 #include "irr_v3d.h"
  24 #include "util/string.h"
  25
  26 struct MoveAction;
  27 struct InventoryLocation;
  28 struct ItemStack;
  29 struct ToolCapabilities;
  30 struct PlayerHPChangeReason;
  31 class ServerActiveObject;
  32
  33 class ScriptApiPlayer : virtual public ScriptApiBase
  34 {
  35 public:
  36         virtual ~ScriptApiPlayer() = default;
  37
  38         void on_newplayer(ServerActiveObject *player);
  39         void on_dieplayer(ServerActiveObject *player, const PlayerHPChangeReason &reason);
  40         bool on_respawnplayer(ServerActiveObject *player);
  41         bool on_prejoinplayer(const std::string &name, const std::string &ip,
  42                         std::string *reason);
  43         bool can_bypass_userlimit(const std::string &name, const std::string &ip);
  44         void on_joinplayer(ServerActiveObject *player, s64 last_login);
  45         void on_leaveplayer(ServerActiveObject *player, bool timeout);
  46         void on_cheat(ServerActiveObject *player, const std::string &cheat_type);
  47         bool on_punchplayer(ServerActiveObject *player, ServerActiveObject *hitter,
  48                         float time_from_last_punch, const ToolCapabilities *toolcap,
  49                         v3f dir, s32 damage);
  50         void on_rightclickplayer(ServerActiveObject *player, ServerActiveObject *clicker);
  51         s32 on_player_hpchange(ServerActiveObject *player, s32 hp_change,
  52                         const PlayerHPChangeReason &reason);
  53         void on_playerReceiveFields(ServerActiveObject *player,
  54                         const std::string &formname, const StringMap &fields);
  55         void on_authplayer(const std::string &name, const std::string &ip, bool is_success);
  56
  57         // Player inventory callbacks
  58         // Return number of accepted items to be moved
  59         int player_inventory_AllowMove(
  60                 const MoveAction &ma, int count,
  61                 ServerActiveObject *player);
  62         // Return number of accepted items to be put
  63         int player_inventory_AllowPut(
  64                 const MoveAction &ma, const ItemStack &stack,
  65                 ServerActiveObject *player);
  66         // Return number of accepted items to be taken
  67         int player_inventory_AllowTake(
  68                 const MoveAction &ma, const ItemStack &stack,
  69                 ServerActiveObject *player);
  70         // Report moved items
  71         void player_inventory_OnMove(
  72                 const MoveAction &ma, int count,
  73                 ServerActiveObject *player);
  74         // Report put items
  75         void player_inventory_OnPut(
  76                 const MoveAction &ma, const ItemStack &stack,
  77                 ServerActiveObject *player);
  78         // Report taken items
  79         void player_inventory_OnTake(
  80                 const MoveAction &ma, const ItemStack &stack,
  81                 ServerActiveObject *player);
  82 private:
  83         void pushPutTakeArguments(
  84                 const char *method, const InventoryLocation &loc,
  85                 const std::string &listname, int index, const ItemStack &stack,
  86                 ServerActiveObject *player);
  87         void pushMoveArguments(const MoveAction &ma,
  88                 int count, ServerActiveObject *player);
  89 };