src/object/thunderstorm.hpp

   1 //  $Id$
   2 //
   3 //  SuperTux - Thunderstorm Game Object
   4 //  Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.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 __THUNDERSTORM_H__
  21 #define __THUNDERSTORM_H__
  22
  23 #include "game_object.hpp"
  24 #include "timer.hpp"
  25 #include "lisp/lisp.hpp"
  26 #include "scripting/thunderstorm.hpp"
  27 #include "script_interface.hpp"
  28
  29 /**
  30  * Thunderstorm scriptable GameObject; plays thunder, lightning and electrifies water at regular interval
  31  */
  32 class Thunderstorm : public GameObject, public ScriptInterface
  33 {
  34 public:
  35     Thunderstorm(const lisp::Lisp& reader);
  36
  37     void update(float elapsed_time);
  38     void draw(DrawingContext& context);
  39
  40     virtual void expose(HSQUIRRELVM vm, SQInteger table_idx);
  41     virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
  42
  43     /**
  44      * Start playing thunder and lightning at configured interval
  45      */
  46     void start();
  47
  48     /**
  49      * Stop playing thunder and lightning at configured interval
  50      */
  51     void stop();
  52
  53     /**
  54      * Play thunder
  55      */
  56     void thunder();
  57
  58     /**
  59      * Play lightning, i.e. call flash() and electrify()
  60      */
  61     void lightning();
  62
  63     /**
  64      * Display a nice flash
  65      */
  66     void flash();
  67
  68     /**
  69      * Electrify water throughout the whole sector for a short time
  70      */
  71     void electrify();
  72
  73 private:
  74     std::string name; /**< user-defined name for use in scripts or empty string if not scriptable */
  75     bool running; /**< whether we currently automatically trigger lightnings */
  76     float interval; /**< time between two lightnings */
  77
  78     Timer time_to_thunder; /**< counts down until next thunder */
  79     Timer time_to_lightning; /**< counts down until next lightning */
  80     Timer flash_display_timer; /**< counts down while flash is displayed */
  81 };
  82
  83 #endif
  84