src/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
  35 enum LocalPlayerAnimations
  36 {
  37         NO_ANIM,
  38         WALK_ANIM,
  39         DIG_ANIM,
  40         WD_ANIM
  41 }; // no local animation, walking, digging, both
  42
  43 class LocalPlayer : public Player
  44 {
  45 public:
  46         LocalPlayer(Client *client, const char *name);
  47         virtual ~LocalPlayer() = default;
  48
  49         ClientActiveObject *parent = nullptr;
  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 isAttached = false;
  55         bool touching_ground = false;
  56         // This oscillates so that the player jumps a bit above the surface
  57         bool in_liquid = false;
  58         // This is more stable and defines the maximum speed of the player
  59         bool in_liquid_stable = false;
  60         // Gets the viscosity of water to calculate friction
  61         u8 liquid_viscosity = 0;
  62         bool is_climbing = false;
  63         bool swimming_vertical = false;
  64         bool is_slipping = false;
  65
  66         float physics_override_speed = 1.0f;
  67         float physics_override_jump = 1.0f;
  68         float physics_override_gravity = 1.0f;
  69         bool physics_override_sneak = true;
  70         bool physics_override_sneak_glitch = false;
  71         // Temporary option for old move code
  72         bool physics_override_new_move = true;
  73
  74         v3f overridePosition;
  75
  76         void move(f32 dtime, Environment *env, f32 pos_max_d);
  77         void move(f32 dtime, Environment *env, f32 pos_max_d,
  78                         std::vector<CollisionInfo> *collision_info);
  79         // Temporary option for old move code
  80         void old_move(f32 dtime, Environment *env, f32 pos_max_d,
  81                         std::vector<CollisionInfo> *collision_info);
  82
  83         void applyControl(float dtime, Environment *env);
  84
  85         v3s16 getStandingNodePos();
  86         v3s16 getFootstepNodePos();
  87
  88         // Used to check if anything changed and prevent sending packets if not
  89         v3f last_position;
  90         v3f last_speed;
  91         float last_pitch = 0.0f;
  92         float last_yaw = 0.0f;
  93         unsigned int last_keyPressed = 0;
  94         u8 last_camera_fov = 0;
  95         u8 last_wanted_range = 0;
  96
  97         float camera_impact = 0.0f;
  98
  99         bool makes_footstep_sound = true;
 100
 101         int last_animation = NO_ANIM;
 102         float last_animation_speed;
 103
 104         std::string hotbar_image = "";
 105         std::string hotbar_selected_image = "";
 106
 107         video::SColor light_color = video::SColor(255, 255, 255, 255);
 108
 109         float hurt_tilt_timer = 0.0f;
 110         float hurt_tilt_strength = 0.0f;
 111
 112         GenericCAO *getCAO() const { return m_cao; }
 113
 114         void setCAO(GenericCAO *toset)
 115         {
 116                 assert(!m_cao); // Pre-condition
 117                 m_cao = toset;
 118         }
 119
 120         u32 maxHudId() const { return hud.size(); }
 121
 122         u16 getBreath() const { return m_breath; }
 123         void setBreath(u16 breath) { m_breath = breath; }
 124
 125         v3s16 getLightPosition() const;
 126
 127         void setYaw(f32 yaw) { m_yaw = yaw; }
 128         f32 getYaw() const { return m_yaw; }
 129
 130         void setPitch(f32 pitch) { m_pitch = pitch; }
 131         f32 getPitch() const { return m_pitch; }
 132
 133         inline void setPosition(const v3f &position)
 134         {
 135                 m_position = position;
 136                 m_sneak_node_exists = false;
 137         }
 138
 139         v3f getPosition() const { return m_position; }
 140         v3f getEyePosition() const { return m_position + getEyeOffset(); }
 141         v3f getEyeOffset() const;
 142         void setEyeHeight(float eye_height) { m_eye_height = eye_height; }
 143
 144         void setCollisionbox(const aabb3f &box) { m_collisionbox = box; }
 145
 146         float getZoomFOV() const { return m_zoom_fov; }
 147         void setZoomFOV(float zoom_fov) { m_zoom_fov = zoom_fov; }
 148
 149 private:
 150         void accelerateHorizontal(const v3f &target_speed, const f32 max_increase);
 151         void accelerateVertical(const v3f &target_speed, const f32 max_increase);
 152         bool updateSneakNode(Map *map, const v3f &position, const v3f &sneak_max);
 153         float getSlipFactor(Environment *env, const v3f &speedH);
 154
 155         v3f m_position;
 156         v3s16 m_standing_node;
 157
 158         v3s16 m_sneak_node = v3s16(32767, 32767, 32767);
 159         // Stores the top bounding box of m_sneak_node
 160         aabb3f m_sneak_node_bb_top = aabb3f(0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f);
 161         // Whether the player is allowed to sneak
 162         bool m_sneak_node_exists = false;
 163         // Whether a "sneak ladder" structure is detected at the players pos
 164         // see detectSneakLadder() in the .cpp for more info (always false if disabled)
 165         bool m_sneak_ladder_detected = false;
 166
 167         // ***** Variables for temporary option of the old move code *****
 168         // Stores the max player uplift by m_sneak_node
 169         f32 m_sneak_node_bb_ymax = 0.0f;
 170         // Whether recalculation of m_sneak_node and its top bbox is needed
 171         bool m_need_to_get_new_sneak_node = true;
 172         // Node below player, used to determine whether it has been removed,
 173         // and its old type
 174         v3s16 m_old_node_below = v3s16(32767, 32767, 32767);
 175         std::string m_old_node_below_type = "air";
 176         // ***** End of variables for temporary option *****
 177
 178         bool m_can_jump = false;
 179         u16 m_breath = PLAYER_MAX_BREATH_DEFAULT;
 180         f32 m_yaw = 0.0f;
 181         f32 m_pitch = 0.0f;
 182         bool camera_barely_in_ceiling = false;
 183         aabb3f m_collisionbox = aabb3f(-BS * 0.30f, 0.0f, -BS * 0.30f, BS * 0.30f,
 184                         BS * 1.75f, BS * 0.30f);
 185         float m_eye_height = 1.625f;
 186         float m_zoom_fov = 0.0f;
 187
 188         GenericCAO *m_cao = nullptr;
 189         Client *m_client;
 190 };