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.161 by root, Sun Apr 20 05:24:55 2008 UTC vs.
Revision 1.186 by elmex, Mon Oct 6 18:26:35 2008 UTC

1/* 1/*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG. 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Deliantra team 4 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (©) 2001,2007 Mark Wedel & Crossfire Development Team 5 * Copyright (©) 2001,2007 Mark Wedel & Crossfire Development Team
6 * Copyright (©) 1992,2007 Frank Tore Johansen 6 * Copyright (©) 1992,2007 Frank Tore Johansen
7 * 7 *
8 * Deliantra 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
74 * 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
75 * "dangling" from it; this could also end up containing 'parse errors'. 75 * "dangling" from it; this could also end up containing 'parse errors'.
76 * 76 *
77 * key and value are shared-strings. 77 * key and value are shared-strings.
78 * 78 *
79 * 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
80 * accessing the list directly. 80 * accessing the list directly.
81 * 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.
82 */ 82 */
83struct key_value 83struct key_value : slice_allocated
84{ 84{
85 key_value *next; 85 key_value *next;
86 shstr key, value; 86 shstr key, value;
87}; 87};
88 88
175 arch_ptr ACC (RW, arch); /* Pointer to archetype */ 175 arch_ptr ACC (RW, arch); /* Pointer to archetype */
176 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 */
177 177
178 float ACC (RW, speed); /* The overall speed of this object */ 178 float ACC (RW, speed); /* The overall speed of this object */
179 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 */
180 uint32 ACC (RW, nrof); /* How many of the objects */ 180 sint32 ACC (RW, nrof); /* How many of the objects */
181 181
182 /* This next big block are basically used for monsters and equipment */ 182 /* This next big block is basically used for monsters and equipment */
183 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 */
184 184
185 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */ 185 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */
186 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */ 186 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
187 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */ 187 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */
204 sint8 ACC (RW, item_power); /* power rating of the object */ 204 sint8 ACC (RW, item_power); /* power rating of the object */
205 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) */
206 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 */
207 sint32 ACC (RW, weight); /* Attributes of the object */ 207 sint32 ACC (RW, weight); /* Attributes of the object */
208 sint32 ACC (RW, weight_limit);/* Weight-limit of object */ 208 sint32 ACC (RW, weight_limit);/* Weight-limit of object */
209 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 */
210 sint64 ACC (RW, perm_exp); /* Permanent exp */ 210 sint64 ACC (RW, perm_exp); /* Permanent exp */
211 uint32 ACC (RW, weapontype); /* type of weapon */ 211 uint32 ACC (RW, weapontype); /* type of weapon */
212 uint32 ACC (RW, tooltype); /* type of tool or build facility */ 212 uint32 ACC (RW, tooltype); /* type of tool or build facility */
213 body_slot slot [NUM_BODY_LOCATIONS]; 213 body_slot slot [NUM_BODY_LOCATIONS];
214 faceidx ACC (RW, face); /* the graphical face */ 214 faceidx ACC (RW, face); /* the graphical face */
260 bool ACC (RW, flag[NUM_FLAGS]); 260 bool ACC (RW, flag[NUM_FLAGS]);
261#endif 261#endif
262 uint16 ACC (RW, animation_id);/* An index into the animation array */ 262 uint16 ACC (RW, animation_id);/* An index into the animation array */
263 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */ 263 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */
264 uint8 ACC (RW, last_anim); /* last sequence used to draw face */ 264 uint8 ACC (RW, last_anim); /* last sequence used to draw face */
265 sint16 ACC (RW, elevation); /* elevation of this terrain - not currently used */
266 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */ 265 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */
267 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 */
268}; 270};
269 271
270struct object : zero_initialised, object_copy 272struct object : zero_initialised, object_copy
271{ 273{
272 // These variables are not changed by ->copy_to 274 // These variables are not changed by ->copy_to
273 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 */
274 276
275 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 277 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
276 int ACC (RO, count); 278 int ACC (RO, count);
277 object_vector_index ACC (RO, index); // index into objects 279 object_vector_index ACC (RO, index); // index into objects
278 object_vector_index ACC (RO, active); // index into actives 280 object_vector_index ACC (RO, active); // index into actives
294 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 */
295 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
296 client_container *seen_by; // seen by which player/container currently? 298 client_container *seen_by; // seen by which player/container currently?
297 key_value *key_values; /* Fields not explictly known by the loader. */ 299 key_value *key_values; /* Fields not explictly known by the loader. */
298 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
299 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
300 MTH void post_load_check (); // do some adjustments after parsing 337 MTH void post_load_check (); // do some adjustments after parsing
301 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.
302 bool write (object_freezer &f); 339 bool write (object_freezer &f);
303 340
304 MTH int slottype () const; 341 MTH int slottype () const;
305 MTH static object *create (); 342 MTH static object *create ();
306 const mapxy &operator =(const mapxy &pos); 343 const mapxy &operator =(const mapxy &pos);
307 object &operator =(const object &src);
308 MTH void copy_to (object *dst); 344 MTH void copy_to (object *dst);
309 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
310 void do_destroy (); 347 void do_destroy ();
311 void gather_callbacks (AV *&callbacks, event_type event) const; 348 void gather_callbacks (AV *&callbacks, event_type event) const;
312 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 }
313 355
314 // 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
315 MTH void destroy_inv (bool drop_to_ground = false); 357 MTH void destroy_inv (bool drop_to_ground = false);
316 MTH object *insert (object *item); // insert into inventory 358 MTH object *insert (object *item); // insert into inventory
317 MTH void play_sound (faceidx sound) const; 359 MTH void play_sound (faceidx sound);
318 360
319 void do_remove (); 361 void do_remove ();
320 MTH void remove () 362 MTH void remove ()
321 { 363 {
322 if (!flag [FLAG_REMOVED]) 364 if (!flag [FLAG_REMOVED])
377 // info must hold 256 * 3 bytes currently 419 // info must hold 256 * 3 bytes currently
378 const char *debug_desc (char *info) const; 420 const char *debug_desc (char *info) const;
379 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
380 const char *flag_desc (char *desc, int len) const; 422 const char *flag_desc (char *desc, int len) const;
381 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
382 int number_of () const 427 MTH int number_of () const
383 { 428 {
384 return nrof ? nrof : 1; 429 return nrof ? nrof : 1;
385 } 430 }
386 431
387 uint64 total_weight () const 432 MTH sint32 total_weight () const
388 { 433 {
389 return weight * number_of (); 434 return (weight + carrying) * number_of ();
390 } 435 }
436
437 MTH void update_weight ();
391 438
392 // return the dominant material of this item, always return something 439 // return the dominant material of this item, always return something
393 const materialtype_t *dominant_material () const; 440 const materialtype_t *dominant_material () const;
394 441
395 // return the volume of this object in cm³ 442 // return the volume of this object in cm³
396 uint64 volume () const 443 MTH uint64 volume () const
397 { 444 {
398 return total_weight () 445 return total_weight ()
399 * 1000 446 * 1000
400 * (type == CONTAINER ? 1000 : 1) 447 * (type == CONTAINER ? 1000 : 1)
401 / dominant_material ()->density; 448 / dominant_material ()->density;
402 } 449 }
403 450
451 MTH bool is_wiz () const { return flag [FLAG_WIZ]; }
404 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; }
405 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
406 || type == CLOAK || type == BOOTS || type == GLOVES 454 || type == CLOAK || type == BOOTS || type == GLOVES
407 || type == BRACERS || type == GIRDLE; } 455 || type == BRACERS || type == GIRDLE; }
408 MTH bool is_alive () const { return (type == PLAYER 456 MTH bool is_alive () const { return (type == PLAYER
425 /* This return true if object has still randomitems which 473 /* This return true if object has still randomitems which
426 * could be expanded. 474 * could be expanded.
427 */ 475 */
428 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]; }
429 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
430 // 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
431 MTH object *in_player () const 504 MTH object *in_player ()
432 { 505 {
433 for (object *op = env; op; op = op->env) 506 object *op = outer_env ();
434 if (op->type == PLAYER)
435 return op;
436 507
437 return 0; 508 return op->type == PLAYER ? op : 0;
438 } 509 }
439 510
440 // "temporary" helper function 511 // "temporary" helper function
441 MTH object *head_ () 512 MTH object *head_ ()
442 { 513 {
445 516
446 MTH bool is_head () 517 MTH bool is_head ()
447 { 518 {
448 return head_ () == this; 519 return head_ () == this;
449 } 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;
450 534
451 MTH std::string long_desc (object *who = 0); 535 MTH std::string long_desc (object *who = 0);
452 MTH std::string describe_monster (object *who = 0); 536 MTH std::string describe_monster (object *who = 0);
453 MTH std::string describe_item (object *who = 0); 537 MTH std::string describe_item (object *who = 0);
454 MTH std::string describe (object *who = 0); 538 MTH std::string describe (object *who = 0);
474 // set the given flag on all objects in the inventory recursively 558 // set the given flag on all objects in the inventory recursively
475 MTH void set_flag_inv (int flag, int value = 1); 559 MTH void set_flag_inv (int flag, int value = 1);
476 560
477 void enter_exit (object *exit);//Perl 561 void enter_exit (object *exit);//Perl
478 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
479 564
480 // returns the mapspace this object is in 565 // returns the mapspace this object is in
481 mapspace &ms () const; 566 mapspace &ms () const;
482 567
483 // fully recursive iterator 568 // fully recursive iterator
519 { 604 {
520 return this; 605 return this;
521 } 606 }
522 607
523 /* This returns TRUE if the object is something that 608 /* This returns TRUE if the object is something that
524 * should be displayed in the floorbox/inventory window 609 * a client might want to know about.
525 */ 610 */
526 MTH bool client_visible () const 611 MTH bool client_visible () const
527 { 612 {
528 return !invisible && type != PLAYER; 613 return !invisible && type != PLAYER;
614 }
615
616 // the client does nrof * this weight
617 MTH sint32 client_weight () const
618 {
619 return weight + carrying;
529 } 620 }
530 621
531 MTH struct region *region () const; 622 MTH struct region *region () const;
532 623
533 void statusmsg (const char *msg, int color = NDI_BLACK); 624 void statusmsg (const char *msg, int color = NDI_BLACK);
542 void link (); 633 void link ();
543 void unlink (); 634 void unlink ();
544 635
545 object (); 636 object ();
546 ~object (); 637 ~object ();
638
639private:
640 object &operator =(const object &);
641 object (const object &);
547}; 642};
548 643
549// move this object to the top of its env's inventory to speed up 644// move this object to the top of its env's inventory to speed up
550// searches for it. 645// searches for it.
551static object * 646static object *
604 MTH static archetype *find (const_utf8_string name); 699 MTH static archetype *find (const_utf8_string name);
605 700
606 MTH void link (); 701 MTH void link ();
607 MTH void unlink (); 702 MTH void unlink ();
608 703
704 MTH static object *get (const char *name); // (find() || singularity)->instance()
609 MTH object *instance (); 705 MTH object *instance ();
610 706
611 object_vector_index ACC (RW, archid); // index in archvector 707 object_vector_index ACC (RW, archid); // index in archvector
612 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 708 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
613 709
618 static archetype *read (object_thawer &f); 714 static archetype *read (object_thawer &f);
619 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more 715 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
620 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */ 716 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
621}; 717};
622 718
719// compatbiility, remove once replaced by ->instance
720inline object *
721arch_to_object (archetype *at)
722{
723 return at->instance ();
724}
725
623inline void 726inline void
624object_freezer::put (keyword k, archetype *v) 727object_freezer::put (keyword k, archetype *v)
625{ 728{
626 put (k, v ? &v->archname : (const char *)0); 729 put (k, v ? &v->archname : (const char *)0);
627} 730}
632 735
633extern objectvec objects; 736extern objectvec objects;
634extern activevec actives; 737extern activevec actives;
635extern archvec archetypes; 738extern archvec archetypes;
636 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
637#define for_all_objects(var) \ 745#define for_all_objects(var) \
638 for (unsigned _i = 0; _i < objects.size (); ++_i) \ 746 for (unsigned _i = 0; _i < objects.size (); ++_i) \
639 statementvar (object *, var, objects [_i]) 747 statementvar (object *, var, objects [_i])
640 748
641#define for_all_actives(var) \ 749#define for_all_actives(var) \
642 for (unsigned _i = 0; _i < actives.size (); ++_i) \ 750 for (unsigned _i = 0; _i < actives.size (); ++_i) \
643 statementvar (object *, var, actives [_i]) 751 statementvar (object *, var, actives [_i])
644 752
645#define for_all_archetypes(var) \ 753#define for_all_archetypes(var) \
646 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \ 754 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \
647 statementvar (archetype *, var, archetypes [_i]) 755 statementvar (archetype *, var, archetypes [_i])
648 756
649/* 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
650 * being added or removed. 758 * being added or removed.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines