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.175 by root, Sun May 4 18:46:01 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
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 uint32 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 */
273 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */ 294 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 295 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? 296 client_container *seen_by; // seen by which player/container currently?
276 key_value *key_values; /* Fields not explictly known by the loader. */ 297 key_value *key_values; /* Fields not explictly known by the loader. */
277 298
299 // privates / perl
300 const shstr &kv_get (const shstr &key) const;
301 void kv_del (const shstr &key);
302 void kv_set (const shstr &key, const shstr &value);
303
304 // custom extra fields management
305 struct key_value_access_proxy
306 {
307 object &ob;
308 shstr key;
309
310 key_value_access_proxy (object &ob, const shstr &key)
311 : ob (ob), key (key)
312 {
313 }
314
315 const key_value_access_proxy &operator =(const shstr &value) const
316 {
317 ob.kv_set (key, value);
318 return *this;
319 }
320
321 operator const shstr &() const { return ob.kv_get (key); }
322 operator const char *() const { return ob.kv_get (key); }
323
324 private:
325 void operator =(int);
326 };
327
328 // operator [] is too annoying to use
329 const key_value_access_proxy kv (const shstr &key)
330 {
331 return key_value_access_proxy (*this, key);
332 }
333
278 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all 334 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 335 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. 336 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
281 bool write (object_freezer &f); 337 bool write (object_freezer &f);
282 338
283 MTH int slottype () const; 339 MTH int slottype () const;
284 MTH static object *create (); 340 MTH static object *create ();
285 const mapxy &operator =(const mapxy &pos); 341 const mapxy &operator =(const mapxy &pos);
286 object &operator =(const object &src);
287 MTH void copy_to (object *dst); 342 MTH void copy_to (object *dst);
288 MTH object *clone (); // create + copy_to 343 MTH object *clone (); // create + copy_to a single object
344 MTH object *deep_clone (); // copy whole more chain and inventory
289 void do_destroy (); 345 void do_destroy ();
290 void gather_callbacks (AV *&callbacks, event_type event) const; 346 void gather_callbacks (AV *&callbacks, event_type event) const;
291 MTH void destroy (bool destroy_inventory = false); 347 MTH void destroy (bool destroy_inventory = false);
292 348
293 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 349 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
294 MTH void destroy_inv (bool drop_to_ground = false); 350 MTH void destroy_inv (bool drop_to_ground = false);
295 MTH object *insert (object *item); // insert into inventory 351 MTH object *insert (object *item); // insert into inventory
296 MTH void play_sound (faceidx sound) const; 352 MTH void play_sound (faceidx sound);
297 353
298 void do_remove (); 354 void do_remove ();
299 MTH void remove () 355 MTH void remove ()
300 { 356 {
301 if (!flag [FLAG_REMOVED]) 357 if (!flag [FLAG_REMOVED])
356 // info must hold 256 * 3 bytes currently 412 // info must hold 256 * 3 bytes currently
357 const char *debug_desc (char *info) const; 413 const char *debug_desc (char *info) const;
358 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers 414 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers
359 const char *flag_desc (char *desc, int len) const; 415 const char *flag_desc (char *desc, int len) const;
360 416
417 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
418 MTH object *split (sint32 nr = 1); // return 0 on failure
419
361 int number_of () const 420 MTH int number_of () const
362 { 421 {
363 return nrof ? nrof : 1; 422 return nrof ? nrof : 1;
364 } 423 }
365 424
366 uint64 total_weight () const 425 MTH sint32 total_weight () const
367 { 426 {
368 return weight * number_of (); 427 return (weight + carrying) * number_of ();
369 } 428 }
429
430 MTH void update_weight ();
370 431
371 // return the dominant material of this item, always return something 432 // return the dominant material of this item, always return something
372 const materialtype_t *dominant_material () const; 433 const materialtype_t *dominant_material () const;
373 434
374 // return the volume of this object in cm³ 435 // return the volume of this object in cm³
375 uint64 volume () const 436 MTH uint64 volume () const
376 { 437 {
377 return total_weight () 438 return total_weight ()
378 * 1000 439 * 1000
379 * (type == CONTAINER ? 1000 : 1) 440 * (type == CONTAINER ? 1000 : 1)
380 / dominant_material ()->density; 441 / dominant_material ()->density;
404 /* This return true if object has still randomitems which 465 /* This return true if object has still randomitems which
405 * could be expanded. 466 * could be expanded.
406 */ 467 */
407 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } 468 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
408 469
470 // returns the outermost owner, never returns 0
471 MTH object *outer_owner ()
472 {
473 for (object *op = this; ; op = op->owner)
474 if (!op->owner)
475 return op;
476 }
477
478 // returns the outermost environment, never returns 0
479 MTH object *outer_env ()
480 {
481 for (object *op = this; ; op = op->env)
482 if (!op->env)
483 return op;
484 }
485
409 // returns the player that has this object in his inventory, or 0 486 // returns the player that has this object in his inventory, or 0
487 // we assume the player is always the outer env
410 MTH object *in_player () const 488 MTH object *in_player ()
411 { 489 {
412 for (object *op = env; op; op = op->env) 490 object *op = outer_env ();
413 if (op->type == PLAYER)
414 return op;
415 491
416 return 0; 492 return op->type == PLAYER ? op : 0;
417 } 493 }
418 494
419 // "temporary" helper function 495 // "temporary" helper function
420 MTH object *head_ () 496 MTH object *head_ ()
421 { 497 {
424 500
425 MTH bool is_head () 501 MTH bool is_head ()
426 { 502 {
427 return head_ () == this; 503 return head_ () == this;
428 } 504 }
505
506 MTH bool is_on_map () const
507 {
508 return !env && !flag [FLAG_REMOVED];
509 }
510
511 // returns the player that cna see this object, if any
512 MTH object *visible_to () const;
429 513
430 MTH std::string long_desc (object *who = 0); 514 MTH std::string long_desc (object *who = 0);
431 MTH std::string describe_monster (object *who = 0); 515 MTH std::string describe_monster (object *who = 0);
432 MTH std::string describe_item (object *who = 0); 516 MTH std::string describe_item (object *who = 0);
433 MTH std::string describe (object *who = 0); 517 MTH std::string describe (object *who = 0);
448 MTH void activate (); 532 MTH void activate ();
449 MTH void deactivate (); 533 MTH void deactivate ();
450 MTH void activate_recursive (); 534 MTH void activate_recursive ();
451 MTH void deactivate_recursive (); 535 MTH void deactivate_recursive ();
452 536
453 // set the givne flag on all objects in the inventory recursively 537 // set the given flag on all objects in the inventory recursively
454 MTH void set_flag_inv (int flag, int value = 1); 538 MTH void set_flag_inv (int flag, int value = 1);
455 539
456 void enter_exit (object *exit);//Perl 540 void enter_exit (object *exit);//Perl
457 MTH void enter_map (maptile *newmap, int x, int y); 541 MTH void enter_map (maptile *newmap, int x, int y);
542 void player_goto (const char *path, int x, int y); // only for players
458 543
459 // returns the mapspace this object is in 544 // returns the mapspace this object is in
460 mapspace &ms () const; 545 mapspace &ms () const;
461 546
462 // fully recursive iterator 547 // fully recursive iterator
498 { 583 {
499 return this; 584 return this;
500 } 585 }
501 586
502 /* This returns TRUE if the object is something that 587 /* This returns TRUE if the object is something that
503 * should be displayed in the floorbox/inventory window 588 * a client might want to know about.
504 */ 589 */
505 MTH bool client_visible () const 590 MTH bool client_visible () const
506 { 591 {
507 return !invisible && type != PLAYER; 592 return !invisible && type != PLAYER;
593 }
594
595 // the client does nrof * this weight
596 MTH sint32 client_weight () const
597 {
598 return weight + carrying;
508 } 599 }
509 600
510 MTH struct region *region () const; 601 MTH struct region *region () const;
511 602
512 void statusmsg (const char *msg, int color = NDI_BLACK); 603 void statusmsg (const char *msg, int color = NDI_BLACK);
521 void link (); 612 void link ();
522 void unlink (); 613 void unlink ();
523 614
524 object (); 615 object ();
525 ~object (); 616 ~object ();
617
618private:
619 object &operator =(const object &);
620 object (const object &);
526}; 621};
527 622
528// move this object to the top of its env's inventory to speed up 623// move this object to the top of its env's inventory to speed up
529// searches for it. 624// searches for it.
530static object * 625static object *
551} objectlink; 646} objectlink;
552 647
553typedef struct oblinkpt 648typedef struct oblinkpt
554{ /* Used to link together several object links */ 649{ /* Used to link together several object links */
555 struct oblnk *link; 650 struct oblnk *link;
556 long value; /* Used as connected value in buttons/gates */ 651 sint32 value; /* Used as connected value in buttons/gates */
557 struct oblinkpt *next; 652 struct oblinkpt *next;
558} oblinkpt; 653} oblinkpt;
559 654
560object *find_skill_by_name (object *who, const char *name); 655object *find_skill_by_name (object *who, const char *name);
561object *find_skill_by_name (object *who, const shstr &sh); 656object *find_skill_by_name (object *who, const shstr &sh);
571 */ 666 */
572 667
573INTERFACE_CLASS (archetype) 668INTERFACE_CLASS (archetype)
574struct archetype : object 669struct archetype : object
575{ 670{
671 static arch_ptr empty; // the empty_archetype
672 MTH static void gc ();
673
576 archetype (const char *name); 674 archetype (const char *name);
577 ~archetype (); 675 ~archetype ();
578 void gather_callbacks (AV *&callbacks, event_type event) const; 676 void gather_callbacks (AV *&callbacks, event_type event) const;
579 677
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); 678 MTH static archetype *find (const_utf8_string name);
584 679
585 MTH void link (); 680 MTH void link ();
586 MTH void unlink (); 681 MTH void unlink ();
587 682
683 MTH static object *get (const char *name); // (find() || singularity)->instance()
588 MTH object *instance (); 684 MTH object *instance ();
589 685
590 object_vector_index ACC (RW, archid); // index in archvector 686 object_vector_index ACC (RW, archid); // index in archvector
591 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 687 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
592 bool ACC (RW, stub); // if true, this is an invalid archetype
593 688
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...) */ 689 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); 690 sint8 ACC (RW, max_x), ACC (RW, max_y);
691
692 // support for archetype loading
693 static archetype *read (object_thawer &f);
694 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
695 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
596}; 696};
597 697
598inline void 698inline void
599object_freezer::put (keyword k, archetype *v) 699object_freezer::put (keyword k, archetype *v)
600{ 700{

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines