some commenting on the map classes

[l2e.git] / src / map / Map.h

diff --git a/src/map/Map.h b/src/map/Map.h
index a985d8491f44928335ba06a618677d095da6079f..b751d5ece04f97b33a431b6f8df78e8024ba24e7 100644 (file)
--- a/src/map/Map.h
+++ b/src/map/Map.h
@@ -1,5 +1,5 @@
 /*
- * Map.h
+  * Map.h
  *
  *  Created on: Sep 29, 2012
  *      Author: holy
@@ -17,6 +17,15 @@
 
 namespace map {
 
+/// Represents a single map in the game.
+/// Maps are made up of uniform areas of tiles.
+/// The looks of a tile is defined by the Tileset() sprite with Tile::Offset()
+/// as the column and row in the sprite.
+/// Maps can be propulated with triggers and entities. Those are or use with
+/// MapState and are not handled by the map itself.
+/// Positions are expressed either as pixel or tile coordinates depending on
+/// function purpose with (0|0) being the top left corner and positive values
+/// extending to the right and down respectively.
 class Map {
 
 public:
@@ -24,19 +33,31 @@ public:
        ~Map() { }
 
 public:
+       /// The sprite used as the tileset.
        const graphics::Sprite *Tileset() const { return tileset; }
+       /// Returns the Area at given pixel coordinates or 0 if off the map.
        Area *AreaAt(const geometry::Vector<int> &);
        const Area *AreaAt(const geometry::Vector<int> &) const;
+       /// Returns the Tile at given pixel coordinates or 0 if off the map.
        Tile *TileAt(const geometry::Vector<int> &);
        const Tile *TileAt(const geometry::Vector<int> &) const;
+       /// Returns the Trigger at given pixel coordinates or 0 if off the map.
+       /// Multiple triggers are not supported. The first one found is returned.
        Trigger *TriggerAt(const geometry::Vector<int> &);
+       /// The battle background image for this map if neither the tile nor the
+       /// area has one specified.
        SDL_Surface *BattleBackgroundAt(const geometry::Vector<int> &);
+       /// Convert coordinates pixel to tile.
        geometry::Vector<int> TileCoordinates(const geometry::Vector<int> &) const;
 
        Entity *EntitiesBegin() { return entities; }
        Entity *EntitiesEnd() { return entities + numEntities; }
 
+       /// Render the map.
+       /// Entities are not rendered by this function.
        void Render(SDL_Surface *dest, const geometry::Vector<int> &offset) const;
+       /// Render a debugging overlay that includes collision and trigger
+       /// information.
        void RenderDebug(SDL_Surface *dest, const geometry::Vector<int> &offset) const;
 
        static void CreateTypeDescription();