2 // Copyright (C) 2006 Matthias Braun <matze@braunis.de>
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.
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.
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/>.
17 #ifndef HEADER_SUPERTUX_OBJECT_DISPLAY_EFFECT_HPP
18 #define HEADER_SUPERTUX_OBJECT_DISPLAY_EFFECT_HPP
20 #include "scripting/display_effect.hpp"
21 #include "supertux/game_object.hpp"
22 #include "supertux/script_interface.hpp"
24 class DisplayEffect : public GameObject,
25 public scripting::DisplayEffect,
26 public ScriptInterface
29 DisplayEffect(const std::string& name = std::string());
30 virtual ~DisplayEffect();
32 void expose(HSQUIRRELVM vm, SQInteger table_idx);
33 void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
35 void update(float elapsed_time);
36 void draw(DrawingContext& context);
39 * @name Scriptable Methods
43 void fade_out(float fadetime);
44 void fade_in(float fadetime);
45 void set_black(bool enabled);
47 void sixteen_to_nine(float fadetime);
48 void four_to_three(float fadetime);
56 NO_FADE, FADE_IN, FADE_OUT
59 float screen_fadetime;
62 float border_fadetime;