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.146 by root, Mon Aug 27 06:29:17 2007 UTC vs.
Revision 1.164 by root, Mon Apr 21 06:16:02 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 */
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 ();
287 MTH void destroy (bool destroy_inventory = false); 312 MTH void destroy (bool destroy_inventory = false);
288 313
289 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 314 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
290 MTH void destroy_inv (bool drop_to_ground = false); 315 MTH void destroy_inv (bool drop_to_ground = false);
291 MTH object *insert (object *item); // insert into inventory 316 MTH object *insert (object *item); // insert into inventory
292 MTH void play_sound (faceidx sound) const; 317 MTH void play_sound (faceidx sound);
293 318
294 void do_remove (); 319 void do_remove ();
295 MTH void remove () 320 MTH void remove ()
296 { 321 {
297 if (!flag [FLAG_REMOVED]) 322 if (!flag [FLAG_REMOVED])
298 do_remove (); 323 do_remove ();
299 } 324 }
325
326 MTH bool blocked (maptile *m, int x, int y) const;
300 327
301 void move_to (const mapxy &pos) 328 void move_to (const mapxy &pos)
302 { 329 {
303 remove (); 330 remove ();
304 *this = pos; 331 *this = pos;
350 // info must hold 256 * 3 bytes currently 377 // info must hold 256 * 3 bytes currently
351 const char *debug_desc (char *info) const; 378 const char *debug_desc (char *info) const;
352 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers 379 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers
353 const char *flag_desc (char *desc, int len) const; 380 const char *flag_desc (char *desc, int len) const;
354 381
382 MTH bool decrease_nr (sint32 nr);
383 MTH object *split_nr (sint32 nr);
384
355 int number_of () const 385 MTH int number_of () const
356 { 386 {
357 return nrof ? nrof : 1; 387 return nrof ? nrof : 1;
358 } 388 }
359 389
360 uint64 total_weight () const 390 MTH sint32 total_weight () const
361 { 391 {
362 return weight * number_of (); 392 return (weight + carrying) * number_of ();
363 } 393 }
394
395 MTH void update_weight ();
364 396
365 // return the dominant material of this item, always return something 397 // return the dominant material of this item, always return something
366 const materialtype_t *dominant_material () const; 398 const materialtype_t *dominant_material () const;
367 399
368 // return the volume of this object in cm³ 400 // return the volume of this object in cm³
369 uint64 volume () const 401 MTH uint64 volume () const
370 { 402 {
371 return total_weight () 403 return total_weight ()
372 * 1000 404 * 1000
373 * (type == CONTAINER ? 1000 : 1) 405 * (type == CONTAINER ? 1000 : 1)
374 / dominant_material ()->density; 406 / dominant_material ()->density;
398 /* This return true if object has still randomitems which 430 /* This return true if object has still randomitems which
399 * could be expanded. 431 * could be expanded.
400 */ 432 */
401 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } 433 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
402 434
435 // returns the outermost environment, never returns 0
436 MTH object *outer_env ()
437 {
438 for (object *op = this; ; op = op->env)
439 if (!op->env)
440 return op;
441 }
442
403 // returns the player that has this object in his inventory, or 0 443 // returns the player that has this object in his inventory, or 0
444 // we assume the player is always the outer env
404 MTH object *in_player () const 445 MTH object *in_player ()
405 { 446 {
406 for (object *op = env; op; op = op->env) 447 object *op = outer_env ();
407 if (op->type == PLAYER)
408 return op;
409 448
410 return 0; 449 return op->type == PLAYER ? op : 0;
411 } 450 }
412 451
413 // "temporary" helper function 452 // "temporary" helper function
414 MTH object *head_ () 453 MTH object *head_ ()
415 { 454 {
417 } 456 }
418 457
419 MTH bool is_head () 458 MTH bool is_head ()
420 { 459 {
421 return head_ () == this; 460 return head_ () == this;
461 }
462
463 MTH bool is_on_map () const
464 {
465 return !env && !flag [FLAG_REMOVED];
422 } 466 }
423 467
424 MTH std::string long_desc (object *who = 0); 468 MTH std::string long_desc (object *who = 0);
425 MTH std::string describe_monster (object *who = 0); 469 MTH std::string describe_monster (object *who = 0);
426 MTH std::string describe_item (object *who = 0); 470 MTH std::string describe_item (object *who = 0);
442 MTH void activate (); 486 MTH void activate ();
443 MTH void deactivate (); 487 MTH void deactivate ();
444 MTH void activate_recursive (); 488 MTH void activate_recursive ();
445 MTH void deactivate_recursive (); 489 MTH void deactivate_recursive ();
446 490
447 // set the givne flag on all objects in the inventory recursively 491 // set the given flag on all objects in the inventory recursively
448 MTH void set_flag_inv (int flag, int value = 1); 492 MTH void set_flag_inv (int flag, int value = 1);
449 493
450 void enter_exit (object *exit);//Perl 494 void enter_exit (object *exit);//Perl
451 MTH void enter_map (maptile *newmap, int x, int y); 495 MTH void enter_map (maptile *newmap, int x, int y);
452 496
504 MTH struct region *region () const; 548 MTH struct region *region () const;
505 549
506 void statusmsg (const char *msg, int color = NDI_BLACK); 550 void statusmsg (const char *msg, int color = NDI_BLACK);
507 void failmsg (const char *msg, int color = NDI_RED); 551 void failmsg (const char *msg, int color = NDI_RED);
508 552
553 const char *query_inventory (object *who = 0, const char *indent = "");
554
555 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
556 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
557
509protected: 558protected:
510 void link (); 559 void link ();
511 void unlink (); 560 void unlink ();
512 561
513 object (); 562 object ();
540} objectlink; 589} objectlink;
541 590
542typedef struct oblinkpt 591typedef struct oblinkpt
543{ /* Used to link together several object links */ 592{ /* Used to link together several object links */
544 struct oblnk *link; 593 struct oblnk *link;
545 long value; /* Used as connected value in buttons/gates */ 594 sint32 value; /* Used as connected value in buttons/gates */
546 struct oblinkpt *next; 595 struct oblinkpt *next;
547} oblinkpt; 596} oblinkpt;
548 597
549object *find_skill_by_name (object *who, const char *name); 598object *find_skill_by_name (object *who, const char *name);
550object *find_skill_by_name (object *who, const shstr &sh); 599object *find_skill_by_name (object *who, const shstr &sh);
560 */ 609 */
561 610
562INTERFACE_CLASS (archetype) 611INTERFACE_CLASS (archetype)
563struct archetype : object 612struct archetype : object
564{ 613{
614 static arch_ptr empty; // the empty_archetype
615 MTH static void gc ();
616
565 archetype (const char *name); 617 archetype (const char *name);
566 ~archetype (); 618 ~archetype ();
567 void gather_callbacks (AV *&callbacks, event_type event) const; 619 void gather_callbacks (AV *&callbacks, event_type event) const;
568 620
569 static archetype *read (object_thawer &f);
570 static archetype *get (const char *name); // find or create
571 static archetype *find (const char *name); 621 MTH static archetype *find (const_utf8_string name);
572 622
573 void link (); 623 MTH void link ();
574 void unlink (); 624 MTH void unlink ();
625
626 MTH object *instance ();
575 627
576 object_vector_index ACC (RW, archid); // index in archvector 628 object_vector_index ACC (RW, archid); // index in archvector
577 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 629 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
578 bool ACC (RW, stub); // if true, this is an invalid archetype
579 uint32 ACC (RW, editable); /* editable flags (mainly for editor) */
580 630
581 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ 631 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
582 sint8 ACC (RW, max_x), ACC (RW, max_y); 632 sint8 ACC (RW, max_x), ACC (RW, max_y);
633
634 // support for archetype loading
635 static archetype *read (object_thawer &f);
636 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
637 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
583}; 638};
584 639
585inline void 640inline void
586object_freezer::put (keyword k, archetype *v) 641object_freezer::put (keyword k, archetype *v)
587{ 642{
631 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - 686 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
632 * Use for treasure chests so the new object is the highest thing 687 * Use for treasure chests so the new object is the highest thing
633 * beneath the player, but not actually above it. Note - the 688 * beneath the player, but not actually above it. Note - the
634 * map and x,y coordinates for the object to be inserted must 689 * map and x,y coordinates for the object to be inserted must
635 * match the originator. 690 * match the originator.
636 * INS_MAP_LOAD: disable lots of checkings done at insertion to
637 * speed up map loading process, as we assume the ordering in
638 * loaded map is correct.
639 * 691 *
640 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY 692 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
641 * are mutually exclusive. The behaviour for passing more than one 693 * are mutually exclusive. The behaviour for passing more than one
642 * should be considered undefined - while you may notice what happens 694 * should be considered undefined - while you may notice what happens
643 * right now if you pass more than one, that could very well change 695 * right now if you pass more than one, that could very well change
646#define INS_NO_MERGE 0x0001 698#define INS_NO_MERGE 0x0001
647#define INS_ABOVE_FLOOR_ONLY 0x0002 699#define INS_ABOVE_FLOOR_ONLY 0x0002
648#define INS_NO_WALK_ON 0x0004 700#define INS_NO_WALK_ON 0x0004
649#define INS_ON_TOP 0x0008 701#define INS_ON_TOP 0x0008
650#define INS_BELOW_ORIGINATOR 0x0010 702#define INS_BELOW_ORIGINATOR 0x0010
651#define INS_MAP_LOAD 0x0020
652 703
653#define ARCH_DEPLETION "depletion" 704#define ARCH_DEPLETION "depletion"
654 705
655#endif 706#endif
656 707

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines