src/worldmap/worldmap.cpp

   1 //  $Id$
   2 //
   3 //  SuperTux -  A Jump'n Run
   4 //  Copyright (C) 2004 Ingo Ruhnke <grumbel@gmx.de>
   5 //  Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.de>
   6 //
   7 //  This program is free software; you can redistribute it and/or
   8 //  modify it under the terms of the GNU General Public License
   9 //  as published by the Free Software Foundation; either version 2
  10 //  of the License, or (at your option) any later version.
  11 //
  12 //  This program is distributed in the hope that it will be useful,
  13 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 //  GNU General Public License for more details.
  16 //
  17 //  You should have received a copy of the GNU General Public License
  18 //  along with this program; if not, write to the Free Software
  19 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  20 #include <config.h>
  21
  22 #include <iostream>
  23 #include <fstream>
  24 #include <vector>
  25 #include <cassert>
  26 #include <stdexcept>
  27 #include <sstream>
  28 #include <unistd.h>
  29 #include <physfs.h>
  30
  31 #include "worldmap.hpp"
  32
  33 #include "gettext.hpp"
  34 #include "log.hpp"
  35 #include "mainloop.hpp"
  36 #include "shrinkfade.hpp"
  37 #include "video/surface.hpp"
  38 #include "video/drawing_context.hpp"
  39 #include "sprite/sprite_manager.hpp"
  40 #include "audio/sound_manager.hpp"
  41 #include "lisp/parser.hpp"
  42 #include "lisp/lisp.hpp"
  43 #include "lisp/list_iterator.hpp"
  44 #include "lisp/writer.hpp"
  45 #include "game_session.hpp"
  46 #include "sector.hpp"
  47 #include "worldmap.hpp"
  48 #include "resources.hpp"
  49 #include "log.hpp"
  50 #include "world.hpp"
  51 #include "player_status.hpp"
  52 #include "textscroller.hpp"
  53 #include "main.hpp"
  54 #include "spawn_point.hpp"
  55 #include "file_system.hpp"
  56 #include "gui/menu.hpp"
  57 #include "gui/mousecursor.hpp"
  58 #include "control/joystickkeyboardcontroller.hpp"
  59 #include "object/background.hpp"
  60 #include "object/tilemap.hpp"
  61 #include "options_menu.hpp"
  62 #include "scripting/squirrel_error.hpp"
  63 #include "scripting/squirrel_util.hpp"
  64 #include "worldmap/level.hpp"
  65 #include "worldmap/special_tile.hpp"
  66 #include "worldmap/tux.hpp"
  67 #include "worldmap/sprite_change.hpp"
  68
  69 namespace WorldMapNS {
  70
  71 enum WorldMapMenuIDs {
  72   MNID_RETURNWORLDMAP,
  73   MNID_QUITWORLDMAP
  74 };
  75
  76 WorldMap* WorldMap::current_ = NULL;
  77
  78 Direction reverse_dir(Direction direction)
  79 {
  80   switch(direction)
  81     {
  82     case D_WEST:
  83       return D_EAST;
  84     case D_EAST:
  85       return D_WEST;
  86     case D_NORTH:
  87       return D_SOUTH;
  88     case D_SOUTH:
  89       return D_NORTH;
  90     case D_NONE:
  91       return D_NONE;
  92     }
  93   return D_NONE;
  94 }
  95
  96 std::string
  97 direction_to_string(Direction direction)
  98 {
  99   switch(direction)
 100     {
 101     case D_WEST:
 102       return "west";
 103     case D_EAST:
 104       return "east";
 105     case D_NORTH:
 106       return "north";
 107     case D_SOUTH:
 108       return "south";
 109     default:
 110       return "none";
 111     }
 112 }
 113
 114 Direction
 115 string_to_direction(const std::string& directory)
 116 {
 117   if (directory == "west")
 118     return D_WEST;
 119   else if (directory == "east")
 120     return D_EAST;
 121   else if (directory == "north")
 122     return D_NORTH;
 123   else if (directory == "south")
 124     return D_SOUTH;
 125   else if (directory == "none")
 126     return D_NONE;
 127   else {
 128     log_warning << "unknown direction: \"" << directory << "\"" << std::endl;
 129     return D_NONE;
 130   }
 131 }
 132
 133 //---------------------------------------------------------------------------
 134
 135 WorldMap::WorldMap(const std::string& filename, const std::string& force_spawnpoint)
 136   : tux(0), solids(0), force_spawnpoint(force_spawnpoint)
 137 {
 138   tile_manager.reset(new TileManager("images/worldmap.strf"));
 139
 140   tux = new Tux(this);
 141   add_object(tux);
 142
 143   name = "<no title>";
 144   music = "music/salcon.ogg";
 145
 146   total_stats.reset();
 147
 148   worldmap_menu.reset(new Menu());
 149   worldmap_menu->add_label(_("Pause"));
 150   worldmap_menu->add_hl();
 151   worldmap_menu->add_entry(MNID_RETURNWORLDMAP, _("Continue"));
 152   worldmap_menu->add_submenu(_("Options"), get_options_menu());
 153   worldmap_menu->add_hl();
 154   worldmap_menu->add_entry(MNID_QUITWORLDMAP, _("Quit World"));
 155
 156   load(filename);
 157
 158   // create a new squirrel table for the worldmap
 159   using namespace Scripting;
 160
 161   sq_collectgarbage(global_vm);
 162   sq_newtable(global_vm);
 163   sq_pushroottable(global_vm);
 164   if(SQ_FAILED(sq_setdelegate(global_vm, -2)))
 165     throw Scripting::SquirrelError(global_vm, "Couldn't set worldmap_table delegate");
 166
 167   sq_resetobject(&worldmap_table);
 168   if(SQ_FAILED(sq_getstackobj(global_vm, -1, &worldmap_table)))
 169     throw Scripting::SquirrelError(global_vm, "Couldn't get table from stack");
 170
 171   sq_addref(global_vm, &worldmap_table);
 172   sq_pop(global_vm, 1);
 173 }
 174
 175 WorldMap::~WorldMap()
 176 {
 177   using namespace Scripting;
 178
 179   for(ScriptList::iterator i = scripts.begin();
 180       i != scripts.end(); ++i) {
 181     HSQOBJECT& object = *i;
 182     sq_release(global_vm, &object);
 183   }
 184   sq_release(global_vm, &worldmap_table);
 185
 186   sq_collectgarbage(global_vm);
 187
 188   if(current_ == this)
 189     current_ = NULL;
 190
 191   for(GameObjects::iterator i = game_objects.begin();
 192       i != game_objects.end(); ++i) {
 193     GameObject* object = *i;
 194     object->unref();
 195   }
 196
 197   for(SpawnPoints::iterator i = spawn_points.begin();
 198       i != spawn_points.end(); ++i) {
 199     delete *i;
 200   }
 201 }
 202
 203 void
 204 WorldMap::add_object(GameObject* object)
 205 {
 206   TileMap* tilemap = dynamic_cast<TileMap*> (object);
 207   if(tilemap != 0 && tilemap->is_solid()) {
 208     solids = tilemap;
 209   }
 210
 211   object->ref();
 212   game_objects.push_back(object);
 213 }
 214
 215 void
 216 WorldMap::move_to_spawnpoint(const std::string& spawnpoint)
 217 {
 218   for(SpawnPoints::iterator i = spawn_points.begin(); i != spawn_points.end(); ++i) {
 219     SpawnPoint* sp = *i;
 220     if(sp->name == spawnpoint) {
 221       Vector p = sp->pos;
 222       tux->set_tile_pos(p);
 223       tux->set_direction(sp->auto_dir);
 224       return;
 225     }
 226   }
 227   log_warning << "Spawnpoint '" << spawnpoint << "' not found." << std::endl;
 228   if (spawnpoint != "main") {
 229     move_to_spawnpoint("main");
 230   }
 231 }
 232
 233 void
 234 WorldMap::change(const std::string& filename, const std::string& force_spawnpoint)
 235 {
 236   main_loop->exit_screen();
 237   main_loop->push_screen(new WorldMap(filename, force_spawnpoint));
 238 }
 239
 240 void
 241 WorldMap::load(const std::string& filename)
 242 {
 243   map_filename = filename;
 244   levels_path = FileSystem::dirname(map_filename);
 245
 246   try {
 247     lisp::Parser parser;
 248     std::auto_ptr<lisp::Lisp> root (parser.parse(map_filename));
 249
 250     const lisp::Lisp* lisp = root->get_lisp("supertux-level");
 251     if(!lisp)
 252       throw std::runtime_error("file isn't a supertux-level file.");
 253
 254     lisp->get("name", name);
 255
 256     const lisp::Lisp* sector = lisp->get_lisp("sector");
 257     if(!sector)
 258       throw std::runtime_error("No sector sepcified in worldmap file.");
 259
 260     lisp::ListIterator iter(sector);
 261     while(iter.next()) {
 262       if(iter.item() == "tilemap") {
 263         add_object(new TileMap(*(iter.lisp()), tile_manager.get()));
 264       } else if(iter.item() == "background") {
 265         add_object(new Background(*(iter.lisp())));
 266       } else if(iter.item() == "music") {
 267         iter.value()->get(music);
 268       } else if(iter.item() == "init-script") {
 269         iter.value()->get(init_script);
 270       } else if(iter.item() == "worldmap-spawnpoint") {
 271         SpawnPoint* sp = new SpawnPoint(iter.lisp());
 272         spawn_points.push_back(sp);
 273       } else if(iter.item() == "level") {
 274         LevelTile* level = new LevelTile(levels_path, iter.lisp());
 275         levels.push_back(level);
 276         add_object(level);
 277       } else if(iter.item() == "special-tile") {
 278         SpecialTile* special_tile = new SpecialTile(iter.lisp());
 279         special_tiles.push_back(special_tile);
 280         add_object(special_tile);
 281       } else if(iter.item() == "sprite-change") {
 282         SpriteChange* sprite_change = new SpriteChange(iter.lisp());
 283         sprite_changes.push_back(sprite_change);
 284         add_object(sprite_change);
 285       } else if(iter.item() == "teleporter") {
 286         Teleporter* teleporter = new Teleporter(iter.lisp());
 287         teleporters.push_back(teleporter);
 288         add_object(teleporter);
 289       } else if(iter.item() == "name") {
 290         // skip
 291       } else {
 292         log_warning << "Unknown token '" << iter.item() << "' in worldmap" << std::endl;
 293       }
 294     }
 295     if(solids == 0)
 296       throw std::runtime_error("No solid tilemap specified");
 297
 298     move_to_spawnpoint("main");
 299
 300   } catch(std::exception& e) {
 301     std::stringstream msg;
 302     msg << "Problem when parsing worldmap '" << map_filename << "': " <<
 303       e.what();
 304     throw std::runtime_error(msg.str());
 305   }
 306 }
 307
 308 void
 309 WorldMap::get_level_title(LevelTile& level)
 310 {
 311   /** get special_tile's title */
 312   level.title = "<no title>";
 313
 314   try {
 315     lisp::Parser parser;
 316     std::auto_ptr<lisp::Lisp> root (parser.parse(levels_path + level.get_name()));
 317
 318     const lisp::Lisp* level_lisp = root->get_lisp("supertux-level");
 319     if(!level_lisp)
 320       return;
 321
 322     level_lisp->get("name", level.title);
 323   } catch(std::exception& e) {
 324     log_warning << "Problem when reading leveltitle: " << e.what() << std::endl;
 325     return;
 326   }
 327 }
 328
 329 void WorldMap::calculate_total_stats()
 330 {
 331   total_stats.reset();
 332   for(LevelTiles::iterator i = levels.begin(); i != levels.end(); ++i) {
 333     LevelTile* level = *i;
 334     if (level->solved) {
 335       total_stats += level->statistics;
 336     }
 337   }
 338 }
 339
 340 void
 341 WorldMap::on_escape_press()
 342 {
 343   // Show or hide the menu
 344   if(!Menu::current()) {
 345     Menu::set_current(worldmap_menu.get());
 346     tux->set_direction(D_NONE);  // stop tux movement when menu is called
 347   } else {
 348     Menu::set_current(NULL);
 349   }
 350 }
 351
 352 Vector
 353 WorldMap::get_next_tile(Vector pos, Direction direction)
 354 {
 355   switch(direction) {
 356     case D_WEST:
 357       pos.x -= 1;
 358       break;
 359     case D_EAST:
 360       pos.x += 1;
 361       break;
 362     case D_NORTH:
 363       pos.y -= 1;
 364       break;
 365     case D_SOUTH:
 366       pos.y += 1;
 367       break;
 368     case D_NONE:
 369       break;
 370   }
 371   return pos;
 372 }
 373
 374 bool
 375 WorldMap::path_ok(Direction direction, const Vector& old_pos, Vector* new_pos)
 376 {
 377   *new_pos = get_next_tile(old_pos, direction);
 378
 379   if (!(new_pos->x >= 0 && new_pos->x < solids->get_width()
 380         && new_pos->y >= 0 && new_pos->y < solids->get_height()))
 381     { // New position is outsite the tilemap
 382       return false;
 383     }
 384   else
 385     { // Check if the tile allows us to go to new_pos
 386       switch(direction)
 387         {
 388         case D_WEST:
 389           return (at(old_pos)->getData() & Tile::WORLDMAP_WEST
 390               && at(*new_pos)->getData() & Tile::WORLDMAP_EAST);
 391
 392         case D_EAST:
 393           return (at(old_pos)->getData() & Tile::WORLDMAP_EAST
 394               && at(*new_pos)->getData() & Tile::WORLDMAP_WEST);
 395
 396         case D_NORTH:
 397           return (at(old_pos)->getData() & Tile::WORLDMAP_NORTH
 398               && at(*new_pos)->getData() & Tile::WORLDMAP_SOUTH);
 399
 400         case D_SOUTH:
 401           return (at(old_pos)->getData() & Tile::WORLDMAP_SOUTH
 402               && at(*new_pos)->getData() & Tile::WORLDMAP_NORTH);
 403
 404         case D_NONE:
 405           assert(!"path_ok() can't walk if direction is NONE");
 406         }
 407       return false;
 408     }
 409 }
 410
 411 void
 412 WorldMap::finished_level(Level* gamelevel)
 413 {
 414   // TODO use Level* parameter here?
 415   LevelTile* level = at_level();
 416
 417   bool old_level_state = level->solved;
 418   level->solved = true;
 419   level->sprite->set_action("solved");
 420
 421   // deal with statistics
 422   level->statistics.merge(gamelevel->stats);
 423   calculate_total_stats();
 424
 425   save_state();
 426   if(World::current() != NULL)
 427     World::current()->save_state();
 428
 429   if (old_level_state != level->solved && level->auto_path) {
 430     // Try to detect the next direction to which we should walk
 431     // FIXME: Mostly a hack
 432     Direction dir = D_NONE;
 433
 434     const Tile* tile = at(tux->get_tile_pos());
 435
 436     // first, test for crossroads
 437     if (tile->getData() & Tile::WORLDMAP_CNSE || tile->getData() && Tile::WORLDMAP_CNSW
 438      || tile->getData() & Tile::WORLDMAP_CNEW || tile->getData() && Tile::WORLDMAP_CSEW
 439      || tile->getData() & Tile::WORLDMAP_CNSEW)
 440       dir = D_NONE;
 441     else if (tile->getData() & Tile::WORLDMAP_NORTH
 442         && tux->back_direction != D_NORTH)
 443       dir = D_NORTH;
 444     else if (tile->getData() & Tile::WORLDMAP_SOUTH
 445         && tux->back_direction != D_SOUTH)
 446       dir = D_SOUTH;
 447     else if (tile->getData() & Tile::WORLDMAP_EAST
 448         && tux->back_direction != D_EAST)
 449       dir = D_EAST;
 450     else if (tile->getData() & Tile::WORLDMAP_WEST
 451         && tux->back_direction != D_WEST)
 452       dir = D_WEST;
 453
 454     if (dir != D_NONE) {
 455       tux->set_direction(dir);
 456     }
 457   }
 458
 459   if (level->extro_script != "") {
 460     try {
 461       std::istringstream in(level->extro_script);
 462       run_script(in, "worldmap:extro_script");
 463     } catch(std::exception& e) {
 464       log_fatal << "Couldn't run level-extro-script: " << e.what() << std::endl;
 465     }
 466   }
 467 }
 468
 469 void
 470 WorldMap::update(float delta)
 471 {
 472   Menu* menu = Menu::current();
 473   if(menu != NULL) {
 474     menu->update();
 475
 476     if(menu == worldmap_menu.get()) {
 477       switch (worldmap_menu->check())
 478       {
 479         case MNID_RETURNWORLDMAP: // Return to game
 480           Menu::set_current(0);
 481           break;
 482         case MNID_QUITWORLDMAP: // Quit Worldmap
 483           main_loop->exit_screen();
 484           break;
 485       }
 486     }
 487
 488     return;
 489   }
 490
 491   // update GameObjects
 492   for(size_t i = 0; i < game_objects.size(); ++i) {
 493     GameObject* object = game_objects[i];
 494     object->update(delta);
 495   }
 496
 497   // remove old GameObjects
 498   for(GameObjects::iterator i = game_objects.begin();
 499       i != game_objects.end(); ) {
 500     GameObject* object = *i;
 501     if(!object->is_valid()) {
 502       object->unref();
 503       i = game_objects.erase(i);
 504     } else {
 505       ++i;
 506     }
 507   }
 508
 509   // position "camera"
 510   Vector tux_pos = tux->get_pos();
 511   camera_offset.x = tux_pos.x - SCREEN_WIDTH/2;
 512   camera_offset.y = tux_pos.y - SCREEN_HEIGHT/2;
 513
 514   if (camera_offset.x < 0)
 515     camera_offset.x = 0;
 516   if (camera_offset.y < 0)
 517     camera_offset.y = 0;
 518
 519   if (camera_offset.x > solids->get_width()*32 - SCREEN_WIDTH)
 520     camera_offset.x = solids->get_width()*32 - SCREEN_WIDTH;
 521   if (camera_offset.y > solids->get_height()*32 - SCREEN_HEIGHT)
 522     camera_offset.y = solids->get_height()*32 - SCREEN_HEIGHT;
 523
 524   // handle input
 525   bool enter_level = false;
 526   if(main_controller->pressed(Controller::ACTION)
 527       || main_controller->pressed(Controller::JUMP)
 528       || main_controller->pressed(Controller::MENU_SELECT))
 529     enter_level = true;
 530   if(main_controller->pressed(Controller::PAUSE_MENU))
 531     on_escape_press();
 532
 533   // check for teleporters
 534   Teleporter* teleporter = at_teleporter(tux->get_tile_pos());
 535   if (teleporter && (teleporter->automatic || (enter_level && (!tux->is_moving())))) {
 536     enter_level = false;
 537     if (teleporter->worldmap != "") {
 538       change(teleporter->worldmap, teleporter->spawnpoint);
 539     } else {
 540       // TODO: an animation, camera scrolling or a fading would be a nice touch
 541       sound_manager->play("sounds/warp.wav");
 542       tux->back_direction = D_NONE;
 543       move_to_spawnpoint(teleporter->spawnpoint);
 544     }
 545   }
 546
 547   // check for auto-play levels
 548   LevelTile* level = at_level();
 549   if (level && (level->auto_play) && (!level->solved) && (!tux->is_moving())) {
 550     enter_level = true;
 551     level->solved = true;
 552   }
 553
 554   if (enter_level && !tux->is_moving())
 555     {
 556       /* Check level action */
 557       LevelTile* level = at_level();
 558       if (!level) {
 559         //Respawn if player on a tile with no level and nowhere to go.
 560         const Tile* tile = at(tux->get_tile_pos());
 561         if(!( tile->getData() & ( Tile::WORLDMAP_NORTH |  Tile::WORLDMAP_SOUTH | Tile::WORLDMAP_WEST | Tile::WORLDMAP_EAST ))){
 562           log_warning << "Player at illegal position " << tux->get_tile_pos().x << ", " << tux->get_tile_pos().y << " respawning." << std::endl;
 563           move_to_spawnpoint("main");
 564           return;
 565         }
 566         log_warning << "No level to enter at: " << tux->get_tile_pos().x << ", " << tux->get_tile_pos().y << std::endl;
 567         return;
 568       }
 569
 570       if (level->pos == tux->get_tile_pos()) {
 571         try {
 572           Vector shrinkpos = Vector(level->pos.x*32 + 16 - camera_offset.x,
 573                                     level->pos.y*32 + 16 - camera_offset.y);
 574           std::string levelfile = levels_path + level->get_name();
 575           main_loop->push_screen(new GameSession(levelfile, &level->statistics),
 576                                  new ShrinkFade(shrinkpos, 0.5));
 577         } catch(std::exception& e) {
 578           log_fatal << "Couldn't load level: " << e.what() << std::endl;
 579         }
 580       }
 581     }
 582   else
 583     {
 584 //      tux->set_direction(input_direction);
 585     }
 586 }
 587
 588 const Tile*
 589 WorldMap::at(Vector p)
 590 {
 591   return solids->get_tile((int) p.x, (int) p.y);
 592 }
 593
 594 LevelTile*
 595 WorldMap::at_level()
 596 {
 597   for(LevelTiles::iterator i = levels.begin(); i != levels.end(); ++i) {
 598     LevelTile* level = *i;
 599     if (level->pos == tux->get_tile_pos())
 600       return level;
 601   }
 602
 603   return NULL;
 604 }
 605
 606 SpecialTile*
 607 WorldMap::at_special_tile()
 608 {
 609   for(SpecialTiles::iterator i = special_tiles.begin();
 610       i != special_tiles.end(); ++i) {
 611     SpecialTile* special_tile = *i;
 612     if (special_tile->pos == tux->get_tile_pos())
 613       return special_tile;
 614   }
 615
 616   return NULL;
 617 }
 618
 619 SpriteChange*
 620 WorldMap::at_sprite_change(const Vector& pos)
 621 {
 622   for(SpriteChanges::iterator i = sprite_changes.begin();
 623       i != sprite_changes.end(); ++i) {
 624     SpriteChange* sprite_change = *i;
 625     if(sprite_change->pos == pos)
 626       return sprite_change;
 627   }
 628
 629   return NULL;
 630 }
 631
 632 Teleporter*
 633 WorldMap::at_teleporter(const Vector& pos)
 634 {
 635   for(std::vector<Teleporter*>::iterator i = teleporters.begin(); i != teleporters.end(); ++i) {
 636     Teleporter* teleporter = *i;
 637     if(teleporter->pos == pos) return teleporter;
 638   }
 639
 640   return NULL;
 641 }
 642
 643 void
 644 WorldMap::draw(DrawingContext& context)
 645 {
 646   context.push_transform();
 647   context.set_translation(camera_offset);
 648
 649   for(GameObjects::iterator i = game_objects.begin();
 650       i != game_objects.end(); ++i) {
 651     GameObject* object = *i;
 652     object->draw(context);
 653   }
 654
 655   draw_status(context);
 656   context.pop_transform();
 657 }
 658
 659 void
 660 WorldMap::draw_status(DrawingContext& context)
 661 {
 662   context.push_transform();
 663   context.set_translation(Vector(0, 0));
 664
 665   player_status->draw(context);
 666
 667   if (!tux->is_moving()) {
 668     for(LevelTiles::iterator i = levels.begin(); i != levels.end(); ++i) {
 669       LevelTile* level = *i;
 670
 671       if (level->pos == tux->get_tile_pos()) {
 672         if(level->title == "")
 673           get_level_title(*level);
 674
 675         context.draw_text(white_text, level->title,
 676             Vector(SCREEN_WIDTH/2,
 677               SCREEN_HEIGHT - white_text->get_height() - 30),
 678             CENTER_ALLIGN, LAYER_FOREGROUND1);
 679
 680         // if level is solved, draw level picture behind stats
 681         /*
 682         if (level->solved) {
 683           if (const Surface* picture = level->get_picture()) {
 684             Vector pos = Vector(SCREEN_WIDTH - picture->get_width(), SCREEN_HEIGHT - picture->get_height());
 685             context.push_transform();
 686             context.set_alpha(0.5);
 687             context.draw_surface(picture, pos, LAYER_FOREGROUND1-1);
 688             context.pop_transform();
 689           }
 690         }
 691         */
 692
 693         level->statistics.draw_worldmap_info(context);
 694         break;
 695       }
 696     }
 697
 698     for(SpecialTiles::iterator i = special_tiles.begin();
 699         i != special_tiles.end(); ++i) {
 700       SpecialTile* special_tile = *i;
 701
 702       if (special_tile->pos == tux->get_tile_pos()) {
 703         /* Display an in-map message in the map, if any as been selected */
 704         if(!special_tile->map_message.empty() && !special_tile->passive_message)
 705           context.draw_text(gold_text, special_tile->map_message,
 706               Vector(SCREEN_WIDTH/2,
 707                 SCREEN_HEIGHT - white_text->get_height() - 60),
 708               CENTER_ALLIGN, LAYER_FOREGROUND1);
 709         break;
 710       }
 711     }
 712
 713     // display teleporter messages
 714     Teleporter* teleporter = at_teleporter(tux->get_tile_pos());
 715     if (teleporter && (teleporter->message != "")) {
 716       Vector pos = Vector(SCREEN_WIDTH/2, SCREEN_HEIGHT - white_text->get_height() - 30);
 717       context.draw_text(white_text, teleporter->message, pos, CENTER_ALLIGN, LAYER_FOREGROUND1);
 718     }
 719
 720   }
 721
 722   /* Display a passive message in the map, if needed */
 723   if(passive_message_timer.started())
 724     context.draw_text(gold_text, passive_message,
 725             Vector(SCREEN_WIDTH/2, SCREEN_HEIGHT - white_text->get_height() - 60),
 726             CENTER_ALLIGN, LAYER_FOREGROUND1);
 727
 728   context.pop_transform();
 729 }
 730
 731 void
 732 WorldMap::setup()
 733 {
 734   sound_manager->play_music(music);
 735   Menu::set_current(NULL);
 736
 737   current_ = this;
 738   load_state();
 739
 740   // if force_spawnpoint was set, move Tux there, then clear force_spawnpoint
 741   if (force_spawnpoint != "") {
 742     move_to_spawnpoint(force_spawnpoint);
 743     force_spawnpoint = "";
 744   }
 745
 746   tux->setup();
 747
 748   // register worldmap_table as worldmap in scripting
 749   using namespace Scripting;
 750
 751   sq_pushroottable(global_vm);
 752   sq_pushstring(global_vm, "worldmap", -1);
 753   sq_pushobject(global_vm, worldmap_table);
 754   if(SQ_FAILED(sq_createslot(global_vm, -3)))
 755     throw SquirrelError(global_vm, "Couldn't set worldmap in roottable");
 756   sq_pop(global_vm, 1);
 757
 758   if(init_script != "") {
 759     std::istringstream in(init_script);
 760     run_script(in, "WorldMap::init");
 761   }
 762 }
 763
 764 void
 765 WorldMap::leave()
 766 {
 767   // remove worldmap_table from roottable
 768   using namespace Scripting;
 769
 770   sq_pushroottable(global_vm);
 771   sq_pushstring(global_vm, "worldmap", -1);
 772   if(SQ_FAILED(sq_deleteslot(global_vm, -2, SQFalse)))
 773     throw SquirrelError(global_vm, "Couldn't unset worldmap in roottable");
 774   sq_pop(global_vm, 1);
 775 }
 776
 777 static void store_float(HSQUIRRELVM vm, const char* name, float val)
 778 {
 779   sq_pushstring(vm, name, -1);
 780   sq_pushfloat(vm, val);
 781   if(SQ_FAILED(sq_createslot(vm, -3)))
 782     throw Scripting::SquirrelError(vm, "Couldn't add float value to table");
 783 }
 784
 785 /*
 786 static void store_int(HSQUIRRELVM vm, const char* name, int val)
 787 {
 788   sq_pushstring(vm, name, -1);
 789   sq_pushinteger(vm, val);
 790   if(SQ_FAILED(sq_createslot(vm, -3)))
 791     throw Scripting::SquirrelError(vm, "Couldn't add float value to table");
 792 }
 793 */
 794
 795 static void store_string(HSQUIRRELVM vm, const char* name, const std::string& val)
 796 {
 797   sq_pushstring(vm, name, -1);
 798   sq_pushstring(vm, val.c_str(), val.length());
 799   if(SQ_FAILED(sq_createslot(vm, -3)))
 800     throw Scripting::SquirrelError(vm, "Couldn't add float value to table");
 801 }
 802
 803 static void store_bool(HSQUIRRELVM vm, const char* name, bool val)
 804 {
 805   sq_pushstring(vm, name, -1);
 806   sq_pushbool(vm, val ? SQTrue : SQFalse);
 807   if(SQ_FAILED(sq_createslot(vm, -3)))
 808     throw Scripting::SquirrelError(vm, "Couldn't add float value to table");
 809 }
 810
 811 static float read_float(HSQUIRRELVM vm, const char* name)
 812 {
 813   sq_pushstring(vm, name, -1);
 814   if(SQ_FAILED(sq_get(vm, -2))) {
 815     std::ostringstream msg;
 816     msg << "Couldn't get float value for '" << name << "' from table";
 817     throw Scripting::SquirrelError(vm, msg.str());
 818   }
 819
 820   float result;
 821   if(SQ_FAILED(sq_getfloat(vm, -1, &result))) {
 822     std::ostringstream msg;
 823     msg << "Couldn't get float value for '" << name << "' from table";
 824     throw Scripting::SquirrelError(vm, msg.str());
 825   }
 826   sq_pop(vm, 1);
 827
 828   return result;
 829 }
 830
 831 static std::string read_string(HSQUIRRELVM vm, const char* name)
 832 {
 833   sq_pushstring(vm, name, -1);
 834   if(SQ_FAILED(sq_get(vm, -2))) {
 835     std::ostringstream msg;
 836     msg << "Couldn't get string value for '" << name << "' from table";
 837     throw Scripting::SquirrelError(vm, msg.str());
 838   }
 839
 840   const char* result;
 841   if(SQ_FAILED(sq_getstring(vm, -1, &result))) {
 842     std::ostringstream msg;
 843     msg << "Couldn't get string value for '" << name << "' from table";
 844     throw Scripting::SquirrelError(vm, msg.str());
 845   }
 846   sq_pop(vm, 1);
 847
 848   return std::string(result);
 849 }
 850
 851 static bool read_bool(HSQUIRRELVM vm, const char* name)
 852 {
 853   sq_pushstring(vm, name, -1);
 854   if(SQ_FAILED(sq_get(vm, -2))) {
 855     std::ostringstream msg;
 856     msg << "Couldn't get bool value for '" << name << "' from table";
 857     throw Scripting::SquirrelError(vm, msg.str());
 858   }
 859
 860   SQBool result;
 861   if(SQ_FAILED(sq_getbool(vm, -1, &result))) {
 862     std::ostringstream msg;
 863     msg << "Couldn't get bool value for '" << name << "' from table";
 864     throw Scripting::SquirrelError(vm, msg.str());
 865   }
 866   sq_pop(vm, 1);
 867
 868   return result == SQTrue;
 869 }
 870
 871 void
 872 WorldMap::save_state()
 873 {
 874   using namespace Scripting;
 875
 876   HSQUIRRELVM vm = global_vm;
 877   int oldtop = sq_gettop(vm);
 878
 879   try {
 880     // get state table
 881     sq_pushroottable(vm);
 882     sq_pushstring(vm, "state", -1);
 883     if(SQ_FAILED(sq_get(vm, -2)))
 884       throw Scripting::SquirrelError(vm, "Couldn't get state table");
 885
 886     // get or create worlds table
 887     sq_pushstring(vm, "worlds", -1);
 888     if(SQ_FAILED(sq_get(vm, -2))) {
 889       sq_pushstring(vm, "worlds", -1);
 890       sq_newtable(vm);
 891       if(SQ_FAILED(sq_createslot(vm, -3)))
 892         throw Scripting::SquirrelError(vm, "Couldn't create state.worlds");
 893
 894       sq_pushstring(vm, "worlds", -1);
 895       if(SQ_FAILED(sq_get(vm, -2)))
 896         throw Scripting::SquirrelError(vm, "Couldn't create.get state.worlds");
 897     }
 898
 899     sq_pushstring(vm, map_filename.c_str(), map_filename.length());
 900     if(SQ_FAILED(sq_deleteslot(vm, -2, SQFalse)))
 901       sq_pop(vm, 1);
 902
 903     // construct new table for this worldmap
 904     sq_pushstring(vm, map_filename.c_str(), map_filename.length());
 905     sq_newtable(vm);
 906
 907     // store tux
 908     sq_pushstring(vm, "tux", -1);
 909     sq_newtable(vm);
 910
 911     store_float(vm, "x", tux->get_tile_pos().x);
 912     store_float(vm, "y", tux->get_tile_pos().y);
 913     store_string(vm, "back", direction_to_string(tux->back_direction));
 914
 915     sq_createslot(vm, -3);
 916
 917     // levels...
 918     sq_pushstring(vm, "levels", -1);
 919     sq_newtable(vm);
 920
 921     for(LevelTiles::iterator i = levels.begin(); i != levels.end(); ++i) {
 922       LevelTile* level = *i;
 923
 924       if (level->solved) {
 925         sq_pushstring(vm, level->get_name().c_str(), -1);
 926         sq_newtable(vm);
 927
 928         store_bool(vm, "solved", true);
 929         // TODO write statistics
 930         // i->statistics.write(writer);
 931
 932         sq_createslot(vm, -3);
 933       }
 934     }
 935
 936     sq_createslot(vm, -3);
 937
 938     // push world into worlds table
 939     sq_createslot(vm, -3);
 940   } catch(std::exception& e) {
 941     sq_settop(vm, oldtop);
 942   }
 943
 944   sq_settop(vm, oldtop);
 945 }
 946
 947 void
 948 WorldMap::load_state()
 949 {
 950   using namespace Scripting;
 951
 952   HSQUIRRELVM vm = global_vm;
 953   int oldtop = sq_gettop(vm);
 954
 955   try {
 956     // get state table
 957     sq_pushroottable(vm);
 958     sq_pushstring(vm, "state", -1);
 959     if(SQ_FAILED(sq_get(vm, -2)))
 960       throw Scripting::SquirrelError(vm, "Couldn't get state table");
 961
 962     // get worlds table
 963     sq_pushstring(vm, "worlds", -1);
 964     if(SQ_FAILED(sq_get(vm, -2)))
 965       throw Scripting::SquirrelError(vm, "Couldn't get state.worlds");
 966
 967     // get table for our world
 968     sq_pushstring(vm, map_filename.c_str(), map_filename.length());
 969     if(SQ_FAILED(sq_get(vm, -2)))
 970       throw Scripting::SquirrelError(vm, "Couldn't get state.world.mapfilename");
 971
 972     // load tux
 973     sq_pushstring(vm, "tux", -1);
 974     if(SQ_FAILED(sq_get(vm, -2)))
 975       throw Scripting::SquirrelError(vm, "Couldn't get tux");
 976
 977     Vector p;
 978     p.x = read_float(vm, "x");
 979     p.y = read_float(vm, "y");
 980     std::string back_str = read_string(vm, "back");
 981     tux->back_direction = string_to_direction(back_str);
 982     tux->set_tile_pos(p);
 983
 984     sq_pop(vm, 1);
 985
 986     // load levels
 987     sq_pushstring(vm, "levels", -1);
 988     if(SQ_FAILED(sq_get(vm, -2)))
 989       throw Scripting::SquirrelError(vm, "Couldn't get levels");
 990
 991     for(LevelTiles::iterator i = levels.begin(); i != levels.end(); ++i) {
 992       LevelTile* level = *i;
 993       sq_pushstring(vm, level->get_name().c_str(), -1);
 994       if(SQ_SUCCEEDED(sq_get(vm, -2))) {
 995         level->solved = read_bool(vm, "solved");
 996         level->sprite->set_action(level->solved ? "solved" : "default");
 997         // i->statistics.parse(*level);
 998         sq_pop(vm, 1);
 999       }
1000     }
1001     sq_pop(vm, 1);
1002
1003   } catch(std::exception& e) {
1004     log_debug << "Not loading worldmap state: " << e.what() << std::endl;
1005   }
1006   sq_settop(vm, oldtop);
1007 }
1008
1009 size_t
1010 WorldMap::level_count()
1011 {
1012   return levels.size();
1013 }
1014
1015 size_t
1016 WorldMap::solved_level_count()
1017 {
1018   size_t count = 0;
1019   for(LevelTiles::iterator i = levels.begin(); i != levels.end(); ++i) {
1020     LevelTile* level = *i;
1021
1022     if(level->solved)
1023       count++;
1024   }
1025
1026   return count;
1027 }
1028
1029 HSQUIRRELVM
1030 WorldMap::run_script(std::istream& in, const std::string& sourcename)
1031 {
1032   using namespace Scripting;
1033
1034   // garbage collect thread list
1035   for(ScriptList::iterator i = scripts.begin();
1036       i != scripts.end(); ) {
1037     HSQOBJECT& object = *i;
1038     HSQUIRRELVM vm = object_to_vm(object);
1039
1040     if(sq_getvmstate(vm) != SQ_VMSTATE_SUSPENDED) {
1041       sq_release(global_vm, &object);
1042       i = scripts.erase(i);
1043       continue;
1044     }
1045
1046     ++i;
1047   }
1048
1049   HSQOBJECT object = create_thread(global_vm);
1050   scripts.push_back(object);
1051
1052   HSQUIRRELVM vm = object_to_vm(object);
1053
1054   // set worldmap_table as roottable for the thread
1055   sq_pushobject(vm, worldmap_table);
1056   sq_setroottable(vm);
1057
1058   compile_and_run(vm, in, sourcename);
1059
1060   return vm;
1061 }
1062
1063 } // namespace WorldMapNS