home · contact · privacy
Fixed README typo.
[plomrogue] / src / map_objects.h
index abf77ebcc54fbcaa4a89b0d90de274db5338cc03..5cbab7bc3e44effce04aa7a124eb0809b696156a 100644 (file)
@@ -1,50 +1,87 @@
+/* map_objects.h
+ *
+ * Structs for objects on the map and their type definitions, and routines to
+ * initialize these and load and save them from/to files.
+ */
+
 #ifndef MAP_OBJECTS_H
 #define MAP_OBJECTS_H
 
-#include <stdio.h>
-#include "yx_uint16.h"
 
+
+#include <stdio.h> /* for FILE typedef */
+#include <stdint.h> /* for uint8_t */
+#include "yx_uint16.h" /* for yx_uint16 coordinates */
 struct World;
 
-struct Player {
-  struct yx_uint16 pos;
-  unsigned char hitpoints; };
-
-struct MapObj {
-  void * next;
-  char type;
-  struct yx_uint16 pos; };
-
-struct MapObjDef {
-  struct MapObjDef * next;
-  char id;
-  char mapchar;
-  char * desc; };
-
-struct Item {
-  struct MapObj map_obj; };
-
-struct Monster {
-  struct MapObj map_obj;
-  unsigned char hitpoints; };
-
-struct ItemDef {
-  struct MapObjDef map_obj_def; };
-
-struct MonsterDef {
-  struct MapObjDef map_obj_def;
-  unsigned char hitpoints_start; };
-
-extern void init_map_object_defs (struct World *, char *);
-extern void readwrite_map_objects_dummy (void *, FILE *);
-extern void write_map_objects_monsterdata (void *, FILE *);
-extern void write_map_objects (void * start, FILE *, void (*) (void *, FILE *) );
-extern void read_map_objects_monsterdata (void *, FILE *);
-extern void read_map_objects (void *, FILE *, size_t, void (*) (void *, FILE *) );
-extern void build_map_objects_monsterdata (struct MapObjDef *, void *);
-extern void build_map_objects_itemdata (struct MapObjDef *, void *);
-extern void * build_map_objects (struct World *, void *, char, unsigned char, size_t,
-                                 void (*) (struct MapObjDef *, void *));
-extern struct MapObjDef * get_map_obj_def (struct World *, char);
+
+
+struct MapObj
+{
+    struct MapObj * next;        /* pointer to next one in map object chain */
+    uint8_t id;                  /* individual map object's unique identifier */
+    uint8_t type;                /* ID of appropriate map object definition */
+    uint8_t lifepoints;          /* 0: object is inanimate; >0: hitpoints */
+    struct yx_uint16 pos;        /* coordinate on map */
+};
+
+
+
+struct MapObjDef
+{
+    struct MapObjDef * next;
+    uint8_t id;         /* unique identifier of map object type */
+    uint8_t corpse_id;  /* id of type to change into upon destruction */
+    char char_on_map;   /* map object symbol to appear on map */
+    char * name;        /* string to describe object in game log*/
+    uint8_t lifepoints; /* default value for map object lifepoints member */
+};
+
+
+
+/* Initialize map object defnitions chain from file at path "filename". */
+extern void init_map_object_defs(struct World * world, char * filename);
+
+
+
+/* Free map object definitions chain starting at "mod_start". */
+extern void free_map_object_defs(struct MapObjDef * mod_start);
+
+
+
+/* Add new object(s) ("n": how many?) of "type" to map on random position(s).
+ * New animate objects are never placed in the same square with other animated
+ * ones.
+ */
+extern void add_map_object(struct World * world, uint8_t type);
+extern void add_map_objects(struct World * world, uint8_t type, uint8_t n);
+
+
+
+/* Write map objects chain to "file". */
+extern void write_map_objects(struct World * world, FILE * file);
+
+/* Read from "file" map objects chain; use "line" as char array for fgets() and
+ * expect strings of max. "linemax" length.
+ */
+extern void read_map_objects(struct World * world, FILE * file,
+                             char * line, int linemax);
+
+
+
+/* Free map objects in map object chain starting at "mo_start. */
+extern void free_map_objects(struct MapObj * mo_start);
+
+
+
+/* Get pointer to the MapObj struct that represents the player. */
+extern struct MapObj * get_player(struct World * world);
+
+
+
+/* Get pointer to the map object definition of identifier "def_id". */
+extern struct MapObjDef * get_map_object_def(struct World * w, uint8_t id);
+
+
 
 #endif