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.138 by root, Thu Jul 26 00:27:08 2007 UTC vs.
Revision 1.163 by root, Sun Apr 20 23:25:09 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 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 */
184 sint32 ACC (RW, carrying); /* How much weight this object contains */ 209 sint32 ACC (RW, carrying); /* How much weight this object contains */
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;
291 void do_remove (); 319 void do_remove ();
292 MTH void remove () 320 MTH void remove ()
293 { 321 {
294 if (!flag [FLAG_REMOVED]) 322 if (!flag [FLAG_REMOVED])
295 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);
296 } 333 }
297 334
298 static bool can_merge_slow (object *op1, object *op2); 335 static bool can_merge_slow (object *op1, object *op2);
299 336
300 // this is often used in time-critical code, so optimise 337 // this is often used in time-critical code, so optimise
340 // info must hold 256 * 3 bytes currently 377 // info must hold 256 * 3 bytes currently
341 const char *debug_desc (char *info) const; 378 const char *debug_desc (char *info) const;
342 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
343 const char *flag_desc (char *desc, int len) const; 380 const char *flag_desc (char *desc, int len) const;
344 381
345 int number_of () const 382 MTH int number_of () const
346 { 383 {
347 return nrof ? nrof : 1; 384 return nrof ? nrof : 1;
348 } 385 }
349 386
350 uint64 total_weight () const 387 MTH sint32 total_weight () const
351 { 388 {
352 return weight * number_of (); 389 return weight * number_of () + carrying;
353 } 390 }
391
392 MTH void update_weight ();
354 393
355 // return the dominant material of this item, always return something 394 // return the dominant material of this item, always return something
356 const materialtype_t *dominant_material () const; 395 const materialtype_t *dominant_material () const;
357 396
358 // return the volume of this object in cm³ 397 // return the volume of this object in cm³
359 uint64 volume () const 398 MTH uint64 volume () const
360 { 399 {
361 return total_weight () 400 return total_weight ()
362 * 1000 401 * 1000
363 * (type == CONTAINER ? 1000 : 1) 402 * (type == CONTAINER ? 1000 : 1)
364 / dominant_material ()->density; 403 / dominant_material ()->density;
381 420
382 // temporary: wether the object can be saved in a map file 421 // temporary: wether the object can be saved in a map file
383 // contr => is a player 422 // contr => is a player
384 // head => only save head of a multitile object 423 // head => only save head of a multitile object
385 // owner => can not reference owner yet 424 // owner => can not reference owner yet
386 MTH bool can_map_save () const { return !contr && !head && !owner && !flag [FLAG_NO_MAP_SAVE]; } 425 MTH bool can_map_save () const { return !head && (!owner || owner->contr) && !contr && !flag [FLAG_NO_MAP_SAVE]; }
387 426
388 /* This return true if object has still randomitems which 427 /* This return true if object has still randomitems which
389 * could be expanded. 428 * could be expanded.
390 */ 429 */
391 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } 430 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
431
432 // returns the outermost environment, never returns 0
433 MTH object *outer_env ()
434 {
435 for (object *op = this; ; op = op->env)
436 if (!op->env)
437 return op;
438 }
392 439
393 // returns the player that has this object in his inventory, or 0 440 // returns the player that has this object in his inventory, or 0
394 MTH object *in_player () const 441 MTH object *in_player () const
395 { 442 {
396 for (object *op = env; op; op = op->env) 443 for (object *op = env; op; op = op->env)
432 MTH void activate (); 479 MTH void activate ();
433 MTH void deactivate (); 480 MTH void deactivate ();
434 MTH void activate_recursive (); 481 MTH void activate_recursive ();
435 MTH void deactivate_recursive (); 482 MTH void deactivate_recursive ();
436 483
437 // set the givne flag on all objects in the inventory recursively 484 // set the given flag on all objects in the inventory recursively
438 MTH void set_flag_inv (int flag, int value = 1); 485 MTH void set_flag_inv (int flag, int value = 1);
439 486
440 void enter_exit (object *exit);//Perl 487 void enter_exit (object *exit);//Perl
441 MTH void enter_map (maptile *newmap, int x, int y); 488 MTH void enter_map (maptile *newmap, int x, int y);
442 489
491 return !invisible && type != PLAYER; 538 return !invisible && type != PLAYER;
492 } 539 }
493 540
494 MTH struct region *region () const; 541 MTH struct region *region () const;
495 542
543 void statusmsg (const char *msg, int color = NDI_BLACK);
544 void failmsg (const char *msg, int color = NDI_RED);
545
546 const char *query_inventory (object *who = 0, const char *indent = "");
547
548 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
549 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
550
496protected: 551protected:
497 void link (); 552 void link ();
498 void unlink (); 553 void unlink ();
499 554
500 object (); 555 object ();
527} objectlink; 582} objectlink;
528 583
529typedef struct oblinkpt 584typedef struct oblinkpt
530{ /* Used to link together several object links */ 585{ /* Used to link together several object links */
531 struct oblnk *link; 586 struct oblnk *link;
532 long value; /* Used as connected value in buttons/gates */ 587 sint32 value; /* Used as connected value in buttons/gates */
533 struct oblinkpt *next; 588 struct oblinkpt *next;
534} oblinkpt; 589} oblinkpt;
535 590
536object *find_skill_by_name (object *who, const char *name); 591object *find_skill_by_name (object *who, const char *name);
537object *find_skill_by_name (object *who, const shstr &sh); 592object *find_skill_by_name (object *who, const shstr &sh);
547 */ 602 */
548 603
549INTERFACE_CLASS (archetype) 604INTERFACE_CLASS (archetype)
550struct archetype : object 605struct archetype : object
551{ 606{
607 static arch_ptr empty; // the empty_archetype
608 MTH static void gc ();
609
552 archetype (const char *name); 610 archetype (const char *name);
553 ~archetype (); 611 ~archetype ();
554 void gather_callbacks (AV *&callbacks, event_type event) const; 612 void gather_callbacks (AV *&callbacks, event_type event) const;
555 613
556 static archetype *read (object_thawer &f);
557 static archetype *get (const char *name); // find or create
558 static archetype *find (const char *name); 614 MTH static archetype *find (const_utf8_string name);
559 615
560 void link (); 616 MTH void link ();
561 void unlink (); 617 MTH void unlink ();
618
619 MTH object *instance ();
562 620
563 object_vector_index ACC (RW, archid); // index in archvector 621 object_vector_index ACC (RW, archid); // index in archvector
564 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 622 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
565 bool ACC (RW, stub); // if true, this is an invalid archetype
566 uint32 ACC (RW, editable); /* editable flags (mainly for editor) */
567 623
568 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ 624 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
569 sint8 ACC (RW, max_x), ACC (RW, max_y); 625 sint8 ACC (RW, max_x), ACC (RW, max_y);
626
627 // support for archetype loading
628 static archetype *read (object_thawer &f);
629 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
630 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
570}; 631};
571 632
572inline void 633inline void
573object_freezer::put (keyword k, archetype *v) 634object_freezer::put (keyword k, archetype *v)
574{ 635{
618 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - 679 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
619 * Use for treasure chests so the new object is the highest thing 680 * Use for treasure chests so the new object is the highest thing
620 * beneath the player, but not actually above it. Note - the 681 * beneath the player, but not actually above it. Note - the
621 * map and x,y coordinates for the object to be inserted must 682 * map and x,y coordinates for the object to be inserted must
622 * match the originator. 683 * match the originator.
623 * INS_MAP_LOAD: disable lots of checkings done at insertion to
624 * speed up map loading process, as we assume the ordering in
625 * loaded map is correct.
626 * 684 *
627 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY 685 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
628 * are mutually exclusive. The behaviour for passing more than one 686 * are mutually exclusive. The behaviour for passing more than one
629 * should be considered undefined - while you may notice what happens 687 * should be considered undefined - while you may notice what happens
630 * right now if you pass more than one, that could very well change 688 * right now if you pass more than one, that could very well change
633#define INS_NO_MERGE 0x0001 691#define INS_NO_MERGE 0x0001
634#define INS_ABOVE_FLOOR_ONLY 0x0002 692#define INS_ABOVE_FLOOR_ONLY 0x0002
635#define INS_NO_WALK_ON 0x0004 693#define INS_NO_WALK_ON 0x0004
636#define INS_ON_TOP 0x0008 694#define INS_ON_TOP 0x0008
637#define INS_BELOW_ORIGINATOR 0x0010 695#define INS_BELOW_ORIGINATOR 0x0010
638#define INS_MAP_LOAD 0x0020
639 696
640#define ARCH_DEPLETION "depletion" 697#define ARCH_DEPLETION "depletion"
641 698
642#endif 699#endif
643 700

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines