Added doxygen comments to core game code.
[supertux.git] / src / game_session.hpp
1 //  $Id$
2 //
3 //  SuperTux
4 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
5 //
6 //  This program is free software; you can redistribute it and/or
7 //  modify it under the terms of the GNU General Public License
8 //  as published by the Free Software Foundation; either version 2
9 //  of the License, or (at your option) any later version.
10 //
11 //  This program is distributed in the hope that it will be useful,
12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 //  GNU General Public License for more details.
15 //
16 //  You should have received a copy of the GNU General Public License
17 //  along with this program; if not, write to the Free Software
18 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19 #ifndef SUPERTUX_GAMELOOP_H
20 #define SUPERTUX_GAMELOOP_H
21
22 #include <string>
23 #include <SDL.h>
24 #include <squirrel.h>
25 #include "screen.hpp"
26 #include "math/vector.hpp"
27 #include "video/surface.hpp"
28 #include "object/endsequence.hpp"
29
30 class Level;
31 class Sector;
32 class Statistics;
33 class DrawingContext;
34 class CodeController;
35 class Menu;
36
37 /**
38  * Screen that runs a Level, where Players run and jump through Sectors.
39  */
40 class GameSession : public Screen
41 {
42 public:
43   GameSession(const std::string& levelfile, Statistics* statistics = NULL);
44   ~GameSession();
45
46   void record_demo(const std::string& filename);
47   int get_demo_random_seed(const std::string& filename);
48   void play_demo(const std::string& filename);
49
50   void draw(DrawingContext& context);
51   void update(float frame_ratio);
52   void setup();
53
54   void set_current()
55   { current_ = this; }
56   static GameSession* current()
57   { return current_; }
58
59   /// ends the current level
60   void finish(bool win = true);
61   void respawn(const std::string& sectorname, const std::string& spawnpointname);
62   void set_reset_point(const std::string& sectorname, const Vector& pos);
63   std::string get_reset_point_sectorname()
64   { return reset_sector; }
65
66   Vector get_reset_point_pos()
67   { return reset_pos; }
68
69   void display_info_box(const std::string& text);
70
71   Sector* get_current_sector()
72   { return currentsector; }
73
74   Level* get_current_level()
75   { return level.get(); }
76
77   void start_sequence(const std::string& sequencename);
78
79   /**
80    * returns the "working directory" usually this is the directory where the
81    * currently played level resides. This is used when locating additional
82    * resources for the current level/world
83    */
84   std::string get_working_directory();
85   void restart_level();
86
87   void toggle_pause();
88
89 private:
90   void check_end_conditions();
91   void process_events();
92   void capture_demo_step();
93
94   void levelintro();
95   void drawstatus(DrawingContext& context);
96   void draw_pause(DrawingContext& context);
97
98   HSQUIRRELVM run_script(std::istream& in, const std::string& sourcename);
99   void on_escape_press();
100   void process_menu();
101
102   std::auto_ptr<Level> level;
103   std::auto_ptr<Surface> statistics_backdrop;
104
105   // scripts
106   typedef std::vector<HSQOBJECT> ScriptList;
107   ScriptList scripts;
108
109   Sector* currentsector;
110
111   int levelnb;
112   int pause_menu_frame;
113
114   EndSequence* end_sequence;
115
116   bool  game_pause;
117   float speed_before_pause;
118
119   std::string levelfile;
120
121   // reset point (the point where tux respawns if he dies)
122   std::string reset_sector;
123   Vector reset_pos;
124
125   // the sector and spawnpoint we should spawn after this frame
126   std::string newsector;
127   std::string newspawnpoint;
128
129   static GameSession* current_;
130
131   Statistics* best_level_statistics;
132
133   std::ostream* capture_demo_stream;
134   std::string capture_file;
135   std::istream* playback_demo_stream;
136   CodeController* demo_controller;
137
138   std::auto_ptr<Menu> game_menu;
139
140   float play_time; /**< total time in seconds that this session ran interactively */
141 };
142
143 #endif /*SUPERTUX_GAMELOOP_H*/