server/include/object.h

/*
    CrossFire, A Multiplayer game for X-windows

    Copyright (C) 2001 Mark Wedel & Crossfire Development Team
    Copyright (C) 1992 Frank Tore Johansen

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

    The authors can be reached via e-mail at crossfire-devel@real-time.com
*/

#ifndef OBJECT_H
#define OBJECT_H

#include "cfperl.h"
#include "shstr.h"

typedef uint32 tag_t;
#define NUM_BODY_LOCATIONS      12
#define BODY_ARMS               1

/* See common/item.c */

typedef struct Body_Locations
{
  const char *save_name;        /* Name used to load/save it to disk */
  const char *use_name;         /* Name used when describing an item we can use */
  const char *nonuse_name;      /* Name to describe objects we can't use */
} Body_Locations;

extern Body_Locations body_locations[NUM_BODY_LOCATIONS];

/*
 * Each object (this also means archetypes!) could have a few of these
 * "dangling" from it; this could also end up containing 'parse errors'.
 *
 * key and value are shared-strings.
 *
 * Please use get_ob_key_value(), set_ob_key_value() from object.c rather than
 * accessing the list directly.
 * Exception is if you want to walk this list for some reason.
 */
struct key_value
{
  key_value *next;
  shstr key, value;
};

struct UUID
{
  uint64 seq;
};

extern void init_uuid ();
extern UUID gen_uuid ();

/* Definition for WILL_APPLY values.  Replaces having harcoded values
 * sprinkled in the code.  Note that some of these also replace fields
 * that were in the can_apply area.  What is the point of having both
 * can_apply and will_apply?
 */
#define WILL_APPLY_HANDLE       0x01
#define WILL_APPLY_TREASURE     0x02
#define WILL_APPLY_EARTHWALL    0x04
#define WILL_APPLY_DOOR         0x08
#define WILL_APPLY_FOOD         0x10

/* However, if you're keeping a pointer of some sort, you probably
 * don't just want it copied, so you'll need to add to common/object.C,
 * e.g. copy_object.
 */

// these are not being copied
ACC_CLASS (object)
struct object_keep : refcounted
{
  tag_t ACC (RW, count);                /* Generation count for this object */
  UUID uuid;                            // Unique Identifier, survives saves etc.

  /* These variables are not changed by copy_object() */
  struct pl *ACC (RW, contr);   /* Pointer to the player which control this object */
  struct object *ACC (RW, next);        /* Pointer to the next object in the free/used list */
  struct object *ACC (RW, prev);        /* Pointer to the previous object in the free/used list */
  struct object *ACC (RW, active_next); /* Next & previous object in the 'active' */
  struct object *ACC (RW, active_prev); /* List.  This is used in process_events */
  /* so that the entire object list does not */
  /* need to be gone through. */
  struct object *ACC (RW, below);       /* Pointer to the object stacked below this one */
  struct object *ACC (RW, above);       /* Pointer to the object stacked above this one */
  /* Note: stacked in the *same* environment */
  struct object *inv;                   /* Pointer to the first object in the inventory */
  struct object *ACC (RW, container);   /* Current container being used.  I think this
                                         * is only used by the player right now.
                                         */
  struct object *ACC (RW, env); /* Pointer to the object which is the environment.
                                 * This is typically the container that the object is in.
                                 */
  struct object *ACC (RW, more);        /* Pointer to the rest of a large body of objects */
  struct object *head;  /* Points to the main object of a large body */ // NO ACC, perl semantics are different
  struct mapstruct *ACC (RW, map);      /* Pointer to the map in which this object is present */
};

// these are being copied
struct object_copy : attachable<object>
{
  shstr ACC (RW, name);         /* The name of the object, obviously... */
  shstr ACC (RW, name_pl);      /* The plural name of the object */
  shstr ACC (RW, title);                /* Of foo, etc */
  shstr ACC (RW, race);         /* human, goblin, dragon, etc */
  shstr ACC (RW, slaying);      /* Which race to do double damage to */
  /* If this is an exit, this is the filename */
  shstr ACC (RW, skill);                /* Name of the skill this object uses/grants */
  shstr ACC (RW, msg);          /* If this is a book/sign/magic mouth/etc */
  shstr ACC (RW, lore);         /* Obscure information about this object, */
  /* To get put into books and the like. */
  shstr ACC (RW, materialname); /* specific material name */
  shstr ACC (RW, custom_name);  /* Custom name assigned by player */
  refptr<object> ACC (RW, owner);       /* Pointer to the object which controls this one */
  refptr<object> ACC (RW, enemy);       /* Monster/player to follow even if not closest */
  refptr<object> ACC (RW, attacked_by); /* This object start to attack us! only player & monster */
  refptr<object> ACC (RW, chosen_skill);        /* the skill chosen to use */
  refptr<object> ACC (RW, spellitem);   /* Spell ability monster is choosing to use */
  refptr<object> ACC (RW, spell);       /* Spell that was being cast */
  refptr<object> ACC (RW, current_weapon);      /* Pointer to the weapon currently used */
};

