Removed trailing whitespace from all *.?pp files
[supertux.git] / src / object / player.hpp
index 7005674..3dda1fd 100644 (file)
@@ -1,12 +1,10 @@
-//  $Id$
-//
 //  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 2
-//  of the License, or (at your option) any later version.
+//  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
 //  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, write to the Free Software
-//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-
-#ifndef SUPERTUX_PLAYER_H
-#define SUPERTUX_PLAYER_H
-
-#include <vector>
-#include <SDL.h>
-
-#include "timer.hpp"
-#include "direction.hpp"
-#include "video/surface.hpp"
-#include "moving_object.hpp"
-#include "sprite/sprite.hpp"
-#include "physic.hpp"
-#include "control/controller.hpp"
-#include "control/codecontroller.hpp"
+//  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 "player_status.hpp"
-#include "display_effect.hpp"
-#include "script_interface.hpp"
-#include "console.hpp"
-#include "coin.hpp"
+#include "sprite/sprite_ptr.hpp"
+#include "supertux/direction.hpp"
+#include "supertux/moving_object.hpp"
+#include "supertux/physic.hpp"
+#include "supertux/player_status.hpp"
+#include "supertux/script_interface.hpp"
+#include "supertux/timer.hpp"
 
 class BadGuy;
 class Portable;
 class Climbable;
+class Controller;
+class CodeController;
+class Surface;
+class Timer;
 
 /* Times: */
 static const float TUX_SAFE_TIME = 1.8f;
@@ -48,57 +40,21 @@ static const float TUX_INVINCIBLE_TIME = 14.0f;
 static const float TUX_INVINCIBLE_TIME_WARNING = 2.0f;
 static const float GROWING_TIME = 0.35f;
 static const int GROWING_FRAMES = 7;
+static const float TUX_BACKFLIP_TIME = 2.1f; // minimum air time that backflip results in a loss of control
 
 class Camera;
 class PlayerStatus;
 
