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