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