home · contact · privacy
Add basic food clock (but no consumables yet to re-set it).
[plomrogue] / src / server / things.h
index 3040d04b193bf021390390d998d35d9d566dac8b..494d1a5aade2461d07c723e9f10ab53c68abc0f5 100644 (file)
 /* src/server/things.h
  *
- * Structs for things and their type definitions, and routines to initialize
- * these and load and save them from/to files.
+ * This file is part of PlomRogue. PlomRogue is licensed under the GPL version 3
+ * or any later version. For details on its copyright, license, and warranties,
+ * see the file NOTICE in the root directory of the PlomRogue source package.
+ *
+ * Structs for things and their type and action definitions, and routines to
+ * initialize these.
  */
 
 #ifndef THINGS_H
 #define THINGS_H
 
-#include <stdint.h> /* uint8_t */
-#include "../common/yx_uint8.h" /* yx_uint8 structs */
+#include <stdint.h> /* uint8_t, int16_t, uint16_t */
+#include "../common/yx_uint8.h" /* yx_uint8 */
 
 
 
 struct Thing
 {
-    struct Thing * next;        /* pointer to next one in things chain */
-    struct Thing * owns;        /* chain of things owned / in inventory */
-    struct yx_uint8 pos;         /* coordinate on map */
-    uint8_t * fov_map;           /* map of the thing's field of view */
-    uint8_t id;                  /* individual thing's unique identifier */
-    uint8_t type;                /* ID of appropriate thing definition */
-    uint8_t lifepoints;          /* 0: thing is inanimate; >0: hitpoints */
-    uint8_t command;             /* thing's current action; 0 if none */
-    uint8_t arg;                 /* optional field for .command argument */
-    uint8_t progress;            /* turns already passed to realize .command */
+    struct Thing * next;
+    uint8_t id;                   /* individual thing's unique identifier */
+    struct Thing * owns;          /* chain of things owned / in inventory */
+    struct ThingInMemory * t_mem; /* chain of things remembered */
+    struct yx_uint8 pos;          /* coordinate on map */
+    char * fov_map;               /* thing's FOV map; 'v':visible, 'H':hidden */
+    char * mem_map;               /* map knowledge of thing by FOV and memory */
+    char * mem_depth_map;         /* map of map memory up-to-dateness */
+    int16_t satiation;            /* negative: hungry; positive: over-fed */
+    uint8_t type;                 /* ID of appropriate thing definition */
+    uint8_t lifepoints;           /* 0: thing is inanimate; >0: hitpoints */
+    uint8_t command;              /* thing's current action; 0 if none */
+    uint8_t arg;                  /* optional field for .command argument */
+    uint8_t progress;             /* turns already passed to realize .command */
+};
+
+struct ThingInMemory
+{
+    struct ThingInMemory * next;
+    struct yx_uint8 pos;                             /* position on memorized */
+    uint8_t type;                                    /* thing type identifier */
 };
 
 struct ThingType
 {
-    uint8_t id;         /* thing type identifier / sets .type */
     struct ThingType * next;
-    char char_on_map;   /* thing symbol to appear on map */
-    char * name;        /* string to describe thing in game log */
-    uint8_t corpse_id;  /* type to change thing into upon destruction */
-    uint8_t lifepoints; /* default start value for thing's .lifepoints */
-    uint8_t consumable; /* can be eaten if !0, for so much hitpoint win */
-    uint8_t start_n;    /* how many of these does the map start with? */
+    uint8_t id;          /* thing type identifier / sets .type */
+    char char_on_map;    /* thing symbol to appear on map */
+    char * name;         /* string to describe thing in game log */
+    uint16_t stomach;    /* if >0, defines onset & chance of hunger suffering */
+    uint8_t corpse_id;   /* type to change thing into upon destruction */
+    uint8_t lifepoints;  /* default start value for thing's .lifepoints */
+    uint8_t consumable;  /* can be eaten if !0, for so much hitpoint win */
+    uint8_t start_n;     /* how many of these does the map start with? */
+    uint8_t proliferate; /* if >0: inverse of chance to proliferate */
 };
 
