X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;ds=sidebyside;f=src%2Fyx_uint16.h;h=188e553e0014b820bf7e2e0dfa783913abb1bf27;hb=470540c932775c26a65513935bbc1c17dc19468d;hp=70fc39d1dfaf1ec8836fbfac069c1617024312f9;hpb=f07cfd3448cb75abc1ae6fbfc9a946b8c4b91f5d;p=plomrogue

diff --git a/src/yx_uint16.h b/src/yx_uint16.h
index 70fc39d..188e553 100644
--- a/src/yx_uint16.h
+++ b/src/yx_uint16.h
@@ -1,16 +1,35 @@
+/* yx_uint16.h
+ *
+ * Structs and routines for coordinates and movement in 2-dimensional space
+ * (such as the ncurses screen and game maps).
+ */
+
 #ifndef YX_UINT16_H
 #define YX_UINT16_H
 
-#define NORTH 1
-#define EAST 2
-#define SOUTH 3
-#define WEST 4
+#include <stdint.h> /* for uint8_t, uint16_t */
+
+
+
+/* Coordinates for maps of max. 65536x65536 cells. */
+struct yx_uint16
+{
+    uint16_t y;
+    uint16_t x;
+};
+
+
+
+/* Return 1 if two yx_uint16 coordinates at "a" and "b" are equal, else 0. */
+extern uint8_t yx_uint16_cmp(struct yx_uint16 * a, struct yx_uint16 * b);
+
+/* Return yx_uint16 coordinate one step from coordinate yx in direction "dir"
+ * (east: 'E', west: 'W', north: 'N', south: 'S').
+ *
+ * If an invalid dir "d" is passed, "yx" remains unchanged.
+ */
+extern struct yx_uint16 mv_yx_in_dir(char dir, struct yx_uint16 yx);
 
-struct yx_uint16 {
-  uint16_t y;
-  uint16_t x; };
 
-extern char yx_uint16_cmp (struct yx_uint16, struct yx_uint16);
-struct yx_uint16 mv_yx_in_dir (char, struct yx_uint16);
 
 #endif