src/game_session.cpp

   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 #include <config.h>
  20
  21 #include <fstream>
  22 #include <sstream>
  23 #include <cassert>
  24 #include <cstdio>
  25 #include <cstdlib>
  26 #include <cmath>
  27 #include <cstring>
  28 #include <cerrno>
  29 #include <unistd.h>
  30 #include <ctime>
  31 #include <stdexcept>
  32
  33 #include <SDL.h>
  34
  35 #include "game_session.hpp"
  36 #include "log.hpp"
  37 #include "worldmap/worldmap.hpp"
  38 #include "mainloop.hpp"
  39 #include "audio/sound_manager.hpp"
  40 #include "gui/menu.hpp"
  41 #include "sector.hpp"
  42 #include "level.hpp"
  43 #include "tile.hpp"
  44 #include "player_status.hpp"
  45 #include "object/particlesystem.hpp"
  46 #include "object/background.hpp"
  47 #include "object/gradient.hpp"
  48 #include "object/tilemap.hpp"
  49 #include "object/camera.hpp"
  50 #include "object/player.hpp"
  51 #include "object/level_time.hpp"
  52 #include "lisp/lisp.hpp"
  53 #include "lisp/parser.hpp"
  54 #include "resources.hpp"
  55 #include "statistics.hpp"
  56 #include "timer.hpp"
  57 #include "options_menu.hpp"
  58 #include "object/fireworks.hpp"
  59 #include "textscroller.hpp"
  60 #include "control/codecontroller.hpp"
  61 #include "control/joystickkeyboardcontroller.hpp"
  62 #include "main.hpp"
  63 #include "file_system.hpp"
  64 #include "gameconfig.hpp"
  65 #include "gettext.hpp"
  66 #include "console.hpp"
  67 #include "flip_level_transformer.hpp"
  68 #include "trigger/secretarea_trigger.hpp"
  69 #include "random_generator.hpp"
  70 #include "scripting/squirrel_util.hpp"
  71
  72 // the engine will be run with a logical framerate of 64fps.
  73 // We chose 64fps here because it is a power of 2, so 1/64 gives an "even"
  74 // binary fraction...
  75 static const float LOGICAL_FPS = 64.0;
  76
  77 enum GameMenuIDs {
  78   MNID_CONTINUE,
  79   MNID_ABORTLEVEL
  80 };
  81
  82 GameSession* GameSession::current_ = NULL;
  83
  84 GameSession::GameSession(const std::string& levelfile_, Statistics* statistics)
  85   : level(0), currentsector(0),
  86     end_sequence(NO_ENDSEQUENCE), end_sequence_controller(0),
  87     levelfile(levelfile_), best_level_statistics(statistics),
  88     capture_demo_stream(0), playback_demo_stream(0), demo_controller(0),
  89     play_time(0)
  90 {
  91   current_ = this;
  92   currentsector = NULL;
  93
  94   game_pause = false;
  95
  96   statistics_backdrop.reset(new Surface("images/engine/menu/score-backdrop.png"));
  97
  98   restart_level(true);
  99
 100   game_menu.reset(new Menu());
 101   game_menu->add_label(_("Pause"));
 102   game_menu->add_hl();
 103   game_menu->add_entry(MNID_CONTINUE, _("Continue"));
 104   game_menu->add_submenu(_("Options"), get_options_menu());
 105   game_menu->add_hl();
 106   game_menu->add_entry(MNID_ABORTLEVEL, _("Abort Level"));
 107 }
 108
 109 void
 110 GameSession::restart_level(bool fromBeginning)
 111 {
 112   game_pause   = false;
 113   end_sequence = NO_ENDSEQUENCE;
 114
 115   main_controller->reset();
 116
 117   currentsector = 0;
 118
 119   level.reset(new Level);
 120   level->load(levelfile);
 121   level->stats.total_coins = level->get_total_coins();
 122   level->stats.total_badguys = level->get_total_badguys();
 123   level->stats.total_secrets = level->get_total_count<SecretAreaTrigger>();
 124   level->stats.reset();
 125   if (!fromBeginning) level->stats.declare_invalid();
 126
 127   if (fromBeginning) reset_sector="";
 128   if(reset_sector != "") {
 129     currentsector = level->get_sector(reset_sector);
 130     if(!currentsector) {
 131       std::stringstream msg;
 132       msg << "Couldn't find sector '" << reset_sector << "' for resetting tux.";
 133       throw std::runtime_error(msg.str());
 134     }
 135     currentsector->activate(reset_pos);
 136   } else {
 137     currentsector = level->get_sector("main");
 138     if(!currentsector)
 139       throw std::runtime_error("Couldn't find main sector");
 140     currentsector->activate("main");
 141   }
 142
 143   //levelintro();
 144
 145   currentsector->play_music(LEVEL_MUSIC);
 146
 147   if(capture_file != "") {
 148     int newSeed=0;               // next run uses a new seed
 149     while (newSeed == 0)            // which is the next non-zero random num.
 150         newSeed = systemRandom.rand();
 151     config->random_seed = systemRandom.srand(newSeed);
 152     log_info << "Next run uses random seed " <<config->random_seed <<std::endl;
 153     record_demo(capture_file);
 154   }
 155 }
 156
 157 GameSession::~GameSession()
 158 {
 159   delete capture_demo_stream;
 160   delete playback_demo_stream;
 161   delete demo_controller;
 162
 163   delete end_sequence_controller;
 164
 165   current_ = NULL;
 166 }
 167
 168 void
 169 GameSession::record_demo(const std::string& filename)
 170 {
 171   delete capture_demo_stream;
 172
 173   capture_demo_stream = new std::ofstream(filename.c_str());
 174   if(!capture_demo_stream->good()) {
 175     std::stringstream msg;
 176     msg << "Couldn't open demo file '" << filename << "' for writing.";
 177     throw std::runtime_error(msg.str());
 178   }
 179   capture_file = filename;
 180
 181   char buf[30];                            // save the seed in the demo file
 182   snprintf(buf, sizeof(buf), "random_seed=%10d", config->random_seed);
 183   for (int i=0; i==0 || buf[i-1]; i++)
 184     capture_demo_stream->put(buf[i]);
 185 }
 186
 187 int
 188 GameSession::get_demo_random_seed(const std::string& filename)
 189 {
 190   std::istream* test_stream = new std::ifstream(filename.c_str());
 191   if(test_stream->good()) {
 192     char buf[30];                     // recall the seed from the demo file
 193     int seed;
 194     for (int i=0; i<30 && (i==0 || buf[i-1]); i++)
 195       test_stream->get(buf[i]);
 196     if (sscanf(buf, "random_seed=%10d", &seed) == 1) {
 197       log_info << "Random seed " << seed << " from demo file" << std::endl;
 198          return seed;
 199     }
 200     else
 201       log_info << "Demo file contains no random number" << std::endl;
 202   }
 203   return 0;
 204 }
 205
 206 void
 207 GameSession::play_demo(const std::string& filename)
 208 {
 209   delete playback_demo_stream;
 210   delete demo_controller;
 211
 212   playback_demo_stream = new std::ifstream(filename.c_str());
 213   if(!playback_demo_stream->good()) {
 214     std::stringstream msg;
 215     msg << "Couldn't open demo file '" << filename << "' for reading.";
 216     throw std::runtime_error(msg.str());
 217   }
 218
 219   Player& tux = *currentsector->player;
 220   demo_controller = new CodeController();
 221   tux.set_controller(demo_controller);
 222
 223   // skip over random seed, if it exists in the file
 224   char buf[30];                            // ascii decimal seed
 225   int seed;
 226   for (int i=0; i<30 && (i==0 || buf[i-1]); i++)
 227     playback_demo_stream->get(buf[i]);
 228   if (sscanf(buf, "random_seed=%010d", &seed) != 1)
 229     playback_demo_stream->seekg(0);     // old style w/o seed, restart at beg
 230 }
 231
 232 void
 233 GameSession::levelintro()
 234 {
 235   sound_manager->stop_music();
 236
 237   DrawingContext context;
 238   for(Sector::GameObjects::iterator i = currentsector->gameobjects.begin();
 239       i != currentsector->gameobjects.end(); ++i) {
 240     Background* background = dynamic_cast<Background*> (*i);
 241     if(background) {
 242       background->draw(context);
 243     }
 244     Gradient* gradient = dynamic_cast<Gradient*> (*i);
 245     if(gradient) {
 246       gradient->draw(context);
 247     }
 248   }
 249
 250 //  context.draw_text(gold_text, level->get_name(), Vector(SCREEN_WIDTH/2, 160),
 251 //      CENTER_ALLIGN, LAYER_FOREGROUND1);
 252   context.draw_center_text(gold_text, level->get_name(), Vector(0, 160),
 253       LAYER_FOREGROUND1);
 254
 255   std::stringstream ss_coins;
 256   ss_coins << _("Coins") << ": " << player_status->coins;
 257   context.draw_text(white_text, ss_coins.str(), Vector(SCREEN_WIDTH/2, 210),
 258       CENTER_ALLIGN, LAYER_FOREGROUND1);
 259
 260   if((level->get_author().size()) && (level->get_author() != "SuperTux Team"))
 261     context.draw_text(white_small_text,
 262       std::string(_("contributed by ")) + level->get_author(),
 263       Vector(SCREEN_WIDTH/2, 350), CENTER_ALLIGN, LAYER_FOREGROUND1);
 264
 265   if(best_level_statistics != NULL)
 266     best_level_statistics->draw_message_info(context, _("Best Level Statistics"));
 267
 268   wait_for_event(1.0, 3.0);
 269 }
 270
 271 void
 272 GameSession::on_escape_press()
 273 {
 274   if(currentsector->player->is_dying() || end_sequence != NO_ENDSEQUENCE)
 275     return;   // don't let the player open the menu, when he is dying
 276
 277   if(level->on_menukey_script != "") {
 278     std::istringstream in(level->on_menukey_script);
 279     run_script(in, "OnMenuKeyScript");
 280   } else {
 281     toggle_pause();
 282   }
 283 }
 284
 285 void
 286 GameSession::toggle_pause()
 287 {
 288   if(Menu::current() == NULL) {
 289     Menu::set_current(game_menu.get());
 290     game_menu->set_active_item(MNID_CONTINUE);
 291     game_pause = true;
 292   } else {
 293     Menu::set_current(NULL);
 294     game_pause = false;
 295   }
 296 }
 297
 298 HSQUIRRELVM
 299 GameSession::run_script(std::istream& in, const std::string& sourcename)
 300 {
 301   using namespace Scripting;
 302
 303   // garbage collect thread list
 304   for(ScriptList::iterator i = scripts.begin();
 305       i != scripts.end(); ) {
 306     HSQOBJECT& object = *i;
 307     HSQUIRRELVM vm = object_to_vm(object);
 308
 309     if(sq_getvmstate(vm) != SQ_VMSTATE_SUSPENDED) {
 310       sq_release(global_vm, &object);
 311       i = scripts.erase(i);
 312       continue;
 313     }
 314
 315     ++i;
 316   }
 317
 318   HSQOBJECT object = create_thread(global_vm);
 319   scripts.push_back(object);
 320
 321   HSQUIRRELVM vm = object_to_vm(object);
 322
 323   compile_and_run(vm, in, sourcename);
 324
 325   return vm;
 326 }
 327
 328 void
 329 GameSession::process_events()
 330 {
 331   Player& tux = *currentsector->player;
 332
 333   // end of pause mode?
 334   if(!Menu::current() && game_pause) {
 335     game_pause = false;
 336   }
 337
 338   if (end_sequence != NO_ENDSEQUENCE) {
 339     if(end_sequence_controller == 0) {
 340       end_sequence_controller = new CodeController();
 341       tux.set_controller(end_sequence_controller);
 342     }
 343
 344     end_sequence_controller->press(Controller::RIGHT);
 345
 346     if (int(last_x_pos) == int(tux.get_pos().x))
 347       end_sequence_controller->press(Controller::JUMP);
 348     last_x_pos = tux.get_pos().x;
 349   }
 350
 351   // playback a demo?
 352   if(playback_demo_stream != 0) {
 353     demo_controller->update();
 354     char left = false;
 355     char right = false;
 356     char up = false;
 357     char down = false;
 358     char jump = false;
 359     char action = false;
 360     playback_demo_stream->get(left);
 361     playback_demo_stream->get(right);
 362     playback_demo_stream->get(up);
 363     playback_demo_stream->get(down);
 364     playback_demo_stream->get(jump);
 365     playback_demo_stream->get(action);
 366     demo_controller->press(Controller::LEFT, left);
 367     demo_controller->press(Controller::RIGHT, right);
 368     demo_controller->press(Controller::UP, up);
 369     demo_controller->press(Controller::DOWN, down);
 370     demo_controller->press(Controller::JUMP, jump);
 371     demo_controller->press(Controller::ACTION, action);
 372   }
 373
 374   // save input for demo?
 375   if(capture_demo_stream != 0) {
 376     capture_demo_stream ->put(main_controller->hold(Controller::LEFT));
 377     capture_demo_stream ->put(main_controller->hold(Controller::RIGHT));
 378     capture_demo_stream ->put(main_controller->hold(Controller::UP));
 379     capture_demo_stream ->put(main_controller->hold(Controller::DOWN));
 380     capture_demo_stream ->put(main_controller->hold(Controller::JUMP));
 381     capture_demo_stream ->put(main_controller->hold(Controller::ACTION));
 382   }
 383 }
 384
 385 void
 386 GameSession::check_end_conditions()
 387 {
 388   Player* tux = currentsector->player;
 389
 390   /* End of level? */
 391   if(end_sequence && endsequence_timer.check()) {
 392     finish(true);
 393     return;
 394   } else if (!end_sequence && tux->is_dead()) {
 395     if (player_status->coins < 0) {
 396       // No more coins: restart level from beginning
 397       player_status->coins = 0;
 398       restart_level(true);
 399     } else {
 400       // Still has coins: restart level from last reset point
 401       restart_level(false);
 402     }
 403
 404     return;
 405   }
 406 }
 407
 408 void
 409 GameSession::draw(DrawingContext& context)
 410 {
 411   currentsector->draw(context);
 412   drawstatus(context);
 413
 414   if(game_pause)
 415     draw_pause(context);
 416 }
 417
 418 void
 419 GameSession::draw_pause(DrawingContext& context)
 420 {
 421   context.draw_filled_rect(
 422       Vector(0,0), Vector(SCREEN_WIDTH, SCREEN_HEIGHT),
 423       Color(.2, .2, .2, .5), LAYER_FOREGROUND1);
 424 }
 425
 426 void
 427 GameSession::process_menu()
 428 {
 429   Menu* menu = Menu::current();
 430   if(menu) {
 431     menu->update();
 432
 433     if(menu == game_menu.get()) {
 434       switch (game_menu->check()) {
 435         case MNID_CONTINUE:
 436           Menu::set_current(0);
 437           break;
 438         case MNID_ABORTLEVEL:
 439           Menu::set_current(0);
 440           main_loop->exit_screen();
 441           break;
 442       }
 443     }
 444   }
 445 }
 446
 447 void
 448 GameSession::setup()
 449 {
 450   Menu::set_current(NULL);
 451   current_ = this;
 452
 453   // Eat unneeded events
 454   SDL_Event event;
 455   while(SDL_PollEvent(&event))
 456   {}
 457 }
 458
 459 void
 460 GameSession::update(float elapsed_time)
 461 {
 462   // handle controller
 463   if(main_controller->pressed(Controller::PAUSE_MENU))
 464     on_escape_press();
 465
 466   process_events();
 467   process_menu();
 468
 469   check_end_conditions();
 470
 471   // respawning in new sector?
 472   if(newsector != "" && newspawnpoint != "") {
 473     Sector* sector = level->get_sector(newsector);
 474     if(sector == 0) {
 475       log_warning << "Sector '" << newsector << "' not found" << std::endl;
 476     }
 477     sector->activate(newspawnpoint);
 478     sector->play_music(LEVEL_MUSIC);
 479     currentsector = sector;
 480     newsector = "";
 481     newspawnpoint = "";
 482   }
 483
 484   // Update the world state and all objects in the world
 485   if(!game_pause) {
 486     // Update the world
 487     if (end_sequence == ENDSEQUENCE_RUNNING) {
 488       currentsector->update(elapsed_time/2);
 489     } else if(end_sequence == NO_ENDSEQUENCE) {
 490       play_time += elapsed_time; //TODO: make sure we don't count cutscene time
 491       level->stats.time = play_time;
 492       currentsector->update(elapsed_time);
 493     }
 494   }
 495
 496   // update sounds
 497   sound_manager->set_listener_position(currentsector->player->get_pos());
 498
 499   /* Handle music: */
 500   if (end_sequence)
 501     return;
 502
 503   if(currentsector->player->invincible_timer.started()) {
 504     if(currentsector->player->invincible_timer.get_timeleft() <=
 505        TUX_INVINCIBLE_TIME_WARNING) {
 506       currentsector->play_music(HERRING_WARNING_MUSIC);
 507     } else {
 508       currentsector->play_music(HERRING_MUSIC);
 509     }
 510   } else if(currentsector->get_music_type() != LEVEL_MUSIC) {
 511     currentsector->play_music(LEVEL_MUSIC);
 512   }
 513 }
 514
 515 void
 516 GameSession::finish(bool win)
 517 {
 518   using namespace WorldMapNS;
 519
 520   if(win) {
 521     if(WorldMap::current())
 522       WorldMap::current()->finished_level(level.get());
 523   }
 524
 525   main_loop->exit_screen();
 526 }
 527
 528 void
 529 GameSession::respawn(const std::string& sector, const std::string& spawnpoint)
 530 {
 531   newsector = sector;
 532   newspawnpoint = spawnpoint;
 533 }
 534
 535 void
 536 GameSession::set_reset_point(const std::string& sector, const Vector& pos)
 537 {
 538   reset_sector = sector;
 539   reset_pos = pos;
 540 }
 541
 542 std::string
 543 GameSession::get_working_directory()
 544 {
 545   return FileSystem::dirname(levelfile);
 546 }
 547
 548 void
 549 GameSession::display_info_box(const std::string& text)
 550 {
 551   InfoBox* box = new InfoBox(text);
 552
 553   bool running = true;
 554   DrawingContext context;
 555
 556   while(running)  {
 557
 558     // TODO make a screen out of this, another mainloop is ugly
 559     main_controller->update();
 560     SDL_Event event;
 561     while (SDL_PollEvent(&event)) {
 562       main_controller->process_event(event);
 563       if(event.type == SDL_QUIT)
 564         main_loop->quit();
 565     }
 566
 567     if(main_controller->pressed(Controller::JUMP)
 568         || main_controller->pressed(Controller::ACTION)
 569         || main_controller->pressed(Controller::PAUSE_MENU)
 570         || main_controller->pressed(Controller::MENU_SELECT))
 571       running = false;
 572     else if(main_controller->pressed(Controller::DOWN))
 573       box->scrolldown();
 574     else if(main_controller->pressed(Controller::UP))
 575       box->scrollup();
 576     box->draw(context);
 577     draw(context);
 578     context.do_drawing();
 579     sound_manager->update();
 580   }
 581
 582   delete box;
 583 }
 584
 585 void
 586 GameSession::start_sequence(const std::string& sequencename)
 587 {
 588   if(sequencename == "endsequence" || sequencename == "fireworks") {
 589     if(end_sequence)
 590       return;
 591
 592     end_sequence = ENDSEQUENCE_RUNNING;
 593     endsequence_timer.start(7.3);
 594     last_x_pos = -1;
 595     sound_manager->play_music("music/leveldone.ogg", false);
 596     currentsector->player->invincible_timer.start(7.3);
 597
 598     // Stop all clocks.
 599     for(std::vector<GameObject*>::iterator i = currentsector->gameobjects.begin();
 600         i != currentsector->gameobjects.end(); ++i)
 601     {
 602       GameObject* obj = *i;
 603
 604       LevelTime* lt = dynamic_cast<LevelTime*> (obj);
 605       if(lt)
 606         lt->stop();
 607     }
 608
 609     if(sequencename == "fireworks") {
 610       currentsector->add_object(new Fireworks());
 611     }
 612   } else if(sequencename == "stoptux") {
 613     if(!end_sequence) {
 614       log_warning << "Final target reached without an active end sequence" << std::endl;
 615       this->start_sequence("endsequence");
 616     }
 617     end_sequence =  ENDSEQUENCE_WAITING;
 618   } else {
 619     log_warning << "Unknown sequence '" << sequencename << "'" << std::endl;
 620   }
 621 }
 622
 623 /* (Status): */
 624 void
 625 GameSession::drawstatus(DrawingContext& context)
 626 {
 627   player_status->draw(context);
 628
 629   // draw level stats while end_sequence is running
 630   if (end_sequence) {
 631     level->stats.draw_endseq_panel(context, best_level_statistics, statistics_backdrop.get());
 632   }
 633 }
 634