+struct ThingAction
+{
+    struct ThingAction * next;
+    uint8_t id;   /* identifies action in Thing.command; therefore must be >0 */
+    void (* func) (struct Thing *);    /* function called after .effort turns */
+    char * name;                       /* human-readable identifier */
+    uint8_t effort;                    /* how many turns the action takes */
+};
 
 
-/* Free thing types chain starting at "tt_start". */
-extern void free_thing_types(struct ThingType * tt_start);
 
-/* Add thing(s) ("n": how many?) of "type" to map on random position(s). New
- * animate things are never placed in the same square with other animate ones.
+/* Add thing action of "id" to world.thing_actions, with .name defaulting to
+ * s[S_CMD_WAIT], .func to actor_wait() and .effort to 1. If "id" is not >= 1
+ * and <= UINT8_MAX, use lowest unused id. Return thing action.
  */
-extern void add_things(uint8_t type, uint8_t n);
+extern struct ThingAction * add_thing_action(uint8_t id);
 
-/* Free things in things chain starting at "t_start. */
-extern void free_things(struct Thing * t_start);
+/* Add thing type of "id" to world.thing_types, with .corpse_id defaulting to
+ * the new thing type's .id, .name to "(none)" and the remaining values to 0. If
+ * "id" is not >= 0 and <= UINT8_MAX, use lowest unused id. Return thing type.
+ */
+extern struct ThingType * add_thing_type(int16_t id);
 
-/* Move thing of "id" from "source" inventory to "target" inventory. */
-extern void own_thing(struct Thing ** target, struct Thing ** source,
-                      uint8_t id);
+/* Add thing of "id" and "type" on position of "y"/x" to world.things. If "id"
+ * is not >= 0 and <= UINT8_MAX, use lowest unused id. Build .fov_map if
+ * world.exists is non-zero. Return thing.
+ */
+extern struct Thing * add_thing(int16_t id, uint8_t type, uint8_t y, uint8_t x);
 
-/* Get pointer to the Thing struct that represents the player. */
-extern struct Thing * get_player();
+/* Add to thing memory of "t" thing of type id "type" and position "y"/"x". */
+extern void add_thing_to_memory_map(struct Thing * t, uint8_t type,
+                                    uint8_t y, uint8_t x);
+
+/* Free ThingAction / ThingType / Thing / ThingInMemory chain starting at "ta" /
+ * "tt" / "t" / "tm".
+ */
+extern void free_thing_actions(struct ThingAction * ta);
+extern void free_thing_types(struct ThingType * tt);
+extern void free_things(struct Thing * t);
+extern void free_things_in_memory(struct ThingInMemory * tm);
 
-/* Get pointer to the thing type of identifier "def_id". */
+/* Return pointer to ThingAction/ThingType of "id", or NULL if none found. */
+extern struct ThingAction * get_thing_action(uint8_t id);
 extern struct ThingType * get_thing_type(uint8_t id);
 
+/* Return world.thing_actions ThingAction.id for "name" or 0 if none found. */
+extern uint8_t get_thing_action_id_by_name(char * name);
+
+/* Return thing of "id" in chain at "ptr", search inventories too if "deep".
+ * Return NULL if nothing found.
+ */
+extern struct Thing * get_thing(struct Thing * ptr, uint8_t id, uint8_t deep);
+
+/* Get pointer to the non-owend Thing struct that represents the player, or NULL
+ * if none found.
+ */
+extern struct Thing * get_player();
+
+/* Try to create "t" offspring on random passable neighbor cell if available
+ * (and, if "t" is of animate thing type, not inhabited by animate thing) and
+ * "t"'s type's .proliferation is >0, with a chance of 1/.proliferation.
+ */
+extern void try_thing_proliferation(struct Thing * t);
+
+/* Add thing(s) ("n": how many?) of "type" to map on random passable
+ * position(s). New animate things are never placed in the same square with
+ * other animate ones.
+ */
+extern void add_things(uint8_t type, uint8_t n);
+
+/* Move thing of "id" from "source" inventory to "target" inventory. */
+extern void own_thing(struct Thing ** target, struct Thing ** source,
+                      uint8_t id);
+
 /* Move not only "t" to "pos", but also all things owned by it. */
 extern void set_thing_position(struct Thing * t, struct yx_uint8 pos);