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

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

Diff Legend

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

Comparing deliantra/server/include/object.h (file contents): Revision 1.87 by root, Sun Jan 14 22:06:05 2007 UTC vs. Revision 1.199 by elmex, Mon Jan 12 00:17:23 2009 UTC

Diff Legend

Comparing deliantra/server/include/object.h (file contents):
Revision 1.87 by root, Sun Jan 14 22:06:05 2007 UTC vs.
Revision 1.199 by elmex, Mon Jan 12 00:17:23 2009 UTC