X-Git-Url: https://plomlompom.com/repos/foo.html?a=blobdiff_plain;f=src%2Fserver%2Fmap.h;h=d9ebf7476fc8a38f584a8dd1c29f42b8012065d1;hb=c89e7df6e7b6b64037b5b964e10a63ad38f86eb5;hp=d704bc27ba81c15144d4ac31e382aa5171c5dbcc;hpb=f6615d3be438bbca4997c38c546c0d8724da80d4;p=plomrogue
diff --git a/src/server/map.h b/src/server/map.h
index d704bc2..d9ebf74 100644
--- a/src/server/map.h
+++ b/src/server/map.h
@@ -1,4 +1,8 @@
/* src/server/map.h
+ *
+ * This file is part of PlomRogue. PlomRogue is licensed under the GPL version 3
+ * or any later version. For details on its copyright, license, and warranties,
+ * see the file NOTICE in the root directory of the PlomRogue source package.
*
* Routines to create and navigate game map.
*/
@@ -21,10 +25,23 @@ struct yx_uint8;
*/
extern void remake_map();
-/* Wrapper to mv_yx_in_dir_wrap(), returns 1 if the wrapped function moved "yx"
- * within the wrap borders and the map size, else 0.
+/* Move "yx" into hex direction "dir". Available hex directions are: 'e'
+ * (north-east), 'd' (east), 'c' (south-east), 'x' (south-west), 's' (west), 'w'
+ * (north-west). Returns 1 if the move was legal, else 0.
+ *
+ * A move is legal if "yx" ends up in the confines of the map and the original
+ * wrap space. The latter is left to a neighbor wrap space if "yx" moves beyond
+ * the minimal (0) or maximal (UINT8_MAX) column or row of possible map space â
+ * in which case "yx".y or "yx".x will snap to the respective opposite side. The
+ * current wrapping state is kept between successive calls until a "yx" of NULL
+ * is passed, in which case the function does nothing but zero the wrap state.
+ * Successive wrapping may move "yx" several wrap spaces into either direction,
+ * or return it into the original wrap space.
*/
extern uint8_t mv_yx_in_dir_legal(char dir, struct yx_uint8 * yx);
+/* Initialize (empty) map array at "map". */
+extern void init_empty_map(char ** map);
+
#endif