X-Git-Url: https://plomlompom.com/repos/index.html?a=blobdiff_plain;f=src%2Fyx_uint16.h;h=86812f4ed03e1a14e32e65645d5278910096cdca;hb=7290dec4219eaa2325aa00ef6139f715743dba3a;hp=eb951a7fd895d959046d3e5078a1ddaed71e74ac;hpb=35cdeffc062d3d87f1526bbff10c401b56b1345a;p=plomrogue
diff --git a/src/yx_uint16.h b/src/yx_uint16.h
index eb951a7..86812f4 100644
--- a/src/yx_uint16.h
+++ b/src/yx_uint16.h
@@ -1,13 +1,15 @@
-/* yx_uint16.h
+/* yx_uint16.h
*
- * Structs and routines for coordinates and movement in 2-dimensional space
- * (such as the ncurses screen and game maps).
+ * 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
-#include
+#include /* for uint8_t, uint16_t */
+
+
/* Coordinates for maps of max. 65536x65536 cells. */
struct yx_uint16
@@ -16,20 +18,30 @@ struct yx_uint16
uint16_t x;
};
-/* This encodes directions. */
+
+/* Directions available for movement. */
enum dir
{
NORTH = 1,
- EAST = 2,
- SOUTH = 3,
- WEST = 4
+ EAST,
+ SOUTH,
+ WEST
};
-/* Return 1 if two yx_uint16 coordinates a and b are equal, else 0. */
-extern char yx_uint16_cmp(struct yx_uint16 a, struct yx_uint16 b);
-/* Return yx_uint16 coordinate one step from coordinate yx in direction dir. */
+
+/* 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.
+ *
+ * If an invalid dir "d" is passed, "yx" remains unchanged.
+ */
extern struct yx_uint16 mv_yx_in_dir(enum dir d, struct yx_uint16 yx);
+
+
#endif