Merged changes from branches/supertux-milestone2-grumbel/ to trunk/supertux/
[supertux.git] / src / object / wind.hpp
1 //  SuperTux - Wind
2 //  Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.de>
3 //
4 //  This program is free software: you can redistribute it and/or modify
5 //  it under the terms of the GNU General Public License as published by
6 //  the Free Software Foundation, either version 3 of the License, or
7 //  (at your option) any later version.
8 //
9 //  This program is distributed in the hope that it will be useful,
10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 //  GNU General Public License for more details.
13 //
14 //  You should have received a copy of the GNU General Public License
15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
16
17 #ifndef HEADER_SUPERTUX_OBJECT_WIND_HPP
18 #define HEADER_SUPERTUX_OBJECT_WIND_HPP
19
20 #include "supertux/moving_object.hpp"
21 #include "supertux/script_interface.hpp"
22 #include "util/reader_fwd.hpp"
23
24 class Player;
25
26 /**
27  * Defines an area that will gently push Players in one direction
28  */
29 class Wind : public MovingObject, 
30              public ScriptInterface
31 {
32 public:
33   Wind(const Reader& reader);
34
35   void update(float elapsed_time);
36   void draw(DrawingContext& context);
37   HitResponse collision(GameObject& other, const CollisionHit& hit);
38
39   /**
40    * @name Scriptable Methods
41    * @{
42    */
43
44   /**
45    * start blowing
46    */
47   void start();
48
49   /**
50    * stop blowing
51    */
52   void stop();
53
54   /**
55    * @}
56    */
57
58   virtual void expose(HSQUIRRELVM vm, SQInteger table_idx);
59   virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
60
61 private:
62   bool blowing; /**< true if wind is currently switched on */
63   Vector speed;
64   float acceleration;
65
66   float elapsed_time; /**< stores last elapsed_time gotten at update() */
67 };
68
69 #endif
70
71 /* EOF */