Added support for setting up end sequence animations on levels.
[supertux.git] / src / gameloop.h
1 //  $Id$
2 // 
3 //  SuperTux
4 //  Copyright (C) 2004 Bill Kendrick <bill@newbreedsoftware.com>
5 //                     Tobias Glaesser <tobi.web@gmx.de>
6 //                     Ingo Ruhnke <grumbel@gmx.de>
7 //
8 //  This program is free software; you can redistribute it and/or
9 //  modify it under the terms of the GNU General Public License
10 //  as published by the Free Software Foundation; either version 2
11 //  of the License, or (at your option) any later version.
12 //
13 //  This program is distributed in the hope that it will be useful,
14 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
15 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 //  GNU General Public License for more details.
17 // 
18 //  You should have received a copy of the GNU General Public License
19 //  along with this program; if not, write to the Free Software
20 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21
22 #ifndef SUPERTUX_GAMELOOP_H
23 #define SUPERTUX_GAMELOOP_H
24
25 #include "special/timer.h"
26 #include "special/base.h"
27 #include "special/frame_rate.h"
28
29 using namespace SuperTux;
30
31 /* GameLoop modes */
32
33 #define ST_GL_PLAY 0
34 #define ST_GL_TEST 1
35 #define ST_GL_LOAD_GAME 2
36 #define ST_GL_LOAD_LEVEL_FILE  3
37 #define ST_GL_DEMO_GAME  4
38
39 enum GameMenuIDs {
40   MNID_CONTINUE,
41   MNID_ABORTLEVEL
42   };
43
44 extern int game_started;
45
46 class Level;
47 class Sector;
48 class Statistics;
49
50 namespace SuperTux {
51 class DrawingContext;
52 }
53
54 /** The GameSession class controlls the controll flow of a World, ie.
55     present the menu on specifc keypresses, render and update it while
56     keeping the speed and framerate sane, etc. */
57 class GameSession
58 {
59 private:
60   Timer fps_timer;
61   Timer frame_timer;
62   Timer endsequence_timer;
63   Level* level;
64   Sector* currentsector;
65
66   int st_gl_mode;
67   int levelnb;
68   float fps_fps;
69   FrameRate frame_rate;
70   int pause_menu_frame;
71
72   /** If true the end_sequence will be played, user input will be
73       ignored while doing that */
74   enum EndSequenceState {
75     NO_ENDSEQUENCE,
76     ENDSEQUENCE_RUNNING, // tux is running right
77     ENDSEQUENCE_WAITING  // waiting for the end of the music
78   };
79   EndSequenceState end_sequence;
80   float last_x_pos;
81
82   bool game_pause;
83
84   std::string levelname;
85   bool flip_level;
86
87   // the sector and spawnpoint we shoudl spawn after this frame
88   std::string newsector;
89   std::string newspawnpoint;
90
91 public:
92   enum ExitStatus { ES_NONE, ES_LEVEL_FINISHED, ES_GAME_OVER, ES_LEVEL_ABORT };
93 private:
94   ExitStatus exit_status;
95 public:
96   DrawingContext* context;
97   Timer time_left;
98
99   GameSession(const std::string& level, int mode, bool flip_level_ = false, Statistics* statistics = NULL);
100   ~GameSession();
101
102   /** Enter the busy loop */
103   ExitStatus run();
104
105   void draw();
106   void action(double frame_ratio);
107
108   void set_current()
109   { current_ = this; }
110   static GameSession* current() { return current_; }
111
112   void respawn(const std::string& sectorname,
113       const std::string& spawnpointname);
114   Sector* get_current_sector()
115   { return currentsector; }
116   
117 private:
118   static GameSession* current_;
119
120   // for cheating
121   std::string last_keys;
122   // for fire works
123   Timer random_timer;
124
125   void restart_level();
126
127   void check_end_conditions();
128   void start_timers();
129   void process_events();
130
131   void levelintro();
132   void drawstatus(DrawingContext& context);
133   void drawendscreen();
134   void drawresultscreen(void);
135
136   void on_escape_press();
137   void process_menu();
138
139   Statistics* best_level_statistics;
140 };
141
142 std::string slotinfo(int slot);
143
144 bool rectcollision(base_type* one, base_type* two);
145 void bumpbrick(float x, float y);
146
147 /** Return true if the gameloop() was entered, false otherwise */
148 bool process_load_game_menu();
149
150 #endif /*SUPERTUX_GAMELOOP_H*/
151