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