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.155 by root, Thu Apr 10 15:35:16 2008 UTC vs.
Revision 1.184 by root, Mon Sep 29 10:31:32 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
96 96
97 UUID () { } 97 UUID () { }
98 UUID (uint64 seq) : seq(seq) { } 98 UUID (uint64 seq) : seq(seq) { }
99 operator uint64() { return seq; } 99 operator uint64() { return seq; }
100 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 }
101}; 122};
102 123
103/* Definition for WILL_APPLY values. Replaces having harcoded values 124/* Definition for WILL_APPLY values. Replaces having harcoded values
104 * 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
105 * 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
154 arch_ptr ACC (RW, arch); /* Pointer to archetype */ 175 arch_ptr ACC (RW, arch); /* Pointer to archetype */
155 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 */
156 177
157 float ACC (RW, speed); /* The overall speed of this object */ 178 float ACC (RW, speed); /* The overall speed of this object */
158 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 */
159 uint32 ACC (RW, nrof); /* How many of the objects */ 180 sint32 ACC (RW, nrof); /* How many of the objects */
160 181
161 /* This next big block are basically used for monsters and equipment */ 182 /* This next big block is basically used for monsters and equipment */
162 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 */
163 184
164 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */ 185 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */
165 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */ 186 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
166 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */ 187 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */
183 sint8 ACC (RW, item_power); /* power rating of the object */ 204 sint8 ACC (RW, item_power); /* power rating of the object */
184 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) */
185 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 */
186 sint32 ACC (RW, weight); /* Attributes of the object */ 207 sint32 ACC (RW, weight); /* Attributes of the object */
187 sint32 ACC (RW, weight_limit);/* Weight-limit of object */ 208 sint32 ACC (RW, weight_limit);/* Weight-limit of object */
188 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 */
189 sint64 ACC (RW, perm_exp); /* Permanent exp */ 210 sint64 ACC (RW, perm_exp); /* Permanent exp */
190 uint32 ACC (RW, weapontype); /* type of weapon */ 211 uint32 ACC (RW, weapontype); /* type of weapon */
191 uint32 ACC (RW, tooltype); /* type of tool or build facility */ 212 uint32 ACC (RW, tooltype); /* type of tool or build facility */
192 body_slot slot [NUM_BODY_LOCATIONS]; 213 body_slot slot [NUM_BODY_LOCATIONS];
193 faceidx ACC (RW, face); /* the graphical face */ 214 faceidx ACC (RW, face); /* the graphical face */
239 bool ACC (RW, flag[NUM_FLAGS]); 260 bool ACC (RW, flag[NUM_FLAGS]);
240#endif 261#endif
241 uint16 ACC (RW, animation_id);/* An index into the animation array */ 262 uint16 ACC (RW, animation_id);/* An index into the animation array */
242 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */ 263 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */
243 uint8 ACC (RW, last_anim); /* last sequence used to draw face */ 264 uint8 ACC (RW, last_anim); /* last sequence used to draw face */
244 sint16 ACC (RW, elevation); /* elevation of this terrain - not currently used */
245 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */ 265 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */
246 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 */
247}; 270};
248 271
249struct object : zero_initialised, object_copy 272struct object : zero_initialised, object_copy
250{ 273{
251 // These variables are not changed by ->copy_to 274 // These variables are not changed by ->copy_to
252 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 */
253 276
254 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 277 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
255 int ACC (RO, count); 278 int ACC (RO, count);
256 object_vector_index ACC (RO, index); // index into objects 279 object_vector_index ACC (RO, index); // index into objects
257 object_vector_index ACC (RO, active); // index into actives 280 object_vector_index ACC (RO, active); // index into actives
273 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 */
274 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
275 client_container *seen_by; // seen by which player/container currently? 298 client_container *seen_by; // seen by which player/container currently?
276 key_value *key_values; /* Fields not explictly known by the loader. */ 299 key_value *key_values; /* Fields not explictly known by the loader. */
277 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
278 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
279 MTH void post_load_check (); // do some adjustments after parsing 337 MTH void post_load_check (); // do some adjustments after parsing
280 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.
281 bool write (object_freezer &f); 339 bool write (object_freezer &f);
282 340
283 MTH int slottype () const; 341 MTH int slottype () const;
284 MTH static object *create (); 342 MTH static object *create ();
285 const mapxy &operator =(const mapxy &pos); 343 const mapxy &operator =(const mapxy &pos);
286 object &operator =(const object &src);
287 MTH void copy_to (object *dst); 344 MTH void copy_to (object *dst);
288 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
289 void do_destroy (); 347 void do_destroy ();
290 void gather_callbacks (AV *&callbacks, event_type event) const; 348 void gather_callbacks (AV *&callbacks, event_type event) const;
291 MTH void destroy (bool destroy_inventory = false); 349 MTH void destroy (bool destroy_inventory = false);
350 MTH void drop_and_destroy ()
351 {
352 destroy_inv (true);
353 destroy ();
354 }
292 355
293 // 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
294 MTH void destroy_inv (bool drop_to_ground = false); 357 MTH void destroy_inv (bool drop_to_ground = false);
295 MTH object *insert (object *item); // insert into inventory 358 MTH object *insert (object *item); // insert into inventory
296 MTH void play_sound (faceidx sound) const; 359 MTH void play_sound (faceidx sound);
297 360
298 void do_remove (); 361 void do_remove ();
299 MTH void remove () 362 MTH void remove ()
300 { 363 {
301 if (!flag [FLAG_REMOVED]) 364 if (!flag [FLAG_REMOVED])
356 // info must hold 256 * 3 bytes currently 419 // info must hold 256 * 3 bytes currently
357 const char *debug_desc (char *info) const; 420 const char *debug_desc (char *info) const;
358 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
359 const char *flag_desc (char *desc, int len) const; 422 const char *flag_desc (char *desc, int len) const;
360 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
361 int number_of () const 427 MTH int number_of () const
362 { 428 {
363 return nrof ? nrof : 1; 429 return nrof ? nrof : 1;
364 } 430 }
365 431
366 uint64 total_weight () const 432 MTH sint32 total_weight () const
367 { 433 {
368 return weight * number_of (); 434 return (weight + carrying) * number_of ();
369 } 435 }
436
437 MTH void update_weight ();
370 438
371 // return the dominant material of this item, always return something 439 // return the dominant material of this item, always return something
372 const materialtype_t *dominant_material () const; 440 const materialtype_t *dominant_material () const;
373 441
374 // return the volume of this object in cm³ 442 // return the volume of this object in cm³
375 uint64 volume () const 443 MTH uint64 volume () const
376 { 444 {
377 return total_weight () 445 return total_weight ()
378 * 1000 446 * 1000
379 * (type == CONTAINER ? 1000 : 1) 447 * (type == CONTAINER ? 1000 : 1)
380 / dominant_material ()->density; 448 / dominant_material ()->density;
381 } 449 }
382 450
451 MTH bool is_wiz () const { return flag [FLAG_WIZ]; }
383 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; }
384 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
385 || type == CLOAK || type == BOOTS || type == GLOVES 454 || type == CLOAK || type == BOOTS || type == GLOVES
386 || type == BRACERS || type == GIRDLE; } 455 || type == BRACERS || type == GIRDLE; }
387 MTH bool is_alive () const { return (type == PLAYER 456 MTH bool is_alive () const { return (type == PLAYER
404 /* This return true if object has still randomitems which 473 /* This return true if object has still randomitems which
405 * could be expanded. 474 * could be expanded.
406 */ 475 */
407 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]; }
408 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
409 // 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
410 MTH object *in_player () const 504 MTH object *in_player ()
411 { 505 {
412 for (object *op = env; op; op = op->env) 506 object *op = outer_env ();
413 if (op->type == PLAYER)
414 return op;
415 507
416 return 0; 508 return op->type == PLAYER ? op : 0;
417 } 509 }
418 510
419 // "temporary" helper function 511 // "temporary" helper function
420 MTH object *head_ () 512 MTH object *head_ ()
421 { 513 {
424 516
425 MTH bool is_head () 517 MTH bool is_head ()
426 { 518 {
427 return head_ () == this; 519 return head_ () == this;
428 } 520 }
521
522 MTH bool is_on_map () const
523 {
524 return !env && !flag [FLAG_REMOVED];
525 }
526
527 // returns the player that cna see this object, if any
528 MTH object *visible_to () const;
429 529
430 MTH std::string long_desc (object *who = 0); 530 MTH std::string long_desc (object *who = 0);
431 MTH std::string describe_monster (object *who = 0); 531 MTH std::string describe_monster (object *who = 0);
432 MTH std::string describe_item (object *who = 0); 532 MTH std::string describe_item (object *who = 0);
433 MTH std::string describe (object *who = 0); 533 MTH std::string describe (object *who = 0);
448 MTH void activate (); 548 MTH void activate ();
449 MTH void deactivate (); 549 MTH void deactivate ();
450 MTH void activate_recursive (); 550 MTH void activate_recursive ();
451 MTH void deactivate_recursive (); 551 MTH void deactivate_recursive ();
452 552
453 // set the givne flag on all objects in the inventory recursively 553 // set the given flag on all objects in the inventory recursively
454 MTH void set_flag_inv (int flag, int value = 1); 554 MTH void set_flag_inv (int flag, int value = 1);
455 555
456 void enter_exit (object *exit);//Perl 556 void enter_exit (object *exit);//Perl
457 MTH void enter_map (maptile *newmap, int x, int y); 557 MTH void enter_map (maptile *newmap, int x, int y);
558 void player_goto (const char *path, int x, int y); // only for players
458 559
459 // returns the mapspace this object is in 560 // returns the mapspace this object is in
460 mapspace &ms () const; 561 mapspace &ms () const;
461 562
462 // fully recursive iterator 563 // fully recursive iterator
498 { 599 {
499 return this; 600 return this;
500 } 601 }
501 602
502 /* This returns TRUE if the object is something that 603 /* This returns TRUE if the object is something that
503 * should be displayed in the floorbox/inventory window 604 * a client might want to know about.
504 */ 605 */
505 MTH bool client_visible () const 606 MTH bool client_visible () const
506 { 607 {
507 return !invisible && type != PLAYER; 608 return !invisible && type != PLAYER;
609 }
610
611 // the client does nrof * this weight
612 MTH sint32 client_weight () const
613 {
614 return weight + carrying;
508 } 615 }
509 616
510 MTH struct region *region () const; 617 MTH struct region *region () const;
511 618
512 void statusmsg (const char *msg, int color = NDI_BLACK); 619 void statusmsg (const char *msg, int color = NDI_BLACK);
521 void link (); 628 void link ();
522 void unlink (); 629 void unlink ();
523 630
524 object (); 631 object ();
525 ~object (); 632 ~object ();
633
634private:
635 object &operator =(const object &);
636 object (const object &);
526}; 637};
527 638
528// move this object to the top of its env's inventory to speed up 639// move this object to the top of its env's inventory to speed up
529// searches for it. 640// searches for it.
530static object * 641static object *
551} objectlink; 662} objectlink;
552 663
553typedef struct oblinkpt 664typedef struct oblinkpt
554{ /* Used to link together several object links */ 665{ /* Used to link together several object links */
555 struct oblnk *link; 666 struct oblnk *link;
556 long value; /* Used as connected value in buttons/gates */ 667 sint32 value; /* Used as connected value in buttons/gates */
557 struct oblinkpt *next; 668 struct oblinkpt *next;
558} oblinkpt; 669} oblinkpt;
559 670
560object *find_skill_by_name (object *who, const char *name); 671object *find_skill_by_name (object *who, const char *name);
561object *find_skill_by_name (object *who, const shstr &sh); 672object *find_skill_by_name (object *who, const shstr &sh);
571 */ 682 */
572 683
573INTERFACE_CLASS (archetype) 684INTERFACE_CLASS (archetype)
574struct archetype : object 685struct archetype : object
575{ 686{
687 static arch_ptr empty; // the empty_archetype
688 MTH static void gc ();
689
576 archetype (const char *name); 690 archetype (const char *name);
577 ~archetype (); 691 ~archetype ();
578 void gather_callbacks (AV *&callbacks, event_type event) const; 692 void gather_callbacks (AV *&callbacks, event_type event) const;
579 693
580 static archetype *read (object_thawer &f);
581
582 MTH static archetype *get (const_utf8_string name); // find or create
583 MTH static archetype *find (const_utf8_string name); 694 MTH static archetype *find (const_utf8_string name);
584 695
585 MTH void link (); 696 MTH void link ();
586 MTH void unlink (); 697 MTH void unlink ();
587 698
699 MTH static object *get (const char *name); // (find() || singularity)->instance()
588 MTH object *instance (); 700 MTH object *instance ();
589 701
590 object_vector_index ACC (RW, archid); // index in archvector 702 object_vector_index ACC (RW, archid); // index in archvector
591 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 703 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
592 bool ACC (RW, stub); // if true, this is an invalid archetype
593 704
594 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ 705 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
595 sint8 ACC (RW, max_x), ACC (RW, max_y); 706 sint8 ACC (RW, max_x), ACC (RW, max_y);
707
708 // support for archetype loading
709 static archetype *read (object_thawer &f);
710 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
711 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
596}; 712};
713
714// compatbiility, remove once replaced by ->instance
715inline object *
716arch_to_object (archetype *at)
717{
718 return at->instance ();
719}
597 720
598inline void 721inline void
599object_freezer::put (keyword k, archetype *v) 722object_freezer::put (keyword k, archetype *v)
600{ 723{
601 put (k, v ? &v->archname : (const char *)0); 724 put (k, v ? &v->archname : (const char *)0);
607 730
608extern objectvec objects; 731extern objectvec objects;
609extern activevec actives; 732extern activevec actives;
610extern archvec archetypes; 733extern archvec archetypes;
611 734
735// "safely" iterate over inv in a way such that the current item is removable
736// quite horrible, thats why its hidden in some macro
737#define for_inv_removable(op,var) \
738 for (object *var, *next_ = (op)->inv; (var = next_), var && (next_ = var->below), var; )
739
612#define for_all_objects(var) \ 740#define for_all_objects(var) \
613 for (unsigned _i = 0; _i < objects.size (); ++_i) \ 741 for (unsigned _i = 0; _i < objects.size (); ++_i) \
614 statementvar (object *, var, objects [_i]) 742 statementvar (object *, var, objects [_i])
615 743
616#define for_all_actives(var) \ 744#define for_all_actives(var) \
617 for (unsigned _i = 0; _i < actives.size (); ++_i) \ 745 for (unsigned _i = 0; _i < actives.size (); ++_i) \
618 statementvar (object *, var, actives [_i]) 746 statementvar (object *, var, actives [_i])
619 747
620#define for_all_archetypes(var) \ 748#define for_all_archetypes(var) \
621 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \ 749 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \
622 statementvar (archetype *, var, archetypes [_i]) 750 statementvar (archetype *, var, archetypes [_i])
623 751
624/* Used by update_object to know if the object being passed is 752/* Used by update_object to know if the object being passed is
625 * being added or removed. 753 * being added or removed.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines