src/object/player.hpp

   1 //  $Id$
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   5 //
   6 //  This program is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU General Public License
   8 //  as published by the Free Software Foundation; either version 2
   9 //  of the License, or (at your option) any later version.
  10 //
  11 //  This program is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 //  GNU General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU General Public License
  17 //  along with this program; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19
  20 #ifndef SUPERTUX_PLAYER_H
  21 #define SUPERTUX_PLAYER_H
  22
  23 #include <vector>
  24 #include <SDL.h>
  25
  26 #include "timer.hpp"
  27 #include "direction.hpp"
  28 #include "video/surface.hpp"
  29 #include "moving_object.hpp"
  30 #include "sprite/sprite.hpp"
  31 #include "physic.hpp"
  32 #include "control/controller.hpp"
  33 #include "control/codecontroller.hpp"
  34 #include "scripting/player.hpp"
  35 #include "player_status.hpp"
  36 #include "display_effect.hpp"
  37 #include "script_interface.hpp"
  38 #include "console.hpp"
  39 #include "coin.hpp"
  40
  41 class BadGuy;
  42 class Portable;
  43 class Climbable;
  44
  45 /* Times: */
  46 static const float TUX_SAFE_TIME = 1.8f;
  47 static const float TUX_INVINCIBLE_TIME = 10.0f;
  48 static const float TUX_INVINCIBLE_TIME_WARNING = 2.0f;
  49 static const float GROWING_TIME = 0.35f;
  50 static const int GROWING_FRAMES = 7;
  51
  52 class Camera;
  53 class PlayerStatus;
  54
  55 class Player : public MovingObject, public UsesPhysic, public Scripting::Player, public ScriptInterface
  56 {
  57 public:
  58   enum FallMode { ON_GROUND, JUMPING, TRAMPOLINE_JUMP, FALLING };
  59
  60   Controller* controller;
  61   CodeController* scripting_controller; /**< This controller is used when the Player is controlled via scripting */
  62   PlayerStatus* player_status;
  63   bool duck;
  64   bool dead;
  65   //Tux can only go this fast. If set to 0 no special limit is used, only the default limits.
  66   void set_speedlimit(float newlimit);
  67   float get_speedlimit();
  68
  69 private:
  70   bool dying;
  71   bool backflipping;
  72   int  backflip_direction;
  73   Direction peeking;
  74   bool swimming;
  75   float speedlimit;
  76   Controller* scripting_controller_old; /**< Saves the old controller while the scripting_controller is used */
  77   bool jump_early_apex;
  78
  79 public:
  80   Direction dir;
  81   Direction old_dir;
  82
  83   float last_ground_y;
  84   FallMode fall_mode;
  85
  86   bool on_ground_flag;
  87   bool jumping;
  88   bool can_jump;
  89   bool wants_buttjump;
  90   bool does_buttjump;
  91
  92   Timer invincible_timer;
  93   Timer skidding_timer;
  94   Timer safe_timer;
  95   Timer kick_timer;
  96   Timer shooting_timer;   // used to show the arm when Tux is shooting
  97   Timer dying_timer;
  98   bool growing;
  99   Timer idle_timer;
 100   Timer backflip_timer;
 101
 102 public:
 103   Player(PlayerStatus* player_status, const std::string& name);
 104   virtual ~Player();
 105
 106   virtual void expose(HSQUIRRELVM vm, SQInteger table_idx);
 107   virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
 108
 109   void set_controller(Controller* controller);
 110   Controller* get_controller()
 111   {
 112     return controller;
 113   }
 114
 115   void use_scripting_controller(bool use_or_release);
 116   void do_scripting_controller(std::string control, bool pressed);
 117
 118   virtual void update(float elapsed_time);
 119   virtual void draw(DrawingContext& context);
 120   virtual void collision_solid(const CollisionHit& hit);
 121   virtual HitResponse collision(GameObject& other, const CollisionHit& hit);
 122   virtual void collision_tile(uint32_t tile_attributes);
 123
 124   void make_invincible();
 125   bool is_invincible() const
 126   {
 127     return invincible_timer.started();
 128   }
 129   bool is_dying() const
 130   {
 131     return dying;
 132   }
 133   Direction peeking_direction() const
 134   {
 135     return peeking;
 136   }
 137
 138   void kill(bool completely);
 139   void check_bounds(Camera* camera);
 140   void move(const Vector& vector);
 141
 142   virtual bool add_bonus(const std::string& bonus);
 143   virtual void add_coins(int count);
 144   virtual int get_coins();
 145
 146   /**
 147    * picks up a bonus, taking care not to pick up lesser bonus items than we already have
 148    *
 149    * @returns true if the bonus has been set (or was already good enough)
 150    *          false if the bonus could not be set (for example no space for big tux)
 151    */
 152   bool add_bonus(BonusType type, bool animate = false);
 153   /**
 154    * like add_bonus, but can also downgrade the bonus items carried
 155    */
 156   bool set_bonus(BonusType type, bool animate = false);
 157
 158   PlayerStatus* get_status()
 159   {
 160     return player_status;
 161   }
 162   // set kick animation
 163   void kick();
 164
 165   /**
 166    * play cheer animation.
 167    * This might need some space and behave in an unpredictable way. Best to use this at level end.
 168    */
 169   void do_cheer();
 170
 171   /**
 172    * duck down if possible.
 173    * this won't last long as long as input is enabled.
 174    */
 175   void do_duck();
 176
 177   /**
 178    * stand back up if possible.
 179    */
 180   void do_standup();
 181
 182   /**
 183    * do a backflip if possible.
 184    */
 185   void do_backflip();
 186
 187   /**
 188    * jump in the air if possible
 189    * sensible values for yspeed are negative - unless we want to jump into the ground of course
 190    */
 191   void do_jump(float yspeed);
 192
 193   /**
 194    * Adds velocity to the player (be carefull when using this)
 195    */
 196   void add_velocity(const Vector& velocity);
 197
 198   /**
 199    * Adds velocity to the player until given end speed is reached
 200    */
 201   void add_velocity(const Vector& velocity, const Vector& end_speed);
 202
 203   /**
 204    * Returns the current velocity of the player
 205    */
 206   Vector get_velocity();
 207
 208   void bounce(BadGuy& badguy);
 209
 210   bool is_dead() const
 211   { return dead; }
 212   bool is_big();
 213
 214   void set_visible(bool visible);
 215   bool get_visible();
 216
 217   bool on_ground();
 218
 219   Portable* get_grabbed_object() const
 220   {
 221       return grabbed_object;
 222   }
 223
 224   /**
 225    * Switches ghost mode on/off.
 226    * Lets Tux float around and through solid objects.
 227    */
 228   void set_ghost_mode(bool enable);
 229
 230   /**
 231    * Switches edit mode on/off.
 232    * In edit mode, Tux will enter ghost_mode instead of dying.
 233    */
 234   void set_edit_mode(bool enable);
 235
 236   /**
 237    * Returns whether ghost mode is currently enabled
 238    */
 239   bool get_ghost_mode() { return ghost_mode; }
 240
 241   /**
 242    * Changes height of bounding box.
 243    * Returns true if successful, false otherwise
 244    */
 245   bool adjust_height(float new_height);
 246
 247   /**
 248    * Orders the current GameSession to start a sequence
 249    */
 250   void trigger_sequence(std::string sequence_name);
 251
 252   /**
 253    * Requests that the player start climbing the given Climbable
 254    */
 255   void start_climbing(Climbable& climbable);
 256
 257   /**
 258    * Requests that the player stop climbing the given Climbable
 259    */
 260   void stop_climbing(Climbable& climbable);
 261
 262 private:
 263   void handle_input();
 264   void handle_input_ghost(); /**< input handling while in ghost mode */
 265   void handle_input_climbing(); /**< input handling while climbing */
 266   bool deactivated;
 267
 268   void init();
 269
 270   void handle_horizontal_input();
 271   void handle_vertical_input();
 272
 273   void activate();
 274   void deactivate();
 275   void walk(float speed);
 276
 277   void do_jump_apex();
 278   void early_jump_apex();
 279
 280   /**
 281    * slows Tux down a little, based on where he's standing
 282    */
 283   void apply_friction();
 284
 285   bool visible;
 286
 287   Portable* grabbed_object;
 288
 289   Sprite* sprite; /**< The main sprite representing Tux */
 290   Sprite* smalltux_gameover;
 291   Sprite* smalltux_star;
 292   Sprite* bigtux_star;
 293
 294   std::auto_ptr<Surface> airarrow; /**< arrow indicating Tux' position when he's above the camera */
 295
 296   Vector floor_normal;
 297   void try_grab();
 298
 299   bool ghost_mode; /**< indicates if Tux should float around and through solid objects */
 300   bool edit_mode; /**< indicates if Tux should switch to ghost mode rather than dying */
 301
 302   Timer unduck_hurt_timer; /**< if Tux wants to stand up again after ducking and cannot, this timer is started */
 303
 304   Climbable* climbing; /**< Climbable object we are currently climbing, null if none */
 305 };
 306
 307 #endif /*SUPERTUX_PLAYER_H*/