src/worldmap/worldmap.hpp

   1 //  $Id$
   2 //
   3 //  SuperTux
   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 #ifndef SUPERTUX_WORLDMAP_H
  21 #define SUPERTUX_WORLDMAP_H
  22
  23 #include <vector>
  24 #include <string>
  25
  26 #include "math/vector.hpp"
  27 #include "lisp/lisp.hpp"
  28 #include "control/controller.hpp"
  29 #include "statistics.hpp"
  30 #include "timer.hpp"
  31 #include "screen.hpp"
  32 #include "tile_manager.hpp"
  33 #include "game_object.hpp"
  34 #include "console.hpp"
  35 #include "../level.hpp"
  36
  37 class Sprite;
  38 class Menu;
  39 class SpawnPoint;
  40 class GameObject;
  41 class TileMap;
  42
  43 namespace WorldMapNS {
  44
  45 class Tux;
  46 class LevelTile;
  47 class SpecialTile;
  48 class SpriteChange;
  49
  50 // For one way tiles
  51 enum {
  52   BOTH_WAYS,
  53   NORTH_SOUTH_WAY,
  54   SOUTH_NORTH_WAY,
  55   EAST_WEST_WAY,
  56   WEST_EAST_WAY
  57 };
  58
  59 enum Direction { D_NONE, D_WEST, D_EAST, D_NORTH, D_SOUTH };
  60
  61 std::string direction_to_string(Direction d);
  62 Direction   string_to_direction(const std::string& d);
  63 Direction reverse_dir(Direction d);
  64
  65 /**
  66  * Screen that displays a worldmap
  67  */
  68 class WorldMap : public Screen
  69 {
  70 private:
  71   Tux* tux;
  72
  73   static WorldMap* current_;
  74
  75   std::auto_ptr<Menu> worldmap_menu;
  76
  77   Vector camera_offset;
  78
  79   std::string name;
  80   std::string music;
  81   std::string init_script;
  82
  83   typedef std::vector<GameObject*> GameObjects;
  84   GameObjects game_objects;
  85   TileMap* solids;
  86
  87   std::auto_ptr<TileManager> tile_manager;
  88
  89 public:
  90   /** Variables to deal with the passive map messages */
  91   Timer passive_message_timer;
  92   std::string passive_message;
  93
  94 private:
  95   std::string map_filename;
  96   std::string levels_path;
  97
  98   typedef std::vector<SpecialTile*> SpecialTiles;
  99   SpecialTiles special_tiles;
 100   typedef std::vector<LevelTile*> LevelTiles;
 101   LevelTiles levels;
 102   typedef std::vector<SpriteChange*> SpriteChanges;
 103   SpriteChanges sprite_changes;
 104   typedef std::vector<SpawnPoint*> SpawnPoints;
 105   SpawnPoints spawn_points;
 106
 107   Statistics total_stats;
 108
 109   HSQOBJECT worldmap_table;
 110   typedef std::vector<HSQOBJECT> ScriptList;
 111   ScriptList scripts;
 112
 113 public:
 114   WorldMap(const std::string& filename);
 115   ~WorldMap();
 116
 117   void add_object(GameObject* object);
 118
 119   static WorldMap* current()
 120   { return current_; }
 121
 122   virtual void setup();
 123   virtual void leave();
 124
 125   /** Update worldmap state */
 126   virtual void update(float delta);
 127   /** Draw worldmap */
 128   virtual void draw(DrawingContext& context);
 129
 130   Vector get_next_tile(Vector pos, Direction direction);
 131   const Tile* at(Vector pos);
 132
 133   size_t level_count();
 134   size_t solved_level_count();
 135
 136   /**
 137    * gets called from the GameSession when a level has been successfully
 138    * finished
 139    */
 140   void finished_level(Level* level);
 141
 142   LevelTile* at_level();
 143   SpecialTile* at_special_tile();
 144   SpriteChange* at_sprite_change(const Vector& pos);
 145
 146   /** Check if it is possible to walk from \a pos into \a direction,
 147       if possible, write the new position to \a new_pos */
 148   bool path_ok(Direction direction, const Vector& pos, Vector* new_pos);
 149
 150   /**
 151    * Save worldmap state to squirrel state table
 152    */
 153   void save_state();
 154
 155   /**
 156    * Load worldmap state from squirrel state table
 157    */
 158   void load_state();
 159
 160   const std::string& get_title() const
 161   { return name; }
 162
 163   /**
 164    * runs a script in the context of the worldmap (and keeps a reference to
 165    * the script (so the script gets destroyed when the worldmap is destroyed)
 166    */
 167   HSQUIRRELVM run_script(std::istream& in, const std::string& sourcename);
 168
 169 private:
 170   void get_level_title(LevelTile& level);
 171   void draw_status(DrawingContext& context);
 172   void calculate_total_stats();
 173
 174   void load(const std::string& filename);
 175   void on_escape_press();
 176   void parse_special_tile(const lisp::Lisp* lisp);
 177   void parse_sprite_change(const lisp::Lisp* lisp);
 178 };
 179
 180 } // namespace WorldMapNS
 181
 182 #endif