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

Comparing deliantra/server/include/object.h (file contents):
Revision 1.11 by root, Tue Aug 29 05:03:55 2006 UTC vs.
Revision 1.213 by root, Mon Oct 19 21:48:49 2009 UTC

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

Diff Legend

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

Comparing deliantra/server/include/object.h (file contents): Revision 1.11 by root, Tue Aug 29 05:03:55 2006 UTC vs. Revision 1.213 by root, Mon Oct 19 21:48:49 2009 UTC

Diff Legend

Comparing deliantra/server/include/object.h (file contents):
Revision 1.11 by root, Tue Aug 29 05:03:55 2006 UTC vs.
Revision 1.213 by root, Mon Oct 19 21:48:49 2009 UTC