[ViewVC] Diff of: cvs/deliantra/server/include/object.h

Comparing deliantra/server/include/object.h (file contents):
Revision 1.5 by root, Fri Aug 25 17:11:53 2006 UTC vs.
Revision 1.201 by root, Sat Jun 27 03:51:05 2009 UTC

…		…
1	/*	1	/*
2	* static char *rcsid_object_h =	2	* This file is part of Deliantra, the Roguelike Realtime MMORPG.
3	* "$Id: object.h,v 1.5 2006/08/25 17:11:53 root Exp $";	3	*
		4	* Copyright (©) 2005,2006,2007,2008,2009 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
		5	* Copyright (©) 2001,2007 Mark Wedel & Crossfire Development Team
		6	* Copyright (©) 1992,2007 Frank Tore Johansen
		7	*
		8	* Deliantra is free software: you can redistribute it and/or modify
		9	* it under the terms of the GNU General Public License as published by
		10	* the Free Software Foundation, either version 3 of the License, or
		11	* (at your option) any later version.
		12	*
		13	* This program is distributed in the hope that it will be useful,
		14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
		15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		16	* GNU General Public License for more details.
		17	*
		18	* You should have received a copy of the GNU General Public License
		19	* along with this program. If not, see <http://www.gnu.org/licenses/>.
		20	*
		21	* The authors can be reached via e-mail to <support@deliantra.net>
4	*/	22	*/
5
6	/*
7	CrossFire, A Multiplayer game for X-windows
8
9	Copyright (C) 2001 Mark Wedel & Crossfire Development Team
10	Copyright (C) 1992 Frank Tore Johansen
11
12	This program is free software; you can redistribute it and/or modify
13	it under the terms of the GNU General Public License as published by
14	the Free Software Foundation; either version 2 of the License, or
15	(at your option) any later version.
16
17	This program is distributed in the hope that it will be useful,
18	but WITHOUT ANY WARRANTY; without even the implied warranty of
19	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20	GNU General Public License for more details.
21
22	You should have received a copy of the GNU General Public License
23	along with this program; if not, write to the Free Software
24	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25
26	The authors can be reached via e-mail at crossfire-devel@real-time.com
27	*/
28		23
29	#ifndef OBJECT_H	24	#ifndef OBJECT_H
30	#define OBJECT_H	25	#define OBJECT_H
31		26
		27	#include <bitset>
		28
		29	#include "cfperl.h"
		30	#include "shstr.h"
		31
