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