src/scripting/tilemap.hpp

   1 //  SuperTux
   2 //  Copyright (C) 2006 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_TILEMAP_HPP
  18 #define HEADER_SUPERTUX_SCRIPTING_TILEMAP_HPP
  19
  20 #ifndef SCRIPTING_API
  21 class TileMap;
  22 typedef TileMap _TileMap;
  23 #endif
  24
  25 namespace Scripting {
  26
  27 class TileMap
  28 {
  29 public:
  30 #ifndef SCRIPTING_API
  31   TileMap(_TileMap* tilemap);
  32   ~TileMap();
  33 #endif
  34
  35   /** Move tilemap until at given node, then stop */
  36   void goto_node(int node_no);
  37
  38   /** Start moving tilemap */
  39   void start_moving();
  40
  41   /** Stop tilemap at next node */
  42   void stop_moving();
  43
  44   /**
  45    * Start fading the tilemap to opacity given by @c alpha.
  46    * Destination opacity will be reached after @c seconds seconds. Also influences solidity.
  47    */
  48   void fade(float alpha, float seconds);
  49
  50   /**
  51    * Instantly switch tilemap's opacity to @c alpha. Also influences solidity.
  52    */
  53   void set_alpha(float alpha);
  54
  55   /**
  56    * 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.
  57    */
  58   float get_alpha();
  59
  60 #ifndef SCRIPTING_API
  61   _TileMap* tilemap;
  62 #endif
  63 };
  64
  65 }
  66
  67 #endif
  68
  69 /* EOF */