src/supertux/game_session.cpp

   1 //  SuperTux
   2 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   3 //
   4 //  This program is free software: you can redistribute it and/or modify
   5 //  it under the terms of the GNU General Public License as published by
   6 //  the Free Software Foundation, either version 3 of the License, or
   7 //  (at your option) any later version.
   8 //
   9 //  This program is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 //  GNU General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU General Public License
  15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #include "supertux/game_session.hpp"
  18
  19 #include <float.h>
  20 #include <fstream>
  21
  22 #include "audio/sound_manager.hpp"
  23 #include "control/input_manager.hpp"
  24 #include "gui/menu.hpp"
  25 #include "gui/menu_manager.hpp"
  26 #include "math/random_generator.hpp"
  27 #include "object/camera.hpp"
  28 #include "object/endsequence_fireworks.hpp"
  29 #include "object/endsequence_walkleft.hpp"
  30 #include "object/endsequence_walkright.hpp"
  31 #include "object/level_time.hpp"
  32 #include "object/player.hpp"
  33 #include "scripting/squirrel_util.hpp"
  34 #include "supertux/gameconfig.hpp"
  35 #include "supertux/globals.hpp"
  36 #include "supertux/levelintro.hpp"
  37 #include "supertux/levelset_screen.hpp"
  38 #include "supertux/menu/menu_storage.hpp"
  39 #include "supertux/menu/options_menu.hpp"
  40 #include "supertux/player_status.hpp"
  41 #include "supertux/savegame.hpp"
  42 #include "supertux/screen_fade.hpp"
  43 #include "supertux/screen_manager.hpp"
  44 #include "supertux/sector.hpp"
  45 #include "util/file_system.hpp"
  46 #include "util/gettext.hpp"
  47 #include "worldmap/worldmap.hpp"
  48
  49 GameSession::GameSession(const std::string& levelfile_, Savegame& savegame, Statistics* statistics) :
  50   level(),
  51   statistics_backdrop(Surface::create("images/engine/menu/score-backdrop.png")),
  52   scripts(),
  53   currentsector(nullptr),
  54   levelnb(),
  55   pause_menu_frame(),
  56   end_sequence(0),
  57   game_pause(false),
  58   speed_before_pause(g_screen_manager->get_speed()),
  59   levelfile(levelfile_),
  60   reset_sector(),
  61   reset_pos(),
  62   newsector(),
  63   newspawnpoint(),
  64   best_level_statistics(statistics),
  65   m_savegame(savegame),
  66   capture_demo_stream(0),
  67   capture_file(),
  68   playback_demo_stream(0),
  69   demo_controller(0),
  70   play_time(0),
  71   edit_mode(false),
  72   levelintro_shown(false),
  73   coins_at_start(),
  74   bonus_at_start(),
  75   max_fire_bullets_at_start(),
  76   max_ice_bullets_at_start()
  77 {
  78   if (restart_level() != 0)
  79     throw std::runtime_error ("Initializing the level failed.");
  80 }
  81
  82 int
  83 GameSession::restart_level()
  84 {
  85     PlayerStatus* currentStatus = m_savegame.get_player_status();
  86     coins_at_start = currentStatus->coins;
  87     bonus_at_start = currentStatus->bonus;
  88     max_fire_bullets_at_start = currentStatus->max_fire_bullets;
  89     max_ice_bullets_at_start = currentStatus->max_ice_bullets;
  90
  91   if (edit_mode) {
  92     force_ghost_mode();
  93     return (-1);
  94   }
  95
  96   game_pause   = false;
  97   end_sequence = 0;
  98
  99   g_input_manager->reset();
 100
 101   currentsector = 0;
 102
 103   level.reset(new Level);
 104   try {
 105     level->load(levelfile);
 106     level->stats.total_coins = level->get_total_coins();
 107     level->stats.total_badguys = level->get_total_badguys();
 108     level->stats.total_secrets = level->get_total_secrets();
 109     level->stats.reset();
 110
 111     if(reset_sector != "") {
 112       currentsector = level->get_sector(reset_sector);
 113       if(!currentsector) {
 114         std::stringstream msg;
 115         msg << "Couldn't find sector '" << reset_sector << "' for resetting tux.";
 116         throw std::runtime_error(msg.str());
 117       }
 118       currentsector->activate(reset_pos);
 119     } else {
 120       currentsector = level->get_sector("main");
 121       if(!currentsector)
 122         throw std::runtime_error("Couldn't find main sector");
 123       play_time = 0;
 124       currentsector->activate("main");
 125     }
 126   } catch(std::exception& e) {
 127     log_fatal << "Couldn't start level: " << e.what() << std::endl;
 128     g_screen_manager->pop_screen();
 129     return (-1);
 130   }
 131
 132   sound_manager->stop_music();
 133   currentsector->play_music(LEVEL_MUSIC);
 134
 135   if(capture_file != "") {
 136     int newSeed=0;               // next run uses a new seed
 137     while (newSeed == 0)            // which is the next non-zero random num.
 138       newSeed = gameRandom.rand();
 139     g_config->random_seed = gameRandom.srand(newSeed);
 140     log_info << "Next run uses random seed " << g_config->random_seed <<std::endl;
 141     record_demo(capture_file);
 142   }
 143
 144   return (0);
 145 }
 146
 147 GameSession::~GameSession()
 148 {
 149   delete capture_demo_stream;
 150   delete playback_demo_stream;
 151   delete demo_controller;
 152 }
 153
 154 void
 155 GameSession::record_demo(const std::string& filename)
 156 {
 157   delete capture_demo_stream;
 158
 159   capture_demo_stream = new std::ofstream(filename.c_str());
 160   if(!capture_demo_stream->good()) {
 161     std::stringstream msg;
 162     msg << "Couldn't open demo file '" << filename << "' for writing.";
 163     throw std::runtime_error(msg.str());
 164   }
 165   capture_file = filename;
 166
 167   char buf[30];                            // save the seed in the demo file
 168   snprintf(buf, sizeof(buf), "random_seed=%10d", g_config->random_seed);
 169   for (int i=0; i==0 || buf[i-1]; i++)
 170     capture_demo_stream->put(buf[i]);
 171 }
 172
 173 int
 174 GameSession::get_demo_random_seed(const std::string& filename)
 175 {
 176   std::istream* test_stream = new std::ifstream(filename.c_str());
 177   if(test_stream->good()) {
 178     char buf[30];                     // recall the seed from the demo file
 179     int seed;
 180     for (int i=0; i<30 && (i==0 || buf[i-1]); i++)
 181       test_stream->get(buf[i]);
 182     if (sscanf(buf, "random_seed=%10d", &seed) == 1) {
 183       log_info << "Random seed " << seed << " from demo file" << std::endl;
 184       return seed;
 185     }
 186     else
 187       log_info << "Demo file contains no random number" << std::endl;
 188   }
 189   delete test_stream;
 190   test_stream = nullptr;
 191   return 0;
 192 }
 193
 194 void
 195 GameSession::play_demo(const std::string& filename)
 196 {
 197   delete playback_demo_stream;
 198   delete demo_controller;
 199
 200   playback_demo_stream = new std::ifstream(filename.c_str());
 201   if(!playback_demo_stream->good()) {
 202     std::stringstream msg;
 203     msg << "Couldn't open demo file '" << filename << "' for reading.";
 204     throw std::runtime_error(msg.str());
 205   }
 206
 207   Player& tux = *currentsector->player;
 208   demo_controller = new CodeController();
 209   tux.set_controller(demo_controller);
 210
 211   // skip over random seed, if it exists in the file
 212   char buf[30];                            // ascii decimal seed
 213   int seed;
 214   for (int i=0; i<30 && (i==0 || buf[i-1]); i++)
 215     playback_demo_stream->get(buf[i]);
 216   if (sscanf(buf, "random_seed=%010d", &seed) != 1)
 217     playback_demo_stream->seekg(0);     // old style w/o seed, restart at beg
 218 }
 219
 220 void
 221 GameSession::on_escape_press()
 222 {
 223   if(currentsector->player->is_dying() || end_sequence)
 224   {
 225     // Let the timers run out, we fast-forward them to force past a sequence
 226     if (end_sequence)
 227       end_sequence->stop();
 228
 229     currentsector->player->dying_timer.start(FLT_EPSILON);
 230     return;   // don't let the player open the menu, when he is dying
 231   }
 232
 233   if(level->on_menukey_script != "") {
 234     std::istringstream in(level->on_menukey_script);
 235     run_script(in, "OnMenuKeyScript");
 236   } else {
 237     toggle_pause();
 238   }
 239 }
 240
 241 void
 242 GameSession::toggle_pause()
 243 {
 244   // pause
 245   if(!game_pause) {
 246     speed_before_pause = g_screen_manager->get_speed();
 247     g_screen_manager->set_speed(0);
 248     MenuManager::instance().set_menu(MenuStorage::GAME_MENU);
 249     game_pause = true;
 250   }
 251
 252   // unpause is done in update() after the menu is processed
 253 }
 254
 255 void
 256 GameSession::abort_level()
 257 {
 258   MenuManager::instance().clear_menu_stack();
 259   g_screen_manager->pop_screen();
 260   currentsector->player->set_bonus(bonus_at_start);
 261   PlayerStatus *currentStatus = m_savegame.get_player_status();
 262   currentStatus->coins = coins_at_start;
 263   currentStatus->max_fire_bullets = max_fire_bullets_at_start;
 264   currentStatus->max_ice_bullets = max_ice_bullets_at_start;
 265 }
 266
 267 void
 268 GameSession::set_editmode(bool edit_mode)
 269 {
 270   if (this->edit_mode == edit_mode) return;
 271   this->edit_mode = edit_mode;
 272
 273   currentsector->get_players()[0]->set_edit_mode(edit_mode);
 274
 275   if (edit_mode) {
 276
 277     // entering edit mode
 278
 279   } else {
 280
 281     // leaving edit mode
 282     restart_level();
 283
 284   }
 285 }
 286
 287 void
 288 GameSession::force_ghost_mode()
 289 {
 290   currentsector->get_players()[0]->set_ghost_mode(true);
 291 }
 292
 293 HSQUIRRELVM
 294 GameSession::run_script(std::istream& in, const std::string& sourcename)
 295 {
 296   using namespace scripting;
 297
 298   // garbage collect thread list
 299   for(ScriptList::iterator i = scripts.begin();
 300       i != scripts.end(); ) {
 301     HSQOBJECT& object = *i;
 302     HSQUIRRELVM vm = object_to_vm(object);
 303
 304     if(sq_getvmstate(vm) != SQ_VMSTATE_SUSPENDED) {
 305       sq_release(global_vm, &object);
 306       i = scripts.erase(i);
 307       continue;
 308     }
 309
 310     ++i;
 311   }
 312
 313   HSQOBJECT object = create_thread(global_vm);
 314   scripts.push_back(object);
 315
 316   HSQUIRRELVM vm = object_to_vm(object);
 317
 318   compile_and_run(vm, in, sourcename);
 319
 320   return vm;
 321 }
 322
 323 void
 324 GameSession::process_events()
 325 {
 326   // playback a demo?
 327   if(playback_demo_stream != 0) {
 328     demo_controller->update();
 329     char left = false;
 330     char right = false;
 331     char up = false;
 332     char down = false;
 333     char jump = false;
 334     char action = false;
 335     playback_demo_stream->get(left);
 336     playback_demo_stream->get(right);
 337     playback_demo_stream->get(up);
 338     playback_demo_stream->get(down);
 339     playback_demo_stream->get(jump);
 340     playback_demo_stream->get(action);
 341     demo_controller->press(Controller::LEFT, left);
 342     demo_controller->press(Controller::RIGHT, right);
 343     demo_controller->press(Controller::UP, up);
 344     demo_controller->press(Controller::DOWN, down);
 345     demo_controller->press(Controller::JUMP, jump);
 346     demo_controller->press(Controller::ACTION, action);
 347   }
 348
 349   // save input for demo?
 350   if(capture_demo_stream != 0) {
 351     Controller *controller = g_input_manager->get_controller();
 352     capture_demo_stream ->put(controller->hold(Controller::LEFT));
 353     capture_demo_stream ->put(controller->hold(Controller::RIGHT));
 354     capture_demo_stream ->put(controller->hold(Controller::UP));
 355     capture_demo_stream ->put(controller->hold(Controller::DOWN));
 356     capture_demo_stream ->put(controller->hold(Controller::JUMP));
 357     capture_demo_stream ->put(controller->hold(Controller::ACTION));
 358   }
 359 }
 360
 361 void
 362 GameSession::check_end_conditions()
 363 {
 364   Player* tux = currentsector->player;
 365
 366   /* End of level? */
 367   if(end_sequence && end_sequence->is_done()) {
 368     finish(true);
 369   } else if (!end_sequence && tux->is_dead()) {
 370     restart_level();
 371   }
 372 }
 373
 374 void
 375 GameSession::draw(DrawingContext& context)
 376 {
 377   currentsector->draw(context);
 378   drawstatus(context);
 379
 380   if(game_pause)
 381     draw_pause(context);
 382 }
 383
 384 void
 385 GameSession::draw_pause(DrawingContext& context)
 386 {
 387   context.draw_filled_rect(
 388     Vector(0,0), Vector(SCREEN_WIDTH, SCREEN_HEIGHT),
 389     Color(0.0f, 0.0f, 0.0f, .25f), LAYER_FOREGROUND1);
 390 }
 391
 392 void
 393 GameSession::setup()
 394 {
 395   if (currentsector == NULL)
 396     return;
 397
 398   if(currentsector != Sector::current()) {
 399     currentsector->activate(currentsector->player->get_pos());
 400   }
 401   currentsector->play_music(LEVEL_MUSIC);
 402
 403   int total_stats_to_be_collected = level->stats.total_coins + level->stats.total_badguys + level->stats.total_secrets;
 404   if ((!levelintro_shown) && (total_stats_to_be_collected > 0)) {
 405     levelintro_shown = true;
 406     g_screen_manager->push_screen(std::unique_ptr<Screen>(new LevelIntro(level.get(), best_level_statistics)));
 407   }
 408 }
 409
 410 void
 411 GameSession::leave()
 412 {
 413 }
 414
 415 void
 416 GameSession::update(float elapsed_time)
 417 {
 418   // handle controller
 419   if(g_input_manager->get_controller()->pressed(Controller::PAUSE_MENU))
 420   {
 421     on_escape_press();
 422   }
 423
 424   if(g_input_manager->get_controller()->pressed(Controller::CHEAT_MENU))
 425   {
 426     game_pause = true;
 427     MenuManager::instance().set_menu(MenuStorage::CHEAT_MENU);
 428   }
 429
 430   process_events();
 431   MenuManager::instance().check_menu();
 432
 433   // Unpause the game if the menu has been closed
 434   if (game_pause && !MenuManager::instance().is_active()) {
 435     g_screen_manager->set_speed(speed_before_pause);
 436     game_pause = false;
 437   }
 438
 439   check_end_conditions();
 440
 441   // respawning in new sector?
 442   if(newsector != "" && newspawnpoint != "") {
 443     Sector* sector = level->get_sector(newsector);
 444     if(sector == 0) {
 445       log_warning << "Sector '" << newsector << "' not found" << std::endl;
 446       sector = level->get_sector("main");
 447     }
 448     sector->activate(newspawnpoint);
 449     sector->play_music(LEVEL_MUSIC);
 450     currentsector = sector;
 451     //Keep persistent across sectors
 452     if(edit_mode)
 453       currentsector->get_players()[0]->set_edit_mode(edit_mode);
 454     newsector = "";
 455     newspawnpoint = "";
 456   }
 457
 458   // Update the world state and all objects in the world
 459   if(!game_pause) {
 460     // Update the world
 461     if (!end_sequence) {
 462       play_time += elapsed_time; //TODO: make sure we don't count cutscene time
 463       level->stats.time = play_time;
 464       currentsector->update(elapsed_time);
 465     } else {
 466       if (!end_sequence->is_tux_stopped()) {
 467         currentsector->update(elapsed_time);
 468       } else {
 469         end_sequence->update(elapsed_time);
 470       }
 471     }
 472   }
 473
 474   // update sounds
 475   if (currentsector && currentsector->camera) sound_manager->set_listener_position(currentsector->camera->get_center());
 476
 477   /* Handle music: */
 478   if (end_sequence)
 479     return;
 480
 481   if(currentsector->player->invincible_timer.started()) {
 482     if(currentsector->player->invincible_timer.get_timeleft() <=
 483        TUX_INVINCIBLE_TIME_WARNING) {
 484       currentsector->play_music(HERRING_WARNING_MUSIC);
 485     } else {
 486       currentsector->play_music(HERRING_MUSIC);
 487     }
 488   } else if(currentsector->get_music_type() != LEVEL_MUSIC) {
 489     currentsector->play_music(LEVEL_MUSIC);
 490   }
 491 }
 492
 493 void
 494 GameSession::finish(bool win)
 495 {
 496   using namespace worldmap;
 497
 498   if (edit_mode) {
 499     force_ghost_mode();
 500     return;
 501   }
 502
 503   if(win) {
 504     if(WorldMap::current())
 505     {
 506       WorldMap::current()->finished_level(level.get());
 507     }
 508
 509     if (LevelsetScreen::current())
 510     {
 511       LevelsetScreen::current()->finished_level(win);
 512     }
 513   }
 514
 515   g_screen_manager->pop_screen();
 516 }
 517
 518 void
 519 GameSession::respawn(const std::string& sector, const std::string& spawnpoint)
 520 {
 521   newsector = sector;
 522   newspawnpoint = spawnpoint;
 523 }
 524
 525 void
 526 GameSession::set_reset_point(const std::string& sector, const Vector& pos)
 527 {
 528   reset_sector = sector;
 529   reset_pos = pos;
 530 }
 531
 532 std::string
 533 GameSession::get_working_directory()
 534 {
 535   return FileSystem::dirname(levelfile);
 536 }
 537
 538 void
 539 GameSession::start_sequence(const std::string& sequencename)
 540 {
 541   // do not play sequences when in edit mode
 542   if (edit_mode) {
 543     force_ghost_mode();
 544     return;
 545   }
 546
 547   // handle special "stoptux" sequence
 548   if (sequencename == "stoptux") {
 549     if (!end_sequence) {
 550       log_warning << "Final target reached without an active end sequence" << std::endl;
 551       this->start_sequence("endsequence");
 552     }
 553     if (end_sequence) end_sequence->stop_tux();
 554     return;
 555   }
 556
 557   // abort if a sequence is already playing
 558   if (end_sequence)
 559     return;
 560
 561   if (sequencename == "endsequence") {
 562     if (currentsector->get_players()[0]->get_physic().get_velocity_x() < 0) {
 563       end_sequence = new EndSequenceWalkLeft();
 564     } else {
 565       end_sequence = new EndSequenceWalkRight();
 566     }
 567   } else if (sequencename == "fireworks") {
 568     end_sequence = new EndSequenceFireworks();
 569   } else {
 570     log_warning << "Unknown sequence '" << sequencename << "'. Ignoring." << std::endl;
 571     return;
 572   }
 573
 574   /* slow down the game for end-sequence */
 575   g_screen_manager->set_speed(0.5f);
 576
 577   currentsector->add_object(end_sequence);
 578   end_sequence->start();
 579
 580   sound_manager->play_music("music/leveldone.ogg", false);
 581   currentsector->player->set_winning();
 582
 583   // Stop all clocks.
 584   for(std::vector<GameObject*>::iterator i = currentsector->gameobjects.begin();
 585       i != currentsector->gameobjects.end(); ++i)
 586   {
 587     GameObject* obj = *i;
 588
 589     LevelTime* lt = dynamic_cast<LevelTime*> (obj);
 590     if(lt)
 591       lt->stop();
 592   }
 593 }
 594
 595 /* (Status): */
 596 void
 597 GameSession::drawstatus(DrawingContext& context)
 598 {
 599   m_savegame.get_player_status()->draw(context);
 600
 601   // draw level stats while end_sequence is running
 602   if (end_sequence) {
 603     level->stats.draw_endseq_panel(context, best_level_statistics, statistics_backdrop);
 604   }
 605 }
 606
 607 /* EOF */