f5e1d245e41491f41ada3139c2424cdc13d60b14
[supertux.git] / src / object / platform.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
20 #ifndef __PLATFORM_H__
21 #define __PLATFORM_H__
22
23 #include <memory>
24 #include <string>
25 #include "object/moving_sprite.hpp"
26 #include "object/path.hpp"
27 #include "object/path_walker.hpp"
28 #include "script_interface.hpp"
29
30 /**
31  * This class is the base class for platforms that tux can stand on
32  */
33 class Platform : public MovingSprite, public ScriptInterface
34 {
35 public:
36   Platform(const lisp::Lisp& reader);
37   Platform(const Platform& platform);
38   virtual Platform* clone() const { return new Platform(*this); }
39
40   virtual HitResponse collision(GameObject& other, const CollisionHit& hit);
41   virtual void update(float elapsed_time);
42   const Vector& get_speed() const
43   {
44     return speed;
45   }
46
47   /** Move platform until at given node, then stop */
48   void goto_node(int node_no);
49
50   /** Start moving platform */
51   void start_moving();
52
53   /** Stop platform at next node */
54   void stop_moving();
55
56   virtual void expose(HSQUIRRELVM vm, SQInteger table_idx);
57   virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
58
59   Path& get_path() {
60     return *path.get();
61   }
62
63 private:
64   std::string name; /**< user-defined name for use in scripts or empty string if not scriptable */
65   std::auto_ptr<Path> path;
66   std::auto_ptr<PathWalker> walker;
67   Vector speed;
68
69 };
70
71 #endif
72