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.136 by root, Thu Jul 5 08:10:30 2007 UTC vs.
Revision 1.170 by root, Wed Apr 30 10:31:04 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); /* Face with colors */ 214 faceidx ACC (RW, face); /* the graphical face */
215 faceidx ACC (RW, sound); /* the sound face */
216 faceidx ACC (RW, sound_destroy); /* played on destroy */
190 living ACC (RO, stats); /* Str, Con, Dex, etc */ 217 living ACC (RO, stats); /* Str, Con, Dex, etc */
191 /* See the pod/objects.pod for more info about body locations */ 218 /* See the pod/objects.pod for more info about body locations */
192 219
193 /* Following mostly refers to fields only used for monsters */ 220 /* Following mostly refers to fields only used for monsters */
194 uint32 ACC (RW, hide); /* The object is hidden, not invisible */ 221 uint32 ACC (RW, hide); /* The object is hidden, not invisible */
248 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 275 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
249 int ACC (RO, count); 276 int ACC (RO, count);
250 object_vector_index ACC (RO, index); // index into objects 277 object_vector_index ACC (RO, index); // index into objects
251 object_vector_index ACC (RO, active); // index into actives 278 object_vector_index ACC (RO, active); // index into actives
252 279
253 player_ptr ACC (RW, contr); /* Pointer to the player which control this object */ 280 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */
254 281
255 object *ACC (RW, below); /* Pointer to the object stacked below this one */ 282 object *ACC (RW, below); /* Pointer to the object stacked below this one */
256 object *ACC (RW, above); /* Pointer to the object stacked above this one */ 283 object *ACC (RW, above); /* Pointer to the object stacked above this one */
257 /* Note: stacked in the *same* environment */ 284 /* Note: stacked in the *same* environment */
258 object *inv; /* Pointer to the first object in the inventory */ 285 object *inv; /* Pointer to the first object in the inventory */
268 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
269 client_container *seen_by; // seen by which player/container currently? 296 client_container *seen_by; // seen by which player/container currently?
270 key_value *key_values; /* Fields not explictly known by the loader. */ 297 key_value *key_values; /* Fields not explictly known by the loader. */
271 298
272 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
273 void post_load_check (); // do some adjustments after parsing 300 MTH void post_load_check (); // do some adjustments after parsing
274 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.
275 bool write (object_freezer &f); 302 bool write (object_freezer &f);
276 303
277 MTH int slottype () const; 304 MTH int slottype () const;
278 MTH static object *create (); 305 MTH static object *create ();
306 const mapxy &operator =(const mapxy &pos);
279 object &operator =(const object &src); 307 object &operator =(const object &src);
280 MTH void copy_to (object *dst); 308 MTH void copy_to (object *dst);
281 MTH object *clone (); // create + copy_to 309 MTH object *clone (); // create + copy_to
282 void do_destroy (); 310 void do_destroy ();
283 void gather_callbacks (AV *&callbacks, event_type event) const; 311 void gather_callbacks (AV *&callbacks, event_type event) const;
284 MTH void destroy (bool destroy_inventory = false); 312 MTH void destroy (bool destroy_inventory = false);
285 313
286 // 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
287 MTH void destroy_inv (bool drop_to_ground = false); 315 MTH void destroy_inv (bool drop_to_ground = false);
288 MTH object *insert (object *item); // insert into inventory 316 MTH object *insert (object *item); // insert into inventory
317 MTH void play_sound (faceidx sound);
318
289 void do_remove (); 319 void do_remove ();
290 MTH void remove () 320 MTH void remove ()
291 { 321 {
292 if (!flag [FLAG_REMOVED]) 322 if (!flag [FLAG_REMOVED])
293 do_remove (); 323 do_remove ();
324 }
325
326 MTH bool blocked (maptile *m, int x, int y) const;
327
328 void move_to (const mapxy &pos)
329 {
330 remove ();
331 *this = pos;
332 insert_at (this, this);
294 } 333 }
295 334
296 static bool can_merge_slow (object *op1, object *op2); 335 static bool can_merge_slow (object *op1, object *op2);
297 336
298 // this is often used in time-critical code, so optimise 337 // this is often used in time-critical code, so optimise
338 // info must hold 256 * 3 bytes currently 377 // info must hold 256 * 3 bytes currently
339 const char *debug_desc (char *info) const; 378 const char *debug_desc (char *info) const;
340 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
341 const char *flag_desc (char *desc, int len) const; 380 const char *flag_desc (char *desc, int len) const;
342 381
382 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
383 MTH object *split (sint32 nr = 1); // return 0 on failure
384
343 int number_of () const 385 MTH int number_of () const
344 { 386 {
345 return nrof ? nrof : 1; 387 return nrof ? nrof : 1;
346 } 388 }
347 389
348 uint64 total_weight () const 390 MTH sint32 total_weight () const
349 { 391 {
350 return weight * number_of (); 392 return (weight + carrying) * number_of ();
351 } 393 }
394
395 MTH void update_weight ();
352 396
353 // return the dominant material of this item, always return something 397 // return the dominant material of this item, always return something
354 const materialtype_t *dominant_material () const; 398 const materialtype_t *dominant_material () const;
355 399
356 // return the volume of this object in cm³ 400 // return the volume of this object in cm³
357 uint64 volume () const 401 MTH uint64 volume () const
358 { 402 {
359 return total_weight () 403 return total_weight ()
360 * 1000 404 * 1000
361 * (type == CONTAINER ? 1000 : 1) 405 * (type == CONTAINER ? 1000 : 1)
362 / dominant_material ()->density; 406 / dominant_material ()->density;
379 423
380 // temporary: wether the object can be saved in a map file 424 // temporary: wether the object can be saved in a map file
381 // contr => is a player 425 // contr => is a player
382 // head => only save head of a multitile object 426 // head => only save head of a multitile object
383 // owner => can not reference owner yet 427 // owner => can not reference owner yet
384 MTH bool can_map_save () const { return !contr && !head && !owner && !flag [FLAG_NO_MAP_SAVE]; } 428 MTH bool can_map_save () const { return !head && (!owner || owner->contr) && !contr && !flag [FLAG_NO_MAP_SAVE]; }
385 429
386 /* This return true if object has still randomitems which 430 /* This return true if object has still randomitems which
387 * could be expanded. 431 * could be expanded.
388 */ 432 */
389 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]; }
390 434
435 // returns the outermost owner, never returns 0
436 MTH object *outer_owner ()
437 {
438 for (object *op = this; ; op = op->owner)
439 if (!op->owner)
440 return op;
441 }
442
443 // returns the outermost environment, never returns 0
444 MTH object *outer_env ()
445 {
446 for (object *op = this; ; op = op->env)
447 if (!op->env)
448 return op;
449 }
450
391 // returns the player that has this object in his inventory, or 0 451 // returns the player that has this object in his inventory, or 0
452 // we assume the player is always the outer env
392 MTH object *in_player () const 453 MTH object *in_player ()
393 { 454 {
394 for (object *op = env; op; op = op->env) 455 object *op = outer_env ();
395 if (op->type == PLAYER)
396 return op;
397 456
398 return 0; 457 return op->type == PLAYER ? op : 0;
399 } 458 }
400 459
401 // "temporary" helper function 460 // "temporary" helper function
402 MTH object *head_ () 461 MTH object *head_ ()
403 { 462 {
406 465
407 MTH bool is_head () 466 MTH bool is_head ()
408 { 467 {
409 return head_ () == this; 468 return head_ () == this;
410 } 469 }
470
471 MTH bool is_on_map () const
472 {
473 return !env && !flag [FLAG_REMOVED];
474 }
475
476 // returns the player that cna see this object, if any
477 MTH object *visible_to () const;
411 478
412 MTH std::string long_desc (object *who = 0); 479 MTH std::string long_desc (object *who = 0);
413 MTH std::string describe_monster (object *who = 0); 480 MTH std::string describe_monster (object *who = 0);
414 MTH std::string describe_item (object *who = 0); 481 MTH std::string describe_item (object *who = 0);
415 MTH std::string describe (object *who = 0); 482 MTH std::string describe (object *who = 0);
423 MTH void create_treasure (treasurelist *tl, int flags = 0); 490 MTH void create_treasure (treasurelist *tl, int flags = 0);
424 491
425 // insert object at same map position as 'where' 492 // insert object at same map position as 'where'
426 // handles both inventory and map "positions" 493 // handles both inventory and map "positions"
427 MTH object *insert_at (object *where, object *originator = 0, int flags = 0); 494 MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
495 MTH void drop_unpaid_items ();
428 496
429 MTH void activate (); 497 MTH void activate ();
430 MTH void deactivate (); 498 MTH void deactivate ();
431 MTH void activate_recursive (); 499 MTH void activate_recursive ();
432 MTH void deactivate_recursive (); 500 MTH void deactivate_recursive ();
433 501
434 // set the givne flag on all objects in the inventory recursively 502 // set the given flag on all objects in the inventory recursively
435 MTH void set_flag_inv (int flag, int value = 1); 503 MTH void set_flag_inv (int flag, int value = 1);
436 504
437 void enter_exit (object *exit);//Perl 505 void enter_exit (object *exit);//Perl
438 MTH void enter_map (maptile *newmap, int x, int y); 506 MTH void enter_map (maptile *newmap, int x, int y);
439 507
479 { 547 {
480 return this; 548 return this;
481 } 549 }
482 550
483 /* This returns TRUE if the object is something that 551 /* This returns TRUE if the object is something that
484 * should be displayed in the floorbox/inventory window 552 * a client might want to know about.
485 */ 553 */
486 MTH bool client_visible () const 554 MTH bool client_visible () const
487 { 555 {
488 return !invisible && type != PLAYER; 556 return !invisible && type != PLAYER;
489 } 557 }
490 558
559 // the client does nrof * this weight
560 MTH sint32 client_weight () const
561 {
562 return weight + carrying;
563 }
564
491 MTH struct region *region () const; 565 MTH struct region *region () const;
566
567 void statusmsg (const char *msg, int color = NDI_BLACK);
568 void failmsg (const char *msg, int color = NDI_RED);
569
570 const char *query_inventory (object *who = 0, const char *indent = "");
571
572 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
573 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
492 574
493protected: 575protected:
494 void link (); 576 void link ();
495 void unlink (); 577 void unlink ();
496 578
524} objectlink; 606} objectlink;
525 607
526typedef struct oblinkpt 608typedef struct oblinkpt
527{ /* Used to link together several object links */ 609{ /* Used to link together several object links */
528 struct oblnk *link; 610 struct oblnk *link;
529 long value; /* Used as connected value in buttons/gates */ 611 sint32 value; /* Used as connected value in buttons/gates */
530 struct oblinkpt *next; 612 struct oblinkpt *next;
531} oblinkpt; 613} oblinkpt;
532 614
533object *find_skill_by_name (object *who, const char *name); 615object *find_skill_by_name (object *who, const char *name);
534object *find_skill_by_name (object *who, const shstr &sh); 616object *find_skill_by_name (object *who, const shstr &sh);
544 */ 626 */
545 627
546INTERFACE_CLASS (archetype) 628INTERFACE_CLASS (archetype)
547struct archetype : object 629struct archetype : object
548{ 630{
631 static arch_ptr empty; // the empty_archetype
632 MTH static void gc ();
633
549 archetype (const char *name); 634 archetype (const char *name);
550 ~archetype (); 635 ~archetype ();
551 void gather_callbacks (AV *&callbacks, event_type event) const; 636 void gather_callbacks (AV *&callbacks, event_type event) const;
552 637
553 static archetype *read (object_thawer &f);
554 static archetype *get (const char *name); // find or create
555 static archetype *find (const char *name); 638 MTH static archetype *find (const_utf8_string name);
556 639
557 void link (); 640 MTH void link ();
558 void unlink (); 641 MTH void unlink ();
642
643 MTH static object *get (const char *name); // find()->instance()
644 MTH object *instance ();
559 645
560 object_vector_index ACC (RW, archid); // index in archvector 646 object_vector_index ACC (RW, archid); // index in archvector
561 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 647 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
562 bool ACC (RW, stub); // if true, this is an invalid archetype
563 uint32 ACC (RW, editable); /* editable flags (mainly for editor) */
564 648
565 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ 649 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
566 sint8 ACC (RW, max_x), ACC (RW, max_y); 650 sint8 ACC (RW, max_x), ACC (RW, max_y);
651
652 // support for archetype loading
653 static archetype *read (object_thawer &f);
654 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
655 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
567}; 656};
568 657
569inline void 658inline void
570object_freezer::put (keyword k, archetype *v) 659object_freezer::put (keyword k, archetype *v)
571{ 660{
615 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - 704 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
616 * Use for treasure chests so the new object is the highest thing 705 * Use for treasure chests so the new object is the highest thing
617 * beneath the player, but not actually above it. Note - the 706 * beneath the player, but not actually above it. Note - the
618 * map and x,y coordinates for the object to be inserted must 707 * map and x,y coordinates for the object to be inserted must
619 * match the originator. 708 * match the originator.
620 * INS_MAP_LOAD: disable lots of checkings done at insertion to
621 * speed up map loading process, as we assume the ordering in
622 * loaded map is correct.
623 * 709 *
624 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY 710 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
625 * are mutually exclusive. The behaviour for passing more than one 711 * are mutually exclusive. The behaviour for passing more than one
626 * should be considered undefined - while you may notice what happens 712 * should be considered undefined - while you may notice what happens
627 * right now if you pass more than one, that could very well change 713 * right now if you pass more than one, that could very well change
630#define INS_NO_MERGE 0x0001 716#define INS_NO_MERGE 0x0001
631#define INS_ABOVE_FLOOR_ONLY 0x0002 717#define INS_ABOVE_FLOOR_ONLY 0x0002
632#define INS_NO_WALK_ON 0x0004 718#define INS_NO_WALK_ON 0x0004
633#define INS_ON_TOP 0x0008 719#define INS_ON_TOP 0x0008
634#define INS_BELOW_ORIGINATOR 0x0010 720#define INS_BELOW_ORIGINATOR 0x0010
635#define INS_MAP_LOAD 0x0020
636 721
637#define ARCH_DEPLETION "depletion" 722#define ARCH_DEPLETION "depletion"
638 723
639#endif 724#endif
640 725

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines