home · contact · privacy
Changed way world.map_obj_count is transmitted; also re-factoring of map_objects...
[plomrogue] / src / map_objects.h
index 6f3772e5272fd858760d6d4218032a6784c163ce..fd7a8191739ccb9d8d69214972e06007d4b455b4 100644 (file)
@@ -1,41 +1,79 @@
-#ifndef ACTORS_H
-#define ACTORS_H
-
-#include <stdio.h>
-#include "yx_uint16.h"
-
-struct World;
-struct Map;
-
-struct Player {
-  struct yx_uint16 pos;
-  unsigned char hitpoints; };
-
-struct ChainMapObject {
-  void * next;
-  unsigned char name;
-  struct yx_uint16 pos; };
-
-struct Item {
-  struct ChainMapObject cmo; };
-
-struct Monster {
-  struct ChainMapObject cmo;
-  unsigned char hitpoints; };
-
-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 (void *);
-extern void build_map_objects_itemdata (void *);
-extern void build_map_objects (void *, unsigned char, size_t, void (*) (void *), struct Map *);
-
-extern struct yx_uint16 find_passable_pos (struct Map *);
-extern char is_passable (struct Map *, struct yx_uint16);
-extern void move_monster (struct World *, struct Monster *);
-extern void move_player (struct World *, char);
-extern void player_wait(struct World *);
+/* 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> /* for FILE typedef */
+#include <stdint.h> /* for uint8_t */
+#include "yx_uint16.h" /* for yx_uint16 coordinates */
+
+
+
+struct MapObj
+{
+    struct MapObj * next;        /* pointer to next one in map object chain */
+    struct MapObj * owns;        /* chain of map objects owned / in inventory */
+    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 */
+    uint8_t command;             /* map object's current action */
+    uint8_t arg;                 /* optional field for .command argument */
+    uint8_t progress;            /* turns already passed to realize .command */
+};
+
+struct MapObjDef
+{
+    struct MapObjDef * next;
+    uint8_t id;         /* map object definition identifier / sets .type */
+    uint8_t corpse_id;  /* type to change map object 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 start value for map object's .lifepoints */
+};
+
+
+
+/* Initialize map object definitions chain from file at path "filename". */
+extern void init_map_object_defs(char * filename);
+
+/* Free map object definitions chain starting at "mod_start". */
+extern void free_map_object_defs(struct MapObjDef * mod_start);
+
+/* Write map objects chain to "file". */
+extern void write_map_objects(FILE * file);
+
+/* Read map objects chain from "file"; use "line" as char array for fgets() and
+ * expect line strings of max. "linemax" length to be read by it.
+ */
+extern void read_map_objects(FILE * file, char * line, int linemax);
+
+/* Add 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 animate ones.
+ */
+extern void add_map_object(uint8_t type);
+extern void add_map_objects(uint8_t type, uint8_t n);
+
+/* Free map objects in map object chain starting at "mo_start. */
+extern void free_map_objects(struct MapObj * mo_start);
+
+/* Move object of "id" from "source" inventory to "target" inventory. */
+extern void own_map_object(struct MapObj ** target, struct MapObj ** source,
+                           uint8_t id);
+
+/* Get pointer to the MapObj struct that represents the player. */
+extern struct MapObj * get_player();
+
+/* Get pointer to the map object definition of identifier "def_id". */
+extern struct MapObjDef * get_map_object_def(uint8_t id);
+
+/* Move not only "mo" to "pos", but also all map objects owned by it. */
+extern void set_object_position(struct MapObj * mo, struct yx_uint16 pos);
+
+
 
 #endif