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

Comparing deliantra/server/include/object.h (file contents):
Revision 1.79 by root, Wed Jan 3 20:08:04 2007 UTC vs.
Revision 1.197 by root, Thu Jan 8 19:23:44 2009 UTC

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

Diff Legend

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

Comparing deliantra/server/include/object.h (file contents): Revision 1.79 by root, Wed Jan 3 20:08:04 2007 UTC vs. Revision 1.197 by root, Thu Jan 8 19:23:44 2009 UTC

Diff Legend

Comparing deliantra/server/include/object.h (file contents):
Revision 1.79 by root, Wed Jan 3 20:08:04 2007 UTC vs.
Revision 1.197 by root, Thu Jan 8 19:23:44 2009 UTC