src/scripting/willowisp.hpp

   1 //  $Id$
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2007 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 __SCRIPTING_WILLOWISP_H__
  21 #define __SCRIPTING_WILLOWISP_H__
  22
  23 namespace Scripting
  24 {
  25
  26 class WillOWisp
  27 {
  28 public:
  29 #ifndef SCRIPTING_API
  30   virtual ~WillOWisp()
  31   {}
  32 #endif
  33
  34   /** Move willowisp to given node */
  35   virtual void goto_node(int node_no) = 0;
  36
  37   /** set willowisp state; can be:
  38    * -stopped          willowisp doesn't move
  39    * -move_path        willowisp moves along the path (call goto_node)
  40    * -move_path_track  willowisp moves along path but catches tux when he is near
  41    * -normal           "normal" mode starts tracking tux when he is near enough
  42    * -vanish           vanish
  43    */
  44   virtual void set_state(const std::string& state) = 0;
  45
  46   virtual void start_moving() = 0;
  47   virtual void stop_moving() = 0;
  48 };
  49
  50 }
  51
  52 #endif