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

Comparing deliantra/server/include/object.h (file contents):
Revision 1.90 by root, Sat Jan 20 22:09:52 2007 UTC vs.
Revision 1.188 by root, Sun Nov 16 03:52:12 2008 UTC

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

Diff Legend

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

Comparing deliantra/server/include/object.h (file contents): Revision 1.90 by root, Sat Jan 20 22:09:52 2007 UTC vs. Revision 1.188 by root, Sun Nov 16 03:52:12 2008 UTC

Diff Legend

Comparing deliantra/server/include/object.h (file contents):
Revision 1.90 by root, Sat Jan 20 22:09:52 2007 UTC vs.
Revision 1.188 by root, Sun Nov 16 03:52:12 2008 UTC