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.160 by root, Sun Apr 20 00:44:12 2008 UTC vs.
Revision 1.173 by root, Sun May 4 08:25:33 2008 UTC

1/* 1/*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG. 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Deliantra 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 * Deliantra 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
74 * 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
75 * "dangling" from it; this could also end up containing 'parse errors'. 75 * "dangling" from it; this could also end up containing 'parse errors'.
76 * 76 *
77 * key and value are shared-strings. 77 * key and value are shared-strings.
78 * 78 *
79 * 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
80 * accessing the list directly. 80 * accessing the list directly.
81 * 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.
82 */ 82 */
83struct key_value 83struct key_value : slice_allocated
84{ 84{
85 key_value *next; 85 key_value *next;
86 shstr key, value; 86 shstr key, value;
87}; 87};
88 88
177 177
178 float ACC (RW, speed); /* The overall speed of this object */ 178 float ACC (RW, speed); /* The overall speed of this object */
179 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 */
180 uint32 ACC (RW, nrof); /* How many of the objects */ 180 uint32 ACC (RW, nrof); /* How many of the objects */
181 181
182 /* This next big block are basically used for monsters and equipment */ 182 /* This next big block is basically used for monsters and equipment */
183 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 */
184 184
185 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */ 185 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */
186 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */ 186 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
187 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */ 187 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */
204 sint8 ACC (RW, item_power); /* power rating of the object */ 204 sint8 ACC (RW, item_power); /* power rating of the object */
205 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) */
206 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 */
207 sint32 ACC (RW, weight); /* Attributes of the object */ 207 sint32 ACC (RW, weight); /* Attributes of the object */
208 sint32 ACC (RW, weight_limit);/* Weight-limit of object */ 208 sint32 ACC (RW, weight_limit);/* Weight-limit of object */
209 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 */
210 sint64 ACC (RW, perm_exp); /* Permanent exp */ 210 sint64 ACC (RW, perm_exp); /* Permanent exp */
211 uint32 ACC (RW, weapontype); /* type of weapon */ 211 uint32 ACC (RW, weapontype); /* type of weapon */
212 uint32 ACC (RW, tooltype); /* type of tool or build facility */ 212 uint32 ACC (RW, tooltype); /* type of tool or build facility */
213 body_slot slot [NUM_BODY_LOCATIONS]; 213 body_slot slot [NUM_BODY_LOCATIONS];
214 faceidx ACC (RW, face); /* the graphical face */ 214 faceidx ACC (RW, face); /* the graphical face */
294 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 */
295 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
296 client_container *seen_by; // seen by which player/container currently? 296 client_container *seen_by; // seen by which player/container currently?
297 key_value *key_values; /* Fields not explictly known by the loader. */ 297 key_value *key_values; /* Fields not explictly known by the loader. */
298 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
299 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
300 MTH void post_load_check (); // do some adjustments after parsing 335 MTH void post_load_check (); // do some adjustments after parsing
301 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.
302 bool write (object_freezer &f); 337 bool write (object_freezer &f);
303 338
304 MTH int slottype () const; 339 MTH int slottype () const;
305 MTH static object *create (); 340 MTH static object *create ();
306 const mapxy &operator =(const mapxy &pos); 341 const mapxy &operator =(const mapxy &pos);
307 object &operator =(const object &src);
308 MTH void copy_to (object *dst); 342 MTH void copy_to (object *dst);
309 MTH object *clone (); // create + copy_to 343 MTH object *clone (); // create + copy_to a single object
344 MTH object *deep_clone (); // copy whole more chain and inventory
310 void do_destroy (); 345 void do_destroy ();
311 void gather_callbacks (AV *&callbacks, event_type event) const; 346 void gather_callbacks (AV *&callbacks, event_type event) const;
312 MTH void destroy (bool destroy_inventory = false); 347 MTH void destroy (bool destroy_inventory = false);
313 348
314 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 349 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
315 MTH void destroy_inv (bool drop_to_ground = false); 350 MTH void destroy_inv (bool drop_to_ground = false);
316 MTH object *insert (object *item); // insert into inventory 351 MTH object *insert (object *item); // insert into inventory
317 MTH void play_sound (faceidx sound) const; 352 MTH void play_sound (faceidx sound);
318 353
319 void do_remove (); 354 void do_remove ();
320 MTH void remove () 355 MTH void remove ()
321 { 356 {
322 if (!flag [FLAG_REMOVED]) 357 if (!flag [FLAG_REMOVED])
377 // info must hold 256 * 3 bytes currently 412 // info must hold 256 * 3 bytes currently
378 const char *debug_desc (char *info) const; 413 const char *debug_desc (char *info) const;
379 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers 414 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers
380 const char *flag_desc (char *desc, int len) const; 415 const char *flag_desc (char *desc, int len) const;
381 416
417 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
418 MTH object *split (sint32 nr = 1); // return 0 on failure
419
382 int number_of () const 420 MTH int number_of () const
383 { 421 {
384 return nrof ? nrof : 1; 422 return nrof ? nrof : 1;
385 } 423 }
386 424
387 uint64 total_weight () const 425 MTH sint32 total_weight () const
388 { 426 {
389 return weight * number_of (); 427 return (weight + carrying) * number_of ();
390 } 428 }
429
430 MTH void update_weight ();
391 431
392 // return the dominant material of this item, always return something 432 // return the dominant material of this item, always return something
393 const materialtype_t *dominant_material () const; 433 const materialtype_t *dominant_material () const;
394 434
395 // return the volume of this object in cm³ 435 // return the volume of this object in cm³
396 uint64 volume () const 436 MTH uint64 volume () const
397 { 437 {
398 return total_weight () 438 return total_weight ()
399 * 1000 439 * 1000
400 * (type == CONTAINER ? 1000 : 1) 440 * (type == CONTAINER ? 1000 : 1)
401 / dominant_material ()->density; 441 / dominant_material ()->density;
425 /* This return true if object has still randomitems which 465 /* This return true if object has still randomitems which
426 * could be expanded. 466 * could be expanded.
427 */ 467 */
428 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } 468 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
429 469
470 // returns the outermost owner, never returns 0
471 MTH object *outer_owner ()
472 {
473 for (object *op = this; ; op = op->owner)
474 if (!op->owner)
475 return op;
476 }
477
478 // returns the outermost environment, never returns 0
479 MTH object *outer_env ()
480 {
481 for (object *op = this; ; op = op->env)
482 if (!op->env)
483 return op;
484 }
485
430 // returns the player that has this object in his inventory, or 0 486 // returns the player that has this object in his inventory, or 0
487 // we assume the player is always the outer env
431 MTH object *in_player () const 488 MTH object *in_player ()
432 { 489 {
433 for (object *op = env; op; op = op->env) 490 object *op = outer_env ();
434 if (op->type == PLAYER)
435 return op;
436 491
437 return 0; 492 return op->type == PLAYER ? op : 0;
438 } 493 }
439 494
440 // "temporary" helper function 495 // "temporary" helper function
441 MTH object *head_ () 496 MTH object *head_ ()
442 { 497 {
445 500
446 MTH bool is_head () 501 MTH bool is_head ()
447 { 502 {
448 return head_ () == this; 503 return head_ () == this;
449 } 504 }
505
506 MTH bool is_on_map () const
507 {
508 return !env && !flag [FLAG_REMOVED];
509 }
510
511 // returns the player that cna see this object, if any
512 MTH object *visible_to () const;
450 513
451 MTH std::string long_desc (object *who = 0); 514 MTH std::string long_desc (object *who = 0);
452 MTH std::string describe_monster (object *who = 0); 515 MTH std::string describe_monster (object *who = 0);
453 MTH std::string describe_item (object *who = 0); 516 MTH std::string describe_item (object *who = 0);
454 MTH std::string describe (object *who = 0); 517 MTH std::string describe (object *who = 0);
519 { 582 {
520 return this; 583 return this;
521 } 584 }
522 585
523 /* This returns TRUE if the object is something that 586 /* This returns TRUE if the object is something that
524 * should be displayed in the floorbox/inventory window 587 * a client might want to know about.
525 */ 588 */
526 MTH bool client_visible () const 589 MTH bool client_visible () const
527 { 590 {
528 return !invisible && type != PLAYER; 591 return !invisible && type != PLAYER;
592 }
593
594 // the client does nrof * this weight
595 MTH sint32 client_weight () const
596 {
597 return weight + carrying;
529 } 598 }
530 599
531 MTH struct region *region () const; 600 MTH struct region *region () const;
532 601
533 void statusmsg (const char *msg, int color = NDI_BLACK); 602 void statusmsg (const char *msg, int color = NDI_BLACK);
542 void link (); 611 void link ();
543 void unlink (); 612 void unlink ();
544 613
545 object (); 614 object ();
546 ~object (); 615 ~object ();
616
617private:
618 object &operator =(const object &);
619 object (const object &);
547}; 620};
548 621
549// move this object to the top of its env's inventory to speed up 622// move this object to the top of its env's inventory to speed up
550// searches for it. 623// searches for it.
551static object * 624static object *
592 */ 665 */
593 666
594INTERFACE_CLASS (archetype) 667INTERFACE_CLASS (archetype)
595struct archetype : object 668struct archetype : object
596{ 669{
597 static archetype *empty; // the empty_archetype 670 static arch_ptr empty; // the empty_archetype
671 MTH static void gc ();
598 672
599 archetype (const char *name); 673 archetype (const char *name);
600 ~archetype (); 674 ~archetype ();
601 void gather_callbacks (AV *&callbacks, event_type event) const; 675 void gather_callbacks (AV *&callbacks, event_type event) const;
602 676
603 MTH static archetype *find (const_utf8_string name); 677 MTH static archetype *find (const_utf8_string name);
604 678
605 MTH void link (); 679 MTH void link ();
606 MTH void unlink (); 680 MTH void unlink ();
607 681
682 MTH static object *get (const char *name); // find()->instance()
608 MTH object *instance (); 683 MTH object *instance ();
609 684
610 object_vector_index ACC (RW, archid); // index in archvector 685 object_vector_index ACC (RW, archid); // index in archvector
611 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 686 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
612 687

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines