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