home · contact · privacy
Server/py: Remove superfluous dummy comments.
[plomrogue] / src / server / map.h
1 /* src/server/map.h
2  *
3  * This file is part of PlomRogue. PlomRogue is licensed under the GPL version 3
4  * or any later version. For details on its copyright, license, and warranties,
5  * see the file NOTICE in the root directory of the PlomRogue source package.
6  *
7  * Routines to create and navigate game map.
8  */
9
10 #ifndef MAP_H_SERVER
11 #define MAP_H_SERVER
12
13 #include <stdint.h> /* uint8_t */
14 struct yx_uint8;
15
16
17
18 /* (Re-)make island map "~" cells representing water and "." cells representing
19  * land. The island shape is built randomly from world.seed_map by starting with
20  * a sea of one land cell in the middle, then going into a cycle of repeatedly
21  * selecting a random sea cell and transforming it into land if it is neighbor
22  * to land; the cycle ends when a land cell is due to be created right at the
23  * border of the map. Lots of 'X' cells representing trees are put on the
24  * island.
25  */
26 extern void remake_map();
27
28 /* Move "yx" into hex direction "dir". Available hex directions are: 'e'
29  * (north-east), 'd' (east), 'c' (south-east), 'x' (south-west), 's' (west), 'w'
30  * (north-west). Returns 1 if the move was legal, else 0.
31  *
32  * A move is legal if "yx" ends up in the confines of the map and the original
33  * wrap space. The latter is left to a neighbor wrap space if "yx" moves beyond
34  * the minimal (0) or maximal (UINT8_MAX) column or row of possible map space –
35  * in which case "yx".y or "yx".x will snap to the respective opposite side. The
36  * current wrapping state is kept between successive calls until a "yx" of NULL
37  * is passed, in which case the function does nothing but zero the wrap state.
38  * Successive wrapping may move "yx" several wrap spaces into either direction,
39  * or return it into the original wrap space.
40  */
41 extern uint8_t mv_yx_in_dir_legal(char dir, struct yx_uint8 * yx);
42
43 /* Initialize (empty) map array at "map". */
44 extern void init_empty_map(char ** map);
45
46
47 #endif