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

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

Diff Legend

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

Comparing deliantra/server/include/object.h (file contents): Revision 1.124 by root, Fri May 18 12:13:02 2007 UTC vs. Revision 1.212 by root, Mon Oct 12 14:00:58 2009 UTC

Diff Legend

Comparing deliantra/server/include/object.h (file contents):
Revision 1.124 by root, Fri May 18 12:13:02 2007 UTC vs.
Revision 1.212 by root, Mon Oct 12 14:00:58 2009 UTC