// these are being copied and also cleared
struct object_pod
{
  New_Face *ACC (RW, face);     /* Face with colors */
  sint16 ACC (RW, x), ACC (RW, y);      /* Position in the map for this object */
  float ACC (RW, speed);                /* The overall speed of this object */
  float ACC (RW, speed_left);   /* How much speed is left to spend this round */
  uint32 ACC (RW, nrof);                /* How many of the objects */
  sint8 ACC (RW, direction);    /* Means the object is moving that way. */
  sint8 ACC (RW, facing);       /* Object is oriented/facing that way. */

  /* This next big block are basically used for monsters and equipment */
  uint8 ACC (RW, type);         /* PLAYER, BULLET, etc.  See define.h */
  uint8 ACC (RW, subtype);      /* subtype of object */
  uint16 ACC (RW, client_type); /* Public type information.  see doc/Developers/objects */
  sint16 resist[NROFATTACKS];   /* Resistance adjustments for attacks */
  uint32 ACC (RW, attacktype);  /* Bitmask of attacks this object does */
  uint32 ACC (RW, path_attuned);        /* Paths the object is attuned to */
  uint32 ACC (RW, path_repelled);       /* Paths the object is repelled from */
  uint32 ACC (RW, path_denied); /* Paths the object is denied access to */
  uint16 ACC (RW, material);    /* What materials this object consist of */
  sint8 ACC (RW, magic);                /* Any magical bonuses to this item */
  uint8 ACC (RW, state);                /* How the object was last drawn (animation) */
  sint32 ACC (RW, value);       /* How much money it is worth (or contains) */
  /* Note that the last_.. values are sometimes used for non obvious
   * meanings by some objects, eg, sp penalty, permanent exp.
   */
  sint32 ACC (RW, last_heal);   /* Last healed. Depends on constitution */
  sint32 ACC (RW, last_sp);     /* As last_heal, but for spell points */
  sint16 ACC (RW, last_grace);  /* as last_sp, except for grace */
  sint16 ACC (RW, last_eat);    /* How long since we last ate */
  sint16 ACC (RW, invisible);   /* How much longer the object will be invis */
  sint16 ACC (RW, level);       /* Level of creature or object */
  uint8 ACC (RW, pick_up);      /* See crossfire.doc */
  sint8 ACC (RW, item_power);   /* power rating of the object */
  sint8 ACC (RW, gen_sp_armour);        /* sp regen penalty this object has (was last_heal) */
  sint8 ACC (RW, glow_radius);  /* indicates the glow radius of the object */
  sint32 ACC (RW, weight);      /* Attributes of the object */
  sint32 ACC (RW, weight_limit);        /* Weight-limit of object */
  sint32 ACC (RW, carrying);    /* How much weight this object contains */
  sint64 ACC (RW, perm_exp);    /* Permanent exp */
  uint32 ACC (RW, weapontype);  /* type of weapon */
  uint32 ACC (RW, tooltype);    /* type of tool or build facility */
  sint8 body_info[NUM_BODY_LOCATIONS];  /* body info as loaded from the file */
  sint8 body_used[NUM_BODY_LOCATIONS];  /* Calculated value based on items equipped */
  living ACC (RO, stats);       /* Str, Con, Dex, etc */
  /* See the doc/Developers/objects for more info about body locations */

  /* Following mostly refers to fields only used for monsters */
  uint32 ACC (RW, hide);                /* The object is hidden, not invisible */
  /* changes made by kholland@sunlab.cit.cornell.edu */
  /* allows different movement patterns for attackers */
  sint32 ACC (RW, move_status); /* What stage in attack mode */
  uint16 ACC (RW, attack_movement);     /* What kind of attack movement */
  uint16 ACC (RW, run_away);    /* Monster runs away if it's hp goes below this percentage. */
  float ACC (RW, expmul);       /* needed experience = (calc_exp*expmul) - means some */
  /* races/classes can need less/more exp to gain levels */

