src/scripting/thunderstorm.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_THUNDERSTORM_HPP
  18 #define HEADER_SUPERTUX_SCRIPTING_THUNDERSTORM_HPP
  19
  20 #ifndef SCRIPTING_API
  21 class Thunderstorm;
  22 typedef Thunderstorm _Thunderstorm;
  23 #endif
  24
  25 namespace Scripting {
  26
  27 class Thunderstorm
  28 {
  29 public:
  30 #ifndef SCRIPTING_API
  31   Thunderstorm(_Thunderstorm* thunderstorm);
  32   ~Thunderstorm();
  33 #endif
  34
  35   /**
  36    * Start playing thunder and lightning at configured interval
  37    */
  38   void start();
  39
  40   /**
  41    * Stop playing thunder and lightning at configured interval
  42    */
  43   void stop();
  44
  45   /**
  46    * Play thunder
  47    */
  48   void thunder();
  49
  50   /**
  51    * Play lightning, i.e. call flash() and electrify()
  52    */
  53   void lightning();
  54
  55   /**
  56    * Display a nice flash
  57    */
  58   void flash();
  59
  60   /**
  61    * Electrify water throughout the whole sector for a short time
  62    */
  63   void electrify();
  64
  65 #ifndef SCRIPTING_API
  66   _Thunderstorm* thunderstorm;
  67 #endif
  68 };
  69
  70 }
  71
  72 #endif
  73
  74 /* EOF */