home · contact · privacy
More consistent code styling whitespace rules.
[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 #include <stdio.h> /* for FILE typedef */
11 #include <stdint.h> /* for uint8_t */
12 #include "yx_uint16.h" /* for yx_uint16 coordinates */
13
14
15
16 struct MapObj
17 {
18     struct MapObj * next;        /* pointer to next one in map object chain */
19     struct MapObj * owns;        /* chain of map objects owned / in inventory */
20     uint8_t id;                  /* individual map object's unique identifier */
21     uint8_t type;                /* ID of appropriate map object definition */
22     uint8_t lifepoints;          /* 0: object is inanimate; >0: hitpoints */
23     struct yx_uint16 pos;        /* coordinate on map */
24 };
25
26 struct MapObjDef
27 {
28     struct MapObjDef * next;
29     uint8_t id;         /* unique identifier of map object type */
30     uint8_t corpse_id;  /* id of type to change into upon destruction */
31     char char_on_map;   /* map object symbol to appear on map */
32     char * name;        /* string to describe object in game log*/
33     uint8_t lifepoints; /* default value for map object lifepoints member */
34 };
35
36
37
38 /* Initialize map object defnitions chain from file at path "filename". */
39 extern void init_map_object_defs(char * filename);
40
41 /* Free map object definitions chain starting at "mod_start". */
42 extern void free_map_object_defs(struct MapObjDef * mod_start);
43
44 /* Add new object(s) ("n": how many?) of "type" to map on random position(s).
45  * New animate objects are never placed in the same square with other animated
46  * ones.
47  */
48 extern void add_map_object(uint8_t type);
49 extern void add_map_objects(uint8_t type, uint8_t n);
50
51 /* Write map objects chain to "file". */
52 extern void write_map_objects(FILE * file);
53
54 /* Read from "file" map objects chain; use "line" as char array for fgets() and
55  * expect strings of max. "linemax" length.
56  */
57 extern void read_map_objects(FILE * file, char * line, int linemax);
58
59 /* Free map objects in map object chain starting at "mo_start. */
60 extern void free_map_objects(struct MapObj * mo_start);
61
62 /* Move object of "id" from "source" inventory to "target" inventory. */
63 extern void own_map_object(struct MapObj ** target, struct MapObj ** source,
64                            uint8_t id);
65
66 /* Get pointer to the MapObj struct that represents the player. */
67 extern struct MapObj * get_player();
68
69 /* Get pointer to the map object definition of identifier "def_id". */
70 extern struct MapObjDef * get_map_object_def(uint8_t id);
71
72 /* Move not only "mo" to "pos", but also all map objects owned by it. */
73 extern void set_object_position(struct MapObj * mo, struct yx_uint16 pos);
74
75
76
77 #endif