home · contact · privacy
Individual map objects are now identified by unique numbers stored in the savefiles...
[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     uint8_t id;           /* Unique identifier of individual map object. */
34     char type;            /* Map object type identifier (see MapObjDef.id). */
35     struct yx_uint16 pos; /* Coordinate of object on map. */
36 };
37
38 struct Item
39 {
40     struct MapObj map_obj;
41 };
42
43 struct Monster
44 {
45     struct MapObj map_obj;
46     uint8_t hitpoints;
47 };
48
49
50
51 /* Structs for map object *type* definitions. Values common to all members of
52  * a single monster or item type are harvested from these.
53  */
54
55 struct MapObjDef
56 {
57     struct MapObjDef * next;
58     char m_or_i;  /* Is it item or monster? "i" for items, "m" for monsters. */
59     char id;      /* Unique identifier of the map object type to describe. */
60     char mapchar; /* Map object symbol to appear on map.*/
61     char * desc;  /* String describing map object in the game log. */
62 };
63
64 struct ItemDef
65 {
66     struct MapObjDef map_obj_def;
67 };
68
69 struct MonsterDef
70 {
71     struct MapObjDef map_obj_def;
72     uint8_t corpse_id;       /* ID of object type killed monster changes to. */
73     uint8_t hitpoints_start; /* Hitpoints each monster starts with. */
74 };
75
76
77
78 /* Initialize map object type definitions from file at path "filename". */
79 extern void init_map_object_defs(struct World * world, char * filename);
80
81
82
83 /* Free item / monster definitions in map object chain starting at "md_start" /
84  * "id_start".
85  */
86 extern void free_item_defs(struct ItemDef * id_start);
87 extern void free_monster_defs(struct MonsterDef * md_start);
88
89
90
91 /* Build into memory starting at "start" chain of "n" map objects of type
92  * "def_id".
93  */
94 extern void * build_map_objects(struct World * world, void * start, char def_id,
95                                 uint8_t n);
96
97
98
99 /* Write to/read from file chain of map objects starting/to start in memory at
100  * "start".
101  */
102 extern uint8_t write_map_objects(struct World * world, void * start,
103                                  FILE * file);
104 extern uint8_t read_map_objects(struct World * world, void * start,
105                                 FILE * file);
106
107
108 /* Free items / monsters in map object chain starting at "item" / "monster". */
109 extern void free_items(struct Item * item);
110 extern void free_monsters(struct Monster * monster);
111
112 /* Get pointer to the map object definition of identifier "def_id". */
113 extern struct MapObjDef * get_map_obj_def(struct World * world, char def_id);
114
115
116
117 #endif