src/badguy/badguy.hpp

   1 //  $Id$
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2005 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
  19 //  02111-1307, USA.
  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 "moving_object.hpp"
  27 #include "sprite/sprite.hpp"
  28 #include "physic.hpp"
  29 #include "object/player.hpp"
  30 #include "serializable.hpp"
  31 #include "resources.hpp"
  32 #include "sector.hpp"
  33 #include "direction.hpp"
  34 #include "object_factory.hpp"
  35 #include "lisp/parser.hpp"
  36 #include "lisp/lisp.hpp"
  37 #include "lisp/writer.hpp"
  38 #include "video/drawing_context.hpp"
  39 #include "audio/sound_manager.hpp"
  40 #include "audio/sound_source.hpp"
  41 #include "sprite/sprite_manager.hpp"
  42
  43 class BadGuy : public MovingObject, public Serializable
  44 {
  45 public:
  46   BadGuy();
  47   ~BadGuy();
  48
  49   /** Called when the badguy is drawn. The default implementation simply draws
  50    * the badguy sprite on screen
  51    */
  52   virtual void draw(DrawingContext& context);
  53   /** Called each frame. The default implementation checks badguy state and
  54    * calls active_update and inactive_update
  55    */
  56   virtual void update(float elapsed_time);
  57   /** Called when a collision with another object occured. The default
  58    * implemetnation calls collision_player, collision_solid, collision_badguy
  59    * and collision_squished
  60    */
  61   virtual HitResponse collision(GameObject& other,
  62       const CollisionHit& hit);
  63
  64   /** Set the badguy to kill/falling state, which makes him falling of the
  65    * screen (his sprite is turned upside-down)
  66    */
  67   virtual void kill_fall();
  68
  69   /** Writes out the badguy into the included lisp::Writer. Useful e.g. when
  70    * converting an old-format level to the new format.
  71    */
  72   virtual void save(lisp::Writer& );
  73
  74   Vector get_start_position() const
  75   {
  76     return start_position;
  77   }
  78   void set_start_position(const Vector& vec)
  79   {
  80     start_position = vec;
  81   }
  82
  83   /** Count this badguy to the statistics? This value should not be changed
  84    * during runtime. */
  85   bool countMe;
  86
  87 protected:
  88   enum State {
  89     STATE_INIT,
  90     STATE_INACTIVE,
  91     STATE_ACTIVE,
  92     STATE_SQUISHED,
  93     STATE_FALLING
  94   };
  95
  96   /** Called when the badguy collided with a player */
  97   virtual HitResponse collision_player(Player& player,
  98       const CollisionHit& hit);
  99   /** Called when the badguy collided with solid ground */
 100   virtual HitResponse collision_solid(GameObject& other,
 101       const CollisionHit& hit);
 102   /** Called when the badguy collided with another badguy */
 103   virtual HitResponse collision_badguy(BadGuy& other,
 104       const CollisionHit& hit);
 105
 106   /** Called when the player hit the badguy from above. You should return true
 107    * if the badguy was squished, false if squishing wasn't possible
 108    */
 109   virtual bool collision_squished(Player& player);
 110
 111   /** called each frame when the badguy is activated. */
 112   virtual void active_update(float elapsed_time);
 113   /** called each frame when the badguy is not activated. */
 114   virtual void inactive_update(float elapsed_time);
 115
 116   /**
 117    * called when the badguy has been activated. (As a side effect the dir
 118    * variable might have been changed so that it faces towards the player.
 119    */
 120   virtual void activate();
 121   /** called when the badguy has been deactivated */
 122   virtual void deactivate();
 123
 124   void kill_squished(Player& player);
 125
 126   void set_state(State state);
 127   State get_state() const
 128   { return state; }
 129
 130   /**
 131    * returns a pointer to the player, try to avoid this function to avoid
 132    * problems later when we have multiple players or no player in scripted
 133    * sequence.
 134    */
 135   Player* get_player();
 136
 137   Sprite* sprite;
 138   Physic physic;
 139
 140   /// is the enemy activated
 141   bool activated;
 142   /**
 143    * initial position of the enemy. Also the position where enemy respawns when
 144    * after being deactivated.
 145    */
 146   bool is_offscreen();
 147
 148   Vector start_position;
 149
 150   Direction dir;
 151 private:
 152   void try_activate();
 153
 154   State state;
 155   Timer state_timer;
 156 };
 157
 158 #endif
 159