player.hpp

//  SuperTux
//  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
//
//  This program is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program.  If not, see <http://www.gnu.org/licenses/>.

#ifndef HEADER_SUPERTUX_OBJECT_PLAYER_HPP
#define HEADER_SUPERTUX_OBJECT_PLAYER_HPP

#include "scripting/player.hpp"
#include "sprite/sprite_ptr.hpp"
#include "squirrel/exposed_object.hpp"
#include "supertux/direction.hpp"
#include "supertux/moving_object.hpp"
#include "supertux/physic.hpp"
#include "supertux/player_status.hpp"
#include "supertux/sequence.hpp"
#include "supertux/timer.hpp"
#include "video/surface_ptr.hpp"

class BadGuy;
class Portable;
class Climbable;
class Controller;
class CodeController;

extern const float TUX_INVINCIBLE_TIME_WARNING;

class Player final : public MovingObject,
                     public ExposedObject<Player, scripting::Player>
{
public:
  enum FallMode { ON_GROUND, JUMPING, TRAMPOLINE_JUMP, FALLING };

public:
  Player(PlayerStatus& player_status, const std::string& name);
  virtual ~Player();

  virtual void update(float dt_sec) override;
  virtual void draw(DrawingContext& context) override;
  virtual void collision_solid(const CollisionHit& hit) override;
  virtual HitResponse collision(GameObject& other, const CollisionHit& hit) override;
  virtual void collision_tile(uint32_t tile_attributes) override;
  virtual bool is_saveable() const override { return false; }
  virtual bool is_singleton() const override { return true; }

  void set_controller(const Controller* controller);
  void set_winning();
  bool is_winning() const { return m_winning; }

  // Tux can only go this fast. If set to 0 no special limit is used, only the default limits.
  void set_speedlimit(float newlimit);
  float get_speedlimit() const;

  const Controller& get_controller() const { return *m_controller; }

  void use_scripting_controller(bool use_or_release);
  void do_scripting_controller(const std::string& control, bool pressed);

  void make_invincible();

  bool is_invincible() const { return m_invincible_timer.started(); }
  bool is_dying() const { return m_dying; }

  Direction peeking_direction_x() const { return m_peekingX; }
  Direction peeking_direction_y() const { return m_peekingY; }

  void kill(bool completely);
  void move(const Vector& vector);

  bool add_bonus(const std::string& bonus);
  bool set_bonus(const std::string& bonus);
  void add_coins(int count);
  int get_coins() const;

  bool add_bonus(BonusType type, bool animate = false);

  bool set_bonus(BonusType type, bool animate = false);

  PlayerStatus& get_status() const { return m_player_status; }

  void kick();

  void do_cheer();

  void do_duck();

  void do_standup();

  void do_backflip();

  void do_jump(float yspeed);

  void add_velocity(const Vector& velocity);

  void add_velocity(const Vector& velocity, const Vector& end_speed);

  Vector get_velocity() const;

  void bounce(BadGuy& badguy);

  bool is_dead() const { return m_dead; }
  bool is_big() const;
  bool is_stone() const { return m_stone; }

  void set_visible(bool visible);
  bool get_visible() const;

  bool on_ground() const;

  Portable* get_grabbed_object() const { return m_grabbed_object; }
  void stop_grabbing() { m_grabbed_object = nullptr; }

  bool has_grabbed(const std::string& object_name) const;

  void set_ghost_mode(bool enable);

  void set_edit_mode(bool enable);

  bool get_ghost_mode() const { return m_ghost_mode; }

  bool adjust_height(float new_height);

  void trigger_sequence(const std::string& sequence_name, const SequenceData* data = nullptr);

  void trigger_sequence(Sequence seq, const SequenceData* data = nullptr);

  void start_climbing(Climbable& climbable);

  void stop_climbing(Climbable& climbable);

  Physic& get_physic() { return m_physic; }

  void activate();
  void deactivate();

  void walk(float speed);
  void set_dir(bool right);
  void stop_backflipping();

  void position_grabbed_object();
  void try_grab();

private:
  void handle_input();
  void handle_input_ghost(); 
  void handle_input_climbing(); 
  void handle_horizontal_input();
  void handle_vertical_input();

  void do_jump_apex();
  void early_jump_apex();

  bool slightly_above_ground() const;

  BonusType string_to_bonus(const std::string& bonus) const;

  void apply_friction();

  void check_bounds();

private:
  bool m_deactivated;

  const Controller* m_controller;
  std::unique_ptr<CodeController> m_scripting_controller; 
  PlayerStatus& m_player_status;
  bool m_duck;
  bool m_dead;
  bool m_dying;
  bool m_winning;
  bool m_backflipping;
  int  m_backflip_direction;
  Direction m_peekingX;
  Direction m_peekingY;
  float m_ability_time;
  bool m_stone;
  bool m_swimming;
  float m_speedlimit;
  const Controller* m_scripting_controller_old; 
  bool m_jump_early_apex;
  bool m_on_ice;
  bool m_ice_this_frame;
  SpritePtr m_lightsprite;
  SpritePtr m_powersprite;

public:
  Direction m_dir;

private:
  Direction m_old_dir;

public:
  float m_last_ground_y;
  FallMode m_fall_mode;

private:
  bool m_on_ground_flag;
  bool m_jumping;
  bool m_can_jump;
  Timer m_jump_button_timer; 
  bool m_wants_buttjump;

public:
  bool m_does_buttjump;
  Timer m_invincible_timer;

private:
  Timer m_skidding_timer;
  Timer m_safe_timer;
  Timer m_kick_timer;
  Timer m_shooting_timer;   // used to show the arm when Tux is shooting
  Timer m_ability_timer;  // maximum lengh of time that special abilities can last
  Timer m_cooldown_timer; // minimum time period between successive uses of a special ability

public:
  Timer m_dying_timer;

private:
  Timer m_second_growup_sound_timer;
  bool m_growing;
  Timer m_backflip_timer;

  Physic m_physic;

  bool m_visible;

  Portable* m_grabbed_object;

  SpritePtr m_sprite; 
  SurfacePtr m_airarrow; 
  Vector m_floor_normal;

  bool m_ghost_mode; 
  bool m_edit_mode; 
  Timer m_unduck_hurt_timer; 
  Timer m_idle_timer;
  unsigned int m_idle_stage;

  Climbable* m_climbing; 
private:
  Player(const Player&) = delete;
  Player& operator=(const Player&) = delete;
};

#endif

/* EOF */