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 <list>
  26
  27 class Client;
  28 class Environment;
  29 class GenericCAO;
  30 class ClientActiveObject;
  31 class ClientEnvironment;
  32 class IGameDef;
  33
  34 enum LocalPlayerAnimations
  35 {
  36         NO_ANIM,
  37         WALK_ANIM,
  38         DIG_ANIM,
  39         WD_ANIM
  40 }; // no local animation, walking, digging, both
  41
  42 class LocalPlayer : public Player
  43 {
  44 public:
  45         LocalPlayer(Client *client, const char *name);
  46         virtual ~LocalPlayer() = default;
  47
  48         ClientActiveObject *parent = nullptr;
  49
  50         // Initialize hp to 0, so that no hearts will be shown if server
  51         // doesn't support health points
  52         u16 hp = 0;
  53         bool isAttached = false;
  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 is_slipping = 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         v3f overridePosition;
  74
  75         void move(f32 dtime, Environment *env, f32 pos_max_d);
  76         void move(f32 dtime, Environment *env, f32 pos_max_d,
  77                         std::vector<CollisionInfo> *collision_info);
  78         // Temporary option for old move code
  79         void old_move(f32 dtime, Environment *env, f32 pos_max_d,
  80                         std::vector<CollisionInfo> *collision_info);
  81
  82         void applyControl(float dtime, Environment *env);
  83
  84         v3s16 getStandingNodePos();
  85         v3s16 getFootstepNodePos();
  86
  87         // Used to check if anything changed and prevent sending packets if not
  88         v3f last_position;
  89         v3f last_speed;
  90         float last_pitch = 0.0f;
  91         float last_yaw = 0.0f;
  92         unsigned int last_keyPressed = 0;
  93         u8 last_camera_fov = 0;
  94         u8 last_wanted_range = 0;
  95
  96         float camera_impact = 0.0f;
  97
  98         bool makes_footstep_sound = true;
  99
 100         int last_animation = NO_ANIM;
 101         float last_animation_speed;
 102
 103         std::string hotbar_image = "";
 104         std::string hotbar_selected_image = "";
 105
 106         video::SColor light_color = video::SColor(255, 255, 255, 255);
 107
 108         float hurt_tilt_timer = 0.0f;
 109         float hurt_tilt_strength = 0.0f;
 110
 111         GenericCAO *getCAO() const { return m_cao; }
 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                 m_sneak_node_exists = false;
 136         }
 137
 138         v3f getPosition() const { return m_position; }
 139         v3f getEyePosition() const { return m_position + getEyeOffset(); }
 140         v3f getEyeOffset() const;
 141
 142         void setCollisionbox(const aabb3f &box) { m_collisionbox = box; }
 143
 144         bool getCanZoom() const { return m_can_zoom; }
 145         void setCanZoom(bool can_zoom) { m_can_zoom = can_zoom; }
 146
 147 private:
 148         void accelerateHorizontal(const v3f &target_speed, const f32 max_increase);
 149         void accelerateVertical(const v3f &target_speed, const f32 max_increase);
 150         bool updateSneakNode(Map *map, const v3f &position, const v3f &sneak_max);
 151         float getSlipFactor(Environment *env, const v3f &speedH);
 152
 153         v3f m_position;
 154         v3s16 m_standing_node;
 155
 156         v3s16 m_sneak_node = v3s16(32767, 32767, 32767);
 157         // Stores the top bounding box of m_sneak_node
 158         aabb3f m_sneak_node_bb_top = aabb3f(0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f);
 159         // Whether the player is allowed to sneak
 160         bool m_sneak_node_exists = false;
 161         // Whether a "sneak ladder" structure is detected at the players pos
 162         // see detectSneakLadder() in the .cpp for more info (always false if disabled)
 163         bool m_sneak_ladder_detected = false;
 164
 165         // ***** Variables for temporary option of the old move code *****
 166         // Stores the max player uplift by m_sneak_node
 167         f32 m_sneak_node_bb_ymax = 0.0f;
 168         // Whether recalculation of m_sneak_node and its top bbox is needed
 169         bool m_need_to_get_new_sneak_node = true;
 170         // Node below player, used to determine whether it has been removed,
 171         // and its old type
 172         v3s16 m_old_node_below = v3s16(32767, 32767, 32767);
 173         std::string m_old_node_below_type = "air";
 174         // ***** End of variables for temporary option *****
 175
 176         bool m_can_jump = false;
 177         u16 m_breath = PLAYER_MAX_BREATH_DEFAULT;
 178         f32 m_yaw = 0.0f;
 179         f32 m_pitch = 0.0f;
 180         bool camera_barely_in_ceiling = false;
 181         aabb3f m_collisionbox = aabb3f(-BS * 0.30f, 0.0f, -BS * 0.30f, BS * 0.30f,
 182                         BS * 1.75f, BS * 0.30f);
 183         bool m_can_zoom = true;
 184
 185         GenericCAO *m_cao = nullptr;
 186         Client *m_client;
 187 };