src/scripting/tilemap.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 __SCRIPTING_TILEMAP_H__
  21 #define __SCRIPTING_TILEMAP_H__
  22
  23 #ifndef SCRIPTING_API
  24 class TileMap;
  25 typedef TileMap _TileMap;
  26 #endif
  27
  28 namespace Scripting
  29 {
  30
  31 class TileMap
  32 {
  33 public:
  34 #ifndef SCRIPTING_API
  35   TileMap(_TileMap* tilemap);
  36   ~TileMap();
  37 #endif
  38
  39   /** Move tilemap until at given node, then stop */
  40   void goto_node(int node_no);
  41
  42   /** Start moving tilemap */
  43   void start_moving();
  44
  45   /** Stop tilemap at next node */
  46   void stop_moving();
  47
  48   /**
  49    * Start fading the tilemap to opacity given by @c alpha.
  50    * Destination opacity will be reached after @c seconds seconds. Also influences solidity.
  51    */
  52   void fade(float alpha, float seconds);
  53
  54   /**
  55    * Instantly switch tilemap's opacity to @c alpha. Also influences solidity.
  56    */
  57   void set_alpha(float alpha);
  58
  59   /**
  60    * Return tilemap's opacity. Note that while the tilemap is fading in or out, this will return the current alpha value, not the target alpha.
  61    */
  62   float get_alpha();
  63
  64 #ifndef SCRIPTING_API
  65   _TileMap* tilemap;
  66 #endif
  67 };
  68
  69 }
  70
  71 #endif