  /* Spell related information, may be useful elsewhere
   * Note that other fields are used - these files are basically
   * only used in spells.
   */
  sint16 ACC (RW, duration);    /* How long the spell lasts */
  sint16 ACC (RW, casting_time);        /* time left before spell goes off */
  uint16 ACC (RW, start_holding);
  uint8 ACC (RW, duration_modifier);    /* how level modifies duration */
  uint8 ACC (RW, dam_modifier); /* How going up in level effects damage */
  sint8 ACC (RW, range);                /* Range of the spell */
  uint8 ACC (RW, range_modifier);       /* How going up in level effects range  */
  char *ACC (RW, spellarg);

  /* Following are values used by any object */
  struct treasureliststruct *ACC (RW, randomitems);     /* Items to be generated */
  struct archetype *ACC (RW, arch);             /* Pointer to archetype */
  struct archetype *ACC (RW, other_arch);       /* Pointer used for various things - mostly used for what */
  key_value *key_values;        /* Fields not explictly known by the loader. */
  /* this objects turns into or what this object creates */
  uint32 flags[4];              /* various flags */
  uint16 ACC (RW, animation_id);                /* An index into the animation array */
  uint8 ACC (RW, anim_speed);           /* ticks between animation-frames */
  uint8 ACC (RW, last_anim);            /* last sequence used to draw face */
  sint32 ACC (RW, elevation);           /* elevation of this terrain - not currently used */
  uint8 ACC (RW, smoothlevel);          /* how to smooth this square around */
  uint8 ACC (RW, will_apply);   /* See crossfire.doc */

  MoveType ACC (RW, move_type);         /* Type of movement this object uses */
  MoveType ACC (RW, move_block);                /* What movement types this blocks */
  MoveType ACC (RW, move_allow);                /* What movement types explicitly allowd */
  MoveType ACC (RW, move_on);           /* Move types affected moving on to this space */
  MoveType ACC (RW, move_off);          /* Move types affected moving off this space */
  MoveType ACC (RW, move_slow);         /* Movement types this slows down */
  float ACC (RW, move_slow_penalty);    /* How much this slows down the object */
};

struct object : zero_initialised, object_keep, object_copy, object_pod
{
  static object *create ();
  void free (bool free_inventory = false);

  static void free_mortals ();
  static bool can_merge (object *op1, object *op2);

  void clear ();
  void clone (object *destination);

  void instantiate ()
  {
    if (!uuid.seq) // HACK
      uuid = gen_uuid ();

    attachable<object>::instantiate ();
  }

  void set_owner (object *owner);

  // info must hold 256 * 3 bytes currently
  const char *debug_desc (char *info) const;
  const char *debug_desc () const;

  // fully recursive iterator
  struct iterator_base
  {
    object *item;

    iterator_base (object *container)
    : item (container)
    {
    }

    operator object *() const { return item; }

    object *operator ->() const { return  item; }
    object &operator * () const { return *item; }
  };

  // depth-first recursive iterator
  struct depth_iterator : iterator_base
  {
    depth_iterator (object *container);
    void next ();
    object *operator ++(   ) { next (); return item; }
    object *operator ++(int) { object *i = item; next (); return i; }
  };

  object *begin ()
  {
    return this;
  }

  object *end ()
  {
    return this;
  }

protected:
  friend struct archetype;

  void link ();
  void unlink ();

  object ();
  ~object ();
};

#define get_object() object::create ()
#define free_object(op) (op)->free (0)
#define free_object2(op, free_inv) (op)->free (free_inv)
#define clear_owner(op) (op)->owner = 0
#define copy_owner(op,other) (op)->owner = (other)->owner
#define get_owner(op) (op)->owner
#define clear_object(op) (op)->clear ()

static inline void
set_owner (object *op, object *owner)
{
  op->set_owner (owner);
}

#define CAN_MERGE(op1,op2) ((op1)->value == (op2)->value && (op1)->name == (op2)->name && object::can_merge ((op1), (op2)))

typedef struct oblnk
{                               /* Used to link together several objects */
  object *ob;
  struct oblnk *next;
  tag_t id;
} objectlink;

typedef struct oblinkpt
{                               /* Used to link together several object links */
  struct oblnk *link;
  long value;                   /* Used as connected value in buttons/gates */
  struct oblinkpt *next;
} oblinkpt;

/*
 * The archetype structure is a set of rules on how to generate and manipulate
 * objects which point to archetypes.
 * This probably belongs in arch.h, but there really doesn't appear to
 * be much left in the archetype - all it really is is a holder for the
 * object and pointers.  This structure should get removed, and just replaced
 * by the object structure
 */

ACC_CLASS(archetype)
struct archetype : zero_initialised
{
  archetype ();
  ~archetype ();

