X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=src%2Fmap.h;h=ac303a40036fe3660938c015cf9a33fb6fcda5b9;hb=550d22ec0c3f530f5d317746f3f7e75251a1de4b;hp=c5ceb9429c98b4f8d60a98784204e7b44289f420;hpb=8e2ccd2e08bf2a08049c6c04ea24d79d161b4945;p=plomrogue

diff --git a/src/map.h b/src/map.h
index c5ceb94..ac303a4 100644
--- a/src/map.h
+++ b/src/map.h
@@ -1,17 +1,49 @@
+/* map.h
+ *
+ * Struct for the game map and routines to manipulate it.
+ */
+
 #ifndef MAP_H
 #define MAP_H
 
-#include "yx_uint16.h"
 
+
+#include "yx_uint16.h" /* for yx_uint16 and dir enums */
 struct Player;
 
-struct Map {
-  struct yx_uint16 size;
-  struct yx_uint16 offset;
-  char * cells; };
 
-extern struct Map init_map ();
-extern void map_scroll (struct Map *, char, struct yx_uint16);
-extern void map_center_player (struct Map *, struct Player *, struct yx_uint16);
+
+struct Map
+{
+    struct yx_uint16 size;   /* map's height/width in number of cells */
+    struct yx_uint16 offset; /* the map scroll offset */
+    char * cells;            /* sequence of bytes encoding map cells */
+};
+
+
+
+/* Initialize an island map as 64 x 64 cells of "~" cells representing water and
+ * "." cells representing land. The shape of the island is generated randomly by
+ * starting with a sea containing one land cell in the middle and then going
+ * into a cycle of repeatedly selecting a random cell on the map and
+ * transforming it into a land cell if it is horizontally or vertically neighbor
+ * to one; the cycle ends when a land cell is due to be created right at the
+ * border of the map. The map scroll offset is initialized to 0,0.
+ */
+extern struct Map init_map();
+
+/* Scroll map into direction "dir" by changing the scroll offset if that does
+ * not push the map view beyond the size of the map window as described by
+ * "win_size".
+ */
+extern void map_scroll(struct Map * map, enum dir d, struct yx_uint16 win_size);
+
+/* Scroll map to center on the player by changing the scroll offset following
+ * (and constrained by) the window size as described by "win_size".
+ */
+extern void map_center_player(struct Map * map, struct Player * player,
+                              struct yx_uint16 win_size);
+
+
 
 #endif