32	typedef uint32 tag_t;	32	typedef int tag_t;
		33
		34	enum {
		35	body_skill,
		36	body_combat,
		37	body_range,
		38	body_shield,
		39	body_arm,
		40	body_torso,
		41	body_head,
		42	body_neck,
		43	body_finger,
		44	body_shoulder,
		45	body_foot,
		46	body_hand,
		47	body_wrist,
		48	body_waist,
33	#define NUM_BODY_LOCATIONS 12	49	NUM_BODY_LOCATIONS
34	#define BODY_ARMS 1	50	};
		51
		52	enum slottype_t
		53	{
		54	slot_none,
		55	slot_combat,
		56	slot_ranged,
		57	};
35		58
36	/* See common/item.c */	59	/* See common/item.c */
37		60
38	typedef struct Body_Locations {	61	typedef struct Body_Locations
		62	{
39	const char save_name; / Name used to load/save it to disk */	63	keyword save_name; /* Name used to load/save it to disk */
40	const char use_name; / Name used when describing an item we can use */	64	const char use_name; / Name used when describing an item we can use */
41	const char nonuse_name; / Name to describe objects we can't use */	65	const char nonuse_name; / Name to describe objects we can't use */
42	} Body_Locations;	66	} Body_Locations;
43		67
44	extern Body_Locations body_locations[NUM_BODY_LOCATIONS];	68	extern Body_Locations body_locations[NUM_BODY_LOCATIONS];
45		69
46	typedef struct _event	70	#define NUM_COINS 4 /* number of coin types */
47	{	71	extern const char *const coins[NUM_COINS + 1];
48	int type;
49	const char *hook;
50	const char *plugin;
51	const char *options;
52	struct _event *next;
53	} event;
54		72
55	/*	73	/*
56	* Each object (this also means archetypes!) could have a few of these	74	* Each object (this also means archetypes!) could have a few of these
57	* "dangling" from it; this could also end up containing 'parse errors'.	75	* "dangling" from it; this could also end up containing 'parse errors'.
58	*	76	*
59	* key and value are shared-strings.	77	* key and value are shared-strings.
60	*	78	*
61	* Please use get_ob_key_value(), set_ob_key_value() from object.c rather than	79	* Please use kv_get/kv_set/kv_del from object rather than
62	* accessing the list directly.	80	* accessing the list directly.
63	* Exception is if you want to walk this list for some reason.	81	* Exception is if you want to walk this list for some reason.
64	*/	82	*/
65	typedef struct _key_value {	83	struct key_value : slice_allocated
66	const char * key;	84	{
67	const char * value;
68	struct _key_value * next;	85	key_value *next;
69	} key_value;	86	shstr key, value;
		87	};
70		88
		89	struct UUID
		90	{
		91	uint64 seq;
		92
		93	static UUID cur; // last uuid generated
		94	static void init ();
		95	static UUID gen ();
		96
		97	UUID () { }
		98	UUID (uint64 seq) : seq(seq) { }
		99	operator uint64() { return seq; }
		100	void operator =(uint64 seq) { this->seq = seq; }
		101
		102	typedef char BUF [32];
		103
		104	bool parse (const char *s)
		105	{
		106	return sscanf (s, "<1.%" SCNx64 ">", &seq) == 1;
		107	}
		108
		109	const char c_str (char buf, int len) const
		110	{
		111	snprintf (buf, len, "<1.%" PRIx64 ">", seq);
		112
		113	return buf;
		114	}
		115
		116	const char *c_str () const
		117	{
		118	static BUF buf;
		119
		120	return c_str (buf, sizeof (buf));
		121	}
		122	};
71		123
72	/* Definition for WILL_APPLY values. Replaces having harcoded values	124	/* Definition for WILL_APPLY values. Replaces having harcoded values
73	* sprinkled in the code. Note that some of these also replace fields	125	* sprinkled in the code. Note that some of these also replace fields
74	* that were in the can_apply area. What is the point of having both	126	* that were in the can_apply area. What is the point of having both
75	* can_apply and will_apply?	127	* can_apply and will_apply?
76	*/	128	*/
77	#define WILL_APPLY_HANDLE 0x1	129	#define WILL_APPLY_HANDLE 0x01
78	#define WILL_APPLY_TREASURE 0x2	130	#define WILL_APPLY_TREASURE 0x02
79	#define WILL_APPLY_EARTHWALL 0x4	131	#define WILL_APPLY_EARTHWALL 0x04
80	#define WILL_APPLY_DOOR 0x8	132	#define WILL_APPLY_DOOR 0x08
81	#define WILL_APPLY_FOOD 0x10	133	#define WILL_APPLY_FOOD 0x10
82		134
		135	struct body_slot
		136	{
		137	signed char info:4; /* body info as loaded from the file */
		138	signed char used:4; /* Calculated value based on items equipped */
		139	};
83		140
84	/* Note that the ordering of this structure is sort of relevent -	141	typedef struct oblnk
85	* copy_object copies everything over beyond 'name' using memcpy.	142	{ /* Used to link together several objects */
86	* Thus, values that need to be copied need to be located beyond that	143	object_ptr ob;
87	* point.	144	struct oblnk *next;
88	*	145	} objectlink;
89	* However, if you're keeping a pointer of some sort, you probably	146
90	* don't just want it copied, so you'll need to add to common/object.c,	147	typedef struct oblinkpt
91	* e.g. copy-object	148	{ /* Used to link together several object links */
92	*	149	struct oblnk *link;
93	* I've tried to clean up this structure a bit (in terms of formatting)	150	struct oblinkpt *next;
94	* by making it more consistent. I've also tried to locate some of the fields	151	shstr id; /* Used as connected value in buttons/gates */
95	* more logically together (put the item related ones together, the monster	152	} oblinkpt;
96	* related ones, etc.	153
97	* This structure is best viewed with about a 100 width screen.	154	INTERFACE_CLASS (object)
98	* MSW 2002-07-05	155	// these are being copied
		156	struct object_copy : attachable
		157	{
		158	sint16 ACC (RW, x), ACC (RW, y); /* Position in the map for this object */
		159
		160	uint8 ACC (RW, type); /* PLAYER, BULLET, etc. See define.h */
		161	uint8 ACC (RW, subtype); /* subtype of object */
		162	sint8 ACC (RW, direction); /* Means the object is moving that way. */
		163	sint8 ACC (RW, facing); /* Object is oriented/facing that way. */
		164
		165	shstr ACC (RW, name); /* The name of the object, obviously... */
		166	shstr ACC (RW, name_pl); /* The plural name of the object */
		167	shstr ACC (RW, title); /* Of foo, etc */
		168	shstr ACC (RW, race); /* human, goblin, dragon, etc */
		169	shstr ACC (RW, slaying); /* Which race to do double damage to */
		170	/* If this is an exit, this is the filename */
		171
		172	typedef bitset<NUM_FLAGS> flags_t;
		173	flags_t flag; /* various flags */
		174	#if FOR_PERL
		175	bool ACC (RW, flag[NUM_FLAGS]);
		176	#endif
		177
		178	shstr ACC (RW, materialname); /* specific material name */
		179	shstr ACC (RW, skill); /* Name of the skill this object uses/grants */
		180	// materialtype_t ACC (RW, material); / What material this object consists of */
		181	object_ptr ACC (RW, owner); /* Pointer to the object which controls this one */
		182	object_ptr ACC (RW, enemy); /* Monster/player to follow even if not closest */
		183	object_ptr ACC (RW, attacked_by); /* This object start to attack us! only player & monster */
		184	object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */
		185	object_ptr ACC (RW, spellitem); /* Spell ability monster is choosing to use */
		186	object_ptr ACC (RW, spell); /* Spell that was being cast */
		187	object_ptr ACC (RW, current_weapon); /* Pointer to the weapon currently used */
		188	arch_ptr ACC (RW, arch); /* Pointer to archetype */
		189	arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */
		190
		191	float ACC (RW, speed); /* The overall speed of this object */
		192	float ACC (RW, speed_left); /* How much speed is left to spend this round */
		193	sint32 ACC (RW, nrof); /* How many of the objects */
		194
		195	/* This next big block is basically used for monsters and equipment */
		196	uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */
		197	sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */
		198
		199	uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
		200	uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */
		201	uint32 ACC (RW, path_repelled); /* Paths the object is repelled from */
		202	uint32 ACC (RW, path_denied); /* Paths the object is denied access to */
		203
		204	uint16 ACC (RW, materials); /* What materials this object consists of */
		205	sint8 ACC (RW, magic); /* Any magical bonuses to this item */
		206	uint8 ACC (RW, state); /* How the object was last drawn (animation) */
		207
		208	sint32 ACC (RW, value); /* How much money it is worth (or contains) */
		209	/* Note that the last_.. values are sometimes used for non obvious
		210	* meanings by some objects, eg, sp penalty, permanent exp.
99	*/	211	*/
		212	sint32 ACC (RW, last_heal); /* Last healed. Depends on constitution */
		213	sint32 ACC (RW, last_sp); /* As last_heal, but for spell points */
		214	sint16 ACC (RW, last_grace); /* as last_sp, except for grace */
		215	sint16 ACC (RW, last_eat); /* How long since we last ate */
		216	sint16 ACC (RW, invisible); /* How much longer the object will be invis */
		217	sint16 ACC (RW, level); /* Level of creature or object */
100		218
101	struct object_simple {	219	uint8 ACC (RW, pick_up); /* See crossfire.doc */
		220	sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */
		221	sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */
		222	uint8 ACC (RW, weapontype); /* type of weapon */
		223
		224	faceidx ACC (RW, face); /* the graphical face */
		225
		226	faceidx ACC (RW, sound); /* the sound face */
		227	faceidx ACC (RW, sound_destroy); /* played on destroy */
		228
		229	body_slot slot [NUM_BODY_LOCATIONS];
		230
		231	sint32 ACC (RW, weight); /* Attributes of the object */
		232	sint32 ACC (RW, weight_limit);/* Weight-limit of object */
		233	sint32 ACC (RW, carrying); /* How much weight this object contains, must be 0 if nrof == 0 */
		234	sint64 ACC (RW, perm_exp); /* Permanent exp */
		235	living ACC (RO, stats); /* Str, Con, Dex, etc */
		236	/* See the pod/objects.pod for more info about body locations */
		237
		238	/* Following mostly refers to fields only used for monsters */
		239
		240	/* allows different movement patterns for attackers */
		241	sint32 ACC (RW, move_status); /* What stage in attack mode */
		242	uint16 ACC (RW, attack_movement); /* What kind of attack movement */
		243	uint16 ACC (RW, run_away); /* Monster runs away if it's hp goes below this percentage. */
		244	float ACC (RW, expmul); /* needed experience = (calc_expexpmul) - means some /
		245	/* races/classes can need less/more exp to gain levels */
		246
		247	/* Spell related information, may be useful elsewhere
		248	* Note that other fields are used - these files are basically
		249	* only used in spells.
		250	*/
		251	sint16 ACC (RW, duration); /* How long the spell lasts */
		252	sint16 ACC (RW, casting_time);/* time left before spell goes off */
		253
		254	uint8 ACC (RW, duration_modifier); /* how level modifies duration */
		255	uint8 ACC (RW, dam_modifier); /* How going up in level effects damage */
		256	sint8 ACC (RW, range); /* Range of the spell */
		257	uint8 ACC (RW, range_modifier); /* How going up in level effects range */
		258
		259	MoveType ACC (RW, move_type); /* Type of movement this object uses */
		260	MoveType ACC (RW, move_block);/* What movement types this blocks */
		261	MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */
		262	MoveType ACC (RW, move_on); /* Move types affected moving on to this space */
		263
		264	MoveType ACC (RW, move_off); /* Move types affected moving off this space */
		265	MoveType ACC (RW, move_slow); /* Movement types this slows down */
		266
		267	sint8 ACC (RW, item_power); /* power rating of the object */
		268	// 8 free bits
		269
		270	float ACC (RW, move_slow_penalty); /* How much this slows down the object */
		271	shstr ACC (RW, spellarg); /* only used in arrows - get rid of it? */
		272
		273	/* Following are values used by any object */
		274	/* this objects turns into or what this object creates */
		275	treasurelist ACC (RW, randomitems); / Items to be generated */
		276
		277	uint16 ACC (RW, animation_id);/* An index into the animation array */
		278	uint8 ACC (RW, anim_speed); /* ticks between animation-frames */
		279	uint8 ACC (RW, last_anim); /* last sequence used to draw face */
		280
		281	uint8 ACC (RW, smoothlevel); /* how to smooth this square around */
		282	uint8 ACC (RW, will_apply); /* See crossfire.doc */
		283	uint16 ACC (RW, cached_sp); /* cached spell points used for a spell, used by esrv_update_spells */
		284
		285	uint16 ACC (RW, cached_grace);/* cached grace points used for a spell, used by esrv_update_spells */
		286	uint16 ACC (RW, cached_eat); /* cached food, used by esrv_update_spells */
		287
		288	// rarely-accessed members should be at the end
		289	shstr ACC (RW, tag); // a tag used to tracking this object
		290	shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */
		291	shstr ACC (RW, lore); /* Obscure information about this object, */
		292	/* To get put into books and the like. */
		293	shstr ACC (RW, custom_name); /* Custom name assigned by player */
		294	};
		295
		296	const char query_weight (const object op);
		297	const char query_short_name (const object op);
		298	const char query_name (const object op);
		299	const char query_base_name (const object op, int plural);
		300
		301	struct object : zero_initialised, object_copy
		302	{
102	/* These variables are not changed by copy_object() */	303	// These variables are not changed by ->copy_to
103	struct pl contr; / Pointer to the player which control this object */	304	maptile ACC (RW, map); / Pointer to the map in which this object is present */
104	struct object next; / Pointer to the next object in the free/used list */	305
105	struct object prev; / Pointer to the previous object in the free/used list*/	306	UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
106	struct object active_next; / Next & previous object in the 'active' */	307	int ACC (RO, count);
107	struct object active_prev; / List. This is used in process_events */	308	object_vector_index ACC (RO, index); // index into objects
108	/* so that the entire object list does not */	309	object_vector_index ACC (RO, active); // index into actives
109	/* need to be gone through. */	310
		311	player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set iff type == PLAYER */
		312
110	struct object below; / Pointer to the object stacked below this one */	313	object ACC (RW, below); / Pointer to the object stacked below this one */
111	struct object above; / Pointer to the object stacked above this one */	314	object ACC (RW, above); / Pointer to the object stacked above this one */
112	/* Note: stacked in the same environment*/	315	/* Note: stacked in the same environment */
113	struct object inv; / Pointer to the first object in the inventory */	316	object inv; / Pointer to the first object in the inventory */
		317
		318	//TODO: container must move into client
114	struct object container; / Current container being used. I think this	319	object_ptr ACC (RW, container); /* Current container being used. I think this
115	* is only used by the player right now.	320	* is only used by the player right now.
116	*/	321	*/
117	struct object env; / Pointer to the object which is the environment.	322	object ACC (RW, env); / Pointer to the object which is the environment.
118	* This is typically the container that the object is in.	323	* This is typically the container that the object is in.
119	*/	324	*/
120	struct object more; / Pointer to the rest of a large body of objects */	325	object ACC (RW, more); / Pointer to the rest of a large body of objects */
121	struct object head; / Points to the main object of a large body */	326	object head; / Points to the main object of a large body */ // NO ACC, perl semantics are different
122	struct mapstruct map; / Pointer to the map in which this object is present */	327	client_container *seen_by; // seen by which player/container currently?
		328	key_value key_values; / Fields not explictly known by the loader. */
123		329
124	tag_t count; /* Unique object number for this object */	330	// privates / perl
125	uint16 refcount; /* How many objects points to this object */	331	shstr_tmp kv_get (shstr_tmp key) const;
		332	void kv_del (shstr_tmp key);
		333	void kv_set (shstr_tmp key, shstr_tmp value);
		334
		335	// custom extra fields management
		336	struct key_value_access_proxy
		337	{
		338	object &ob;
		339	shstr_tmp key;
		340
		341	key_value_access_proxy (object &ob, shstr_tmp key)
		342	: ob (ob), key (key)
		343	{
		344	}
		345
		346	const key_value_access_proxy &operator =(shstr_tmp value) const
		347	{
		348	ob.kv_set (key, value);
		349	return *this;
		350	}
		351
		352	operator const shstr_tmp () const { return ob.kv_get (key); }
		353	operator const char *() const { return ob.kv_get (key); }
		354
		355	private:
		356	void operator =(int);
		357	};
		358
		359	// operator [] is too annoying to use
		360	const key_value_access_proxy kv (shstr_tmp key)
		361	{
		362	return key_value_access_proxy (*this, key);
		363	}
		364
		365	bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
		366	MTH void post_load_check (); // do some adjustments after parsing
		367	static object read (object_thawer &f, maptile map = 0); // map argument due to toal design bogosity, must go.
		368	bool write (object_freezer &f);
		369
		370	MTH int slottype () const;
		371	MTH static object *create ();
		372	const mapxy &operator =(const mapxy &pos);
		373	MTH void copy_to (object *dst);
		374	MTH object *clone (); // create + copy_to a single object
		375	MTH object *deep_clone (); // copy whole more chain and inventory
		376	void do_destroy ();
		377	void gather_callbacks (AV *&callbacks, event_type event) const;
		378	MTH void destroy ();
		379	MTH void drop_and_destroy ()
		380	{
		381	destroy_inv (true);
		382	destroy ();
		383	}
		384
		385	// recursively destroy all objects in inventory, optionally dropping them to the ground instead
		386	MTH void destroy_inv (bool drop_to_ground = false);
		387	MTH object insert (object item); // insert into inventory
		388	MTH void play_sound (faceidx sound) const;
		389	MTH void say_msg (const char *msg) const;
		390
		391	void do_remove ();
		392	MTH void remove ()
		393	{
		394	if (!flag [FLAG_REMOVED])
		395	do_remove ();
		396	}
		397
		398	MTH bool blocked (maptile *m, int x, int y) const;
		399
		400	void move_to (const mapxy &pos)
		401	{
		402	remove ();
		403	*this = pos;
		404	insert_at (this, this);
		405	}
		406
		407	// high-level move functions, return true if successful
		408	int move (int dir, object *originator);
		409
		410	int move (int dir)
		411	{
		412	return move (dir, this);
		413	}
		414
		415	static bool can_merge_slow (object op1, object op2);
		416
		417	// this is often used in time-critical code, so optimise
		418	MTH static bool can_merge (object op1, object op2)
		419	{
		420	return op1->value == op2->value
		421	&& op1->name == op2->name
		422	&& can_merge_slow (op1, op2);
		423	}
		424
		425	MTH void set_owner (object *owner);
		426	MTH void set_speed (float speed);
		427	MTH void set_glow_radius (sint8 rad);
		428	MTH bool change_weapon (object *ob);
		429	MTH bool change_skill (object *ob);
		430
		431	MTH void open_container (object *new_container);
		432	MTH void close_container ()
		433	{
		434	open_container (0);
		435	}
		436
		437	MTH object *force_find (shstr_tmp name);
		438	MTH object *force_add (shstr_tmp name, int duration = 0);
		439
		440	oblinkpt *find_link () const;
		441	MTH void add_link (maptile *map, shstr_tmp id);
		442	MTH void remove_link ();
		443
		444	// overwrite the attachable should_invoke function with a version that also checks ev_want_type
		445	bool should_invoke (event_type event)
		446	{
		447	return ev_want_event [event] \|\| ev_want_type [type] \|\| cb;
		448	}
		449
		450	MTH void instantiate ();
		451
		452	// recalculate all stats
		453	MTH void update_stats ();
		454	MTH void roll_stats ();
		455	MTH void swap_stats (int a, int b);
		456	MTH void add_statbonus ();
		457	MTH void remove_statbonus ();
		458	MTH void drain_stat ();
		459	MTH void drain_specific_stat (int deplete_stats);
		460	MTH void change_luck (int value);
		461
		462	// info must hold 256 * 3 bytes currently
		463	const char debug_desc (char info) const;
		464	MTH const char *debug_desc () const; // uses at least 3 round-robin buffers
		465	const char flag_desc (char desc, int len) const;
		466
		467	MTH bool decrease (sint32 nr = 1); // returns true if anything is left
		468	MTH object *split (sint32 nr = 1); // return 0 on failure
		469
		470	MTH int number_of () const
		471	{
		472	return nrof ? nrof : 1;
		473	}
		474
		475	MTH sint32 total_weight () const
		476	{
		477	return (weight + carrying) * number_of ();
		478	}
		479
		480	MTH void update_weight ();
		481
		482	// return the dominant material of this item, always return something
		483	const materialtype_t *dominant_material () const;
		484
		485	// return the volume of this object in cm³
		486	MTH uint64 volume () const
		487	{
		488	return (uint64)total_weight ()
		489	* 1000
		490	* (type == CONTAINER ? 1000 : 1)
		491	/ dominant_material ()->density;
		492	}
		493
		494	MTH bool is_wiz () const { return flag [FLAG_WIZ]; }
		495	MTH bool is_weapon () const { return type == ARROW \|\| type == BOW \|\| type == WEAPON; }
		496	MTH bool is_armor () const { return type == ARMOUR \|\| type == SHIELD \|\| type == HELMET
		497	\|\| type == CLOAK \|\| type == BOOTS \|\| type == GLOVES
		498	\|\| type == BRACERS \|\| type == GIRDLE; }
		499	MTH bool is_alive () const { return (type == PLAYER
		500	\|\| flag [FLAG_MONSTER]
		501	\|\| (flag [FLAG_ALIVE] && !flag [FLAG_GENERATOR] && type != DOOR))
		502	&& !flag [FLAG_IS_A_TEMPLATE]; }
		503	MTH bool is_arrow () const { return type == ARROW
		504	\|\| (type == SPELL_EFFECT
		505	&& (subtype == SP_BULLET \|\| subtype == SP_MAGIC_MISSILE)); }
		506	MTH bool is_range () const { return type == BOW \|\| type == ROD \|\| type == WAND \|\| type == HORN; }
		507
		508	MTH bool has_active_speed () const { return FABS(speed) >= MIN_ACTIVE_SPEED; }
		509
		510	// temporary: wether the object can be saved in a map file
		511	// contr => is a player
		512	// head => only save head of a multitile object
		513	// owner => can not reference owner yet
		514	MTH bool can_map_save () const { return !head && (!owner \|\| owner->contr) && !contr && !flag [FLAG_NO_MAP_SAVE]; }
		515
		516	/* This return true if object has still randomitems which
		517	* could be expanded.
		518	*/
		519	MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
		520
		521	MTH bool has_dialogue () const { return *&msg == '@'; }
		522
		523	// returns the outermost owner, never returns 0
		524	MTH object *outer_owner ()
		525	{
		526	object *op;
		527
		528	for (op = this; op->owner; op = op->owner)
		529	;
		530
		531	return op;
		532	}
		533
		534	// returns the outermost environment, never returns 0
		535	MTH object *outer_env () const
		536	{
		537	const object *op;
		538
		539	for (op = this; op->env; op = op->env)
		540	;
		541
		542	return const_cast<object *>(op);
		543	}
		544
		545	// returns the player that has this object in his inventory, or 0
		546	// we assume the player is always the outer env
		547	MTH object *in_player () const
		548	{
		549	object *op = outer_env ();
		550
		551	return op->type == PLAYER ? op : 0;
		552	}
		553
		554	// "temporary" helper function
		555	MTH object *head_ () const
		556	{
		557	return head ? head : const_cast<object *>(this);
		558	}
		559
		560	MTH bool is_head () const
		561	{
		562	return head_ () == this;
		563	}
		564
		565	MTH bool is_on_map () const
		566	{
		567	return !env && !flag [FLAG_REMOVED];
		568	}
		569
		570	MTH bool is_inserted () const
		571	{
		572	return !flag [FLAG_REMOVED];
		573	}
		574
		575	MTH bool is_player () const
		576	{
		577	return !!contr;
		578	}
		579
		580	MTH bool affects_los () const
		581	{
		582	return glow_radius \|\| flag [FLAG_BLOCKSVIEW];
		583	}
		584
		585	MTH bool has_carried_lights () const
		586	{
		587	return glow_radius;
		588	}
		589
		590	// returns the player that cna see this object, if any
		591	MTH object *visible_to () const;
		592
		593	MTH std::string long_desc (object *who = 0);
		594	MTH std::string describe_monster (object *who = 0);
		595	MTH std::string describe_item (object *who = 0);
		596	MTH std::string describe (object *who = 0);
		597
		598	MTH const char *query_weight () { return ::query_weight (this); }
		599	MTH const char *query_name () { return ::query_name (this); }
		600	MTH const char *query_short_name () { return ::query_short_name (this); }
		601	MTH const char *query_base_name (bool plural) { return ::query_base_name (this, plural); }
		602
		603	// If this object has no extra parts but should have them,
		604	// add them, effectively expanding heads into multipart
		605	// objects. This method only works on objects not inserted
		606	// anywhere.
		607	MTH void expand_tail ();
		608
		609	MTH void create_treasure (treasurelist *tl, int flags = 0);
		610
		611	// insert object at same map position as 'where'
		612	// handles both inventory and map "positions"
		613	MTH object insert_at (object where, object *originator = 0, int flags = 0);
		614	MTH void drop_unpaid_items ();
		615
		616	MTH void activate ();
		617	MTH void deactivate ();
		618	MTH void activate_recursive ();
		619	MTH void deactivate_recursive ();
		620
		621	// set the given flag on all objects in the inventory recursively
		622	MTH void set_flag_inv (int flag, int value = 1);
		623
		624	void enter_exit (object *exit);//Perl
		625	MTH void enter_map (maptile *newmap, int x, int y);
		626	void player_goto (const char *path, int x, int y); // only for players
		627
		628	// returns the mapspace this object is in
		629	mapspace &ms () const;
		630
		631	// fully recursive iterator
		632	struct iterator_base
		633	{
		634	object *item;
		635
		636	iterator_base (object *container)
		637	: item (container)
		638	{
		639	}
		640
		641	operator object *() const { return item; }
		642
		643	object *operator ->() const { return item; }
		644	object &operator * () const { return *item; }
		645	};
		646
		647	MTH unsigned int random_seed () const
		648	{
		649	return (unsigned int)uuid.seq;
		650	}
		651
		652	// depth-first recursive iterator
		653	struct depth_iterator : iterator_base
		654	{
		655	depth_iterator (object *container);
		656	void next ();
		657	object *operator ++( ) { next (); return item; }
		658	object operator ++(int) { object i = item; next (); return i; }
		659	};
		660
		661	object *begin ()
		662	{
		663	return this;
		664	}
		665
		666	object *end ()
		667	{
		668	return this;
		669	}
		670
		671	/* This returns TRUE if the object is something that
		672	* a client might want to know about.
		673	*/
		674	MTH bool client_visible () const
		675	{
		676	return !invisible && type != PLAYER;
		677	}
		678
		679	// the client does nrof * this weight
		680	MTH sint32 client_weight () const
		681	{
		682	return weight + carrying;
		683	}
		684
		685	MTH struct region *region () const;
		686
		687	void statusmsg (const char *msg, int color = NDI_BLACK);
		688	void failmsg (const char *msg, int color = NDI_RED);
		689
		690	const char query_inventory (object who = 0, const char *indent = "");
		691
		692	MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
		693	static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
		694
		695	// make some noise with given item into direction dir,
		696	// currently only used for players to make them temporarily visible
		697	// when they are invisible.
		698	MTH void make_noise ();
		699
		700	/* animation */
		701	bool has_anim () { return animation_id; }
		702	const animation &anim () const { return animations [animation_id]; }
		703	faceidx get_anim_frame (int frame) const { return anim ().faces [frame]; }
		704	void set_anim_frame (int frame) { face = get_anim_frame (frame); }
		705	/* anim_frames () returns the number of animations allocated. The last
		706	* usuable animation will be anim_frames () - 1 (for example, if an object
		707	* has 8 animations, anim_frames () will return 8, but the values will
		708	* range from 0 through 7.
		709	*/
		710	int anim_frames () const { return anim ().num_animations; }
		711	int anim_facings () const { return anim ().facings; }
		712
		713	protected:
		714	void link ();
		715	void unlink ();
		716
		717	object ();
		718	~object ();
		719
		720	private:
		721	object &operator =(const object &);
		722	object (const object &);
126	};	723	};
127		724
128	struct object_special {	725	// move this object to the top of its env's inventory to speed up
129	/* These get an extra add_refcount(), after having been copied by memcpy().	726	// searches for it.
130	* All fields beow this point are automatically copied by memcpy. If	727	static object *
131	* adding something that needs a refcount updated, make sure you modify	728	splay (object *ob)
132	* copy_object to do so. Everything below here also gets cleared	729	{
133	* by clear_object()	730	if (ob->env && ob->env->inv != ob)
134	*/	731	{
135	const char name; / The name of the object, obviously... */	732	if (ob->above) ob->above->below = ob->below;
136	const char name_pl; / The plural name of the object */	733	if (ob->below) ob->below->above = ob->above;
137	const char title; / Of foo, etc */
138	const char race; / human, goblin, dragon, etc */
139	const char slaying; / Which race to do double damage to */
140	/* If this is an exit, this is the filename */
141	const char skill; / Name of the skill this object uses/grants */
142	const char msg; / If this is a book/sign/magic mouth/etc */
143	const char lore; / Obscure information about this object, */
144	/* To get put into books and the like. */
145		734
146	sint16 x,y; /* Position in the map for this object */	735	ob->above = 0;
147	sint16 ox,oy; /* For debugging: Where it was last inserted */	736	ob->below = ob->env->inv;
148	float speed; /* The overall speed of this object */	737	ob->below->above = ob;
149	float speed_left; /* How much speed is left to spend this round */	738	ob->env->inv = ob;
150	uint32 nrof; /* How many of the objects */	739	}
151	New_Face face; / Face with colors */
152	sint8 direction; /* Means the object is moving that way. */
153	sint8 facing; /* Object is oriented/facing that way. */
154		740
155	/* This next big block are basically used for monsters and equipment */	741	return ob;
156	uint8 type; /* PLAYER, BULLET, etc. See define.h */	742	}
157	uint8 subtype; /* subtype of object */
158	uint16 client_type; /* Public type information. see doc/Developers/objects */
159	sint16 resist[NROFATTACKS]; /* Resistance adjustments for attacks */
160	uint32 attacktype; /* Bitmask of attacks this object does */
161	uint32 path_attuned; /* Paths the object is attuned to */
162	uint32 path_repelled; /* Paths the object is repelled from */
163	uint32 path_denied; /* Paths the object is denied access to */
164	uint16 material; /* What materials this object consist of */
165	const char materialname; / specific material name */
166	sint8 magic; /* Any magical bonuses to this item */
167	uint8 state; /* How the object was last drawn (animation) */
168	sint32 value; /* How much money it is worth (or contains) */
169	sint16 level; /* Level of creature or object */
170	/* Note that the last_.. values are sometimes used for non obvious
171	* meanings by some objects, eg, sp penalty, permanent exp.
172	*/
173	sint32 last_heal; /* Last healed. Depends on constitution */
174	sint32 last_sp; /* As last_heal, but for spell points */
175	sint16 last_grace; /* as last_sp, except for grace */
176	sint16 last_eat; /* How long since we last ate */
177	sint16 invisible; /* How much longer the object will be invis */
178	uint8 pick_up; /* See crossfire.doc */
179	sint8 item_power; /* power rating of the object */
180	sint8 gen_sp_armour; /* sp regen penalty this object has (was last_heal)*/
181	sint32 weight; /* Attributes of the object */
182	sint32 weight_limit; /* Weight-limit of object */
183	sint32 carrying; /* How much weight this object contains */
184	sint8 glow_radius; /* indicates the glow radius of the object */
185	living stats; /* Str, Con, Dex, etc */
186	sint64 perm_exp; /* Permanent exp */
187	const char current_weapon_script; / The script of the currently used weapon. Executed */
188	/* each time the object attacks something */
189	struct object current_weapon; / Pointer to the weapon currently used */
190	uint32 weapontype; /* type of weapon */
191	uint32 tooltype; /* type of tool or build facility */
192	sint8 body_info[NUM_BODY_LOCATIONS]; /* body info as loaded from the file */
193	sint8 body_used[NUM_BODY_LOCATIONS]; /* Calculated value based on items equipped */
194	/* See the doc/Developers/objects for more info about body locations */
195		743
196	/* Following mostly refers to fields only used for monsters */	744	object find_skill_by_name_fuzzy (object who, const char *name);
197	struct object owner; / Pointer to the object which controls this one */	745	object find_skill_by_name (object who, shstr_cmp sh);
198	/* Owner should not be referred to directly - */	746	object find_skill_by_number (object who, int skillno);
199	/* get_owner should be used instead. */
200	tag_t ownercount; /* What count the owner had (in case owner */
201	/* has been freed) */
202	struct object enemy; / Monster/player to follow even if not closest */
203	struct object attacked_by; / This object start to attack us! only player & monster */
204	tag_t attacked_by_count; /* the tag of attacker, so we can be sure */
205	struct treasureliststruct randomitems; / Items to be generated */
206	uint16 run_away; /* Monster runs away if it's hp goes below this percentage. */
207	struct object chosen_skill; / the skill chosen to use */
208	uint32 hide; /* The object is hidden, not invisible */
209	/* changes made by kholland@sunlab.cit.cornell.edu */
210	/* allows different movement patterns for attackers */
211	sint32 move_status; /* What stage in attack mode */
212	uint16 attack_movement;/* What kind of attack movement */
213	uint8 will_apply; /* See crossfire.doc */
214	struct object spellitem; / Spell ability monster is choosing to use */
215	double expmul; /* needed experience = (calc_expexpmul) - means some /
216	/* races/classes can need less/more exp to gain levels */
217
218	/* Spell related information, may be useful elsewhere
219	* Note that other fields are used - these files are basically
220	* only used in spells.
221	*/
222	sint16 duration; /* How long the spell lasts */
223	uint8 duration_modifier; /* how level modifies duration */
224	sint16 casting_time; /* time left before spell goes off */
225	struct object spell; / Spell that was being cast */
226	uint16 start_holding;
227	char *spellarg;
228	uint8 dam_modifier; /* How going up in level effects damage */
229	sint8 range; /* Range of the spell */
230	uint8 range_modifier; /* How going up in level effects range */
231
232	/* Following are values used by any object */
233	struct archt arch; / Pointer to archetype */
234	struct archt other_arch; / Pointer used for various things - mostly used for what */
235	/* this objects turns into or what this object creates */
236	uint32 flags[4]; /* various flags */
237	uint16 animation_id; /* An index into the animation array */
238	uint8 anim_speed; /* ticks between animation-frames */
239	uint8 last_anim; /* last sequence used to draw face */
240	sint32 elevation; /* elevation of this terrain - not currently used */
241	uint8 smoothlevel; /* how to smooth this square around*/
242
243	MoveType move_type; /* Type of movement this object uses */
244	MoveType move_block; /* What movement types this blocks */
245	MoveType move_allow; /* What movement types explicitly allowd */
246	MoveType move_on; /* Move types affected moving on to this space */
247	MoveType move_off; /* Move types affected moving off this space */
248	MoveType move_slow; /* Movement types this slows down */
249	float move_slow_penalty; /* How much this slows down the object */
250
251	event *events;
252
253	const char custom_name; / Custom name assigned by player */
254	key_value key_values; / Fields not explictly known by the loader. */
255	};
256
257	struct object : object_special, object_simple {
258	void self, cb; // CF+ perl's self and callback registry
259	};
260
261	typedef struct oblnk { /* Used to link together several objects */
262	object *ob;
263	struct oblnk *next;
264	tag_t id;
265	} objectlink;
266
267	typedef struct oblinkpt { /* Used to link together several object links */
268	struct oblnk *link;
269	long value; /* Used as connected value in buttons/gates */
270	struct oblinkpt *next;
271	} oblinkpt;
272		747
273	/*	748	/*
274	* The archetype structure is a set of rules on how to generate and manipulate	749	* The archetype structure is a set of rules on how to generate and manipulate
275	* objects which point to archetypes.	750	* objects which point to archetypes.
276	* This probably belongs in arch.h, but there really doesn't appear to	751	* This probably belongs in arch.h, but there really doesn't appear to
277	* be much left in the archetype - all it really is is a holder for the	752	* be much left in the archetype - all it really is is a holder for the
278	* object and pointers. This structure should get removed, and just replaced	753	* object and pointers. This structure should get removed, and just replaced
279	* by the object structure	754	* by the object structure
280	*/	755	*/
281		756
282	typedef struct archt {	757	INTERFACE_CLASS (archetype)
		758	struct archetype : object
		759	{
		760	static arch_ptr empty; // the empty_archetype
		761	MTH static void gc ();
		762
		763	archetype (const char *name);
		764	~archetype ();
		765	void gather_callbacks (AV *&callbacks, event_type event) const;
		766
		767	MTH static archetype *find (const_utf8_string name);
		768
		769	MTH void link ();
		770	MTH void unlink ();
		771
		772	MTH static object get (const char name); // (find() \|\| singularity)->instance()
		773	MTH object *instance ();
		774
		775	object_vector_index ACC (RW, archid); // index in archvector
283	const char name; / More definite name, like "generate_kobold" */	776	shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
284	struct archt next; / Next archetype in a linked list */
285	struct archt head; / The main part of a linked object */
286	struct archt more; / Next part of a linked object */
287	object clone; /* An object from which to do copy_object() */
288	uint32 editable; /* editable flags (mainly for editor) */
289	sint8 tail_x, tail_y; /* Where the lower right most portion of the object is
290	* in comparison to the head.
291	*/
292	} archetype;
293		777
		778	sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
		779	sint8 ACC (RW, max_x), ACC (RW, max_y);
		780
		781	// support for archetype loading
		782	static archetype *read (object_thawer &f);
		783	MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
		784	static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
		785	};
		786
		787	// compatbiility, remove once replaced by ->instance
		788	inline object *
		789	arch_to_object (archetype *at)
		790	{
		791	return at->instance ();
		792	}
		793
		794	inline void
		795	object_freezer::put (keyword k, archetype *v)
		796	{
		797	put (k, v ? &v->archname : (const char *)0);
		798	}
		799
		800	typedef object_vector<object, &object::index > objectvec;
		801	typedef object_vector<object, &object::active> activevec;
		802	typedef object_vector<archetype, &archetype::archid> archvec;
		803
