2 // Copyright (C) 2004 Ingo Ruhnke <grumbel@gmx.de>
3 // Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.de>
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.
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.
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/>.
18 #ifndef HEADER_SUPERTUX_WORLDMAP_WORLDMAP_HPP
19 #define HEADER_SUPERTUX_WORLDMAP_WORLDMAP_HPP
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"
63 * Screen that runs a WorldMap, which lets the player choose a Level.
65 class WorldMap : public Screen
67 static Color level_title_color;
68 static Color message_color;
69 static Color teleporter_message_color;
72 typedef std::vector<SpecialTile*> SpecialTiles;
73 typedef std::vector<SpriteChange*> SpriteChanges;
74 typedef std::vector<SpawnPoint*> SpawnPoints;
75 typedef std::vector<LevelTile*> LevelTiles;
76 typedef std::vector<GameObject*> GameObjects;
77 typedef std::vector<HSQOBJECT> ScriptList;
81 PlayerStatus* player_status;
86 static WorldMap* current_;
88 std::auto_ptr<Menu> worldmap_menu;
94 std::string init_script;
96 GameObjects game_objects;
97 std::list<TileMap*> solid_tilemaps;
100 /** Variables to deal with the passive map messages */
101 Timer passive_message_timer;
102 std::string passive_message;
105 std::string map_filename;
106 std::string levels_path;
108 SpecialTiles special_tiles;
110 SpriteChanges sprite_changes;
111 SpawnPoints spawn_points;
112 std::vector<Teleporter*> teleporters;
114 Statistics total_stats;
116 HSQOBJECT worldmap_table;
120 std::string force_spawnpoint; /**< if set, spawnpoint will be forced to this value */
124 /* variables to track panning to a spawn point */
129 WorldMap(const std::string& filename, PlayerStatus* player_status, const std::string& force_spawnpoint = "");
132 void add_object(GameObject* object);
134 void try_expose(GameObject* object);
135 void try_unexpose(GameObject* object);
137 static WorldMap* current()
140 virtual void setup();
141 virtual void leave();
143 /** Update worldmap state */
144 virtual void update(float delta);
146 virtual void draw(DrawingContext& context);
148 Vector get_next_tile(Vector pos, Direction direction);
151 * gets a bitfield of Tile::WORLDMAP_NORTH | Tile::WORLDMAP_WEST | ... values,
152 * which indicates the directions Tux can move to when at the given position.
154 int available_directions_at(Vector pos);
157 * returns a bitfield representing the union of all Tile::WORLDMAP_XXX values
158 * of all solid tiles at the given position
160 int tile_data_at(Vector pos);
162 size_t level_count();
163 size_t solved_level_count();
166 * gets called from the GameSession when a level has been successfully
169 void finished_level(Level* level);
171 /** returns current Tux incarnation */
172 Tux* get_tux() { return tux; }
174 /** returns player status */
175 PlayerStatus* get_player_status() { return player_status; }
177 LevelTile* at_level();
178 SpecialTile* at_special_tile();
179 SpriteChange* at_sprite_change(const Vector& pos);
180 Teleporter* at_teleporter(const Vector& pos);
182 /** Check if it is possible to walk from \a pos into \a direction,
183 if possible, write the new position to \a new_pos */
184 bool path_ok(Direction direction, const Vector& pos, Vector* new_pos);
187 * Save worldmap state to squirrel state table
192 * Load worldmap state from squirrel state table
196 const std::string& get_title() const
200 * runs a script in the context of the worldmap (and keeps a reference to
201 * the script (so the script gets destroyed when the worldmap is destroyed)
203 HSQUIRRELVM run_script(std::istream& in, const std::string& sourcename);
206 * switch to another worldmap.
207 * filename is relative to data root path
209 void change(const std::string& filename, const std::string& force_spawnpoint="");
212 * moves Tux to the given spawnpoint
214 void move_to_spawnpoint(const std::string& spawnpoint, bool pan =false);
217 * returns the width (in tiles) of a worldmap
219 float get_width() const;
222 * returns the height (in tiles) of a worldmap
224 float get_height() const;
227 void get_level_title(LevelTile& level);
228 void draw_status(DrawingContext& context);
229 void calculate_total_stats();
231 void load(const std::string& filename);
232 void on_escape_press();
234 Vector get_camera_pos_for_tux();
235 void clamp_camera_position(Vector& c);
238 WorldMap(const WorldMap&);
239 WorldMap& operator=(const WorldMap&);
242 } // namespace worldmap