src/player.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-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 #ifndef PLAYER_HEADER
  21 #define PLAYER_HEADER
  22
  23 #include "irrlichttypes_bloated.h"
  24 #include "inventory.h"
  25 #include "constants.h"
  26 #include <list>
  27 #include <mutex>
  28
  29 #define PLAYERNAME_SIZE 20
  30
  31 #define PLAYERNAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_"
  32 #define PLAYERNAME_ALLOWED_CHARS_USER_EXPL "'a' to 'z', 'A' to 'Z', '0' to '9', '-', '_'"
  33
  34 struct PlayerControl
  35 {
  36         PlayerControl() {}
  37
  38         PlayerControl(
  39                 bool a_up,
  40                 bool a_down,
  41                 bool a_left,
  42                 bool a_right,
  43                 bool a_jump,
  44                 bool a_aux1,
  45                 bool a_sneak,
  46                 bool a_zoom,
  47                 bool a_LMB,
  48                 bool a_RMB,
  49                 float a_pitch,
  50                 float a_yaw,
  51                 float a_sidew_move_joystick_axis,
  52                 float a_forw_move_joystick_axis
  53         )
  54         {
  55                 up = a_up;
  56                 down = a_down;
  57                 left = a_left;
  58                 right = a_right;
  59                 jump = a_jump;
  60                 aux1 = a_aux1;
  61                 sneak = a_sneak;
  62                 zoom = a_zoom;
  63                 LMB = a_LMB;
  64                 RMB = a_RMB;
  65                 pitch = a_pitch;
  66                 yaw = a_yaw;
  67                 sidew_move_joystick_axis = a_sidew_move_joystick_axis;
  68                 forw_move_joystick_axis = a_forw_move_joystick_axis;
  69         }
  70         bool up = false;
  71         bool down = false;
  72         bool left = false;
  73         bool right = false;
  74         bool jump = false;
  75         bool aux1 = false;
  76         bool sneak = false;
  77         bool zoom = false;
  78         bool LMB = false;
  79         bool RMB = false;
  80         float pitch = 0.0f;
  81         float yaw = 0.0f;
  82         float sidew_move_joystick_axis = 0.0f;
  83         float forw_move_joystick_axis = 0.0f;
  84 };
  85
  86 class Map;
  87 struct CollisionInfo;
  88 struct HudElement;
  89 class Environment;
  90
  91 // IMPORTANT:
  92 // Do *not* perform an assignment or copy operation on a Player or
  93 // RemotePlayer object!  This will copy the lock held for HUD synchronization
  94 class Player
  95 {
  96 public:
  97
  98         Player(const char *name, IItemDefManager *idef);
  99         virtual ~Player() = 0;
 100
 101         virtual void move(f32 dtime, Environment *env, f32 pos_max_d)
 102         {}
 103         virtual void move(f32 dtime, Environment *env, f32 pos_max_d,
 104                         std::vector<CollisionInfo> *collision_info)
 105         {}
 106
 107         v3f getSpeed()
 108         {
 109                 return m_speed;
 110         }
 111
 112         void setSpeed(v3f speed)
 113         {
 114                 m_speed = speed;
 115         }
 116
 117         const char *getName() const { return m_name; }
 118
 119         u32 getFreeHudID()
 120         {
 121                 size_t size = hud.size();
 122                 for (size_t i = 0; i != size; i++) {
 123                         if (!hud[i])
 124                                 return i;
 125                 }
 126                 return size;
 127         }
 128
 129         v3f eye_offset_first;
 130         v3f eye_offset_third;
 131
 132         Inventory inventory;
 133
 134         f32 movement_acceleration_default;
 135         f32 movement_acceleration_air;
 136         f32 movement_acceleration_fast;
 137         f32 movement_speed_walk;
 138         f32 movement_speed_crouch;
 139         f32 movement_speed_fast;
 140         f32 movement_speed_climb;
 141         f32 movement_speed_jump;
 142         f32 movement_liquid_fluidity;
 143         f32 movement_liquid_fluidity_smooth;
 144         f32 movement_liquid_sink;
 145         f32 movement_gravity;
 146
 147         v2s32 local_animations[4];
 148         float local_animation_speed;
 149
 150         u16 peer_id = PEER_ID_INEXISTENT;
 151
 152         std::string inventory_formspec;
 153
 154         PlayerControl control;
 155         const PlayerControl& getPlayerControl() { return control; }
 156
 157         u32 keyPressed = 0;
 158
 159         HudElement* getHud(u32 id);
 160         u32         addHud(HudElement* hud);
 161         HudElement* removeHud(u32 id);
 162         void        clearHud();
 163
 164         u32 hud_flags;
 165         s32 hud_hotbar_itemcount;
 166 protected:
 167         char m_name[PLAYERNAME_SIZE];
 168         v3f m_speed;
 169
 170         std::vector<HudElement *> hud;
 171 private:
 172         // Protect some critical areas
 173         // hud for example can be modified by EmergeThread
 174         // and ServerThread
 175         std::mutex m_mutex;
 176 };
 177
 178 #endif
 179