Server/py: Remove superfluous line.

[plomrogue] / src / server / map.h

diff --git a/src/server/map.h b/src/server/map.h
index 641cb797edca08f8d9ef95692901777d84eb6fd3..d9ebf7476fc8a38f584a8dd1c29f42b8012065d1 100644 (file)
--- 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.
  */
@@ -6,8 +10,8 @@
 #ifndef MAP_H_SERVER
 #define MAP_H_SERVER
 
-#include <stdint.h> /* uint8_t, uint16_t */
-#include "../common/yx_uint8.h" /* yx_uint8 struct */
+#include <stdint.h> /* uint8_t */
+struct yx_uint8;
 
 
 
@@ -21,14 +25,23 @@
  */
 extern void remake_map();
 
-/* Check if coordinate "pos" on (or beyond) world.map is accessible to thing
- * movement.
+/* 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 is_passable(struct yx_uint8 pos);
-
-/* Transform "yx" to an index position in the world map. */
-extern uint16_t yx_to_map_pos(struct yx_uint8 * yx);
+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