fix cr/lfs and remove trailing whitespaces...

[supertux.git] / src / object / player.hpp

diff --git a/src/object/player.hpp b/src/object/player.hpp
index eb5ab8a..866a0bf 100644 (file)
--- a/src/object/player.hpp
+++ b/src/object/player.hpp
@@ -1,7 +1,7 @@
 //  $Id$
 //
-//  SuperTux -  A Jump'n Run
-//  Copyright (C) 2003 Tobias Glaesser <tobi.web@gmx.de>
+//  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
@@ -16,6 +16,7 @@
 //  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
 
@@ -34,6 +35,7 @@
 #include "display_effect.hpp"
 #include "script_interface.hpp"
 #include "console.hpp"
+#include "coin.hpp"
 
 class BadGuy;
 class Portable;
@@ -42,7 +44,7 @@ class Portable;
 static const float TUX_SAFE_TIME = 1.8;
 static const float TUX_INVINCIBLE_TIME = 10.0;
 static const float TUX_INVINCIBLE_TIME_WARNING = 2.0;
-static const float GROWING_TIME = 1.0;
+static const float GROWING_TIME = 0.35;
 static const int GROWING_FRAMES = 7;
 
 class Camera;
@@ -82,7 +84,6 @@ extern TuxBodyParts* ice_tux;
 class Player : public MovingObject, public Scripting::Player, public ScriptInterface
 {
 public:
-  enum HurtMode { KILL, SHRINK };
   enum FallMode { ON_GROUND, JUMPING, TRAMPOLINE_JUMP, FALLING };
 
   Controller* controller;
@@ -94,7 +95,9 @@ private:
   bool dying;
   bool backflipping;
   int  backflip_direction;
-  
+  Direction peeking;
+  bool swimming;
+
 public:
   Direction dir;
   Direction old_dir;
@@ -117,18 +120,23 @@ public:
   Timer idle_timer;
   Timer backflip_timer;
   Physic physic;
-  
+
 public:
   Player(PlayerStatus* player_status);
   virtual ~Player();
 
-  virtual void expose(HSQUIRRELVM vm, int table_idx);
-  virtual void unexpose(HSQUIRRELVM vm, int table_idx);
+  virtual void expose(HSQUIRRELVM vm, SQInteger table_idx);
+  virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
 
-  void set_controller(Controller* controller);  
+  void set_controller(Controller* controller);
+  Controller* get_controller()
+  {
+    return controller;
+  }
 
   virtual void update(float elapsed_time);
   virtual void draw(DrawingContext& context);
+  virtual void collision_solid(const CollisionHit& hit);
   virtual HitResponse collision(GameObject& other, const CollisionHit& hit);
   virtual void collision_tile(uint32_t tile_attributes);
 
@@ -141,11 +149,30 @@ public:
   {
     return dying;
   }
-  
-  void kill(HurtMode mode);
+  Direction peeking_direction() const
+  {
+    return peeking;
+  }
+
+  void kill(bool completely);
   void check_bounds(Camera* camera);
   void move(const Vector& vector);
-  void set_bonus(BonusType type, bool animate = false);
+
+  virtual bool add_bonus(const std::string& bonus);
+  virtual void add_coins(int count);
+
+  /**
+   * picks up a bonus, taking care not to pick up lesser bonus items than we already have
+   *
+   * @returns true if the bonus has been set (or was already good enough)
+   *          false if the bonus could not be set (for example no space for big tux)
+   */
+  bool add_bonus(BonusType type, bool animate = false);
+  /**
+   * like add_bonus, but can also downgrade the bonus items carried
+   */
+  bool set_bonus(BonusType type, bool animate = false);
+
   PlayerStatus* get_status()
   {
     return player_status;
@@ -154,10 +181,43 @@ public:
   void kick();
 
   /**
+   * play cheer animation.
+   * This might need some space and behave in an unpredictable way. Best to use this at level end.
+   */
+  void do_cheer();
+
+  /**
+   * duck down if possible.
+   * this won't last long as long as input is enabled.
+   */
+  void do_duck();
+
+  /**
+   * stand back up if possible.
+   */
+  void do_standup();
+
+  /**
+   * do a backflip if possible.
+   */
+  void do_backflip();
+
+  /**
+   * jump in the air if possible
+   * sensible values for yspeed are negative - unless we want to jump into the ground of course
+   */
+  void do_jump(float yspeed);
+
+  /**
    * Adds velocity to the player (be carefull when using this)
    */
   void add_velocity(const Vector& velocity);
 
+  /**
+   * Adds velocity to the player until given end speed is reached
+   */
+  void add_velocity(const Vector& velocity, const Vector& end_speed);
+
   void bounce(BadGuy& badguy);
 
   bool is_dead() const
@@ -169,12 +229,35 @@ public:
 
   bool on_ground();
 
+  Portable* get_grabbed_object() const
+  {
+      return grabbed_object;
+  }
+
+  /**
+   * Switches ghost mode on/off.
+   * Lets Tux float around and through solid objects.
+   */
+  void set_ghost_mode(bool enable);
+
+  /**
+   * Returns whether ghost mode is currently enabled
+   */
+  bool get_ghost_mode() { return ghost_mode; }
+
+  /**
+   * Changes height of bounding box.
+   * Returns true if successful, false otherwise
+   */
+  bool adjust_height(float new_height);
+
 private:
   void handle_input();
+  void handle_input_ghost(); /**< input handling while in ghost mode */
   bool deactivated;
-  
+
   void init();
-  
+
   void handle_horizontal_input();
   void handle_vertical_input();
 
@@ -182,16 +265,24 @@ private:
   void deactivate();
   void walk(float speed);
 
-  bool visible;
+  /**
+   * slows Tux down a little, based on where he's standing
+   */
+  void apply_friction();
 
-  float adjust_height;
+  bool visible;
 
   Portable* grabbed_object;
 
   Sprite* smalltux_gameover;
   Sprite* smalltux_star;
   Sprite* bigtux_star;
+
   Vector floor_normal;
+
+  bool ghost_mode; /**< indicates if Tux should float around and through solid objects */
+
+  Timer unduck_hurt_timer; /**< if Tux wants to stand up again after ducking and cannot, this timer is started */
 };
 
 #endif /*SUPERTUX_PLAYER_H*/