home · contact · privacy
Fixed README typo.
[plomrogue] / src / map_objects.h
index fb33fe504fd0072b79442b982d3dfab32caf2282..5cbab7bc3e44effce04aa7a124eb0809b696156a 100644 (file)
 
 
 #include <stdio.h> /* for FILE typedef */
+#include <stdint.h> /* for uint8_t */
 #include "yx_uint16.h" /* for yx_uint16 coordinates */
 struct World;
 
 
 
-/* Player is non-standard: single and of a hard-coded type. */
-struct Player
+struct MapObj
 {
-    struct yx_uint16 pos;
-    unsigned char hitpoints;
+    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 */
 };
 
 
 
-/* Structs for standard map objects. */
-
-struct MapObj
+struct MapObjDef
 {
-    void * next;
-    char type;            /* Map object type identifier (see MapObjDef.id). */
-    struct yx_uint16 pos; /* Coordinate of object on map. */
+    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 */
 };
 
-struct Item
-{
-    struct MapObj map_obj;
-};
 
-struct Monster
-{
-    struct MapObj map_obj;
-    unsigned char hitpoints;
-};
+
+/* 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);
 
-/* Structs for map object *type* definitions. Values common to all members of
- * a single monster or item type are harvested from these.
+
+
+/* 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);
 
-struct MapObjDef
-{
-    struct MapObjDef * next;
-    char id;      /* Unique identifier of the map object type to describe. */
-    char mapchar; /* Map object symbol to appear on map.*/
-    char * desc;  /* String describing map object in the game log. */
-};
 
-struct ItemDef
-{
-    struct MapObjDef map_obj_def;
-};
 
-struct MonsterDef
-{
-    struct MapObjDef map_obj_def;
-    unsigned char hitpoints_start; /* Hitpoints each monster starts with. */
-};
+/* 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);
 
 
-/* Initialize map object type definitions from file at path "filename". */
-extern void init_map_object_defs(struct World * world, char * filename);
 
+/* Free map objects in map object chain starting at "mo_start. */
+extern void free_map_objects(struct MapObj * mo_start);
 
 
-/* Build into memory starting at "start" chain of "n" map objects of type
- * "def_id", pass either "build_map_objects_itemdata" or
- * "build_map_objects_monsterdata" as "b_typedata"() to build data specific
- * to monsters or items (or more forms if they ever get invented).
- *
- * TODO: function should decide by itself what "b_typedata"() to call based
- * on monster-or-item info in MapObjDef struct or from a table mapping type
- * identifiers to these.
- */
-extern void * build_map_objects(struct World * world, void * start, char def_id,
-                                 unsigned char n, size_t size,
-                                 void (* b_typedata) (struct MapObjDef *,
-                                                      void *));
-extern void build_map_objects_itemdata(struct MapObjDef * map_obj_def,
-                                       void * start);
-extern void build_map_objects_monsterdata(struct MapObjDef * map_obj_def,
-                                          void * start);
-
-
-
-/* Write to/read from file chain of map objects starting/to start in memory at
- * "start", use "w_typedata"()"/"r_typedata" for data specific to monsters
- * (pass "write_map_objects_monsterdata"/"read_map_objects_itemdata") or items
- * (currently they have no data specific only to them, so pass NULL). Use "size"
- * in read_map_objects() to pass the size of structs of the affected map object
- * type.
- *
- * TODO: the size of these structs should not need to be passed but instead be
- * available via the type id of the affected map object type. The TODO above
- * towards the function deciding its helper function by itself also applies.
- */
-extern void write_map_objects(void * start, FILE * file,
-                              void (* w_typedata) (void *, FILE *) );
-extern void read_map_objects(void * start, FILE * file, size_t size,
-                             void (* w_typedata) (void *, FILE *) );
-extern void write_map_objects_monsterdata(void * start, FILE * file);
-extern void read_map_objects_monsterdata( void * start, FILE * file);
+
+/* 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_obj_def(struct World * world, char def_id);
+extern struct MapObjDef * get_map_object_def(struct World * w, uint8_t id);