X-Git-Url: https://plomlompom.com/repos/foo.html?a=blobdiff_plain;f=src%2Fyx_uint16.h;h=188e553e0014b820bf7e2e0dfa783913abb1bf27;hb=97d23e7656f4c5e634b789fc760183edd7fd581e;hp=e5249b0ab3ca4e69685fc7a845209fb963af9760;hpb=289154889af25ebb05f5ad1149cafd8e82b0b0fa;p=plomrogue
diff --git a/src/yx_uint16.h b/src/yx_uint16.h
index e5249b0..188e553 100644
--- a/src/yx_uint16.h
+++ b/src/yx_uint16.h
@@ -7,8 +7,6 @@
#ifndef YX_UINT16_H
#define YX_UINT16_H
-
-
#include /* for uint8_t, uint16_t */
@@ -20,19 +18,18 @@ struct yx_uint16
uint16_t x;
};
-/* Directions available for movement. */
-enum dir
-{
- NORTH = 1,
- EAST,
- SOUTH,
- WEST
-};
+
/* 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. */
-extern struct yx_uint16 mv_yx_in_dir(enum dir d, struct yx_uint16 yx);
+/* 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);
+
+
#endif