ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/object.h
(Generate patch)

Comparing deliantra/server/include/object.h (file contents):
Revision 1.120 by root, Sat May 12 16:06:42 2007 UTC vs.
Revision 1.186 by elmex, Mon Oct 6 18:26:35 2008 UTC

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

Diff Legend

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