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
  78 public:
  79   Direction dir;
  80   Direction old_dir;
  81
  82   float last_ground_y;
  83   FallMode fall_mode;
  84
  85   bool on_ground_flag;
  86   bool jumping;
  87   bool can_jump;
  88   bool butt_jump;
  89
  90   Timer invincible_timer;
  91   Timer skidding_timer;
  92   Timer safe_timer;
  93   Timer kick_timer;
  94   Timer shooting_timer;   // used to show the arm when Tux is shooting
  95   Timer dying_timer;
  96   bool growing;
  97   Timer idle_timer;
  98   Timer backflip_timer;
  99
 100 public:
 101   Player(PlayerStatus* player_status, const std::string& name);
 102   virtual ~Player();
 103
 104   virtual void expose(HSQUIRRELVM vm, SQInteger table_idx);
 105   virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
 106
 107   void set_controller(Controller* controller);
 108   Controller* get_controller()
 109   {
 110     return controller;
 111   }
 112
 113   void use_scripting_controller(bool use_or_release);
 114   void do_scripting_controller(std::string control, bool pressed);
 115
 116   virtual void update(float elapsed_time);
 117   virtual void draw(DrawingContext& context);
 118   virtual void collision_solid(const CollisionHit& hit);
 119   virtual HitResponse collision(GameObject& other, const CollisionHit& hit);
 120   virtual void collision_tile(uint32_t tile_attributes);
 121
 122   void make_invincible();
 123   bool is_invincible() const
 124   {
 125     return invincible_timer.started();
 126   }
 127   bool is_dying() const
 128   {
 129     return dying;
 130   }
 131   Direction peeking_direction() const
 132   {
 133     return peeking;
 134   }
 135
 136   void kill(bool completely);
 137   void check_bounds(Camera* camera);
 138   void move(const Vector& vector);
 139
 140   virtual bool add_bonus(const std::string& bonus);
 141   virtual void add_coins(int count);
 142   virtual int get_coins();
 143
 144   /**
 145    * picks up a bonus, taking care not to pick up lesser bonus items than we already have
 146    *
 147    * @returns true if the bonus has been set (or was already good enough)
 148    *          false if the bonus could not be set (for example no space for big tux)
 149    */
 150   bool add_bonus(BonusType type, bool animate = false);
 151   /**
 152    * like add_bonus, but can also downgrade the bonus items carried
 153    */
 154   bool set_bonus(BonusType type, bool animate = false);
 155
 156   PlayerStatus* get_status()
 157   {
 158     return player_status;
 159   }
 160   // set kick animation
 161   void kick();
 162
 163   /**
 164    * play cheer animation.
 165    * This might need some space and behave in an unpredictable way. Best to use this at level end.
 166    */
 167   void do_cheer();
 168
 169   /**
 170    * duck down if possible.
 171    * this won't last long as long as input is enabled.
 172    */
 173   void do_duck();
 174
 175   /**
 176    * stand back up if possible.
 177    */
 178   void do_standup();
 179
 180   /**
 181    * do a backflip if possible.
 182    */
 183   void do_backflip();
 184
 185   /**
 186    * jump in the air if possible
 187    * sensible values for yspeed are negative - unless we want to jump into the ground of course
 188    */
 189   void do_jump(float yspeed);
 190
 191   /**
 192    * Adds velocity to the player (be carefull when using this)
 193    */
 194   void add_velocity(const Vector& velocity);
 195
 196   /**
 197    * Adds velocity to the player until given end speed is reached
 198    */
 199   void add_velocity(const Vector& velocity, const Vector& end_speed);
 200
 201   /**
 202    * Returns the current velocity of the player
 203    */
 204   Vector get_velocity();
 205
 206   void bounce(BadGuy& badguy);
 207
 208   bool is_dead() const
 209   { return dead; }
 210   bool is_big();
 211
 212   void set_visible(bool visible);
 213   bool get_visible();
 214
 215   bool on_ground();
 216
 217   Portable* get_grabbed_object() const
 218   {
 219       return grabbed_object;
 220   }
 221
 222   /**
 223    * Switches ghost mode on/off.
 224    * Lets Tux float around and through solid objects.
 225    */
 226   void set_ghost_mode(bool enable);
 227
 228   /**
 229    * Switches edit mode on/off.
 230    * In edit mode, Tux will enter ghost_mode instead of dying.
 231    */
 232   void set_edit_mode(bool enable);
 233
 234   /**
 235    * Returns whether ghost mode is currently enabled
 236    */
 237   bool get_ghost_mode() { return ghost_mode; }
 238
 239   /**
 240    * Changes height of bounding box.
 241    * Returns true if successful, false otherwise
 242    */
 243   bool adjust_height(float new_height);
 244
 245   /**
 246    * Orders the current GameSession to start a sequence
 247    */
 248   void trigger_sequence(std::string sequence_name);
 249
 250   /**
 251    * Requests that the player start climbing the given Climbable
 252    */
 253   void start_climbing(Climbable& climbable);
 254
 255   /**
 256    * Requests that the player stop climbing the given Climbable
 257    */
 258   void stop_climbing(Climbable& climbable);
 259
 260 private:
 261   void handle_input();
 262   void handle_input_ghost(); /**< input handling while in ghost mode */
 263   void handle_input_climbing(); /**< input handling while climbing */
 264   bool deactivated;
 265
 266   void init();
 267
 268   void handle_horizontal_input();
 269   void handle_vertical_input();
 270
 271   void activate();
 272   void deactivate();
 273   void walk(float speed);
 274
 275   /**
 276    * slows Tux down a little, based on where he's standing
 277    */
 278   void apply_friction();
 279
 280   bool visible;
 281
 282   Portable* grabbed_object;
 283
 284   Sprite* sprite; /**< The main sprite representing Tux */
 285   Sprite* smalltux_gameover;
 286   Sprite* smalltux_star;
 287   Sprite* bigtux_star;
 288
 289   std::auto_ptr<Surface> airarrow; /**< arrow indicating Tux' position when he's above the camera */
 290
 291   Vector floor_normal;
 292   void try_grab();
 293
 294   bool ghost_mode; /**< indicates if Tux should float around and through solid objects */
 295   bool edit_mode; /**< indicates if Tux should switch to ghost mode rather than dying */
 296
 297   Timer unduck_hurt_timer; /**< if Tux wants to stand up again after ducking and cannot, this timer is started */
 298
 299   Climbable* climbing; /**< Climbable object we are currently climbing, null if none */
 300 };
 301
 302 #endif /*SUPERTUX_PLAYER_H*/