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.150 by root, Wed Sep 12 11:10:10 2007 UTC vs.
Revision 1.172 by root, Sat May 3 11:14:50 2008 UTC

1/* 1/*
2 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG. 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT 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 * Crossfire TRT 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 3 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,
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, see <http://www.gnu.org/licenses/>. 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * 20 *
21 * The authors can be reached via e-mail to <crossfire@schmorp.de> 21 * The authors can be reached via e-mail to <support@deliantra.net>
22 */ 22 */
23 23
24#ifndef OBJECT_H 24#ifndef OBJECT_H
25#define OBJECT_H 25#define OBJECT_H
26 26
65 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 */
66} Body_Locations; 66} Body_Locations;
67 67
68extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; 68extern Body_Locations body_locations[NUM_BODY_LOCATIONS];
69 69
70#define NUM_COINS 4 /* number of coin types */
71extern const char *const coins[NUM_COINS + 1];
72
70/* 73/*
71 * 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
72 * "dangling" from it; this could also end up containing 'parse errors'. 75 * "dangling" from it; this could also end up containing 'parse errors'.
73 * 76 *
74 * key and value are shared-strings. 77 * key and value are shared-strings.
75 * 78 *
76 * 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
77 * accessing the list directly. 80 * accessing the list directly.
78 * 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.
79 */ 82 */
80struct key_value 83struct key_value : slice_allocated
81{ 84{
82 key_value *next; 85 key_value *next;
83 shstr key, value; 86 shstr key, value;
84}; 87};
85 88
86struct UUID 89struct UUID
87{ 90{
88 uint64 seq; 91 uint64 seq;
92
93 static UUID cur; // last uuid generated
94 static void init ();
95 static UUID gen ();
89 96
90 UUID () { } 97 UUID () { }
91 UUID (uint64 seq) : seq(seq) { } 98 UUID (uint64 seq) : seq(seq) { }
92 operator uint64() { return seq; } 99 operator uint64() { return seq; }
93 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 }
94}; 122};
95
96extern void init_uuid ();
97extern UUID gen_uuid ();
98extern const uint64 UUID_SKIP;
99 123
100/* Definition for WILL_APPLY values. Replaces having harcoded values 124/* Definition for WILL_APPLY values. Replaces having harcoded values
101 * 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
102 * 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
103 * can_apply and will_apply? 127 * can_apply and will_apply?
153 177
154 float ACC (RW, speed); /* The overall speed of this object */ 178 float ACC (RW, speed); /* The overall speed of this object */
155 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 */
156 uint32 ACC (RW, nrof); /* How many of the objects */ 180 uint32 ACC (RW, nrof); /* How many of the objects */
157 181
158 /* This next big block are basically used for monsters and equipment */ 182 /* This next big block is basically used for monsters and equipment */
159 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 */
160 184
161 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */ 185 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */
162 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */ 186 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
163 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */ 187 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */
180 sint8 ACC (RW, item_power); /* power rating of the object */ 204 sint8 ACC (RW, item_power); /* power rating of the object */
181 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) */
182 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 */
183 sint32 ACC (RW, weight); /* Attributes of the object */ 207 sint32 ACC (RW, weight); /* Attributes of the object */
184 sint32 ACC (RW, weight_limit);/* Weight-limit of object */ 208 sint32 ACC (RW, weight_limit);/* Weight-limit of object */
185 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 */
186 sint64 ACC (RW, perm_exp); /* Permanent exp */ 210 sint64 ACC (RW, perm_exp); /* Permanent exp */
187 uint32 ACC (RW, weapontype); /* type of weapon */ 211 uint32 ACC (RW, weapontype); /* type of weapon */
188 uint32 ACC (RW, tooltype); /* type of tool or build facility */ 212 uint32 ACC (RW, tooltype); /* type of tool or build facility */
189 body_slot slot [NUM_BODY_LOCATIONS]; 213 body_slot slot [NUM_BODY_LOCATIONS];
190 faceidx ACC (RW, face); /* the graphical face */ 214 faceidx ACC (RW, face); /* the graphical face */
270 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 */
271 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
272 client_container *seen_by; // seen by which player/container currently? 296 client_container *seen_by; // seen by which player/container currently?
273 key_value *key_values; /* Fields not explictly known by the loader. */ 297 key_value *key_values; /* Fields not explictly known by the loader. */
274 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
275 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
276 MTH void post_load_check (); // do some adjustments after parsing 335 MTH void post_load_check (); // do some adjustments after parsing
277 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.
278 bool write (object_freezer &f); 337 bool write (object_freezer &f);
279 338
280 MTH int slottype () const; 339 MTH int slottype () const;
281 MTH static object *create (); 340 MTH static object *create ();
282 const mapxy &operator =(const mapxy &pos); 341 const mapxy &operator =(const mapxy &pos);
283 object &operator =(const object &src);
284 MTH void copy_to (object *dst); 342 MTH void copy_to (object *dst);
285 MTH object *clone (); // create + copy_to 343 MTH object *clone (); // create + copy_to
286 void do_destroy (); 344 void do_destroy ();
287 void gather_callbacks (AV *&callbacks, event_type event) const; 345 void gather_callbacks (AV *&callbacks, event_type event) const;
288 MTH void destroy (bool destroy_inventory = false); 346 MTH void destroy (bool destroy_inventory = false);
289 347
290 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 348 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
291 MTH void destroy_inv (bool drop_to_ground = false); 349 MTH void destroy_inv (bool drop_to_ground = false);
292 MTH object *insert (object *item); // insert into inventory 350 MTH object *insert (object *item); // insert into inventory
293 MTH void play_sound (faceidx sound) const; 351 MTH void play_sound (faceidx sound);
294 352
295 void do_remove (); 353 void do_remove ();
296 MTH void remove () 354 MTH void remove ()
297 { 355 {
298 if (!flag [FLAG_REMOVED]) 356 if (!flag [FLAG_REMOVED])
353 // info must hold 256 * 3 bytes currently 411 // info must hold 256 * 3 bytes currently
354 const char *debug_desc (char *info) const; 412 const char *debug_desc (char *info) const;
355 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers 413 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers
356 const char *flag_desc (char *desc, int len) const; 414 const char *flag_desc (char *desc, int len) const;
357 415
416 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
417 MTH object *split (sint32 nr = 1); // return 0 on failure
418
358 int number_of () const 419 MTH int number_of () const
359 { 420 {
360 return nrof ? nrof : 1; 421 return nrof ? nrof : 1;
361 } 422 }
362 423
363 uint64 total_weight () const 424 MTH sint32 total_weight () const
364 { 425 {
365 return weight * number_of (); 426 return (weight + carrying) * number_of ();
366 } 427 }
428
429 MTH void update_weight ();
367 430
368 // return the dominant material of this item, always return something 431 // return the dominant material of this item, always return something
369 const materialtype_t *dominant_material () const; 432 const materialtype_t *dominant_material () const;
370 433
371 // return the volume of this object in cm³ 434 // return the volume of this object in cm³
372 uint64 volume () const 435 MTH uint64 volume () const
373 { 436 {
374 return total_weight () 437 return total_weight ()
375 * 1000 438 * 1000
376 * (type == CONTAINER ? 1000 : 1) 439 * (type == CONTAINER ? 1000 : 1)
377 / dominant_material ()->density; 440 / dominant_material ()->density;
401 /* This return true if object has still randomitems which 464 /* This return true if object has still randomitems which
402 * could be expanded. 465 * could be expanded.
403 */ 466 */
404 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } 467 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
405 468
469 // returns the outermost owner, never returns 0
470 MTH object *outer_owner ()
471 {
472 for (object *op = this; ; op = op->owner)
473 if (!op->owner)
474 return op;
475 }
476
477 // returns the outermost environment, never returns 0
478 MTH object *outer_env ()
479 {
480 for (object *op = this; ; op = op->env)
481 if (!op->env)
482 return op;
483 }
484
406 // returns the player that has this object in his inventory, or 0 485 // returns the player that has this object in his inventory, or 0
486 // we assume the player is always the outer env
407 MTH object *in_player () const 487 MTH object *in_player ()
408 { 488 {
409 for (object *op = env; op; op = op->env) 489 object *op = outer_env ();
410 if (op->type == PLAYER)
411 return op;
412 490
413 return 0; 491 return op->type == PLAYER ? op : 0;
414 } 492 }
415 493
416 // "temporary" helper function 494 // "temporary" helper function
417 MTH object *head_ () 495 MTH object *head_ ()
418 { 496 {
421 499
422 MTH bool is_head () 500 MTH bool is_head ()
423 { 501 {
424 return head_ () == this; 502 return head_ () == this;
425 } 503 }
504
505 MTH bool is_on_map () const
506 {
507 return !env && !flag [FLAG_REMOVED];
508 }
509
510 // returns the player that cna see this object, if any
511 MTH object *visible_to () const;
426 512
427 MTH std::string long_desc (object *who = 0); 513 MTH std::string long_desc (object *who = 0);
428 MTH std::string describe_monster (object *who = 0); 514 MTH std::string describe_monster (object *who = 0);
429 MTH std::string describe_item (object *who = 0); 515 MTH std::string describe_item (object *who = 0);
430 MTH std::string describe (object *who = 0); 516 MTH std::string describe (object *who = 0);
445 MTH void activate (); 531 MTH void activate ();
446 MTH void deactivate (); 532 MTH void deactivate ();
447 MTH void activate_recursive (); 533 MTH void activate_recursive ();
448 MTH void deactivate_recursive (); 534 MTH void deactivate_recursive ();
449 535
450 // set the givne flag on all objects in the inventory recursively 536 // set the given flag on all objects in the inventory recursively
451 MTH void set_flag_inv (int flag, int value = 1); 537 MTH void set_flag_inv (int flag, int value = 1);
452 538
453 void enter_exit (object *exit);//Perl 539 void enter_exit (object *exit);//Perl
454 MTH void enter_map (maptile *newmap, int x, int y); 540 MTH void enter_map (maptile *newmap, int x, int y);
455 541
495 { 581 {
496 return this; 582 return this;
497 } 583 }
498 584
499 /* This returns TRUE if the object is something that 585 /* This returns TRUE if the object is something that
500 * should be displayed in the floorbox/inventory window 586 * a client might want to know about.
501 */ 587 */
502 MTH bool client_visible () const 588 MTH bool client_visible () const
503 { 589 {
504 return !invisible && type != PLAYER; 590 return !invisible && type != PLAYER;
505 } 591 }
506 592
593 // the client does nrof * this weight
594 MTH sint32 client_weight () const
595 {
596 return weight + carrying;
597 }
598
507 MTH struct region *region () const; 599 MTH struct region *region () const;
508 600
509 void statusmsg (const char *msg, int color = NDI_BLACK); 601 void statusmsg (const char *msg, int color = NDI_BLACK);
510 void failmsg (const char *msg, int color = NDI_RED); 602 void failmsg (const char *msg, int color = NDI_RED);
603
604 const char *query_inventory (object *who = 0, const char *indent = "");
511 605
512 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference 606 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
513 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible 607 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
514 608
515protected: 609protected:
516 void link (); 610 void link ();
517 void unlink (); 611 void unlink ();
518 612
519 object (); 613 object ();
520 ~object (); 614 ~object ();
615
616private:
617 object &operator =(const object &);
618 object (const object &);
521}; 619};
522 620
523// move this object to the top of its env's inventory to speed up 621// move this object to the top of its env's inventory to speed up
524// searches for it. 622// searches for it.
525static object * 623static object *
546} objectlink; 644} objectlink;
547 645
548typedef struct oblinkpt 646typedef struct oblinkpt
549{ /* Used to link together several object links */ 647{ /* Used to link together several object links */
550 struct oblnk *link; 648 struct oblnk *link;
551 long value; /* Used as connected value in buttons/gates */ 649 sint32 value; /* Used as connected value in buttons/gates */
552 struct oblinkpt *next; 650 struct oblinkpt *next;
553} oblinkpt; 651} oblinkpt;
554 652
555object *find_skill_by_name (object *who, const char *name); 653object *find_skill_by_name (object *who, const char *name);
556object *find_skill_by_name (object *who, const shstr &sh); 654object *find_skill_by_name (object *who, const shstr &sh);
566 */ 664 */
567 665
568INTERFACE_CLASS (archetype) 666INTERFACE_CLASS (archetype)
569struct archetype : object 667struct archetype : object
570{ 668{
669 static arch_ptr empty; // the empty_archetype
670 MTH static void gc ();
671
571 archetype (const char *name); 672 archetype (const char *name);
572 ~archetype (); 673 ~archetype ();
573 void gather_callbacks (AV *&callbacks, event_type event) const; 674 void gather_callbacks (AV *&callbacks, event_type event) const;
574 675
575 static archetype *read (object_thawer &f);
576
577 MTH static archetype *get (const_utf8_string name); // find or create
578 MTH static archetype *find (const_utf8_string name); 676 MTH static archetype *find (const_utf8_string name);
579 677
580 MTH void link (); 678 MTH void link ();
581 MTH void unlink (); 679 MTH void unlink ();
582 680
681 MTH static object *get (const char *name); // find()->instance()
682 MTH object *instance ();
683
583 object_vector_index ACC (RW, archid); // index in archvector 684 object_vector_index ACC (RW, archid); // index in archvector
584 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 685 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
585 bool ACC (RW, stub); // if true, this is an invalid archetype
586 686
587 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ 687 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
588 sint8 ACC (RW, max_x), ACC (RW, max_y); 688 sint8 ACC (RW, max_x), ACC (RW, max_y);
689
690 // support for archetype loading
691 static archetype *read (object_thawer &f);
692 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
693 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
589}; 694};
590 695
591inline void 696inline void
592object_freezer::put (keyword k, archetype *v) 697object_freezer::put (keyword k, archetype *v)
593{ 698{
637 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - 742 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
638 * Use for treasure chests so the new object is the highest thing 743 * Use for treasure chests so the new object is the highest thing
639 * beneath the player, but not actually above it. Note - the 744 * beneath the player, but not actually above it. Note - the
640 * map and x,y coordinates for the object to be inserted must 745 * map and x,y coordinates for the object to be inserted must
641 * match the originator. 746 * match the originator.
642 * INS_MAP_LOAD: disable lots of checkings done at insertion to
643 * speed up map loading process, as we assume the ordering in
644 * loaded map is correct.
645 * 747 *
646 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY 748 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
647 * are mutually exclusive. The behaviour for passing more than one 749 * are mutually exclusive. The behaviour for passing more than one
648 * should be considered undefined - while you may notice what happens 750 * should be considered undefined - while you may notice what happens
649 * right now if you pass more than one, that could very well change 751 * right now if you pass more than one, that could very well change
652#define INS_NO_MERGE 0x0001 754#define INS_NO_MERGE 0x0001
653#define INS_ABOVE_FLOOR_ONLY 0x0002 755#define INS_ABOVE_FLOOR_ONLY 0x0002
654#define INS_NO_WALK_ON 0x0004 756#define INS_NO_WALK_ON 0x0004
655#define INS_ON_TOP 0x0008 757#define INS_ON_TOP 0x0008
656#define INS_BELOW_ORIGINATOR 0x0010 758#define INS_BELOW_ORIGINATOR 0x0010
657#define INS_MAP_LOAD 0x0020
658 759
659#define ARCH_DEPLETION "depletion" 760#define ARCH_DEPLETION "depletion"
660 761
661#endif 762#endif
662 763

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines