-// $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
// 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(std::string name = "");
- virtual ~DisplayEffect();
+ DisplayEffect(const std::string& name = std::string());
+ virtual ~DisplayEffect();
+
+ void expose(HSQUIRRELVM vm, SQInteger table_idx);
+ void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
+
+ void update(float elapsed_time);
+ void draw(DrawingContext& context);
- void expose(HSQUIRRELVM vm, SQInteger table_idx);
- void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
+ /**
+ * @name Scriptable Methods
+ * @{
+ */
- void update(float elapsed_time);
- void draw(DrawingContext& context);
+ 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 */