src/client/localplayer.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 #pragma once
  21
  22 #include "player.h"
  23 #include "environment.h"
  24 #include "constants.h"
  25 #include "settings.h"
  26 #include <list>
  27
  28 class Client;
  29 class Environment;
  30 class GenericCAO;
  31 class ClientActiveObject;
  32 class ClientEnvironment;
  33 class IGameDef;
  34 struct ContentFeatures;
  35 struct collisionMoveResult;
  36
  37 enum LocalPlayerAnimations
  38 {
  39         NO_ANIM,
  40         WALK_ANIM,
  41         DIG_ANIM,
  42         WD_ANIM
  43 }; // no local animation, walking, digging, both
  44
  45 class LocalPlayer : public Player
  46 {
  47 public:
  48         LocalPlayer(Client *client, const char *name);
  49         virtual ~LocalPlayer() = default;
  50
  51         // Initialize hp to 0, so that no hearts will be shown if server
  52         // doesn't support health points
  53         u16 hp = 0;
  54         bool touching_ground = false;
  55         // This oscillates so that the player jumps a bit above the surface
  56         bool in_liquid = false;
  57         // This is more stable and defines the maximum speed of the player
  58         bool in_liquid_stable = false;
  59         // Gets the viscosity of water to calculate friction
  60         u8 liquid_viscosity = 0;
  61         bool is_climbing = false;
  62         bool swimming_vertical = false;
  63         bool swimming_pitch = false;
  64
  65         float physics_override_speed = 1.0f;
  66         float physics_override_jump = 1.0f;
  67         float physics_override_gravity = 1.0f;
  68         bool physics_override_sneak = true;
  69         bool physics_override_sneak_glitch = false;
  70         // Temporary option for old move code
  71         bool physics_override_new_move = true;
  72
  73         void move(f32 dtime, Environment *env, f32 pos_max_d);
  74         void move(f32 dtime, Environment *env, f32 pos_max_d,
  75                         std::vector<CollisionInfo> *collision_info);
  76         // Temporary option for old move code
  77         void old_move(f32 dtime, Environment *env, f32 pos_max_d,
  78                         std::vector<CollisionInfo> *collision_info);
  79
  80         void applyControl(float dtime, Environment *env);
  81
  82         v3s16 getStandingNodePos();
  83         v3s16 getFootstepNodePos();
  84
  85         // Used to check if anything changed and prevent sending packets if not
  86         v3f last_position;
  87         v3f last_speed;
  88         float last_pitch = 0.0f;
  89         float last_yaw = 0.0f;
  90         unsigned int last_keyPressed = 0;
  91         u8 last_camera_fov = 0;
  92         u8 last_wanted_range = 0;
  93
  94         float camera_impact = 0.0f;
  95
  96         bool makes_footstep_sound = true;
  97
  98         int last_animation = NO_ANIM;
  99         float last_animation_speed = 0.0f;
 100
 101         std::string hotbar_image = "";
 102         std::string hotbar_selected_image = "";
 103
 104         video::SColor light_color = video::SColor(255, 255, 255, 255);
 105
 106         float hurt_tilt_timer = 0.0f;
 107         float hurt_tilt_strength = 0.0f;
 108
 109         GenericCAO *getCAO() const { return m_cao; }
 110
 111         ClientActiveObject *getParent() const;
 112
 113         void setCAO(GenericCAO *toset)
 114         {
 115                 assert(!m_cao); // Pre-condition
 116                 m_cao = toset;
 117         }
 118
 119         u32 maxHudId() const { return hud.size(); }
 120
 121         u16 getBreath() const { return m_breath; }
 122         void setBreath(u16 breath) { m_breath = breath; }
 123
 124         v3s16 getLightPosition() const;
 125
 126         void setYaw(f32 yaw) { m_yaw = yaw; }
 127         f32 getYaw() const { return m_yaw; }
 128
 129         void setPitch(f32 pitch) { m_pitch = pitch; }
 130         f32 getPitch() const { return m_pitch; }
 131
 132         inline void setPosition(const v3f &position)
 133         {
 134                 m_position = position;
 135                 if (! m_freecam)
 136                         m_legit_position = position;
 137                 m_sneak_node_exists = false;
 138         }
 139
 140         v3f getPosition() const { return m_position; }
 141
 142         v3f getLegitPosition() const { return m_legit_position; }
 143
 144         v3f getLegitSpeed() const { return m_legit_speed; }
 145
 146         inline void setLegitPosition(const v3f &position)
 147         {
 148                 if (m_freecam)
 149                         m_legit_position = position;
 150                 else
 151                         setPosition(position);
 152         }
 153
 154         inline void freecamEnable()
 155         {
 156                 m_freecam = true;
 157         }
 158
 159         inline void freecamDisable()
 160         {
 161                 m_freecam = false;
 162                 setPosition(m_legit_position);
 163                 setSpeed(m_legit_speed);
 164         }
 165
 166         // Non-transformed eye offset getters
 167         // For accurate positions, use the Camera functions
 168         v3f getEyePosition() const { return m_position + getEyeOffset(); }
 169         v3f getEyeOffset() const;
 170         void setEyeHeight(float eye_height) { m_eye_height = eye_height; }
 171
 172         void setCollisionbox(const aabb3f &box) { m_collisionbox = box; }
 173
 174         const aabb3f& getCollisionbox() const { return m_collisionbox; }
 175
 176         float getZoomFOV() const { return m_zoom_fov; }
 177         void setZoomFOV(float zoom_fov) { m_zoom_fov = zoom_fov; }
 178
 179         bool getAutojump() const { return m_autojump; }
 180
 181         bool isDead() const;
 182
 183         inline void addVelocity(const v3f &vel)
 184         {
 185                 added_velocity += vel;
 186         }
 187
 188         void tryReattach(int id);
 189
 190         bool isWaitingForReattach() const;
 191
 192         bool canWalkOn(const ContentFeatures &f);
 193
 194 private:
 195         void accelerate(const v3f &target_speed, const f32 max_increase_H,
 196                 const f32 max_increase_V, const bool use_pitch);
 197         bool updateSneakNode(Map *map, const v3f &position, const v3f &sneak_max);
 198         float getSlipFactor(Environment *env, const v3f &speedH);
 199         void handleAutojump(f32 dtime, Environment *env,
 200                 const collisionMoveResult &result,
 201                 const v3f &position_before_move, const v3f &speed_before_move,
 202                 f32 pos_max_d);
 203
 204         bool m_freecam = false;
 205         v3f m_position;
 206         v3f m_legit_position;
 207         v3f m_legit_speed;
 208         v3s16 m_standing_node;
 209
 210         v3s16 m_sneak_node = v3s16(32767, 32767, 32767);
 211         // Stores the top bounding box of m_sneak_node
 212         aabb3f m_sneak_node_bb_top = aabb3f(0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f);
 213         // Whether the player is allowed to sneak
 214         bool m_sneak_node_exists = false;
 215         // Whether a "sneak ladder" structure is detected at the players pos
 216         // see detectSneakLadder() in the .cpp for more info (always false if disabled)
 217         bool m_sneak_ladder_detected = false;
 218
 219         // ***** Variables for temporary option of the old move code *****
 220         // Stores the max player uplift by m_sneak_node
 221         f32 m_sneak_node_bb_ymax = 0.0f;
 222         // Whether recalculation of m_sneak_node and its top bbox is needed
 223         bool m_need_to_get_new_sneak_node = true;
 224         // Node below player, used to determine whether it has been removed,
 225         // and its old type
 226         v3s16 m_old_node_below = v3s16(32767, 32767, 32767);
 227         std::string m_old_node_below_type = "air";
 228         // ***** End of variables for temporary option *****
 229
 230         bool m_can_jump = false;
 231         bool m_disable_jump = false;
 232         u16 m_breath = PLAYER_MAX_BREATH_DEFAULT;
 233         f32 m_yaw = 0.0f;
 234         f32 m_pitch = 0.0f;
 235         bool camera_barely_in_ceiling = false;
 236         aabb3f m_collisionbox = aabb3f(-BS * 0.30f, 0.0f, -BS * 0.30f, BS * 0.30f,
 237                 BS * 1.75f, BS * 0.30f);
 238         float m_eye_height = 1.625f;
 239         float m_zoom_fov = 0.0f;
 240         bool m_autojump = false;
 241         float m_autojump_time = 0.0f;
 242
 243         v3f added_velocity = v3f(0.0f); // cleared on each move()
 244         // TODO: Rename to adhere to convention: added_velocity --> m_added_velocity
 245
 246         GenericCAO *m_cao = nullptr;
 247         Client *m_client;
 248 };