Removed trailing whitespace from all *.?pp files
[supertux.git] / src / object / thunderstorm.hpp
index 804312f..d0e481c 100644 (file)
@@ -1,12 +1,10 @@
-//  $Id$
-//
 //  SuperTux - Thunderstorm Game Object
 //  Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.de>
 //
-//  This program is free software; you can redistribute it and/or
-//  modify it under the terms of the GNU General Public License
-//  as published by the Free Software Foundation; either version 2
-//  of the License, or (at your option) any later version.
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
 //
 //  This program is distributed in the hope that it will be useful,
 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
 //  GNU General Public License for more details.
 //
 //  You should have received a copy of the GNU General Public License
-//  along with this program; if not, write to the Free Software
-//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-#ifndef __THUNDERSTORM_H__
-#define __THUNDERSTORM_H__
+#ifndef HEADER_SUPERTUX_OBJECT_THUNDERSTORM_HPP
+#define HEADER_SUPERTUX_OBJECT_THUNDERSTORM_HPP
 
-#include "game_object.hpp"
-#include "timer.hpp"
-#include "lisp/lisp.hpp"
+#include "util/reader_fwd.hpp"
 #include "scripting/thunderstorm.hpp"
-#include "script_interface.hpp"
+#include "supertux/game_object.hpp"
+#include "supertux/script_interface.hpp"
+#include "supertux/timer.hpp"
+#include "video/drawing_context.hpp"
 
 /**
  * Thunderstorm scriptable GameObject; plays thunder, lightning and electrifies water at regular interval
  */
-class Thunderstorm : public GameObject, public Scripting::Thunderstorm, public ScriptInterface
+class Thunderstorm : public GameObject,
+                     public ScriptInterface
 {
 public:
-    Thunderstorm(const lisp::Lisp& reader);
-
-    void update(float elapsed_time);
-    void draw(DrawingContext& context);
-
-    virtual void expose(HSQUIRRELVM vm, SQInteger table_idx);
-    virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
-
-    /**
-     * Start playing thunder and lightning at configured interval
-     */
-    void start();
-    
-    /**
-     * Stop playing thunder and lightning at configured interval
-     */
-    void stop();
-
-    /**
-     * Play thunder
-     */
-    void thunder();
-
-    /**
-     * Play lightning, i.e. call flash() and electrify()
-     */
-    void lightning();
-
-    /**
-     * Display a nice flash
-     */
-    void flash();
-
-    /**
-     * Electrify water throughout the whole sector for a short time
-     */
-    void electrify();
+  Thunderstorm(const Reader& reader);
+
+  void update(float elapsed_time);
+  void draw(DrawingContext& context);
+
+  virtual void expose(HSQUIRRELVM vm, SQInteger table_idx);
+  virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
+
+  /**
+   * @name Scriptable Methods
+   * @{
+   */
+
+  /**
+   * Start playing thunder and lightning at configured interval
+   */
+  void start();
+
+  /**
+   * Stop playing thunder and lightning at configured interval
+   */
+  void stop();
+
+  /**
+   * Play thunder
+   */
+  void thunder();
+
+  /**
+   * Play lightning, i.e. call flash() and electrify()
+   */
+  void lightning();
+
+  /**
+   * Display a nice flash
+   */
+  void flash();
+
+  /**
+   * Electrify water throughout the whole sector for a short time
+   */
+  void electrify();
+
+  /**
+   * @}
+   */
 
 private:
-    std::string name; /**< user-defined name for use in scripts or empty string if not scriptable */
-    bool running; /**< whether we currently automatically trigger lightnings */
-    float interval; /**< time between two lightnings */
-    
-    Timer time_to_thunder; /**< counts down until next thunder */
-    Timer time_to_lightning; /**< counts down until next lightning */
-    Timer flash_display_timer; /**< counts down while flash is displayed */
+  bool running; /**< whether we currently automatically trigger lightnings */
+  float interval; /**< time between two lightnings */
+  int layer; /**< layer, where flash will be painted */
+
+  Timer time_to_thunder; /**< counts down until next thunder */
+  Timer time_to_lightning; /**< counts down until next lightning */
+  Timer flash_display_timer; /**< counts down while flash is displayed */
 };
 
 #endif
 
+/* EOF */