docu improvement for Timer
[supertux.git] / src / gameloop.h
index 2a1ab16..1d01487 100644 (file)
-/*
-  gameloop.h
-  
-  Super Tux - Game Loop!
-  
-  by Bill Kendrick
-  bill@newbreedsoftware.com
-  http://www.newbreedsoftware.com/supertux/
-  
-  April 11, 2000 - Junuary 1st, 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.
 
-#if !defined( SUPERTUX_GAMELOOP_H )
-#define SUPERTUX_GAMELOOP_H 1
+#ifndef SUPERTUX_GAMELOOP_H
+#define SUPERTUX_GAMELOOP_H
 
-#include "sound.h"
-#include "type.h"
+#include "timer.h"
+#include "statistics.h"
 
-/* Bounciness of distros: */
+using namespace SuperTux;
 
-#define NO_BOUNCE 0
-#define BOUNCE 1
+/* GameLoop modes */
 
+#define ST_GL_PLAY 0
+#define ST_GL_TEST 1
+#define ST_GL_LOAD_GAME 2
+#define ST_GL_LOAD_LEVEL_FILE  3
+#define ST_GL_DEMO_GAME  4
 
-/* One-ups... */
+enum GameMenuIDs {
+  MNID_CONTINUE,
+  MNID_ABORTLEVEL
+  };
 
-#define DISTROS_LIFEUP 100
+extern int game_started;
 
+class Level;
+class Sector;
+class Statistics;
 
-/* Upgrade types: */
+namespace SuperTux {
+class DrawingContext;
+}
 
-enum {
-  UPGRADE_MINTS,
-  UPGRADE_COFFEE,
-  UPGRADE_HERRING
-};
+/** 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:
+  Uint32 fps_ticks;
+  Timer2 endsequence_timer;
+  Level* level;
+  Sector* currentsector;
+
+  int st_gl_mode;
+  int levelnb;
+  float fps_fps;
+  int pause_menu_frame;
+
+  /** 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;
 
-/* Scores: */
+  std::string levelname;
+  bool flip_level;
 
-#define SCORE_BRICK 5
-#define SCORE_DISTRO 25
+  // the sector and spawnpoint we shoudl spawn after this frame
+  std::string newsector;
+  std::string newspawnpoint;
 
-/* Function prototypes: */
+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();
+
+  void draw();
+  void action(float frame_ratio);
+
+  void set_current()
+  { current_ = this; }
+  static GameSession* current() { return current_; }
+
+  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);
 
-int gameloop(void);
-void savegame(void);
-void loadgame(char* filename);
-int issolid(float x, float y);
-int isbrick(float x, float y);
-int isice(float x, float y);
-int isfullbox(float x, float y);
-int rectcollision(base_type* one, base_type* two);
-void drawshape(float x, float y, unsigned char c);
-unsigned char shape(float x, float y);
 void bumpbrick(float x, float y);
-void trygrabdistro(float x, float y, int bounciness);
-void trybreakbrick(float x, float y);
-void tryemptybox(float x, float y);
-void trybumpbadguy(float x, float y);
-void add_bouncy_distro(float x, float y);
-void add_broken_brick(float x, float y);
-void add_broken_brick_piece(float x, float y, float xm, float ym);
-void add_bouncy_brick(float x, float y);
-void add_bad_guy(float x, float y, int kind);
-void add_upgrade(float x, float y, int kind);
-void add_bullet(float x, float y, float xm, int dir);
-#endif
+
+/** Return true if the gameloop() was entered, false otherwise */
+bool process_load_game_menu();
+
+#endif /*SUPERTUX_GAMELOOP_H*/