src/worldmap/worldmap.hpp

   1 //  SuperTux
   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 #ifndef HEADER_SUPERTUX_WORLDMAP_WORLDMAP_HPP
  19 #define HEADER_SUPERTUX_WORLDMAP_WORLDMAP_HPP
  20
  21 #include <string>
  22 #include <vector>
  23
  24 #include "control/controller.hpp"
  25 #include "util/reader_fwd.hpp"
  26 #include "math/vector.hpp"
  27 #include "supertux/console.hpp"
  28 #include "supertux/game_object.hpp"
  29 #include "supertux/level.hpp"
  30 #include "supertux/screen.hpp"
  31 #include "supertux/statistics.hpp"
  32 #include "supertux/tile_manager.hpp"
  33 #include "supertux/timer.hpp"
  34 #include "worldmap/direction.hpp"
  35 #include "worldmap/spawn_point.hpp"
  36 #include "worldmap/special_tile.hpp"
  37 #include "worldmap/sprite_change.hpp"
  38 #include "worldmap/teleporter.hpp"
  39
  40 class Sprite;
  41 class Menu;
  42 class GameObject;
  43 class TileMap;
  44
  45 namespace WorldMapNS {
  46
  47 class Tux;
  48 class LevelTile;
  49 class SpecialTile;
  50 class SpriteChange;
  51
  52 // For one way tiles
  53 enum {
  54   BOTH_WAYS,
  55   NORTH_SOUTH_WAY,
  56   SOUTH_NORTH_WAY,
  57   EAST_WEST_WAY,
  58   WEST_EAST_WAY
  59 };
  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 runs a WorldMap, which lets the player choose a Level.
  67  */
  68 class WorldMap : public Screen
  69 {
  70   static Color level_title_color;
  71   static Color message_color;
  72   static Color teleporter_message_color;
  73
  74 private:
  75   typedef std::vector<SpecialTile*> SpecialTiles;
  76   typedef std::vector<SpriteChange*> SpriteChanges;
  77   typedef std::vector<SpawnPoint*> SpawnPoints;
  78   typedef std::vector<LevelTile*> LevelTiles;
  79   typedef std::vector<GameObject*> GameObjects;
  80   typedef std::vector<HSQOBJECT> ScriptList;
  81
  82   Tux* tux;
  83
  84   TileSet *tileset;
  85   bool     free_tileset;
  86
  87   static WorldMap* current_;
  88
  89   std::auto_ptr<Menu> worldmap_menu;
  90
  91   Vector camera_offset;
  92
  93   std::string name;
  94   std::string music;
  95   std::string init_script;
  96
  97   GameObjects game_objects;
  98   std::list<TileMap*> solid_tilemaps;
  99
 100 public:
 101   /** Variables to deal with the passive map messages */
 102   Timer passive_message_timer;
 103   std::string passive_message;
 104
 105 private:
 106   std::string map_filename;
 107   std::string levels_path;
 108
 109   SpecialTiles special_tiles;
 110   LevelTiles levels;
 111   SpriteChanges sprite_changes;
 112   SpawnPoints spawn_points;
 113   std::vector<Teleporter*> teleporters;
 114
 115   Statistics total_stats;
 116
 117   HSQOBJECT worldmap_table;
 118   ScriptList scripts;
 119
 120   Color ambient_light;
 121   std::string force_spawnpoint; /**< if set, spawnpoint will be forced to this value */
 122
 123   bool in_level;
 124
 125   /* variables to track panning to a spawn point */
 126   Vector pan_pos;
 127   bool panning;
 128
 129 public:
 130   WorldMap(const std::string& filename, const std::string& force_spawnpoint = "");
 131   ~WorldMap();
 132
 133   void add_object(GameObject* object);
 134
 135   void try_expose(GameObject* object);
 136   void try_unexpose(GameObject* object);
 137
 138   static WorldMap* current()
 139   { return current_; }
 140
 141   virtual void setup();
 142   virtual void leave();
 143
 144   /** Update worldmap state */
 145   virtual void update(float delta);
 146   /** Draw worldmap */
 147   virtual void draw(DrawingContext& context);
 148
 149   Vector get_next_tile(Vector pos, Direction direction);
 150
 151   /**
 152    * gets a bitfield of Tile::WORLDMAP_NORTH | Tile::WORLDMAP_WEST | ... values,
 153    * which indicates the directions Tux can move to when at the given position.
 154    */
 155   int available_directions_at(Vector pos);
 156
 157   /**
 158    * returns a bitfield representing the union of all Tile::WORLDMAP_XXX values
 159    * of all solid tiles at the given position
 160    */
 161   int tile_data_at(Vector pos);
 162
 163   size_t level_count();
 164   size_t solved_level_count();
 165
 166   /**
 167    * gets called from the GameSession when a level has been successfully
 168    * finished
 169    */
 170   void finished_level(Level* level);
 171
 172   /** returns current Tux incarnation */
 173   Tux* get_tux() { return tux; }
 174
 175   LevelTile* at_level();
 176   SpecialTile* at_special_tile();
 177   SpriteChange* at_sprite_change(const Vector& pos);
 178   Teleporter* at_teleporter(const Vector& pos);
 179
 180   /** Check if it is possible to walk from \a pos into \a direction,
 181       if possible, write the new position to \a new_pos */
 182   bool path_ok(Direction direction, const Vector& pos, Vector* new_pos);
 183
 184   /**
 185    * Save worldmap state to squirrel state table
 186    */
 187   void save_state();
 188
 189   /**
 190    * Load worldmap state from squirrel state table
 191    */
 192   void load_state();
 193
 194   const std::string& get_title() const
 195   { return name; }
 196
 197   /**
 198    * runs a script in the context of the worldmap (and keeps a reference to
 199    * the script (so the script gets destroyed when the worldmap is destroyed)
 200    */
 201   HSQUIRRELVM run_script(std::istream& in, const std::string& sourcename);
 202
 203   /**
 204    * switch to another worldmap.
 205    * filename is relative to data root path
 206    */
 207   void change(const std::string& filename, const std::string& force_spawnpoint="");
 208
 209   /**
 210    * moves Tux to the given spawnpoint
 211    */
 212   void move_to_spawnpoint(const std::string& spawnpoint, bool pan =false);
 213
 214   /**
 215    * returns the width (in tiles) of a worldmap
 216    */
 217   float get_width() const;
 218
 219   /**
 220    * returns the height (in tiles) of a worldmap
 221    */
 222   float get_height() const;
 223
 224 private:
 225   void get_level_title(LevelTile& level);
 226   void draw_status(DrawingContext& context);
 227   void calculate_total_stats();
 228
 229   void load(const std::string& filename);
 230   void on_escape_press();
 231
 232   Vector get_camera_pos_for_tux();
 233   void clamp_camera_position(Vector& c);
 234
 235 private:
 236   WorldMap(const WorldMap&);
 237   WorldMap& operator=(const WorldMap&);
 238 };
 239
 240 } // namespace WorldMapNS
 241
 242 #endif
 243
 244 /* EOF */