Added ability to define a 'target time' for levels which is taken into consideration...
[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
368 WorldMap::get_level_target_time(LevelTile& level)
369 {
370   try {
371     lisp::Parser parser;
372     const lisp::Lisp* root = parser.parse(levels_path + level.get_name());
373
374     const lisp::Lisp* level_lisp = root->get_lisp("supertux-level");
375     if(!level_lisp)
376       return;
377
378     level_lisp->get("target-time", level.target_time);
379   } catch(std::exception& e) {
380     log_warning << "Problem when reading level target time: " << e.what() << std::endl;
381     return;
382   }
383 }
384
385 void WorldMap::calculate_total_stats()
386 {
387   total_stats.zero();
388   for(LevelTiles::iterator i = levels.begin(); i != levels.end(); ++i) {
389     LevelTile* level = *i;
390     if (level->solved) {
391       total_stats += level->statistics;
392     }
393   }
394 }
395
396 void
397 WorldMap::on_escape_press()
398 {
399   // Show or hide the menu
400   if(!MenuManager::current()) {
401     MenuManager::set_current(worldmap_menu.get());
402     tux->set_direction(D_NONE);  // stop tux movement when menu is called
403   } else {
404     MenuManager::set_current(NULL);
405   }
406 }
407
408 Vector
409 WorldMap::get_next_tile(Vector pos, Direction direction)
410 {
411   switch(direction) {
412     case D_WEST:
413       pos.x -= 1;
414       break;
415     case D_EAST:
416       pos.x += 1;
417       break;
418     case D_NORTH:
419       pos.y -= 1;
420       break;
421     case D_SOUTH:
422       pos.y += 1;
423       break;
424     case D_NONE:
425       break;
426   }
427   return pos;
428 }
429
430 bool
431 WorldMap::path_ok(Direction direction, const Vector& old_pos, Vector* new_pos)
432 {
433   *new_pos = get_next_tile(old_pos, direction);
434
435   if (!(new_pos->x >= 0 && new_pos->x < get_width()
436         && new_pos->y >= 0 && new_pos->y < get_height()))
437   { // New position is outsite the tilemap
438     return false;
439   }
440   else
441   { // Check if the tile allows us to go to new_pos
442     int old_tile_data = tile_data_at(old_pos);
443     int new_tile_data = tile_data_at(*new_pos);
444     switch(direction)
445     {
446       case D_WEST:
447         return (old_tile_data & Tile::WORLDMAP_WEST
448                 && new_tile_data & Tile::WORLDMAP_EAST);
449
450       case D_EAST:
451         return (old_tile_data & Tile::WORLDMAP_EAST
452                 && new_tile_data & Tile::WORLDMAP_WEST);
453
454       case D_NORTH:
455         return (old_tile_data & Tile::WORLDMAP_NORTH
456                 && new_tile_data & Tile::WORLDMAP_SOUTH);
457
458       case D_SOUTH:
459         return (old_tile_data & Tile::WORLDMAP_SOUTH
460                 && new_tile_data & Tile::WORLDMAP_NORTH);
461
462       case D_NONE:
463         assert(!"path_ok() can't walk if direction is NONE");
464     }
465     return false;
466   }
467 }
468
469 void
470 WorldMap::finished_level(Level* gamelevel)
471 {
472   // TODO use Level* parameter here?
473   LevelTile* level = at_level();
474
475   bool old_level_state = level->solved;
476   level->solved = true;
477   level->sprite->set_action("solved");
478
479   // deal with statistics
480   level->statistics.merge(gamelevel->stats);
481   calculate_total_stats();
482   get_level_target_time(*level);
483   if(level->statistics.completed(level->statistics, level->target_time)) {
484     level->perfect = true;
485     level->sprite->set_action("perfect");
486   }
487
488   save_state();
489
490   if (old_level_state != level->solved) {
491     // Try to detect the next direction to which we should walk
492     // FIXME: Mostly a hack
493     Direction dir = D_NONE;
494
495     int dirdata = available_directions_at(tux->get_tile_pos());
496     // first, test for crossroads
497     if (dirdata == Tile::WORLDMAP_CNSE ||
498         dirdata == Tile::WORLDMAP_CNSW ||
499         dirdata == Tile::WORLDMAP_CNEW ||
500         dirdata == Tile::WORLDMAP_CSEW ||
501         dirdata == Tile::WORLDMAP_CNSEW)
502       dir = D_NONE;
503     else if (dirdata & Tile::WORLDMAP_NORTH
504              && tux->back_direction != D_NORTH)
505       dir = D_NORTH;
506     else if (dirdata & Tile::WORLDMAP_SOUTH
507              && tux->back_direction != D_SOUTH)
508       dir = D_SOUTH;
509     else if (dirdata & Tile::WORLDMAP_EAST
510              && tux->back_direction != D_EAST)
511       dir = D_EAST;
512     else if (dirdata & Tile::WORLDMAP_WEST
513              && tux->back_direction != D_WEST)
514       dir = D_WEST;
515
516     if (dir != D_NONE) {
517       tux->set_direction(dir);
518     }
519   }
520
521   if (level->extro_script != "") {
522     try {
523       std::istringstream in(level->extro_script);
524       run_script(in, "worldmap:extro_script");
525     } catch(std::exception& e) {
526       log_warning << "Couldn't run level-extro-script: " << e.what() << std::endl;
527     }
528   }
529 }
530
531 Vector
532 WorldMap::get_camera_pos_for_tux() {
533   Vector camera_offset;
534   Vector tux_pos = tux->get_pos();
535   camera_offset.x = tux_pos.x - SCREEN_WIDTH/2;
536   camera_offset.y = tux_pos.y - SCREEN_HEIGHT/2;
537   return camera_offset;
538 }
539
540 void
541 WorldMap::clamp_camera_position(Vector& c) {
542   if (c.x < 0)
543     c.x = 0;
544   if (c.y < 0)
545     c.y = 0;
546
547   if (c.x > (int)get_width()*32 - SCREEN_WIDTH)
548     c.x = (int)get_width()*32 - SCREEN_WIDTH;
549   if (c.y > (int)get_height()*32 - SCREEN_HEIGHT)
550     c.y = (int)get_height()*32 - SCREEN_HEIGHT;
551
552   if (int(get_width()*32) < SCREEN_WIDTH)
553     c.x = get_width()*16.0 - SCREEN_WIDTH/2.0;
554   if (int(get_height()*32) < SCREEN_HEIGHT)
555     c.y = get_height()*16.0 - SCREEN_HEIGHT/2.0;
556 }
557
558 void
559 WorldMap::update(float delta)
560 {
561   if(!in_level) {
562     Menu* menu = MenuManager::current();
563     if(menu != NULL) {
564       if(menu == worldmap_menu.get()) {
565         switch (worldmap_menu->check())
566         {
567           case MNID_RETURNWORLDMAP: // Return to game
568             MenuManager::set_current(0);
569             break;
570           case MNID_QUITWORLDMAP: // Quit Worldmap
571             g_screen_manager->exit_screen();
572             break;
573         }
574       }
575
576       return;
577     }
578
579     // update GameObjects
580     for(size_t i = 0; i < game_objects.size(); ++i) {
581       GameObject* object = game_objects[i];
582       if(!panning || object != tux) {
583         object->update(delta);
584       }
585     }
586
587     // remove old GameObjects
588     for(GameObjects::iterator i = game_objects.begin();
589         i != game_objects.end(); ) {
590       GameObject* object = *i;
591       if(!object->is_valid()) {
592         try_unexpose(object);
593         object->unref();
594         i = game_objects.erase(i);
595       } else {
596         ++i;
597       }
598     }
599
600     /* update solid_tilemaps list */
601     //FIXME: this could be more efficient
602     solid_tilemaps.clear();
603     for(std::vector<GameObject*>::iterator i = game_objects.begin();
604         i != game_objects.end(); ++i)
605     {
606       TileMap* tm = dynamic_cast<TileMap*>(*i);
607       if (!tm) continue;
608       if (tm->is_solid()) solid_tilemaps.push_back(tm);
609     }
610
611     Vector requested_pos;
612
613     // position "camera"
614     if(!panning) {
615       camera_offset = get_camera_pos_for_tux();
616     } else {
617       Vector delta = pan_pos - camera_offset;
618       float mag = delta.norm();
619       if(mag > CAMERA_PAN_SPEED) {
620         delta *= CAMERA_PAN_SPEED/mag;
621       }
622       camera_offset += delta;
623       if(camera_offset == pan_pos) {
624         panning = false;
625       }
626     }
627
628     requested_pos = camera_offset;
629     clamp_camera_position(camera_offset);
630
631     if(panning) {
632       if(requested_pos.x != camera_offset.x) {
633         pan_pos.x = camera_offset.x;
634       }
635       if(requested_pos.y != camera_offset.y) {
636         pan_pos.y = camera_offset.y;
637       }
638     }
639
640     // handle input
641     Controller *controller = g_jk_controller->get_main_controller();
642     bool enter_level = false;
643     if(controller->pressed(Controller::ACTION)
644        || controller->pressed(Controller::JUMP)
645        || controller->pressed(Controller::MENU_SELECT)) {
646       /* some people define UP and JUMP on the same key... */
647       if(!controller->pressed(Controller::UP))
648         enter_level = true;
649     }
650     if(controller->pressed(Controller::PAUSE_MENU))
651       on_escape_press();
652
653     // check for teleporters
654     Teleporter* teleporter = at_teleporter(tux->get_tile_pos());
655     if (teleporter && (teleporter->automatic || (enter_level && (!tux->is_moving())))) {
656       enter_level = false;
657       if (teleporter->worldmap != "") {
658         change(teleporter->worldmap, teleporter->spawnpoint);
659       } else {
660         // TODO: an animation, camera scrolling or a fading would be a nice touch
661         sound_manager->play("sounds/warp.wav");
662         tux->back_direction = D_NONE;
663         move_to_spawnpoint(teleporter->spawnpoint, true);
664       }
665     }
666
667     // check for auto-play levels
668     LevelTile* level = at_level();
669     if (level && (level->auto_play) && (!level->solved) && (!tux->is_moving())) {
670       enter_level = true;
671     }
672
673     if (enter_level && !tux->is_moving())
674     {
675       /* Check level action */
676       LevelTile* level = at_level();
677       if (!level) {
678         //Respawn if player on a tile with no level and nowhere to go.
679         int tile_data = tile_data_at(tux->get_tile_pos());
680         if(!( tile_data & ( Tile::WORLDMAP_NORTH |  Tile::WORLDMAP_SOUTH | Tile::WORLDMAP_WEST | Tile::WORLDMAP_EAST ))){
681           log_warning << "Player at illegal position " << tux->get_tile_pos().x << ", " << tux->get_tile_pos().y << " respawning." << std::endl;
682           move_to_spawnpoint("main");
683           return;
684         }
685         log_warning << "No level to enter at: " << tux->get_tile_pos().x << ", " << tux->get_tile_pos().y << std::endl;
686         return;
687       }
688
689       if (level->pos == tux->get_tile_pos()) {
690         try {
691           Vector shrinkpos = Vector(level->pos.x*32 + 16 - camera_offset.x,
692                                     level->pos.y*32 +  8 - camera_offset.y);
693           std::string levelfile = levels_path + level->get_name();
694
695           // update state and savegame
696           save_state();
697
698           g_screen_manager->push_screen(new GameSession(levelfile, player_status, &level->statistics),
699                                    new ShrinkFade(shrinkpos, 1.0f));
700           in_level = true;
701         } catch(std::exception& e) {
702           log_fatal << "Couldn't load level: " << e.what() << std::endl;
703         }
704       }
705     }
706     else
707     {
708       //      tux->set_direction(input_direction);
709     }
710   }
711 }
712
713 int
714 WorldMap::tile_data_at(Vector p)
715 {
716   int dirs = 0;
717
718   for(std::list<TileMap*>::const_iterator i = solid_tilemaps.begin(); i != solid_tilemaps.end(); i++) {
719     TileMap* tilemap = *i;
720     const Tile* tile = tilemap->get_tile((int)p.x, (int)p.y);
721     int dirdata = tile->getData();
722     dirs |= dirdata;
723   }
724
725   return dirs;
726 }
727
728 int
729 WorldMap::available_directions_at(Vector p)
730 {
731   return tile_data_at(p) & Tile::WORLDMAP_DIR_MASK;
732 }
733
734 LevelTile*
735 WorldMap::at_level()
736 {
737   for(LevelTiles::iterator i = levels.begin(); i != levels.end(); ++i) {
738     LevelTile* level = *i;
739     if (level->pos == tux->get_tile_pos())
740       return level;
741   }
742
743   return NULL;
744 }
745
746 SpecialTile*
747 WorldMap::at_special_tile()
748 {
749   for(SpecialTiles::iterator i = special_tiles.begin();
750       i != special_tiles.end(); ++i) {
751     SpecialTile* special_tile = *i;
752     if (special_tile->pos == tux->get_tile_pos())
753       return special_tile;
754   }
755
756   return NULL;
757 }
758
759 SpriteChange*
760 WorldMap::at_sprite_change(const Vector& pos)
761 {
762   for(SpriteChanges::iterator i = sprite_changes.begin();
763       i != sprite_changes.end(); ++i) {
764     SpriteChange* sprite_change = *i;
765     if(sprite_change->pos == pos)
766       return sprite_change;
767   }
768
769   return NULL;
770 }
771
772 Teleporter*
773 WorldMap::at_teleporter(const Vector& pos)
774 {
775   for(std::vector<Teleporter*>::iterator i = teleporters.begin(); i != teleporters.end(); ++i) {
776     Teleporter* teleporter = *i;
777     if(teleporter->pos == pos) return teleporter;
778   }
779
780   return NULL;
781 }
782
783 void
784 WorldMap::draw(DrawingContext& context)
785 {
786   if (int(get_width()*32) < SCREEN_WIDTH || int(get_height()*32) < SCREEN_HEIGHT)
787     context.draw_filled_rect(Vector(0, 0), Vector(SCREEN_WIDTH, SCREEN_HEIGHT),
788                              Color(0.0f, 0.0f, 0.0f, 1.0f), LAYER_BACKGROUND0);
789
790   context.set_ambient_color( ambient_light );
791   context.push_transform();
792   context.set_translation(camera_offset);
793
794   for(GameObjects::iterator i = game_objects.begin();
795       i != game_objects.end(); ++i) {
796     GameObject* object = *i;
797     if(!panning || object != tux) {
798       object->draw(context);
799     }
800   }
801
802   /*
803   // FIXME: make this a runtime switch similar to draw_collrects/show_collrects?
804   // draw visual indication of possible walk directions
805   static int flipme = 0; 
806   if (flipme++ & 0x04)
807   for (int x = 0; x < get_width(); x++) {
808   for (int y = 0; y < get_height(); y++) {
809   int data = tile_data_at(Vector(x,y));
810   int px = x * 32;
811   int py = y * 32;
812   const int W = 4;
813   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);
814   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);
815   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);
816   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);
817   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);
818   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);
819   }
820   }
821   */
822
823   draw_status(context);
824   context.pop_transform();
825 }
826
827 void
828 WorldMap::draw_status(DrawingContext& context)
829 {
830   context.push_transform();
831   context.set_translation(Vector(0, 0));
832
833   player_status->draw(context);
834
835   if (!tux->is_moving()) {
836     for(LevelTiles::iterator i = levels.begin(); i != levels.end(); ++i) {
837       LevelTile* level = *i;
838
839       if (level->pos == tux->get_tile_pos()) {
840         if(level->title == "")
841           get_level_title(*level);
842
843         context.draw_text(Resources::normal_font, level->title,
844                           Vector(SCREEN_WIDTH/2,
845                                  SCREEN_HEIGHT - Resources::normal_font->get_height() - 10),
846                           ALIGN_CENTER, LAYER_HUD, WorldMap::level_title_color);
847
848         // if level is solved, draw level picture behind stats
849         /*
850           if (level->solved) {
851           if (const Surface* picture = level->get_picture()) {
852           Vector pos = Vector(SCREEN_WIDTH - picture->get_width(), SCREEN_HEIGHT - picture->get_height());
853           context.push_transform();
854           context.set_alpha(0.5);
855           context.draw_surface(picture, pos, LAYER_FOREGROUND1-1);
856           context.pop_transform();
857           }
858           }
859         */
860
861         level->statistics.draw_worldmap_info(context);
862         break;
863       }
864     }
865
866     for(SpecialTiles::iterator i = special_tiles.begin();
867         i != special_tiles.end(); ++i) {
868       SpecialTile* special_tile = *i;
869
870       if (special_tile->pos == tux->get_tile_pos()) {
871         /* Display an in-map message in the map, if any as been selected */
872         if(!special_tile->map_message.empty() && !special_tile->passive_message)
873           context.draw_text(Resources::normal_font, special_tile->map_message,
874                             Vector(SCREEN_WIDTH/2,
875                                    SCREEN_HEIGHT - Resources::normal_font->get_height() - 60),
876                             ALIGN_CENTER, LAYER_FOREGROUND1, WorldMap::message_color);
877         break;
878       }
879     }
880
881     // display teleporter messages
882     Teleporter* teleporter = at_teleporter(tux->get_tile_pos());
883     if (teleporter && (teleporter->message != "")) {
884       Vector pos = Vector(SCREEN_WIDTH/2, SCREEN_HEIGHT - Resources::normal_font->get_height() - 30);
885       context.draw_text(Resources::normal_font, teleporter->message, pos, ALIGN_CENTER, LAYER_FOREGROUND1, WorldMap::teleporter_message_color);
886     }
887
888   }
889
890   /* Display a passive message in the map, if needed */
891   if(passive_message_timer.started())
892     context.draw_text(Resources::normal_font, passive_message,
893                       Vector(SCREEN_WIDTH/2, SCREEN_HEIGHT - Resources::normal_font->get_height() - 60),
894                       ALIGN_CENTER, LAYER_FOREGROUND1, WorldMap::message_color);
895
896   context.pop_transform();
897 }
898
899 void
900 WorldMap::setup()
901 {
902   sound_manager->play_music(music);
903   MenuManager::set_current(NULL);
904
905   current_ = this;
906   load_state();
907
908   // if force_spawnpoint was set, move Tux there, then clear force_spawnpoint
909   if (force_spawnpoint != "") {
910     move_to_spawnpoint(force_spawnpoint);
911     force_spawnpoint = "";
912   }
913
914   tux->setup();
915
916   // register worldmap_table as worldmap in scripting
917   using namespace scripting;
918
919   sq_pushroottable(global_vm);
920   sq_pushstring(global_vm, "worldmap", -1);
921   sq_pushobject(global_vm, worldmap_table);
922   if(SQ_FAILED(sq_createslot(global_vm, -3)))
923     throw SquirrelError(global_vm, "Couldn't set worldmap in roottable");
924   sq_pop(global_vm, 1);
925
926   //Run default.nut just before init script
927   try {
928     IFileStream in(levels_path + "/default.nut");
929     run_script(in, "WorldMap::default.nut");
930   } catch(std::exception& ) {
931     // doesn't exist or erroneous; do nothing
932   }
933
934   if(init_script != "") {
935     std::istringstream in(init_script);
936     run_script(in, "WorldMap::init");
937   }
938 }
939
940 void
941 WorldMap::leave()
942 {
943   using namespace scripting;
944
945   // save state of world and player
946   save_state();
947
948   // remove worldmap_table from roottable
949   sq_pushroottable(global_vm);
950   sq_pushstring(global_vm, "worldmap", -1);
951   if(SQ_FAILED(sq_deleteslot(global_vm, -2, SQFalse)))
952     throw SquirrelError(global_vm, "Couldn't unset worldmap in roottable");
953   sq_pop(global_vm, 1);
954 }
955
956 void
957 WorldMap::save_state()
958 {
959   using namespace scripting;
960
961   HSQUIRRELVM vm = global_vm;
962   int oldtop = sq_gettop(vm);
963
964   try {
965     // get state table
966     sq_pushroottable(vm);
967     sq_pushstring(vm, "state", -1);
968     if(SQ_FAILED(sq_get(vm, -2)))
969       throw scripting::SquirrelError(vm, "Couldn't get state table");
970
971     // get or create worlds table
972     sq_pushstring(vm, "worlds", -1);
973     if(SQ_FAILED(sq_get(vm, -2))) {
974       sq_pushstring(vm, "worlds", -1);
975       sq_newtable(vm);
976       if(SQ_FAILED(sq_createslot(vm, -3)))
977         throw scripting::SquirrelError(vm, "Couldn't create state.worlds");
978
979       sq_pushstring(vm, "worlds", -1);
980       if(SQ_FAILED(sq_get(vm, -2)))
981         throw scripting::SquirrelError(vm, "Couldn't create.get state.worlds");
982     }
983
984     sq_pushstring(vm, map_filename.c_str(), map_filename.length());
985     if(SQ_FAILED(sq_deleteslot(vm, -2, SQFalse)))
986       sq_pop(vm, 1);
987
988     // construct new table for this worldmap
989     sq_pushstring(vm, map_filename.c_str(), map_filename.length());
990     sq_newtable(vm);
991
992     // store tux
993     sq_pushstring(vm, "tux", -1);
994     sq_newtable(vm);
995
996     store_float(vm, "x", tux->get_tile_pos().x);
997     store_float(vm, "y", tux->get_tile_pos().y);
998     store_string(vm, "back", direction_to_string(tux->back_direction));
999
1000     sq_createslot(vm, -3);
1001
1002     // levels...
1003     sq_pushstring(vm, "levels", -1);
1004     sq_newtable(vm);
1005
1006     for(LevelTiles::iterator i = levels.begin(); i != levels.end(); ++i) {
1007       LevelTile* level = *i;
1008
1009       sq_pushstring(vm, level->get_name().c_str(), -1);
1010       sq_newtable(vm);
1011
1012       store_bool(vm, "solved", level->solved);
1013       store_bool(vm, "perfect", level->perfect);
1014       level->statistics.serialize_to_squirrel(vm);
1015
1016       sq_createslot(vm, -3);
1017     }
1018
1019     sq_createslot(vm, -3);
1020
1021     // overall statistics...
1022     total_stats.serialize_to_squirrel(vm);
1023
1024     // push world into worlds table
1025     sq_createslot(vm, -3);
1026   } catch(std::exception& ) {
1027     sq_settop(vm, oldtop);
1028   }
1029
1030   sq_settop(vm, oldtop);
1031
1032   if(World::current() != NULL)
1033     World::current()->save_state();
1034 }
1035
1036 void
1037 WorldMap::load_state()
1038 {
1039   using namespace scripting;
1040
1041   HSQUIRRELVM vm = global_vm;
1042   int oldtop = sq_gettop(vm);
1043
1044   try {
1045     // get state table
1046     sq_pushroottable(vm);
1047     sq_pushstring(vm, "state", -1);
1048     if(SQ_FAILED(sq_get(vm, -2)))
1049       throw scripting::SquirrelError(vm, "Couldn't get state table");
1050
1051     // get worlds table
1052     sq_pushstring(vm, "worlds", -1);
1053     if(SQ_FAILED(sq_get(vm, -2)))
1054       throw scripting::SquirrelError(vm, "Couldn't get state.worlds");
1055
1056     // get table for our world
1057     sq_pushstring(vm, map_filename.c_str(), map_filename.length());
1058     if(SQ_FAILED(sq_get(vm, -2)))
1059       throw scripting::SquirrelError(vm, "Couldn't get state.worlds.mapfilename");
1060
1061     // load tux
1062     sq_pushstring(vm, "tux", -1);
1063     if(SQ_FAILED(sq_get(vm, -2)))
1064       throw scripting::SquirrelError(vm, "Couldn't get tux");
1065
1066     Vector p;
1067     p.x = read_float(vm, "x");
1068     p.y = read_float(vm, "y");
1069     std::string back_str = read_string(vm, "back");
1070     tux->back_direction = string_to_direction(back_str);
1071     tux->set_tile_pos(p);
1072
1073     sq_pop(vm, 1);
1074
1075     // load levels
1076     sq_pushstring(vm, "levels", -1);
1077     if(SQ_FAILED(sq_get(vm, -2)))
1078       throw scripting::SquirrelError(vm, "Couldn't get levels");
1079
1080     for(LevelTiles::iterator i = levels.begin(); i != levels.end(); ++i) {
1081       LevelTile* level = *i;
1082       sq_pushstring(vm, level->get_name().c_str(), -1);
1083       if(SQ_SUCCEEDED(sq_get(vm, -2))) {
1084         level->solved = read_bool(vm, "solved");
1085         level->perfect = read_bool(vm, "perfect");
1086         if(!level->solved)
1087           level->sprite->set_action("default");
1088         else
1089           level->sprite->set_action((level->sprite->has_action("perfect") && level->perfect) ? "perfect" : "solved");
1090         level->statistics.unserialize_from_squirrel(vm);
1091         sq_pop(vm, 1);
1092       }
1093     }
1094
1095     // leave state table
1096     sq_pop(vm, 1);
1097
1098     // load overall statistics
1099     total_stats.unserialize_from_squirrel(vm);
1100
1101   } catch(std::exception& e) {
1102     log_debug << "Not loading worldmap state: " << e.what() << std::endl;
1103   }
1104   sq_settop(vm, oldtop);
1105
1106   in_level = false;
1107 }
1108
1109 size_t
1110 WorldMap::level_count()
1111 {
1112   return levels.size();
1113 }
1114
1115 size_t
1116 WorldMap::solved_level_count()
1117 {
1118   size_t count = 0;
1119   for(LevelTiles::iterator i = levels.begin(); i != levels.end(); ++i) {
1120     LevelTile* level = *i;
1121
1122     if(level->solved)
1123       count++;
1124   }
1125
1126   return count;
1127 }
1128
1129 HSQUIRRELVM
1130 WorldMap::run_script(std::istream& in, const std::string& sourcename)
1131 {
1132   using namespace scripting;
1133
1134   // garbage collect thread list
1135   for(ScriptList::iterator i = scripts.begin();
1136       i != scripts.end(); ) {
1137     HSQOBJECT& object = *i;
1138     HSQUIRRELVM vm = object_to_vm(object);
1139
1140     if(sq_getvmstate(vm) != SQ_VMSTATE_SUSPENDED) {
1141       sq_release(global_vm, &object);
1142       i = scripts.erase(i);
1143       continue;
1144     }
1145
1146     ++i;
1147   }
1148
1149   HSQOBJECT object = create_thread(global_vm);
1150   scripts.push_back(object);
1151
1152   HSQUIRRELVM vm = object_to_vm(object);
1153
1154   // set worldmap_table as roottable for the thread
1155   sq_pushobject(vm, worldmap_table);
1156   sq_setroottable(vm);
1157
1158   compile_and_run(vm, in, sourcename);
1159
1160   return vm;
1161 }
1162
1163 float
1164 WorldMap::get_width() const
1165 {
1166   float width = 0;
1167   for(std::list<TileMap*>::const_iterator i = solid_tilemaps.begin(); i != solid_tilemaps.end(); i++) {
1168     TileMap* solids = *i;
1169     if (solids->get_width() > width) width = solids->get_width();
1170   }
1171   return width;
1172 }
1173
1174 float
1175 WorldMap::get_height() const
1176 {
1177   float height = 0;
1178   for(std::list<TileMap*>::const_iterator i = solid_tilemaps.begin(); i != solid_tilemaps.end(); i++) {
1179     TileMap* solids = *i;
1180     if (solids->get_height() > height) height = solids->get_height();
1181   }
1182   return height;
1183 }
1184
1185 } // namespace worldmap
1186
1187 /* EOF */