Applied sound pre-loading patch from mathnerd314 (#331)

[supertux.git] / src / badguy / badguy.hpp

diff --git a/src/badguy/badguy.hpp b/src/badguy/badguy.hpp
index cf0adc2..2af09d2 100644 (file)
--- a/src/badguy/badguy.hpp
+++ b/src/badguy/badguy.hpp
@@ -38,7 +38,10 @@
 #include "audio/sound_manager.hpp"
 #include "audio/sound_source.hpp"
 
-class BadGuy : public MovingSprite, public Serializable
+/**
+ * Base class for moving sprites that can hurt the Player.
+ */
+class BadGuy : public MovingSprite, protected UsesPhysic, public Serializable
 {
 public:
   BadGuy(const Vector& pos, const std::string& sprite_name, int layer = LAYER_OBJECTS);
@@ -66,11 +69,14 @@ public:
    * screen (his sprite is turned upside-down)
    */
   virtual void kill_fall();
+  
+  /** Call this, if you use custom kill_fall() or kill_squashed(GameObject& object) */
+  virtual void run_dead_script();
 
   /** Writes out the badguy into the included lisp::Writer. Useful e.g. when
    * converting an old-format level to the new format.
    */
-  virtual void save(lisp::Writer& writer);
+  virtual void write(lisp::Writer& writer);
 
   /**
    * True if this badguy can break bricks or open bonusblocks in his current form.
@@ -107,7 +113,7 @@ public:
    * Returns whether to call ignite() when a badguy gets hit by a fire bullet
    */
   virtual bool is_flammable() const;
-  
+
   /**
    * Returns whether this badguys is currently on fire
    */
@@ -146,7 +152,7 @@ protected:
   /** Called when the player hit the badguy from above. You should return true
    * if the badguy was squished, false if squishing wasn't possible
    */
-  virtual bool collision_squished(Player& player);
+  virtual bool collision_squished(GameObject& object);
 
   /** Called when the badguy collided with a bullet */
   virtual HitResponse collision_bullet(Bullet& bullet, const CollisionHit& hit);
@@ -156,6 +162,9 @@ protected:
   /** called each frame when the badguy is not activated. */
   virtual void inactive_update(float elapsed_time);
 
+  bool is_initialized; /**< true if initialize() has already been called */
+  /** called immediately before the first call to initialize */
+  virtual void initialize();
   /**
    * called when the badguy has been activated. (As a side effect the dir
    * variable might have been changed so that it faces towards the player.
@@ -164,7 +173,7 @@ protected:
   /** called when the badguy has been deactivated */
   virtual void deactivate();
 
-  void kill_squished(Player& player);
+  void kill_squished(GameObject& object);
 
   void set_state(State state);
   State get_state() const
@@ -175,10 +184,6 @@ protected:
    */
   Player* get_nearest_player();
 
-  Physic physic;
-
-  /// is the enemy activated
-  bool activated;
   /**
    * initial position of the enemy. Also the position where enemy respawns when
    * after being deactivated.
@@ -219,15 +224,33 @@ protected:
    */
   bool on_ground();
 
+  /**
+   * Returns floor normal stored the last time when update_on_ground_flag was called and we touched something solid from above.
+   */
+  Vector get_floor_normal();
+
   bool frozen;
   bool ignited; /**< true if this badguy is currently on fire */
 
+  std::string dead_script; /**< script to execute when badguy is killed */
+
+  /**
+   * Returns true if we were in STATE_ACTIVE at the beginning of the last call to update()
+   */
+  bool is_active();
+
+  void set_colgroup_active(CollisionGroup group); /**< changes colgroup_active. Also calls set_group when badguy is in STATE_ACTIVE */
+
 private:
   void try_activate();
 
   State state;
+  bool is_active_flag; /**< true if state was STATE_ACTIVE at the beginning of the last call to update() */
   Timer state_timer;
-  bool on_ground_flag;
+  bool on_ground_flag; /**< true if we touched something solid from above and update_on_ground_flag was called last frame */
+  Vector floor_normal; /**< floor normal stored the last time when update_on_ground_flag was called and we touched something solid from above */
+  CollisionGroup colgroup_active; /**< CollisionGroup the badguy should be in while active */
+
 };
 
 #endif