4 // Copyright (C) 2006 Matthias Braun <matze@braunis.de>
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.
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.
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.
23 // moved them here to make it less typing when implementing new badguys
26 #include "object/moving_sprite.hpp"
28 #include "object/player.hpp"
29 #include "serializable.hpp"
30 #include "resources.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"
41 class BadGuy : public MovingSprite, protected UsesPhysic, public Serializable
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);
48 /** Called when the badguy is drawn. The default implementation simply draws
49 * the badguy sprite on screen
51 virtual void draw(DrawingContext& context);
52 /** Called each frame. The default implementation checks badguy state and
53 * calls active_update and inactive_update
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
60 virtual HitResponse collision(GameObject& other, const CollisionHit& hit);
62 /** Called when a collision with tile with special attributes occured */
63 virtual void collision_tile(uint32_t tile_attributes);
65 /** Set the badguy to kill/falling state, which makes him falling of the
66 * screen (his sprite is turned upside-down)
68 virtual void kill_fall();
70 /** Writes out the badguy into the included lisp::Writer. Useful e.g. when
71 * converting an old-format level to the new format.
73 virtual void save(lisp::Writer& writer);
76 * True if this badguy can break bricks or open bonusblocks in his current form.
78 virtual bool can_break()
83 Vector get_start_position() const
85 return start_position;
87 void set_start_position(const Vector& vec)
92 /** Count this badguy to the statistics? This value should not be changed
97 * Called when hit by a fire bullet, and is_flammable() returns true
99 virtual void ignite();
102 * Called to revert a badguy when is_ignited() returns true
104 virtual void extinguish();
107 * Returns whether to call ignite() when a badguy gets hit by a fire bullet
109 virtual bool is_flammable() const;
112 * Returns whether this badguys is currently on fire
114 bool is_ignited() const;
117 * Called when hit by an ice bullet, and is_freezable() returns true.
119 virtual void freeze();
122 * Called to unfreeze the badguy.
124 virtual void unfreeze();
126 virtual bool is_freezable() const;
128 bool is_frozen() const;
139 /** Called when the badguy collided with a player */
140 virtual HitResponse collision_player(Player& player, const CollisionHit& hit);
141 /** Called when the badguy collided with solid ground */
142 virtual void collision_solid(const CollisionHit& hit);
143 /** Called when the badguy collided with another badguy */
144 virtual HitResponse collision_badguy(BadGuy& other, const CollisionHit& hit);
146 /** Called when the player hit the badguy from above. You should return true
147 * if the badguy was squished, false if squishing wasn't possible
149 virtual bool collision_squished(GameObject& object);
151 /** Called when the badguy collided with a bullet */
152 virtual HitResponse collision_bullet(Bullet& bullet, const CollisionHit& hit);
154 /** called each frame when the badguy is activated. */
155 virtual void active_update(float elapsed_time);
156 /** called each frame when the badguy is not activated. */
157 virtual void inactive_update(float elapsed_time);
160 * called when the badguy has been activated. (As a side effect the dir
161 * variable might have been changed so that it faces towards the player.
163 virtual void activate();
164 /** called when the badguy has been deactivated */
165 virtual void deactivate();
167 void kill_squished(GameObject& object);
169 void set_state(State state);
170 State get_state() const
174 * returns a pointer to the nearest player or 0 if no player is available
176 Player* get_nearest_player();
178 /// is the enemy activated
181 * initial position of the enemy. Also the position where enemy respawns when
182 * after being deactivated.
186 * Returns true if we might soon fall at least @c height pixels. Minimum
187 * value for height is 1 pixel
189 bool might_fall(int height = 1);
191 Vector start_position;
194 * The direction we currently face in
199 * The direction we initially faced in
204 * Get Direction from String.
206 Direction str2dir( std::string dir_str );
209 * Update on_ground_flag judging by solid collision @c hit.
210 * This gets called from the base implementation of collision_solid, so call this when overriding collision_solid's default behaviour.
212 void update_on_ground_flag(const CollisionHit& hit);
215 * Returns true if we touched ground in the past frame
216 * This only works if update_on_ground_flag() gets called in collision_solid.
221 * Returns floor normal stored the last time when update_on_ground_flag was called and we touched something solid from above.
223 Vector get_floor_normal();
226 bool ignited; /**< true if this badguy is currently on fire */
228 std::string dead_script; /**< script to execute when badguy is killed */
229 bool draw_dead_script_hint; /**< whether to draw a visual indication that this Badguy triggers a script */
236 bool on_ground_flag; /**< true if we touched something solid from above and update_on_ground_flag was called last frame */
237 Vector floor_normal; /**< floor normal stored the last time when update_on_ground_flag was called and we touched something solid from above */