src/object/thunderstorm.hpp

   1 //  SuperTux - Thunderstorm Game Object
   2 //  Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.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_OBJECT_THUNDERSTORM_HPP
  18 #define HEADER_SUPERTUX_OBJECT_THUNDERSTORM_HPP
  19
  20 #include "util/reader_fwd.hpp"
  21 #include "scripting/thunderstorm.hpp"
  22 #include "supertux/game_object.hpp"
  23 #include "supertux/script_interface.hpp"
  24 #include "supertux/timer.hpp"
  25 #include "video/drawing_context.hpp"
  26
  27 /**
  28  * Thunderstorm scriptable GameObject; plays thunder, lightning and electrifies water at regular interval
  29  */
  30 class Thunderstorm : public GameObject,
  31                      public ScriptInterface
  32 {
  33 public:
  34   Thunderstorm(const Reader& reader);
  35
  36   void update(float elapsed_time);
  37   void draw(DrawingContext& context);
  38
  39   virtual void expose(HSQUIRRELVM vm, SQInteger table_idx);
  40   virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
  41
  42   /**
  43    * @name Scriptable Methods
  44    * @{
  45    */
  46
  47   /**
  48    * Start playing thunder and lightning at configured interval
  49    */
  50   void start();
  51
  52   /**
  53    * Stop playing thunder and lightning at configured interval
  54    */
  55   void stop();
  56
  57   /**
  58    * Play thunder
  59    */
  60   void thunder();
  61
  62   /**
  63    * Play lightning, i.e. call flash() and electrify()
  64    */
  65   void lightning();
  66
  67   /**
  68    * Display a nice flash
  69    */
  70   void flash();
  71
  72   /**
  73    * Electrify water throughout the whole sector for a short time
  74    */
  75   void electrify();
  76
  77   /**
  78    * @}
  79    */
  80
  81 private:
  82   bool running; /**< whether we currently automatically trigger lightnings */
  83   float interval; /**< time between two lightnings */
  84   int layer; /**< layer, where flash will be painted */
  85
  86   Timer time_to_thunder; /**< counts down until next thunder */
  87   Timer time_to_lightning; /**< counts down until next lightning */
  88   Timer flash_display_timer; /**< counts down while flash is displayed */
  89 };
  90
  91 #endif
  92
  93 /* EOF */