294	extern object *objects;	804	extern objectvec objects;
295	extern object *active_objects;	805	extern activevec actives;
296	extern object *free_objects;	806	extern archvec archetypes;
297	extern object objarray[STARTMAX];
298		807
299	extern int nrofallocobjects;	808	// "safely" iterate over inv in a way such that the current item is removable
300	extern int nroffreeobjects;	809	// quite horrible, that's why its hidden in some macro
		810	#define for_inv_removable(op,var) \
		811	for (object var, next_ = (op)->inv; (var = next_), var && (next_ = var->below), var; )
301		812
302	/* This returns TRUE if the object is somethign that	813	#define for_all_objects(var) \
303	* should be displayed in the look window	814	for (unsigned _i = 0; _i < objects.size (); ++_i) \
304	*/	815	statementvar (object *, var, objects [_i])
305	#define LOOK_OBJ(ob) (!ob->invisible && ob->type!=PLAYER && ob->type!=EVENT_CONNECTOR)	816
		817	#define for_all_actives(var) \
		818	for (unsigned _i = 0; _i < actives.size (); ++_i) \
		819	statementvar (object *, var, actives [_i])
		820
		821	#define for_all_archetypes(var) \
		822	for (unsigned _i = 0; _i < archetypes.size (); ++_i) \
		823	statementvar (archetype *, var, archetypes [_i])