  shstr ACC (RW, name);                 /* More definite name, like "generate_kobold" */
  struct archetype *ACC (RW, next);             /* Next archetype in a linked list */
  struct archetype *ACC (RW, head);             /* The main part of a linked object */
  struct archetype *ACC (RW, more);             /* Next part of a linked object */
  object ACC (RO, clone);                       /* An object from which to do copy_object() */
  uint32 ACC (RW, editable);            /* editable flags (mainly for editor) */
  sint8 ACC (RW, tail_x), ACC (RW, tail_y);             /* Where the lower right most portion of the object is
                                 * in comparison to the head.
                                 */
};

extern object *objects;
extern object *active_objects;

extern int nrofallocobjects;

/* This returns TRUE if the object is something that
 * should be displayed in the look window
 */
#define LOOK_OBJ(ob) (!ob->invisible && ob->type!=PLAYER && ob->type!=EVENT_CONNECTOR)

/* Used by update_object to know if the object being passed is
 * being added or removed.
 */
#define UP_OBJ_INSERT   1
#define UP_OBJ_REMOVE   2
#define UP_OBJ_CHANGE   3
#define UP_OBJ_FACE     4       /* Only thing that changed was the face */

/* These are flags passed to insert_ob_in_map and 
 * insert_ob_in_ob.  Note that all flags may not be meaningful
 * for both functions.
 * Most are fairly explanatory:
 * INS_NO_MERGE: don't try to merge inserted object with ones alrady
 *    on space.
 * INS_ABOVE_FLOOR_ONLY: Put object immediatly above the floor.
 * INS_NO_WALK_ON: Don't call check_walk_on against the
 *    originator - saves cpu time if you know the inserted object
 *    is not meaningful in terms of having an effect.
 * INS_ON_TOP: Always put object on top.  Generally only needed when loading
 *     files from disk and ordering needs to be preserved. 
 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
 *     Use for treasure chests so the new object is the highest thing
 *     beneath the player, but not actually above it.  Note - the
 *     map and x,y coordinates for the object to be inserted must
 *     match the originator.
 * INS_MAP_LOAD: disable lots of checkings done at insertion to
 *     speed up map loading process, as we assume the ordering in
 *     loaded map is correct.
 *
 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
 * are mutually exclusive.  The behaviour for passing more than one
 * should be considered undefined - while you may notice what happens
 * right now if you pass more than one, that could very well change
 * in future revisions of the code.
 */
#define INS_NO_MERGE            0x0001
#define INS_ABOVE_FLOOR_ONLY    0x0002
#define INS_NO_WALK_ON          0x0004
#define INS_ON_TOP              0x0008
#define INS_BELOW_ORIGINATOR    0x0010
#define INS_MAP_LOAD            0x0020

#define ARCH_SINGULARITY        "singularity"
#define ARCH_SINGULARITY_LEN    11
#define ARCH_DETECT_MAGIC       "detect_magic"
#define ARCH_DEPLETION          "depletion"
#define ARCH_SYMPTOM            "symptom"

