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.144 by root, Thu Aug 16 11:34:29 2007 UTC vs.
Revision 1.171 by root, Sat May 3 09:04:17 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.
85 88
86struct UUID 89struct UUID
87{ 90{
88 uint64 seq; 91 uint64 seq;
89 92
93 static UUID cur; // last uuid generated
94 static void init ();
95 static UUID gen ();
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?
131 shstr ACC (RW, name_pl); /* The plural name of the object */ 155 shstr ACC (RW, name_pl); /* The plural name of the object */
132 shstr ACC (RW, title); /* Of foo, etc */ 156 shstr ACC (RW, title); /* Of foo, etc */
133 shstr ACC (RW, race); /* human, goblin, dragon, etc */ 157 shstr ACC (RW, race); /* human, goblin, dragon, etc */
134 shstr ACC (RW, slaying); /* Which race to do double damage to */ 158 shstr ACC (RW, slaying); /* Which race to do double damage to */
135 /* 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
136 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 */
137 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 */
138 shstr ACC (RW, lore); /* Obscure information about this object, */ 163 shstr ACC (RW, lore); /* Obscure information about this object, */
139 /* To get put into books and the like. */ 164 /* To get put into books and the like. */
140 shstr ACC (RW, materialname); /* specific material name */ 165 shstr ACC (RW, materialname); /* specific material name */
152 177
153 float ACC (RW, speed); /* The overall speed of this object */ 178 float ACC (RW, speed); /* The overall speed of this object */
154 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 */
155 uint32 ACC (RW, nrof); /* How many of the objects */ 180 uint32 ACC (RW, nrof); /* How many of the objects */
156 181
157 /* This next big block are basically used for monsters and equipment */ 182 /* This next big block is basically used for monsters and equipment */
158 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 */
159 184
160 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */ 185 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */
161 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */ 186 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
162 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */ 187 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */
179 sint8 ACC (RW, item_power); /* power rating of the object */ 204 sint8 ACC (RW, item_power); /* power rating of the object */
180 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) */
181 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 */
182 sint32 ACC (RW, weight); /* Attributes of the object */ 207 sint32 ACC (RW, weight); /* Attributes of the object */
183 sint32 ACC (RW, weight_limit);/* Weight-limit of object */ 208 sint32 ACC (RW, weight_limit);/* Weight-limit of object */
184 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 */
185 sint64 ACC (RW, perm_exp); /* Permanent exp */ 210 sint64 ACC (RW, perm_exp); /* Permanent exp */
186 uint32 ACC (RW, weapontype); /* type of weapon */ 211 uint32 ACC (RW, weapontype); /* type of weapon */
187 uint32 ACC (RW, tooltype); /* type of tool or build facility */ 212 uint32 ACC (RW, tooltype); /* type of tool or build facility */
188 body_slot slot [NUM_BODY_LOCATIONS]; 213 body_slot slot [NUM_BODY_LOCATIONS];
189 faceidx ACC (RW, face); /* the graphical face */ 214 faceidx ACC (RW, face); /* the graphical face */
270 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
271 client_container *seen_by; // seen by which player/container currently? 296 client_container *seen_by; // seen by which player/container currently?
272 key_value *key_values; /* Fields not explictly known by the loader. */ 297 key_value *key_values; /* Fields not explictly known by the loader. */
273 298
274 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all 299 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
275 void post_load_check (); // do some adjustments after parsing 300 MTH void post_load_check (); // do some adjustments after parsing
276 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go. 301 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
277 bool write (object_freezer &f); 302 bool write (object_freezer &f);
278 303
279 MTH int slottype () const; 304 MTH int slottype () const;
280 MTH static object *create (); 305 MTH static object *create ();
281 object &operator =(const object &src); 306 const mapxy &operator =(const mapxy &pos);
282 MTH void copy_to (object *dst); 307 MTH void copy_to (object *dst);
283 MTH object *clone (); // create + copy_to 308 MTH object *clone (); // create + copy_to
284 void do_destroy (); 309 void do_destroy ();
285 void gather_callbacks (AV *&callbacks, event_type event) const; 310 void gather_callbacks (AV *&callbacks, event_type event) const;
286 MTH void destroy (bool destroy_inventory = false); 311 MTH void destroy (bool destroy_inventory = false);
287 312
288 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 313 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
289 MTH void destroy_inv (bool drop_to_ground = false); 314 MTH void destroy_inv (bool drop_to_ground = false);
290 MTH object *insert (object *item); // insert into inventory 315 MTH object *insert (object *item); // insert into inventory
291 MTH void play_sound (faceidx sound) const; 316 MTH void play_sound (faceidx sound);
292 317
293 void do_remove (); 318 void do_remove ();
294 MTH void remove () 319 MTH void remove ()
295 { 320 {
296 if (!flag [FLAG_REMOVED]) 321 if (!flag [FLAG_REMOVED])
297 do_remove (); 322 do_remove ();
323 }
324
325 MTH bool blocked (maptile *m, int x, int y) const;
326
327 void move_to (const mapxy &pos)
328 {
329 remove ();
330 *this = pos;
331 insert_at (this, this);
298 } 332 }
299 333
300 static bool can_merge_slow (object *op1, object *op2); 334 static bool can_merge_slow (object *op1, object *op2);
301 335
302 // this is often used in time-critical code, so optimise 336 // this is often used in time-critical code, so optimise
342 // info must hold 256 * 3 bytes currently 376 // info must hold 256 * 3 bytes currently
343 const char *debug_desc (char *info) const; 377 const char *debug_desc (char *info) const;
344 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers 378 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers
345 const char *flag_desc (char *desc, int len) const; 379 const char *flag_desc (char *desc, int len) const;
346 380
381 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
382 MTH object *split (sint32 nr = 1); // return 0 on failure
383
347 int number_of () const 384 MTH int number_of () const
348 { 385 {
349 return nrof ? nrof : 1; 386 return nrof ? nrof : 1;
350 } 387 }
351 388
352 uint64 total_weight () const 389 MTH sint32 total_weight () const
353 { 390 {
354 return weight * number_of (); 391 return (weight + carrying) * number_of ();
355 } 392 }
393
394 MTH void update_weight ();
356 395
357 // return the dominant material of this item, always return something 396 // return the dominant material of this item, always return something
358 const materialtype_t *dominant_material () const; 397 const materialtype_t *dominant_material () const;
359 398
360 // return the volume of this object in cm³ 399 // return the volume of this object in cm³
361 uint64 volume () const 400 MTH uint64 volume () const
362 { 401 {
363 return total_weight () 402 return total_weight ()
364 * 1000 403 * 1000
365 * (type == CONTAINER ? 1000 : 1) 404 * (type == CONTAINER ? 1000 : 1)
366 / dominant_material ()->density; 405 / dominant_material ()->density;
383 422
384 // temporary: wether the object can be saved in a map file 423 // temporary: wether the object can be saved in a map file
385 // contr => is a player 424 // contr => is a player
386 // head => only save head of a multitile object 425 // head => only save head of a multitile object
387 // owner => can not reference owner yet 426 // owner => can not reference owner yet
388 MTH bool can_map_save () const { return !contr && !head && !owner && !flag [FLAG_NO_MAP_SAVE]; } 427 MTH bool can_map_save () const { return !head && (!owner || owner->contr) && !contr && !flag [FLAG_NO_MAP_SAVE]; }
389 428
390 /* This return true if object has still randomitems which 429 /* This return true if object has still randomitems which
391 * could be expanded. 430 * could be expanded.
392 */ 431 */
393 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } 432 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
394 433
434 // returns the outermost owner, never returns 0
435 MTH object *outer_owner ()
436 {
437 for (object *op = this; ; op = op->owner)
438 if (!op->owner)
439 return op;
440 }
441
442 // returns the outermost environment, never returns 0
443 MTH object *outer_env ()
444 {
445 for (object *op = this; ; op = op->env)
446 if (!op->env)
447 return op;
448 }
449
395 // returns the player that has this object in his inventory, or 0 450 // returns the player that has this object in his inventory, or 0
451 // we assume the player is always the outer env
396 MTH object *in_player () const 452 MTH object *in_player ()
397 { 453 {
398 for (object *op = env; op; op = op->env) 454 object *op = outer_env ();
399 if (op->type == PLAYER)
400 return op;
401 455
402 return 0; 456 return op->type == PLAYER ? op : 0;
403 } 457 }
404 458
405 // "temporary" helper function 459 // "temporary" helper function
406 MTH object *head_ () 460 MTH object *head_ ()
407 { 461 {
410 464
411 MTH bool is_head () 465 MTH bool is_head ()
412 { 466 {
413 return head_ () == this; 467 return head_ () == this;
414 } 468 }
469
470 MTH bool is_on_map () const
471 {
472 return !env && !flag [FLAG_REMOVED];
473 }
474
475 // returns the player that cna see this object, if any
476 MTH object *visible_to () const;
415 477
416 MTH std::string long_desc (object *who = 0); 478 MTH std::string long_desc (object *who = 0);
417 MTH std::string describe_monster (object *who = 0); 479 MTH std::string describe_monster (object *who = 0);
418 MTH std::string describe_item (object *who = 0); 480 MTH std::string describe_item (object *who = 0);
419 MTH std::string describe (object *who = 0); 481 MTH std::string describe (object *who = 0);
434 MTH void activate (); 496 MTH void activate ();
435 MTH void deactivate (); 497 MTH void deactivate ();
436 MTH void activate_recursive (); 498 MTH void activate_recursive ();
437 MTH void deactivate_recursive (); 499 MTH void deactivate_recursive ();
438 500
439 // set the givne flag on all objects in the inventory recursively 501 // set the given flag on all objects in the inventory recursively
440 MTH void set_flag_inv (int flag, int value = 1); 502 MTH void set_flag_inv (int flag, int value = 1);
441 503
442 void enter_exit (object *exit);//Perl 504 void enter_exit (object *exit);//Perl
443 MTH void enter_map (maptile *newmap, int x, int y); 505 MTH void enter_map (maptile *newmap, int x, int y);
444 506
484 { 546 {
485 return this; 547 return this;
486 } 548 }
487 549
488 /* This returns TRUE if the object is something that 550 /* This returns TRUE if the object is something that
489 * should be displayed in the floorbox/inventory window 551 * a client might want to know about.
490 */ 552 */
491 MTH bool client_visible () const 553 MTH bool client_visible () const
492 { 554 {
493 return !invisible && type != PLAYER; 555 return !invisible && type != PLAYER;
494 } 556 }
495 557
558 // the client does nrof * this weight
559 MTH sint32 client_weight () const
560 {
561 return weight + carrying;
562 }
563
496 MTH struct region *region () const; 564 MTH struct region *region () const;
497 565
498 void statusmsg (const char *msg, int color = NDI_BLACK); 566 void statusmsg (const char *msg, int color = NDI_BLACK);
499 void failmsg (const char *msg, int color = NDI_RED); 567 void failmsg (const char *msg, int color = NDI_RED);
568
569 const char *query_inventory (object *who = 0, const char *indent = "");
570
571 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
572 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
500 573
501protected: 574protected:
502 void link (); 575 void link ();
503 void unlink (); 576 void unlink ();
504 577
505 object (); 578 object ();
506 ~object (); 579 ~object ();
580
581private:
582 object &operator =(const object &);
583 object (const object &);
507}; 584};
508 585
509// move this object to the top of its env's inventory to speed up 586// move this object to the top of its env's inventory to speed up
510// searches for it. 587// searches for it.
511static object * 588static object *
532} objectlink; 609} objectlink;
533 610
534typedef struct oblinkpt 611typedef struct oblinkpt
535{ /* Used to link together several object links */ 612{ /* Used to link together several object links */
536 struct oblnk *link; 613 struct oblnk *link;
537 long value; /* Used as connected value in buttons/gates */ 614 sint32 value; /* Used as connected value in buttons/gates */
538 struct oblinkpt *next; 615 struct oblinkpt *next;
539} oblinkpt; 616} oblinkpt;
540 617
541object *find_skill_by_name (object *who, const char *name); 618object *find_skill_by_name (object *who, const char *name);
542object *find_skill_by_name (object *who, const shstr &sh); 619object *find_skill_by_name (object *who, const shstr &sh);
552 */ 629 */
553 630
554INTERFACE_CLASS (archetype) 631INTERFACE_CLASS (archetype)
555struct archetype : object 632struct archetype : object
556{ 633{
634 static arch_ptr empty; // the empty_archetype
635 MTH static void gc ();
636
557 archetype (const char *name); 637 archetype (const char *name);
558 ~archetype (); 638 ~archetype ();
559 void gather_callbacks (AV *&callbacks, event_type event) const; 639 void gather_callbacks (AV *&callbacks, event_type event) const;
560 640
561 static archetype *read (object_thawer &f);
562 static archetype *get (const char *name); // find or create
563 static archetype *find (const char *name); 641 MTH static archetype *find (const_utf8_string name);
564 642
565 void link (); 643 MTH void link ();
566 void unlink (); 644 MTH void unlink ();
645
646 MTH static object *get (const char *name); // find()->instance()
647 MTH object *instance ();
567 648
568 object_vector_index ACC (RW, archid); // index in archvector 649 object_vector_index ACC (RW, archid); // index in archvector
569 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 650 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
570 bool ACC (RW, stub); // if true, this is an invalid archetype
571 uint32 ACC (RW, editable); /* editable flags (mainly for editor) */
572 651
573 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ 652 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
574 sint8 ACC (RW, max_x), ACC (RW, max_y); 653 sint8 ACC (RW, max_x), ACC (RW, max_y);
654
655 // support for archetype loading
656 static archetype *read (object_thawer &f);
657 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
658 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
575}; 659};
576 660
577inline void 661inline void
578object_freezer::put (keyword k, archetype *v) 662object_freezer::put (keyword k, archetype *v)
579{ 663{
623 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - 707 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
624 * Use for treasure chests so the new object is the highest thing 708 * Use for treasure chests so the new object is the highest thing
625 * beneath the player, but not actually above it. Note - the 709 * beneath the player, but not actually above it. Note - the
626 * map and x,y coordinates for the object to be inserted must 710 * map and x,y coordinates for the object to be inserted must
627 * match the originator. 711 * match the originator.
628 * INS_MAP_LOAD: disable lots of checkings done at insertion to
629 * speed up map loading process, as we assume the ordering in
630 * loaded map is correct.
631 * 712 *
632 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY 713 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
633 * are mutually exclusive. The behaviour for passing more than one 714 * are mutually exclusive. The behaviour for passing more than one
634 * should be considered undefined - while you may notice what happens 715 * should be considered undefined - while you may notice what happens
635 * right now if you pass more than one, that could very well change 716 * right now if you pass more than one, that could very well change
638#define INS_NO_MERGE 0x0001 719#define INS_NO_MERGE 0x0001
639#define INS_ABOVE_FLOOR_ONLY 0x0002 720#define INS_ABOVE_FLOOR_ONLY 0x0002
640#define INS_NO_WALK_ON 0x0004 721#define INS_NO_WALK_ON 0x0004
641#define INS_ON_TOP 0x0008 722#define INS_ON_TOP 0x0008
642#define INS_BELOW_ORIGINATOR 0x0010 723#define INS_BELOW_ORIGINATOR 0x0010
643#define INS_MAP_LOAD 0x0020
644 724
645#define ARCH_DEPLETION "depletion" 725#define ARCH_DEPLETION "depletion"
646 726
647#endif 727#endif
648 728

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines