4754e279fe8650b8134d382ce60ae312ac79870d
[supertux.git] / src / worldmap / sprite_change.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 #ifndef __WORLDMAP_SPRITE_CHANGE_HPP__
20 #define __WORLDMAP_SPRITE_CHANGE_HPP__
21
22 #include <string>
23 #include <memory>
24 #include <list>
25 #include "game_object.hpp"
26 #include "lisp/lisp.hpp"
27 #include "math/vector.hpp"
28
29 class Sprite;
30
31 namespace WorldMapNS
32 {
33
34 class SpriteChange : public GameObject
35 {
36 public:
37   SpriteChange(const lisp::Lisp* lisp);
38   virtual ~SpriteChange();
39
40   Vector pos;
41   /**
42    * should tuxs sprite change when the tile has been completely entered,
43    * or already when the tile was just touched
44    */
45   bool change_on_touch;
46   /// sprite to change tux image to
47   std::auto_ptr<Sprite> sprite;
48   /**
49    * stay action can be used for objects like boats or cars, if it is
50    * != "" then this sprite will be displayed when tux left the tile towards
51    * another SpriteChange object.
52    */
53   std::string stay_action;
54
55   /**
56    * name of a group in which only one SpriteChange will ever have its stay_action displayed.
57    * Leave empty if you don't care.
58    */
59   std::string stay_group;
60
61   virtual void draw(DrawingContext& context);
62   virtual void update(float elapsed_time);
63
64   /**
65    * Activates the SpriteChange's stay action, if applicable
66    */
67   void set_stay_action();
68
69   /**
70    * Deactivates the SpriteChange's stay action, if applicable
71    */
72   void clear_stay_action();
73
74 private:
75   /**
76    * should the stayaction be displayed
77    */
78   bool in_stay_action;
79
80   static std::list<SpriteChange*> all_sprite_changes;
81
82 };
83
84 }
85
86 #endif