src/scripting/willowisp.hpp

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