4 // Copyright (C) 2004 Ingo Ruhnke <grumbel@gmx.de>
5 // Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.de>
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License
9 // as published by the Free Software Foundation; either version 2
10 // of the License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 // GNU General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 #ifndef SUPERTUX_WORLDMAP_H
21 #define SUPERTUX_WORLDMAP_H
26 #include "math/vector.hpp"
27 #include "lisp/lisp.hpp"
28 #include "control/controller.hpp"
29 #include "statistics.hpp"
32 #include "tile_manager.hpp"
33 #include "game_object.hpp"
34 #include "console.hpp"
35 #include "../level.hpp"
36 #include "worldmap/special_tile.hpp"
37 #include "worldmap/sprite_change.hpp"
38 #include "worldmap/teleporter.hpp"
39 #include "worldmap/spawn_point.hpp"
40 #include "worldmap/direction.hpp"
47 namespace WorldMapNS {
63 std::string direction_to_string(Direction d);
64 Direction string_to_direction(const std::string& d);
65 Direction reverse_dir(Direction d);
68 * Screen that runs a WorldMap, which lets the player choose a Level.
70 class WorldMap : public Screen
72 static Color level_title_color;
73 static Color message_color;
74 static Color teleporter_message_color;
81 static WorldMap* current_;
83 std::auto_ptr<Menu> worldmap_menu;
89 std::string init_script;
91 typedef std::vector<GameObject*> GameObjects;
92 GameObjects game_objects;
93 std::list<TileMap*> solid_tilemaps;
96 /** Variables to deal with the passive map messages */
97 Timer passive_message_timer;
98 std::string passive_message;
101 std::string map_filename;
102 std::string levels_path;
104 typedef std::vector<SpecialTile*> SpecialTiles;
105 SpecialTiles special_tiles;
106 typedef std::vector<LevelTile*> LevelTiles;
108 typedef std::vector<SpriteChange*> SpriteChanges;
109 SpriteChanges sprite_changes;
110 typedef std::vector<SpawnPoint*> SpawnPoints;
111 SpawnPoints spawn_points;
112 std::vector<Teleporter*> teleporters;
114 Statistics total_stats;
116 HSQOBJECT worldmap_table;
117 typedef std::vector<HSQOBJECT> ScriptList;
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 LevelTile* at_level();
173 SpecialTile* at_special_tile();
174 SpriteChange* at_sprite_change(const Vector& pos);
175 Teleporter* at_teleporter(const Vector& pos);
177 /** Check if it is possible to walk from \a pos into \a direction,
178 if possible, write the new position to \a new_pos */
179 bool path_ok(Direction direction, const Vector& pos, Vector* new_pos);
182 * Save worldmap state to squirrel state table
187 * Load worldmap state from squirrel state table
191 const std::string& get_title() const
195 * runs a script in the context of the worldmap (and keeps a reference to
196 * the script (so the script gets destroyed when the worldmap is destroyed)
198 HSQUIRRELVM run_script(std::istream& in, const std::string& sourcename);
201 * switch to another worldmap.
202 * filename is relative to data root path
204 void change(const std::string& filename, const std::string& force_spawnpoint="");
207 * moves Tux to the given spawnpoint
209 void move_to_spawnpoint(const std::string& spawnpoint, bool pan =false);
212 * returns the width (in tiles) of a worldmap
214 float get_width() const;
217 * returns the height (in tiles) of a worldmap
219 float get_height() const;
222 void get_level_title(LevelTile& level);
223 void draw_status(DrawingContext& context);
224 void calculate_total_stats();
226 void load(const std::string& filename);
227 void on_escape_press();
229 Vector get_camera_pos_for_tux();
230 void clamp_camera_position(Vector& c);
233 } // namespace WorldMapNS