-class Player : public MovingObject, public UsesPhysic, public Scripting::Player, public ScriptInterface
+class Player : public MovingObject,
+               public scripting::Player,
+               public ScriptInterface
 {
 public:
   enum FallMode { ON_GROUND, JUMPING, TRAMPOLINE_JUMP, FALLING };
-
-  Controller* controller;
-  CodeController* scripting_controller; /**< This controller is used when the Player is controlled via scripting */
-  PlayerStatus* player_status;
-  bool duck;
-  bool dead;
   //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();
 
-private:
-  bool dying;
-  bool backflipping;
-  int  backflip_direction;
-  Direction peekingX, peekingY;
-  bool swimming;
-  float speedlimit;
-  Controller* scripting_controller_old; /**< Saves the old controller while the scripting_controller is used */
-  bool jump_early_apex;
-
-public:
-  Direction dir;
-  Direction old_dir;
-
-  float last_ground_y;
-  FallMode fall_mode;
-
-  bool on_ground_flag;
-  bool jumping;
-  bool can_jump;
-  bool wants_buttjump;
-  bool does_buttjump;
-
-  Timer invincible_timer;
-  Timer skidding_timer;
-  Timer safe_timer;
-  Timer kick_timer;
-  Timer shooting_timer;   // used to show the arm when Tux is shooting
-  Timer dying_timer;
-  bool growing;
-  Timer idle_timer;
-  Timer backflip_timer;
-
 public:
   Player(PlayerStatus* player_status, const std::string& name);
   virtual ~Player();
@@ -107,6 +63,15 @@ public:
   virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
 
   void set_controller(Controller* controller);
+  /*
+   * Level solved. Don't kill Tux any more.
+   */
+  void set_winning();
+  bool is_winning()
+  {
+    return winning;
+  }
+
   Controller* get_controller()
   {
     return controller;
@@ -141,7 +106,7 @@ public:
   }
 
   void kill(bool completely);
-  void check_bounds(Camera* camera);
+  void check_bounds();
   void move(const Vector& vector);
 
   virtual bool add_bonus(const std::string& bonus);
@@ -196,7 +161,7 @@ public:
   void do_jump(float yspeed);
 
   /**
-   * Adds velocity to the player (be carefull when using this)
+   * Adds velocity to the player (be careful when using this)
    */
   void add_velocity(const Vector& velocity);
 
@@ -204,7 +169,7 @@ public:
    * Adds velocity to the player until given end speed is reached
    */
   void add_velocity(const Vector& velocity, const Vector& end_speed);
-  
+
   /**
    * Returns the current velocity of the player
    */
@@ -223,7 +188,11 @@ public:
 
   Portable* get_grabbed_object() const
   {
-      return grabbed_object;
+    return grabbed_object;
+  }
+  void stop_grabbing()
+  {
+    grabbed_object = NULL;
   }
 
   /**
@@ -253,7 +222,7 @@ public:
    * Orders the current GameSession to start a sequence
    */
   void trigger_sequence(std::string sequence_name);
-  
+
   /**
    * Requests that the player start climbing the given Climbable
    */
@@ -264,11 +233,12 @@ public:
    */
   void stop_climbing(Climbable& climbable);
 
+  Physic& get_physic() { return physic; }
+
 private:
   void handle_input();
   void handle_input_ghost(); /**< input handling while in ghost mode */
   void handle_input_climbing(); /**< input handling while climbing */
-  bool deactivated;
 
   void init();
 
@@ -278,6 +248,7 @@ private:
   void activate();
   void deactivate();
   void walk(float speed);
+  void set_dir(bool right);
 
   void do_jump_apex();
   void early_jump_apex();
@@ -287,18 +258,64 @@ private:
    */
   void apply_friction();
 
+private:
+  bool deactivated;
+
+  Controller* controller;
+  std::unique_ptr<CodeController> scripting_controller; /**< This controller is used when the Player is controlled via scripting */
+  PlayerStatus* player_status;
+  bool duck;
+  bool dead;
+
+private:
+  bool dying;
+  bool winning;
+  bool backflipping;
+  int  backflip_direction;
+  Direction peekingX;
+  Direction peekingY;
+  bool swimming;
+  float speedlimit;
+  Controller* scripting_controller_old; /**< Saves the old controller while the scripting_controller is used */
+  bool jump_early_apex;
+  bool on_ice;
+  bool ice_this_frame;
+
+public:
+  Direction dir;
+  Direction old_dir;
+
+  float last_ground_y;
+  FallMode fall_mode;
+
+  bool on_ground_flag;
+  bool jumping;
+  bool can_jump;
+  Timer jump_button_timer; /**< started when player presses the jump button; runs until Tux jumps or JUMP_GRACE_TIME runs out */
+  bool wants_buttjump;
+  bool does_buttjump;
+
+  Timer invincible_timer;
+  Timer skidding_timer;
+  Timer safe_timer;
+  Timer kick_timer;
+  Timer shooting_timer;   // used to show the arm when Tux is shooting
+  Timer dying_timer;
+  bool growing;
+  Timer backflip_timer;
+
+  Physic physic;
+
   bool visible;
 
   Portable* grabbed_object;
 
-  Sprite* sprite; /**< The main sprite representing Tux */
-  Sprite* smalltux_gameover;
-  Sprite* smalltux_star;
-  Sprite* bigtux_star;
+  SpritePtr sprite; /**< The main sprite representing Tux */
 
-  std::auto_ptr<Surface> airarrow; /**< arrow indicating Tux' position when he's above the camera */
+  SurfacePtr airarrow; /**< arrow indicating Tux' position when he's above the camera */
 
   Vector floor_normal;
+  void position_grabbed_object();
   void try_grab();
 
   bool ghost_mode; /**< indicates if Tux should float around and through solid objects */
@@ -306,7 +323,16 @@ private:
 
   Timer unduck_hurt_timer; /**< if Tux wants to stand up again after ducking and cannot, this timer is started */
 
+  Timer idle_timer;
+  unsigned int idle_stage;
+
   Climbable* climbing; /**< Climbable object we are currently climbing, null if none */
+
+private:
+  Player(const Player&);
+  Player& operator=(const Player&);
 };
 
 #endif /*SUPERTUX_PLAYER_H*/
+
+/* EOF */