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
75 static WorldMap* current_;
77 std::auto_ptr<Menu> worldmap_menu;
83 std::string init_script;
85 typedef std::vector<GameObject*> GameObjects;
86 GameObjects game_objects;
87 std::list<TileMap*> solid_tilemaps;
89 std::auto_ptr<TileManager> tile_manager;
92 /** Variables to deal with the passive map messages */
93 Timer passive_message_timer;
94 std::string passive_message;
97 std::string map_filename;
98 std::string levels_path;
100 typedef std::vector<SpecialTile*> SpecialTiles;
101 SpecialTiles special_tiles;
102 typedef std::vector<LevelTile*> LevelTiles;
104 typedef std::vector<SpriteChange*> SpriteChanges;
105 SpriteChanges sprite_changes;
106 typedef std::vector<SpawnPoint*> SpawnPoints;
107 SpawnPoints spawn_points;
108 std::vector<Teleporter*> teleporters;
110 Statistics total_stats;
112 HSQOBJECT worldmap_table;
113 typedef std::vector<HSQOBJECT> ScriptList;
117 std::string force_spawnpoint; /**< if set, spawnpoint will be forced to this value */
122 WorldMap(const std::string& filename, const std::string& force_spawnpoint = "");
125 void add_object(GameObject* object);
127 void try_expose(GameObject* object);
128 void try_unexpose(GameObject* object);
130 static WorldMap* current()
133 virtual void setup();
134 virtual void leave();
136 /** Update worldmap state */
137 virtual void update(float delta);
139 virtual void draw(DrawingContext& context);
141 Vector get_next_tile(Vector pos, Direction direction);
144 * gets a bitfield of Tile::WORLDMAP_NORTH | Tile::WORLDMAP_WEST | ... values,
145 * which indicates the directions Tux can move to when at the given position.
147 int available_directions_at(Vector pos);
150 * returns a bitfield representing the union of all Tile::WORLDMAP_XXX values
151 * of all solid tiles at the given position
153 int tile_data_at(Vector pos);
155 size_t level_count();
156 size_t solved_level_count();
159 * gets called from the GameSession when a level has been successfully
162 void finished_level(Level* level);
164 LevelTile* at_level();
165 SpecialTile* at_special_tile();
166 SpriteChange* at_sprite_change(const Vector& pos);
167 Teleporter* at_teleporter(const Vector& pos);
169 /** Check if it is possible to walk from \a pos into \a direction,
170 if possible, write the new position to \a new_pos */
171 bool path_ok(Direction direction, const Vector& pos, Vector* new_pos);
174 * Save worldmap state to squirrel state table
179 * Load worldmap state from squirrel state table
183 const std::string& get_title() const
187 * runs a script in the context of the worldmap (and keeps a reference to
188 * the script (so the script gets destroyed when the worldmap is destroyed)
190 HSQUIRRELVM run_script(std::istream& in, const std::string& sourcename);
193 * switch to another worldmap.
194 * filename is relative to data root path
196 void change(const std::string& filename, const std::string& force_spawnpoint="");
199 * moves Tux to the given spawnpoint
201 void move_to_spawnpoint(const std::string& spawnpoint);
204 * returns the width (in tiles) of a worldmap
206 float get_width() const;
209 * returns the height (in tiles) of a worldmap
211 float get_height() const;
214 void get_level_title(LevelTile& level);
215 void draw_status(DrawingContext& context);
216 void calculate_total_stats();
218 void load(const std::string& filename);
219 void on_escape_press();
222 } // namespace WorldMapNS