src/badguy/badguy.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 __BADGUY_H__
  21 #define __BADGUY_H__
  22
  23 // moved them here to make it less typing when implementing new badguys
  24 #include <math.h>
  25 #include "timer.hpp"
  26 #include "object/moving_sprite.hpp"
  27 #include "physic.hpp"
  28 #include "object/player.hpp"
  29 #include "serializable.hpp"
  30 #include "resources.hpp"
  31 #include "sector.hpp"
  32 #include "direction.hpp"
  33 #include "object_factory.hpp"
  34 #include "lisp/parser.hpp"
  35 #include "lisp/lisp.hpp"
  36 #include "lisp/writer.hpp"
  37 #include "video/drawing_context.hpp"
  38 #include "audio/sound_manager.hpp"
  39 #include "audio/sound_source.hpp"
  40
  41 class BadGuy : public MovingSprite, public Serializable
  42 {
  43 public:
  44   BadGuy(const Vector& pos, const std::string& sprite_name, int layer = LAYER_OBJECTS);
  45   BadGuy(const Vector& pos, Direction direction, const std::string& sprite_name, int layer = LAYER_OBJECTS);
  46   BadGuy(const lisp::Lisp& reader, const std::string& sprite_name, int layer = LAYER_OBJECTS);
  47
  48   /** Called when the badguy is drawn. The default implementation simply draws
  49    * the badguy sprite on screen
  50    */
  51   virtual void draw(DrawingContext& context);
  52   /** Called each frame. The default implementation checks badguy state and
  53    * calls active_update and inactive_update
  54    */
  55   virtual void update(float elapsed_time);
  56   /** Called when a collision with another object occured. The default
  57    * implemetnation calls collision_player, collision_solid, collision_badguy
  58    * and collision_squished
  59    */
  60   virtual HitResponse collision(GameObject& other, const CollisionHit& hit);
  61
  62   /** Called when a collision with tile with special attributes occured */
  63   virtual void collision_tile(uint32_t tile_attributes);
  64
  65   /** Set the badguy to kill/falling state, which makes him falling of the
  66    * screen (his sprite is turned upside-down)
  67    */
  68   virtual void kill_fall();
  69
  70   /** Writes out the badguy into the included lisp::Writer. Useful e.g. when
  71    * converting an old-format level to the new format.
  72    */
  73   virtual void save(lisp::Writer& writer);
  74
  75   /**
  76    * True if this badguy can break bricks or open bonusblocks in his current form.
  77    */
  78   virtual bool can_break()
  79   {
  80     return false;
  81   }
  82
  83   Vector get_start_position() const
  84   {
  85     return start_position;
  86   }
  87   void set_start_position(const Vector& vec)
  88   {
  89     start_position = vec;
  90   }
  91
  92   /** Count this badguy to the statistics? This value should not be changed
  93    * during runtime. */
  94   bool countMe;
  95
  96 protected:
  97   enum State {
  98     STATE_INIT,
  99     STATE_INACTIVE,
 100     STATE_ACTIVE,
 101     STATE_SQUISHED,
 102     STATE_FALLING
 103   };
 104
 105   /** Called when the badguy collided with a player */
 106   virtual HitResponse collision_player(Player& player, const CollisionHit& hit);
 107   /** Called when the badguy collided with solid ground */
 108   virtual void collision_solid(const CollisionHit& hit);
 109   /** Called when the badguy collided with another badguy */
 110   virtual HitResponse collision_badguy(BadGuy& other, const CollisionHit& hit);
 111
 112   /** Called when the player hit the badguy from above. You should return true
 113    * if the badguy was squished, false if squishing wasn't possible
 114    */
 115   virtual bool collision_squished(Player& player);
 116
 117   /** Called when the badguy collided with a bullet */
 118   virtual HitResponse collision_bullet(Bullet& bullet, const CollisionHit& hit);
 119
 120   /** called each frame when the badguy is activated. */
 121   virtual void active_update(float elapsed_time);
 122   /** called each frame when the badguy is not activated. */
 123   virtual void inactive_update(float elapsed_time);
 124
 125   /**
 126    * called when the badguy has been activated. (As a side effect the dir
 127    * variable might have been changed so that it faces towards the player.
 128    */
 129   virtual void activate();
 130   /** called when the badguy has been deactivated */
 131   virtual void deactivate();
 132
 133   void kill_squished(Player& player);
 134
 135   void set_state(State state);
 136   State get_state() const
 137   { return state; }
 138
 139   /**
 140    * returns a pointer to the nearest player or 0 if no player is available
 141    */
 142   Player* get_nearest_player();
 143
 144   Physic physic;
 145
 146   /// is the enemy activated
 147   bool activated;
 148   /**
 149    * initial position of the enemy. Also the position where enemy respawns when
 150    * after being deactivated.
 151    */
 152   bool is_offscreen();
 153   /**
 154    *  Returns true if we might soon fall at least @c height pixels. Minimum
 155    *  value for height is 1 pixel
 156    */
 157   bool might_fall(int height = 1);
 158
 159   Vector start_position;
 160
 161   /**
 162    * The direction we currently face in
 163    */
 164   Direction dir;
 165
 166   /**
 167    * The direction we initially faced in
 168    */
 169   Direction start_dir;
 170
 171   /**
 172    *  Get Direction from String.
 173    */
 174   Direction str2dir( std::string dir_str );
 175
 176   /**
 177    * Update on_ground_flag judging by solid collision @c hit.
 178    * This gets called from the base implementation of collision_solid, so call this when overriding collision_solid's default behaviour.
 179    */
 180   void update_on_ground_flag(const CollisionHit& hit);
 181
 182   /**
 183    * Returns true if we touched ground in the past frame
 184    * This only works if update_on_ground_flag() gets called in collision_solid.
 185    */
 186   bool on_ground();
 187
 188 private:
 189   void try_activate();
 190
 191   State state;
 192   Timer state_timer;
 193   bool on_ground_flag;
 194 };
 195
 196 #endif
 197