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@schmorp.de
*/

#ifndef OBJECT_H
#define OBJECT_H

#include <bitset>

#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;

  UUID () { }
  UUID (uint64 seq) : seq(seq) { }
  operator uint64() { return seq; }
  void operator =(uint64 seq) { this->seq = seq; }
};

extern void init_uuid ();
extern UUID gen_uuid ();
extern const uint64 UUID_SKIP;

/* 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_to ()
 */

ACC_CLASS (object)
// these are being copied
struct object_copy
{
  typedef bitset<NUM_FLAGS> flags_t;

  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 */
  object_ptr ACC (RW, owner);   /* Pointer to the object which controls this one */
  object_ptr ACC (RW, enemy);   /* Monster/player to follow even if not closest */
  object_ptr ACC (RW, attacked_by);     /* This object start to attack us! only player & monster */
  object_ptr ACC (RW, chosen_skill);    /* the skill chosen to use */
  object_ptr ACC (RW, spellitem);       /* Spell ability monster is choosing to use */
  object_ptr ACC (RW, spell);   /* Spell that was being cast */
  object_ptr ACC (RW, current_weapon);  /* Pointer to the weapon currently used */
  arch_ptr ACC (RW, arch);      /* Pointer to archetype */
  arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */

  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 */
  /* this objects turns into or what this object creates */
  treasurelist *ACC (RW, randomitems);  /* Items to be generated */
  key_value *key_values;        /* Fields not explictly known by the loader. */
  flags_t flag;                 /* 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, refcounted, attachable<object>, object_copy
{
  typedef unordered_vector<object *> vector;

  // These variables are not changed by ->copy_to

  tag_t ACC (RW, count);        /* Generation count for this object */
  UUID ACC (RW, uuid);          // Unique Identifier, survives saves etc.

  player_ptr ACC (RW, contr);   /* Pointer to the player which control this object */
  object *ACC (RW, next);       /* Pointer to the next object in the free/used list */
  object *ACC (RW, prev);       /* Pointer to the previous object in the free/used list */
  object *ACC (RW, active_next);/* Next & previous object in the 'active' */
  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. */
  object *ACC (RW, below);      /* Pointer to the object stacked below this one */
  object *ACC (RW, above);      /* Pointer to the object stacked above this one */
                                /* Note: stacked in the *same* environment */
  object *inv;                  /* Pointer to the first object in the inventory */
  object *ACC (RW, container);  /* Current container being used.  I think this
                                 * is only used by the player right now.
                                 */
  object *ACC (RW, env);        /* Pointer to the object which is the environment.
                                 * This is typically the container that the object is in.
                                 */
  object *ACC (RW, more);       /* Pointer to the rest of a large body of objects */
  object *head;                 /* Points to the main object of a large body */ // NO ACC, perl semantics are different
  maptile *ACC (RW, map);       /* Pointer to the map in which this object is present */
  client_container *seen_by;    // seen by which player/container currently?

  static vector mortals;
  static vector active;  // active objects, not yet used
  static vector objects; // not used yet, use first->next->...
  static object *first;  // will be replaced by "objects"

  static object *create ();
  void copy_to (object *dst);
  object *clone (); // create + copy_to
  void destroy (bool destroy_inventory = false);
  void remove ();
  object *insert (object *item); // insert into inventory

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

  // this is often used in time-critical code, so optimise
  static bool can_merge (object *op1, object *op2)
  {
    return op1->value == op2->value
        && op1->name  == op2->name
        && can_merge_slow (op1, op2);
  }

  bool destroyed () { return QUERY_FLAG (this, FLAG_FREED); }

  void set_owner (object *owner);

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

    attachable<object>::instantiate ();
  }

  // recalculate all stats
  void update_stats ();
  void roll_stats ();
  void swap_stats (int a, int b);
  void add_statbonus ();
  void remove_statbonus ();
  void drain_stat ();
  void drain_specific_stat (int deplete_stats);
  void change_luck (int value);

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

  bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; }
  bool is_armor  () const { return type == ARMOUR  || type == SHIELD || type == HELMET
                                || type == CLOAK   || type == BOOTS  || type == GLOVES
                                || type == BRACERS || type == GIRDLE; }
  bool is_alive  () const { return (type == PLAYER
                                    || flag [FLAG_MONSTER]
                                    || (flag [FLAG_ALIVE] && !flag [FLAG_GENERATOR] && type != DOOR))
                                   && !flag [FLAG_IS_A_TEMPLATE]; }
  bool is_arrow  () const { return type == ARROW
                                 || (type == SPELL_EFFECT
                                     && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }

  /* This return true if object has still randomitems which
   * could be expanded.
   */
  bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }

  // returns the player that has this object in his inventory, or 0
  object *in_player () const
  {
    for (object *op = env; op; op = op->env)
      if (op->type == PLAYER)
        return op;

    return 0;
  }

  // returns the mapspace this object is in
  mapspace &ms () 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 ();
};

typedef struct oblnk
{                               /* Used to link together several objects */
  object_ptr ob;
  struct oblnk *next;
} 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, refcounted
{
  archetype ();
  ~archetype ();

  static archetype *find (const char *arch);

  void hash_add (); // add to hastable
  void hash_del (); // remove from hashtable

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