some commenting on the map classes

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

diff --git a/src/map/Area.h b/src/map/Area.h
index d9cc5d0d8784fc49d411a4ebb972a1913763af94..9da3083b3fb42f2a7db9f627327cbab9afdb66a4 100644 (file)
--- a/src/map/Area.h
+++ b/src/map/Area.h
@@ -16,6 +16,9 @@
 
 namespace map {
 
+/// Defines a rectangular section of a map.
+/// Tiles are rendered ltr with a row break each width tiles.
+/// Missing tiles in the last row are possible but don't fool yourself.
 class Area {
 
 public:
@@ -23,21 +26,33 @@ public:
        ~Area() { }
 
 public:
+       /// Get the width in tiles.
        int Width() const { return width; }
+       /// Get the height in tiles.
        int Height() const { return numTiles / width + (numTiles % width ? 1 : 0); }
+       /// Get the size in tiles.
        geometry::Vector<int> Size() const { return geometry::Vector<int>(Width(), Height()); }
+       /// Get a tile by tile coordinates (not pixel coordinates!).
+       Tile *TileAt(const geometry::Vector<int> &);
        const Tile *TileAt(const geometry::Vector<int> &) const;
 
+       /// Get the default battle background for this area.
+       SDL_Surface *BattleBackground() { return battlebg; }
+
        void Render(SDL_Surface *dest, const graphics::Sprite *tileset, const geometry::Vector<int> &offset) const;
        void RenderDebug(SDL_Surface *dest, const graphics::Sprite *tileset, const geometry::Vector<int> &offset) const;
 
+       static void CreateTypeDescription();
+       static void Construct(void *);
+
 // temporary setters
 public:
-       void SetTiles(const Tile *t, int num) { tiles = t; numTiles = num; }
+       void SetTiles(Tile *t, int num) { tiles = t; numTiles = num; }
        void SetWidth(int w) { width = w; }
 
 private:
-       const Tile *tiles;
+       SDL_Surface *battlebg;
+       Tile *tiles;
        int numTiles;
        int width;