docu improvement for Timer

[supertux.git] / src / gameloop.h

diff --git a/src/gameloop.h b/src/gameloop.h
index 542b7b1..1d01487 100644 (file)
--- a/src/gameloop.h
+++ b/src/gameloop.h
@@ -1,21 +1,31 @@
-/*
-  gameloop.h
-  
-  Super Tux - Game Loop!
-  
-  by Bill Kendrick & Tobias Glaesser <tobi.web@gmx.de>
-  bill@newbreedsoftware.com
-  http://www.newbreedsoftware.com/supertux/
-  
-  April 11, 2000 - March 15, 2004
-*/
+//  $Id$
+// 
+//  SuperTux
+//  Copyright (C) 2004 Bill Kendrick <bill@newbreedsoftware.com>
+//                     Tobias Glaesser <tobi.web@gmx.de>
+//                     Ingo Ruhnke <grumbel@gmx.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 distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  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.
 
 #ifndef SUPERTUX_GAMELOOP_H
 #define SUPERTUX_GAMELOOP_H
 
-#include "sound.h"
-#include "type.h"
-#include "level.h"
+#include "timer.h"
+#include "statistics.h"
+
+using namespace SuperTux;
 
 /* GameLoop modes */
 
@@ -23,42 +33,119 @@
 #define ST_GL_TEST 1
 #define ST_GL_LOAD_GAME 2
 #define ST_GL_LOAD_LEVEL_FILE  3
+#define ST_GL_DEMO_GAME  4
 
-// FIXME: Make this local to the gamesession
-extern Level current_level;
+enum GameMenuIDs {
+  MNID_CONTINUE,
+  MNID_ABORTLEVEL
+  };
 
 extern int game_started;
 
+class Level;
+class Sector;
+class Statistics;
+
+namespace SuperTux {
+class DrawingContext;
+}
+
+/** The GameSession class controlls the controll flow of a World, ie.
+    present the menu on specifc keypresses, render and update it while
+    keeping the speed and framerate sane, etc. */
 class GameSession
 {
- private:
-    timer_type fps_timer, frame_timer;
- public:
-  GameSession(const char * subset, int levelnb, int mode);
-  int run();
-};
+private:
+  Uint32 fps_ticks;
+  Timer2 endsequence_timer;
+  Level* level;
+  Sector* currentsector;
 
-void  activate_bad_guys(Level* plevel);
-void  savegame(int slot);
-void  loadgame(int slot);
-std::string slotinfo(int slot);
+  int st_gl_mode;
+  int levelnb;
+  float fps_fps;
+  int pause_menu_frame;
 
-bool  rectcollision(base_type* one, base_type* two);
-void  drawshape(float x, float y, unsigned int c, Uint8 alpha = 255);
-void bumpbrick(float x, float y);
+  /** If true the end_sequence will be played, user input will be
+      ignored while doing that */
+  enum EndSequenceState {
+    NO_ENDSEQUENCE,
+    ENDSEQUENCE_RUNNING, // tux is running right
+    ENDSEQUENCE_WAITING  // waiting for the end of the music
+  };
+  EndSequenceState end_sequence;
+  float last_x_pos;
+
+  bool game_pause;
+
+  std::string levelname;
+  bool flip_level;
+
+  // the sector and spawnpoint we shoudl spawn after this frame
+  std::string newsector;
+  std::string newspawnpoint;
+
+public:
+  enum ExitStatus { ES_NONE, ES_LEVEL_FINISHED, ES_GAME_OVER, ES_LEVEL_ABORT };
+private:
+  ExitStatus exit_status;
+public:
+  DrawingContext* context;
+  Timer2 time_left;
+
+  GameSession(const std::string& level, int mode, bool flip_level_ = false, Statistics* statistics = NULL);
+  ~GameSession();
+
+  /** Enter the busy loop */
+  ExitStatus run();
 
-/** Try to grab the coin at the given coordinates */
-void trygrabdistro(float x, float y, int bounciness);
+  void draw();
+  void action(float frame_ratio);
 
-/** Try to break the brick at the given coordinates */
-void trybreakbrick(float x, float y, bool small);
+  void set_current()
+  { current_ = this; }
+  static GameSession* current() { return current_; }
 
-/** Try to get the content out of a bonus box, thus emptying it */
-void tryemptybox(float x, float y, int col_side);
+  void respawn(const std::string& sectorname,
+      const std::string& spawnpointname);
+  Sector* get_current_sector()
+  { return currentsector; }
+
+  void start_sequence(const std::string& sequencename);
+  
+private:
+  static GameSession* current_;
+
+  // for cheating
+  std::string last_keys;
+
+  // swap points
+  Vector last_swap_point;
+  Statistics last_swap_stats;
+
+  Statistics* best_level_statistics;
+
+  void restart_level();
+
+  void check_end_conditions();
+  void start_timers();
+  void process_events();
+
+  void levelintro();
+  void drawstatus(DrawingContext& context);
+  void drawendscreen();
+  void drawresultscreen(void);
+
+  void on_escape_press();
+  void process_menu();
+};
+
+std::string slotinfo(int slot);
+
+void bumpbrick(float x, float y);
 
-/** Try to bumb a badguy that might we walking above Tux, thus shaking
-    the tile which the badguy is walking on an killing him this way */
-void trybumpbadguy(float x, float y);
+/** Return true if the gameloop() was entered, false otherwise */
+bool process_load_game_menu();
 
 #endif /*SUPERTUX_GAMELOOP_H*/