X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=src%2Fobject%2Fdisplay_effect.hpp;h=3d6a8e4cf07cad6a59b8364b5d0f87b842e7a75c;hb=78ac7aef674f518549f96160c6354b589553f952;hp=0a858b773cbd5d0338daa63b4b07cafb43a2cfad;hpb=07ddaed2a657e4d2a3d038fed223fc5827159caf;p=supertux.git

diff --git a/src/object/display_effect.hpp b/src/object/display_effect.hpp
index 0a858b773..3d6a8e4cf 100644
--- a/src/object/display_effect.hpp
+++ b/src/object/display_effect.hpp
@@ -1,12 +1,10 @@
-//  $Id$
-//
 //  SuperTux
 //  Copyright (C) 2006 Matthias Braun <matze@braunis.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
@@ -14,51 +12,61 @@
 //  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 __OBJECT_DISPLAY_EFFECT_H__
-#define __OBJECT_DISPLAY_EFFECT_H__
+#ifndef HEADER_SUPERTUX_OBJECT_DISPLAY_EFFECT_HPP
+#define HEADER_SUPERTUX_OBJECT_DISPLAY_EFFECT_HPP
 
 #include "scripting/display_effect.hpp"
-#include "game_object.hpp"
-#include "script_interface.hpp"
+#include "supertux/game_object.hpp"
+#include "supertux/script_interface.hpp"
 
-class DisplayEffect : public GameObject, public Scripting::DisplayEffect,
+class DisplayEffect : public GameObject, 
+                      public Scripting::DisplayEffect,
                       public ScriptInterface
 {
 public:
-    DisplayEffect();
-    virtual ~DisplayEffect();
+  DisplayEffect(std::string name = "");
+  virtual ~DisplayEffect();
+
+  void expose(HSQUIRRELVM vm, SQInteger table_idx);
+  void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
 
-    void expose(HSQUIRRELVM vm, int table_idx);
-    void unexpose(HSQUIRRELVM vm, int table_idx);
+  void update(float elapsed_time);
+  void draw(DrawingContext& context);
 
-    void update(float elapsed_time);
-    void draw(DrawingContext& context);
+  /**
+   * @name Scriptable Methods
+   * @{
+   */
 
-    void fade_out(float fadetime);
-    void fade_in(float fadetime);
-    void set_black(bool enabled);
-    bool is_black();
-    void sixteen_to_nine(float fadetime);
-    void four_to_three(float fadetime);
+  void fade_out(float fadetime);
+  void fade_in(float fadetime);
+  void set_black(bool enabled);
+  bool is_black();
+  void sixteen_to_nine(float fadetime);
+  void four_to_three(float fadetime);
+
+  /**
+   * @}
+   */
 
 private:
-    enum FadeType {
-        NO_FADE, FADE_IN, FADE_OUT
-    };
-    FadeType screen_fade;
-    float screen_fadetime;
-    float screen_fading;
-    FadeType border_fade;
-    float border_fadetime;
-    float border_fading;
-    float border_size;
-    
-    bool black;
-    bool borders;
+  enum FadeType {
+    NO_FADE, FADE_IN, FADE_OUT
+  };
+  FadeType screen_fade;
+  float screen_fadetime;
+  float screen_fading;
+  FadeType border_fade;
+  float border_fadetime;
+  float border_fading;
+  float border_size;
+
+  bool black;
+  bool borders;
 };
 
 #endif
 
+/* EOF */