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 "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"
45 namespace WorldMapNS {
61 std::string direction_to_string(Direction d);
62 Direction string_to_direction(const std::string& d);
63 Direction reverse_dir(Direction d);
66 * Screen that runs a WorldMap, which lets the player choose a Level.
68 class WorldMap : public Screen
70 static Color level_title_color;
71 static Color message_color;
72 static Color teleporter_message_color;
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;
87 static WorldMap* current_;
89 std::auto_ptr<Menu> worldmap_menu;
95 std::string init_script;
97 GameObjects game_objects;
98 std::list<TileMap*> solid_tilemaps;
101 /** Variables to deal with the passive map messages */
102 Timer passive_message_timer;
103 std::string passive_message;
106 std::string map_filename;
107 std::string levels_path;
109 SpecialTiles special_tiles;
111 SpriteChanges sprite_changes;
112 SpawnPoints spawn_points;
113 std::vector<Teleporter*> teleporters;
115 Statistics total_stats;
117 HSQOBJECT worldmap_table;
121 std::string force_spawnpoint; /**< if set, spawnpoint will be forced to this value */
125 /* variables to track panning to a spawn point */
130 WorldMap(const std::string& filename, const std::string& force_spawnpoint = "");
133 void add_object(GameObject* object);
135 void try_expose(GameObject* object);
136 void try_unexpose(GameObject* object);
138 static WorldMap* current()
141 virtual void setup();
142 virtual void leave();
144 /** Update worldmap state */
145 virtual void update(float delta);
147 virtual void draw(DrawingContext& context);
149 Vector get_next_tile(Vector pos, Direction direction);
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.
155 int available_directions_at(Vector pos);
158 * returns a bitfield representing the union of all Tile::WORLDMAP_XXX values
159 * of all solid tiles at the given position
161 int tile_data_at(Vector pos);
163 size_t level_count();
164 size_t solved_level_count();
167 * gets called from the GameSession when a level has been successfully
170 void finished_level(Level* level);
172 /** returns current Tux incarnation */
173 Tux* get_tux() { return tux; }
175 LevelTile* at_level();
176 SpecialTile* at_special_tile();
177 SpriteChange* at_sprite_change(const Vector& pos);
178 Teleporter* at_teleporter(const Vector& pos);
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);
185 * Save worldmap state to squirrel state table
190 * Load worldmap state from squirrel state table
194 const std::string& get_title() const
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)
201 HSQUIRRELVM run_script(std::istream& in, const std::string& sourcename);
204 * switch to another worldmap.
205 * filename is relative to data root path
207 void change(const std::string& filename, const std::string& force_spawnpoint="");
210 * moves Tux to the given spawnpoint
212 void move_to_spawnpoint(const std::string& spawnpoint, bool pan =false);
215 * returns the width (in tiles) of a worldmap
217 float get_width() const;
220 * returns the height (in tiles) of a worldmap
222 float get_height() const;
225 void get_level_title(LevelTile& level);
226 void draw_status(DrawingContext& context);
227 void calculate_total_stats();
229 void load(const std::string& filename);
230 void on_escape_press();
232 Vector get_camera_pos_for_tux();
233 void clamp_camera_position(Vector& c);
236 WorldMap(const WorldMap&);
237 WorldMap& operator=(const WorldMap&);
240 } // namespace WorldMapNS