home · contact · privacy
Reformatted map_objects.h to ensure max line length of 80 chars.
[plomrogue] / src / map_objects.h
1 /* map_objects.h
2  *
3  * Structs for objects on the map and their type definitions, and routines to
4  * initialize these and load and save them from/to files.
5  */
6
7 #ifndef MAP_OBJECTS_H
8 #define MAP_OBJECTS_H
9
10
11
12 #include <stdio.h> /* for FILE typedef */
13 #include <stdint.h> /* for uint8_t */
14 #include "yx_uint16.h" /* for yx_uint16 coordinates */
15 struct World;
16
17
18
19 /* Player is non-standard: single and of a hard-coded type. */
20 struct Player
21 {
22     struct yx_uint16 pos;
23     uint8_t hitpoints;
24 };
25
26
27
28 /* Structs for standard map objects. */
29
30 struct MapObj
31 {
32     void * next;
33     char type;            /* Map object type identifier (see MapObjDef.id). */
34     struct yx_uint16 pos; /* Coordinate of object on map. */
35 };
36
37 struct Item
38 {
39     struct MapObj map_obj;
40 };
41
42 struct Monster
43 {
44     struct MapObj map_obj;
45     uint8_t hitpoints;
46 };
47
48
49
50 /* Structs for map object *type* definitions. Values common to all members of
51  * a single monster or item type are harvested from these.
52  */
53
54 struct MapObjDef
55 {
56     struct MapObjDef * next;
57     char m_or_i;  /* Is it item or monster? "i" for items, "m" for monsters. */
58     char id;      /* Unique identifier of the map object type to describe. */
59     char mapchar; /* Map object symbol to appear on map.*/
60     char * desc;  /* String describing map object in the game log. */
61 };
62
63 struct ItemDef
64 {
65     struct MapObjDef map_obj_def;
66 };
67
68 struct MonsterDef
69 {
70     struct MapObjDef map_obj_def;
71     uint8_t hitpoints_start; /* Hitpoints each monster starts with. */
72 };
73
74
75
76 /* Initialize map object type definitions from file at path "filename". */
77 extern void init_map_object_defs(struct World * world, char * filename);
78
79
80
81 /* Build into memory starting at "start" chain of "n" map objects of type
82  * "def_id".
83  */
84 extern void * build_map_objects(struct World * world, void * start, char def_id,
85                                 uint8_t n);
86
87
88
89 /* Write to/read from file chain of map objects starting/to start in memory at
90  * "start".
91  */
92 extern uint8_t write_map_objects(struct World * world, void * start,
93                                  FILE * file);
94 extern uint8_t read_map_objects(struct World * world, void * start,
95                                 FILE * file);
96
97
98
99 /* Get pointer to the map object definition of identifier "def_id". */
100 extern struct MapObjDef * get_map_obj_def(struct World * world, char def_id);
101
102
103
104 #endif