306		824
307	/* Used by update_object to know if the object being passed is	825	/* Used by update_object to know if the object being passed is
308	* being added or removed.	826	* being added or removed.
309	*/	827	*/
310	#define UP_OBJ_INSERT 1	828	#define UP_OBJ_INSERT 1
311	#define UP_OBJ_REMOVE 2	829	#define UP_OBJ_REMOVE 2
312	#define UP_OBJ_CHANGE 3	830	#define UP_OBJ_CHANGE 3
313	#define UP_OBJ_FACE 4 /* Only thing that changed was the face */	831	#define UP_OBJ_FACE 4 /* Only thing that changed was the face */
314		832
315	/* These are flags passed to insert_ob_in_map and	833	/* These are flags passed to insert_ob_in_map and
316	* insert_ob_in_ob. Note that all flags may not be meaningful	834	* insert_ob_in_ob. Note that all flags may not be meaningful
317	* for both functions.	835	* for both functions.
318	* Most are fairly explanatory:	836	* Most are fairly explanatory:
327	* INS_BELOW_ORIGINATOR: Insert new object immediately below originator -	845	* INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
328	* Use for treasure chests so the new object is the highest thing	846	* Use for treasure chests so the new object is the highest thing
329	* beneath the player, but not actually above it. Note - the	847	* beneath the player, but not actually above it. Note - the
330	* map and x,y coordinates for the object to be inserted must	848	* map and x,y coordinates for the object to be inserted must
331	* match the originator.	849	* match the originator.
332	* INS_MAP_LOAD: disable lots of checkings done at insertion to
333	* speed up map loading process, as we assume the ordering in
334	* loaded map is correct.
335	*	850	*
336	* Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY	851	* Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
337	* are mutually exclusive. The behaviour for passing more than one	852	* are mutually exclusive. The behaviour for passing more than one
338	* should be considered undefined - while you may notice what happens	853	* should be considered undefined - while you may notice what happens
339	* right now if you pass more than one, that could very well change	854	* right now if you pass more than one, that could very well change
340	* in future revisions of the code.	855	* in future revisions of the code.
341	*/	856	*/
342	#define INS_NO_MERGE 0x0001	857	#define INS_NO_MERGE 0x0001
343	#define INS_ABOVE_FLOOR_ONLY 0x0002	858	#define INS_ABOVE_FLOOR_ONLY 0x0002
344	#define INS_NO_WALK_ON 0x0004	859	#define INS_NO_WALK_ON 0x0004
345	#define INS_ON_TOP 0x0008	860	#define INS_ON_TOP 0x0008
346	#define INS_BELOW_ORIGINATOR 0x0010	861	#define INS_BELOW_ORIGINATOR 0x0010
347	#define INS_MAP_LOAD 0x0020
348		862
349	#define ARCH_SINGULARITY "singularity"
350	#define ARCH_SINGULARITY_LEN 11
351	#define ARCH_DETECT_MAGIC "detect_magic"
352	#define ARCH_DEPLETION "depletion"	863	#define ARCH_DEPLETION "depletion"
353	#define ARCH_SYMPTOM "symptom"
354
355	extern void (object_free_callback)(object ob); // called for every object_free
356		864
357	#endif	865	#endif
		866

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing deliantra/server/include/object.h (file contents): Revision 1.5 by root, Fri Aug 25 17:11:53 2006 UTC vs. Revision 1.201 by root, Sat Jun 27 03:51:05 2009 UTC

Diff Legend

Comparing deliantra/server/include/object.h (file contents):
Revision 1.5 by root, Fri Aug 25 17:11:53 2006 UTC vs.
Revision 1.201 by root, Sat Jun 27 03:51:05 2009 UTC