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 "scripting/player.hpp"
  34 #include "player_status.hpp"
  35 #include "display_effect.hpp"
  36 #include "script_interface.hpp"
  37 #include "console.hpp"
  38 #include "coin.hpp"
  39
  40 class BadGuy;
  41 class Portable;
  42
  43 /* Times: */
  44 static const float TUX_SAFE_TIME = 1.8;
  45 static const float TUX_INVINCIBLE_TIME = 10.0;
  46 static const float TUX_INVINCIBLE_TIME_WARNING = 2.0;
  47 static const float GROWING_TIME = 0.35;
  48 static const int GROWING_FRAMES = 7;
  49
  50 class Camera;
  51 class PlayerStatus;
  52
  53 extern Surface* growingtux_left[GROWING_FRAMES];
  54 extern Surface* growingtux_right[GROWING_FRAMES];
  55
  56 class TuxBodyParts
  57 {
  58 public:
  59   TuxBodyParts()
  60     : head(0), body(0), arms(0), feet(0)
  61   { }
  62   ~TuxBodyParts() {
  63     delete head;
  64     delete body;
  65     delete arms;
  66     delete feet;
  67   }
  68
  69   void set_action(std::string action, int loops = -1);
  70   void one_time_animation();
  71   void draw(DrawingContext& context, const Vector& pos, int layer);
  72
  73   Sprite* head;
  74   Sprite* body;
  75   Sprite* arms;
  76   Sprite* feet;
  77 };
  78
  79 extern TuxBodyParts* small_tux;
  80 extern TuxBodyParts* big_tux;
  81 extern TuxBodyParts* fire_tux;
  82 extern TuxBodyParts* ice_tux;
  83
  84 class Player : public MovingObject, public Scripting::Player, public ScriptInterface
  85 {
  86 public:
  87   enum FallMode { ON_GROUND, JUMPING, TRAMPOLINE_JUMP, FALLING };
  88
  89   Controller* controller;
  90   PlayerStatus* player_status;
  91   bool duck;
  92   bool dead;
  93
  94 private:
  95   bool dying;
  96   bool backflipping;
  97   int  backflip_direction;
  98   Direction peeking;
  99   bool swimming;
 100
 101 public:
 102   Direction dir;
 103   Direction old_dir;
 104
 105   float last_ground_y;
 106   FallMode fall_mode;
 107
 108   bool on_ground_flag;
 109   bool jumping;
 110   bool can_jump;
 111   bool butt_jump;
 112
 113   Timer invincible_timer;
 114   Timer skidding_timer;
 115   Timer safe_timer;
 116   Timer kick_timer;
 117   Timer shooting_timer;   // used to show the arm when Tux is shooting
 118   Timer dying_timer;
 119   Timer growing_timer;
 120   Timer idle_timer;
 121   Timer backflip_timer;
 122   Physic physic;
 123
 124 public:
 125   Player(PlayerStatus* player_status, const std::string& name);
 126   virtual ~Player();
 127
 128   virtual void expose(HSQUIRRELVM vm, SQInteger table_idx);
 129   virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
 130
 131   void set_controller(Controller* controller);
 132   Controller* get_controller()
 133   {
 134     return controller;
 135   }
 136
 137   virtual void update(float elapsed_time);
 138   virtual void draw(DrawingContext& context);
 139   virtual void collision_solid(const CollisionHit& hit);
 140   virtual HitResponse collision(GameObject& other, const CollisionHit& hit);
 141   virtual void collision_tile(uint32_t tile_attributes);
 142
 143   void make_invincible();
 144   bool is_invincible() const
 145   {
 146     return invincible_timer.started();
 147   }
 148   bool is_dying() const
 149   {
 150     return dying;
 151   }
 152   Direction peeking_direction() const
 153   {
 154     return peeking;
 155   }
 156
 157   void kill(bool completely);
 158   void check_bounds(Camera* camera);
 159   void move(const Vector& vector);
 160
 161   virtual bool add_bonus(const std::string& bonus);
 162   virtual void add_coins(int count);
 163   virtual int get_coins();
 164
 165   /**
 166    * picks up a bonus, taking care not to pick up lesser bonus items than we already have
 167    *
 168    * @returns true if the bonus has been set (or was already good enough)
 169    *          false if the bonus could not be set (for example no space for big tux)
 170    */
 171   bool add_bonus(BonusType type, bool animate = false);
 172   /**
 173    * like add_bonus, but can also downgrade the bonus items carried
 174    */
 175   bool set_bonus(BonusType type, bool animate = false);
 176
 177   PlayerStatus* get_status()
 178   {
 179     return player_status;
 180   }
 181   // set kick animation
 182   void kick();
 183
 184   /**
 185    * play cheer animation.
 186    * This might need some space and behave in an unpredictable way. Best to use this at level end.
 187    */
 188   void do_cheer();
 189
 190   /**
 191    * duck down if possible.
 192    * this won't last long as long as input is enabled.
 193    */
 194   void do_duck();
 195
 196   /**
 197    * stand back up if possible.
 198    */
 199   void do_standup();
 200
 201   /**
 202    * do a backflip if possible.
 203    */
 204   void do_backflip();
 205
 206   /**
 207    * jump in the air if possible
 208    * sensible values for yspeed are negative - unless we want to jump into the ground of course
 209    */
 210   void do_jump(float yspeed);
 211
 212   /**
 213    * Adds velocity to the player (be carefull when using this)
 214    */
 215   void add_velocity(const Vector& velocity);
 216
 217   /**
 218    * Adds velocity to the player until given end speed is reached
 219    */
 220   void add_velocity(const Vector& velocity, const Vector& end_speed);
 221
 222   void bounce(BadGuy& badguy);
 223
 224   bool is_dead() const
 225   { return dead; }
 226   bool is_big();
 227
 228   void set_visible(bool visible);
 229   bool get_visible();
 230
 231   bool on_ground();
 232
 233   Portable* get_grabbed_object() const
 234   {
 235       return grabbed_object;
 236   }
 237
 238   /**
 239    * Switches ghost mode on/off.
 240    * Lets Tux float around and through solid objects.
 241    */
 242   void set_ghost_mode(bool enable);
 243
 244   /**
 245    * Returns whether ghost mode is currently enabled
 246    */
 247   bool get_ghost_mode() { return ghost_mode; }
 248
 249   /**
 250    * Changes height of bounding box.
 251    * Returns true if successful, false otherwise
 252    */
 253   bool adjust_height(float new_height);
 254
 255 private:
 256   void handle_input();
 257   void handle_input_ghost(); /**< input handling while in ghost mode */
 258   bool deactivated;
 259
 260   void init();
 261
 262   void handle_horizontal_input();
 263   void handle_vertical_input();
 264
 265   void activate();
 266   void deactivate();
 267   void walk(float speed);
 268
 269   /**
 270    * slows Tux down a little, based on where he's standing
 271    */
 272   void apply_friction();
 273
 274   bool visible;
 275
 276   Portable* grabbed_object;
 277
 278   Sprite* smalltux_gameover;
 279   Sprite* smalltux_star;
 280   Sprite* bigtux_star;
 281
 282   std::auto_ptr<Surface> airarrow; /**< arrow indicating Tux' position when he's above the camera */
 283
 284   Vector floor_normal;
 285   void try_grab();
 286
 287   bool ghost_mode; /**< indicates if Tux should float around and through solid objects */
 288
 289   Timer unduck_hurt_timer; /**< if Tux wants to stand up again after ducking and cannot, this timer is started */
 290 };
 291
 292 #endif /*SUPERTUX_PLAYER_H*/