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