#endif
Revision:	1.36
Committed:	Thu Sep 14 17:10:25 2006 UTC (17 years, 8 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.35:	+5 -13 lines
Log Message:	removed now obsolete generation counter checks - further slimmed down sizeof(objetc) to 616 bytes
#	User	Rev	Content
1	root	1.1	/*
2			CrossFire, A Multiplayer game for X-windows
3
4			Copyright (C) 2001 Mark Wedel & Crossfire Development Team
5			Copyright (C) 1992 Frank Tore Johansen
6
7			This program is free software; you can redistribute it and/or modify
8			it under the terms of the GNU General Public License as published by
9			the Free Software Foundation; either version 2 of the License, or
10			(at your option) any later version.
11
12			This program is distributed in the hope that it will be useful,
13			but WITHOUT ANY WARRANTY; without even the implied warranty of
14			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			GNU General Public License for more details.
16
17			You should have received a copy of the GNU General Public License
18			along with this program; if not, write to the Free Software
19			Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20
21			The authors can be reached via e-mail at crossfire-devel@real-time.com
22			*/
23
24			#ifndef OBJECT_H
25			#define OBJECT_H
26
27	root	1.6	#include "cfperl.h"
28	root	1.7	#include "shstr.h"
29	root	1.6
30	root	1.1	typedef uint32 tag_t;
31	root	1.14	#define NUM_BODY_LOCATIONS 12
32			#define BODY_ARMS 1
33	root	1.1
34			/* See common/item.c */
35
36	root	1.20	typedef struct Body_Locations
37			{
38			const char save_name; / Name used to load/save it to disk */
39			const char use_name; / Name used when describing an item we can use */
40			const char nonuse_name; / Name to describe objects we can't use */
41	root	1.1	} Body_Locations;
42
43			extern Body_Locations body_locations[NUM_BODY_LOCATIONS];
44
45			/*
46			* Each object (this also means archetypes!) could have a few of these
47			* "dangling" from it; this could also end up containing 'parse errors'.
48			*
49			* key and value are shared-strings.
50			*
51			* Please use get_ob_key_value(), set_ob_key_value() from object.c rather than
52			* accessing the list directly.
53			* Exception is if you want to walk this list for some reason.
54			*/
55	root	1.20	struct key_value
56			{
57			key_value *next;
58			shstr key, value;
59	root	1.15	};
60	root	1.1
61	root	1.34	struct UUID
62			{
63			uint64 seq;
64			};
65
66			extern void init_uuid ();
67			extern UUID gen_uuid ();
68	root	1.1
69			/* Definition for WILL_APPLY values. Replaces having harcoded values
70			* sprinkled in the code. Note that some of these also replace fields
71			* that were in the can_apply area. What is the point of having both
72			* can_apply and will_apply?
73			*/
74	root	1.27	#define WILL_APPLY_HANDLE 0x01
75			#define WILL_APPLY_TREASURE 0x02
76			#define WILL_APPLY_EARTHWALL 0x04
77			#define WILL_APPLY_DOOR 0x08
78	root	1.14	#define WILL_APPLY_FOOD 0x10
79	root	1.1
80	root	1.14	/* However, if you're keeping a pointer of some sort, you probably
81			* don't just want it copied, so you'll need to add to common/object.C,
82			* e.g. copy_object.
83	root	1.1	*/
84	elmex	1.4
85	root	1.18	// these are not being copied
86	root	1.20	ACC_CLASS (object)
87	root	1.28	struct object_keep : refcounted
88	root	1.18	{
89	root	1.36	tag_t ACC (RW, count); /* Generation count for this object */
90	root	1.34	UUID uuid; // Unique Identifier, survives saves etc.
91	root	1.18
92			/* These variables are not changed by copy_object() */
93	root	1.20	struct pl ACC (RW, contr); / Pointer to the player which control this object */
94			struct object ACC (RW, next); / Pointer to the next object in the free/used list */
95			struct object ACC (RW, prev); / Pointer to the previous object in the free/used list */
96			struct object ACC (RW, active_next); / Next & previous object in the 'active' */
97			struct object ACC (RW, active_prev); / List. This is used in process_events */
98			/* so that the entire object list does not */
99			/* need to be gone through. */
100			struct object ACC (RW, below); / Pointer to the object stacked below this one */
101			struct object ACC (RW, above); / Pointer to the object stacked above this one */
102			/* Note: stacked in the same environment */
103			struct object inv; / Pointer to the first object in the inventory */
104			struct object ACC (RW, container); / Current container being used. I think this
105			* is only used by the player right now.
106			*/
107			struct object ACC (RW, env); / Pointer to the object which is the environment.
108			* This is typically the container that the object is in.
109			*/
110			struct object ACC (RW, more); / Pointer to the rest of a large body of objects */
111	root	1.31	struct object head; / Points to the main object of a large body */ // NO ACC, perl semantics are different
112	root	1.20	struct mapstruct ACC (RW, map); / Pointer to the map in which this object is present */
113	elmex	1.4	};
114	root	1.1
115	root	1.18	// these are being copied
116	root	1.25	struct object_copy : attachable<object>
117	root	1.18	{
118	root	1.20	shstr ACC (RW, name); /* The name of the object, obviously... */
119			shstr ACC (RW, name_pl); /* The plural name of the object */
120			shstr ACC (RW, title); /* Of foo, etc */
121			shstr ACC (RW, race); /* human, goblin, dragon, etc */
122			shstr ACC (RW, slaying); /* Which race to do double damage to */
123			/* If this is an exit, this is the filename */
124			shstr ACC (RW, skill); /* Name of the skill this object uses/grants */
125			shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */
126			shstr ACC (RW, lore); /* Obscure information about this object, */
127			/* To get put into books and the like. */
128			shstr ACC (RW, materialname); /* specific material name */
129			shstr ACC (RW, custom_name); /* Custom name assigned by player */
130	root	1.35	refptr<object> ACC (RW, owner); /* Pointer to the object which controls this one */
131			refptr<object> ACC (RW, enemy); /* Monster/player to follow even if not closest */
132			refptr<object> ACC (RW, attacked_by); /* This object start to attack us! only player & monster */
133			refptr<object> ACC (RW, chosen_skill); /* the skill chosen to use */
134			refptr<object> ACC (RW, spellitem); /* Spell ability monster is choosing to use */
135			refptr<object> ACC (RW, spell); /* Spell that was being cast */
136			refptr<object> ACC (RW, current_weapon); /* Pointer to the weapon currently used */
137	root	1.18	};
138	root	1.1
139	root	1.18	// these are being copied and also cleared
140			struct object_pod
141			{
142	root	1.36	New_Face ACC (RW, face); / Face with colors */
143	root	1.20	sint16 ACC (RW, x), ACC (RW, y); /* Position in the map for this object */
144			float ACC (RW, speed); /* The overall speed of this object */
145			float ACC (RW, speed_left); /* How much speed is left to spend this round */
146			uint32 ACC (RW, nrof); /* How many of the objects */
147			sint8 ACC (RW, direction); /* Means the object is moving that way. */
148			sint8 ACC (RW, facing); /* Object is oriented/facing that way. */
149	root	1.18
150			/* This next big block are basically used for monsters and equipment */
151	root	1.20	uint8 ACC (RW, type); /* PLAYER, BULLET, etc. See define.h */
152			uint8 ACC (RW, subtype); /* subtype of object */
153			uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */
154			sint16 resist[NROFATTACKS]; /* Resistance adjustments for attacks */
155			uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
156			uint32 ACC (RW, path_attuned); /* Paths the object is attuned to */
157			uint32 ACC (RW, path_repelled); /* Paths the object is repelled from */
158			uint32 ACC (RW, path_denied); /* Paths the object is denied access to */
159			uint16 ACC (RW, material); /* What materials this object consist of */
160			sint8 ACC (RW, magic); /* Any magical bonuses to this item */
161			uint8 ACC (RW, state); /* How the object was last drawn (animation) */
162			sint32 ACC (RW, value); /* How much money it is worth (or contains) */
163	root	1.18	/* Note that the last_.. values are sometimes used for non obvious
164			* meanings by some objects, eg, sp penalty, permanent exp.
165			*/
166	root	1.20	sint32 ACC (RW, last_heal); /* Last healed. Depends on constitution */
167			sint32 ACC (RW, last_sp); /* As last_heal, but for spell points */
168			sint16 ACC (RW, last_grace); /* as last_sp, except for grace */
169			sint16 ACC (RW, last_eat); /* How long since we last ate */
170			sint16 ACC (RW, invisible); /* How much longer the object will be invis */
171	root	1.26	sint16 ACC (RW, level); /* Level of creature or object */
172	root	1.20	uint8 ACC (RW, pick_up); /* See crossfire.doc */
173			sint8 ACC (RW, item_power); /* power rating of the object */
174			sint8 ACC (RW, gen_sp_armour); /* sp regen penalty this object has (was last_heal) */
175	root	1.26	sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */
176	root	1.20	sint32 ACC (RW, weight); /* Attributes of the object */
177			sint32 ACC (RW, weight_limit); /* Weight-limit of object */
178			sint32 ACC (RW, carrying); /* How much weight this object contains */
179			sint64 ACC (RW, perm_exp); /* Permanent exp */
180			uint32 ACC (RW, weapontype); /* type of weapon */
181			uint32 ACC (RW, tooltype); /* type of tool or build facility */
182			sint8 body_info[NUM_BODY_LOCATIONS]; /* body info as loaded from the file */
183			sint8 body_used[NUM_BODY_LOCATIONS]; /* Calculated value based on items equipped */
184	root	1.36	living ACC (RO, stats); /* Str, Con, Dex, etc */
185	root	1.20	/* See the doc/Developers/objects for more info about body locations */
186	root	1.18
187			/* Following mostly refers to fields only used for monsters */
188	root	1.20	uint32 ACC (RW, hide); /* The object is hidden, not invisible */
189	root	1.18	/* changes made by kholland@sunlab.cit.cornell.edu */
190			/* allows different movement patterns for attackers */
191	root	1.20	sint32 ACC (RW, move_status); /* What stage in attack mode */
192			uint16 ACC (RW, attack_movement); /* What kind of attack movement */
193	root	1.26	uint16 ACC (RW, run_away); /* Monster runs away if it's hp goes below this percentage. */
194			float ACC (RW, expmul); /* needed experience = (calc_expexpmul) - means some /
195	root	1.20	/* races/classes can need less/more exp to gain levels */
196	root	1.18
197			/* Spell related information, may be useful elsewhere
198			* Note that other fields are used - these files are basically
199			* only used in spells.
200			*/
201	root	1.20	sint16 ACC (RW, duration); /* How long the spell lasts */
202			sint16 ACC (RW, casting_time); /* time left before spell goes off */
203	root	1.26	uint16 ACC (RW, start_holding);
204			uint8 ACC (RW, duration_modifier); /* how level modifies duration */
205	root	1.20	uint8 ACC (RW, dam_modifier); /* How going up in level effects damage */
206			sint8 ACC (RW, range); /* Range of the spell */
207			uint8 ACC (RW, range_modifier); /* How going up in level effects range */
208	root	1.36	char *ACC (RW, spellarg);
209	root	1.18
210			/* Following are values used by any object */
211	root	1.35	struct treasureliststruct ACC (RW, randomitems); / Items to be generated */
212	root	1.21	struct archetype ACC (RW, arch); / Pointer to archetype */
213			struct archetype ACC (RW, other_arch); / Pointer used for various things - mostly used for what */
214	root	1.35	key_value key_values; / Fields not explictly known by the loader. */
215	root	1.20	/* this objects turns into or what this object creates */
216			uint32 flags[4]; /* various flags */
217			uint16 ACC (RW, animation_id); /* An index into the animation array */
218			uint8 ACC (RW, anim_speed); /* ticks between animation-frames */
219			uint8 ACC (RW, last_anim); /* last sequence used to draw face */
220			sint32 ACC (RW, elevation); /* elevation of this terrain - not currently used */
221			uint8 ACC (RW, smoothlevel); /* how to smooth this square around */
222	root	1.32	uint8 ACC (RW, will_apply); /* See crossfire.doc */
223	root	1.20
224			MoveType ACC (RW, move_type); /* Type of movement this object uses */
225			MoveType ACC (RW, move_block); /* What movement types this blocks */
226			MoveType ACC (RW, move_allow); /* What movement types explicitly allowd */
227			MoveType ACC (RW, move_on); /* Move types affected moving on to this space */
228			MoveType ACC (RW, move_off); /* Move types affected moving off this space */
229			MoveType ACC (RW, move_slow); /* Movement types this slows down */
230			float ACC (RW, move_slow_penalty); /* How much this slows down the object */
231	elmex	1.4	};
232
233	root	1.18	struct object : zero_initialised, object_keep, object_copy, object_pod
234			{
235	root	1.23	static object *create ();
236			void free (bool free_inventory = false);
237	root	1.22
238	root	1.23	static void free_mortals ();
239			static bool can_merge (object op1, object op2);
240	root	1.19
241	root	1.18	void clear ();
242	root	1.23	void clone (object *destination);
243
244	root	1.34	void instantiate ()
245			{
246			if (!uuid.seq) // HACK
247			uuid = gen_uuid ();
248
249			attachable<object>::instantiate ();
250			}
251
252	root	1.28	void set_owner (object *owner);
253
254	root	1.33	// info must hold 256 * 3 bytes currently
255			const char debug_desc (char info) const;
256			const char *debug_desc () const;
257
258	root	1.29	// fully recursive iterator
259			struct iterator_base
260			{
261			object *item;
262
263	root	1.30	iterator_base (object *container)
264			: item (container)
265	root	1.29	{
266			}
267
268			operator object *() const { return item; }
269
270			object *operator ->() const { return item; }
271			object &operator * () const { return *item; }
272			};
273
274	root	1.30	// depth-first recursive iterator
275			struct depth_iterator : iterator_base
276	root	1.29	{
277	root	1.30	depth_iterator (object *container);
278	root	1.29	void next ();
279			object *operator ++( ) { next (); return item; }
280			object operator ++(int) { object i = item; next (); return i; }
281			};
282
283			object *begin ()
284			{
285	root	1.30	return this;
286	root	1.29	}
287
288			object *end ()
289			{
290	root	1.30	return this;
291	root	1.29	}
292
293	root	1.23	protected:
294			friend struct archetype;
295
296	root	1.24	void link ();
297			void unlink ();
298
299	root	1.23	object ();
300			~object ();
301	elmex	1.4	};
302	root	1.1
303	root	1.28	#define get_object() object::create ()
304			#define free_object(op) (op)->free (0)
305			#define free_object2(op, free_inv) (op)->free (free_inv)
306			#define clear_owner(op) (op)->owner = 0
307			#define copy_owner(op,other) (op)->owner = (other)->owner
308	root	1.36	#define get_owner(op) (op)->owner
309	root	1.28	#define clear_object(op) (op)->clear ()
310
311			static inline void
312			set_owner (object op, object owner)
313			{
314			op->set_owner (owner);
315			}
316
317	root	1.19	#define CAN_MERGE(op1,op2) ((op1)->value == (op2)->value && (op1)->name == (op2)->name && object::can_merge ((op1), (op2)))
318
319	root	1.20	typedef struct oblnk
320			{ /* Used to link together several objects */
321	root	1.1	object *ob;
322			struct oblnk *next;
323			tag_t id;
324			} objectlink;
325
326	root	1.20	typedef struct oblinkpt
327			{ /* Used to link together several object links */
328	root	1.1	struct oblnk *link;
329	root	1.20	long value; /* Used as connected value in buttons/gates */
330	root	1.1	struct oblinkpt *next;
331			} oblinkpt;
332
333			/*
334			* The archetype structure is a set of rules on how to generate and manipulate
335			* objects which point to archetypes.
336			* This probably belongs in arch.h, but there really doesn't appear to
337			* be much left in the archetype - all it really is is a holder for the
338			* object and pointers. This structure should get removed, and just replaced
339			* by the object structure
340			*/
341
342	root	1.20	ACC_CLASS(archetype)
343	root	1.21	struct archetype : zero_initialised
344	root	1.15	{
345	root	1.22	archetype ();
346			~archetype ();
347
348	root	1.20	shstr ACC (RW, name); /* More definite name, like "generate_kobold" */
349	root	1.21	struct archetype ACC (RW, next); / Next archetype in a linked list */
350			struct archetype ACC (RW, head); / The main part of a linked object */
351			struct archetype ACC (RW, more); / Next part of a linked object */
352	root	1.20	object ACC (RO, clone); /* An object from which to do copy_object() */
353			uint32 ACC (RW, editable); /* editable flags (mainly for editor) */
354			sint8 ACC (RW, tail_x), ACC (RW, tail_y); /* Where the lower right most portion of the object is
355			* in comparison to the head.
356			*/
357	root	1.21	};
358	root	1.1
359			extern object *objects;
360			extern object *active_objects;
361
362			extern int nrofallocobjects;
363
364	root	1.15	/* This returns TRUE if the object is something that
365	root	1.1	* should be displayed in the look window
366			*/
367			#define LOOK_OBJ(ob) (!ob->invisible && ob->type!=PLAYER && ob->type!=EVENT_CONNECTOR)
368
369			/* Used by update_object to know if the object being passed is
370			* being added or removed.
371			*/
372			#define UP_OBJ_INSERT 1
373			#define UP_OBJ_REMOVE 2
374			#define UP_OBJ_CHANGE 3
375	root	1.20	#define UP_OBJ_FACE 4 /* Only thing that changed was the face */
376	root	1.1
377			/* These are flags passed to insert_ob_in_map and
378			* insert_ob_in_ob. Note that all flags may not be meaningful
379			* for both functions.
380			* Most are fairly explanatory:
381			* INS_NO_MERGE: don't try to merge inserted object with ones alrady
382			* on space.
383			* INS_ABOVE_FLOOR_ONLY: Put object immediatly above the floor.
384			* INS_NO_WALK_ON: Don't call check_walk_on against the
385			* originator - saves cpu time if you know the inserted object
386			* is not meaningful in terms of having an effect.
387			* INS_ON_TOP: Always put object on top. Generally only needed when loading
388			* files from disk and ordering needs to be preserved.
389			* INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
390			* Use for treasure chests so the new object is the highest thing
391			* beneath the player, but not actually above it. Note - the
392			* map and x,y coordinates for the object to be inserted must
393			* match the originator.
394			* INS_MAP_LOAD: disable lots of checkings done at insertion to
395			* speed up map loading process, as we assume the ordering in
396			* loaded map is correct.
397			*
398			* Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
399			* are mutually exclusive. The behaviour for passing more than one
400			* should be considered undefined - while you may notice what happens
401			* right now if you pass more than one, that could very well change
402			* in future revisions of the code.
403			*/
404	root	1.14	#define INS_NO_MERGE 0x0001
405			#define INS_ABOVE_FLOOR_ONLY 0x0002
406			#define INS_NO_WALK_ON 0x0004
407			#define INS_ON_TOP 0x0008
408			#define INS_BELOW_ORIGINATOR 0x0010
409			#define INS_MAP_LOAD 0x0020
410	root	1.1
411			#define ARCH_SINGULARITY "singularity"
412			#define ARCH_SINGULARITY_LEN 11
413			#define ARCH_DETECT_MAGIC "detect_magic"
414			#define ARCH_DEPLETION "depletion"
415			#define ARCH_SYMPTOM "symptom"
416
417			#endif