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.216 by root, Sun Nov 8 20:55:39 2009 UTC vs.
Revision 1.232 by root, Sat Apr 3 02:29:40 2010 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,2008,2009 Marc Alexander Lehmann / Robin Redeker / the Deliantra team 4 * Copyright (©) 2005,2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (©) 2001,2007 Mark Wedel & Crossfire Development Team 5 * Copyright (©) 2001 Mark Wedel & Crossfire Development Team
6 * Copyright (©) 1992,2007 Frank Tore Johansen 6 * Copyright (©) 1992 Frank Tore Johansen
7 * 7 *
8 * Deliantra is free software: you can redistribute it and/or modify it under 8 * Deliantra is free software: you can redistribute it and/or modify it under
9 * the terms of the Affero GNU General Public License as published by the 9 * the terms of the Affero GNU General Public License as published by the
10 * Free Software Foundation, either version 3 of the License, or (at your 10 * Free Software Foundation, either version 3 of the License, or (at your
11 * option) any later version. 11 * option) any later version.
32 32
33//+GPL 33//+GPL
34 34
35typedef int tag_t; 35typedef int tag_t;
36 36
37// also see common/item.C
37enum { 38enum {
38 body_skill, 39 body_skill,
39 body_combat, 40 body_combat,
40 body_range, 41 body_range,
41 body_shield, 42 body_shield,
50 body_wrist, 51 body_wrist,
51 body_waist, 52 body_waist,
52 NUM_BODY_LOCATIONS 53 NUM_BODY_LOCATIONS
53}; 54};
54 55
55enum slottype_t
56{
57 slot_none,
58 slot_combat,
59 slot_ranged,
60};
61
62/* See common/item.c */ 56/* See common/item.c */
63 57
64typedef struct Body_Locations 58typedef struct Body_Locations
65{ 59{
66 keyword save_name; /* Name used to load/save it to disk */ 60 keyword save_name; /* Name used to load/save it to disk */
93 87
94struct UUID 88struct UUID
95{ 89{
96 uint64 seq; 90 uint64 seq;
97 91
92 enum { MAX_LEN = 3 + 16 + 1 + 1 }; // <1. + hex + > + \0
93
98 static UUID cur; // last uuid generated 94 static UUID cur; // last uuid generated
99 static void init (); 95 static void init ();
100 static UUID gen (); 96 static UUID gen ();
101 97
102 UUID () { } 98 UUID () { }
103 UUID (uint64 seq) : seq(seq) { } 99 UUID (uint64 seq) : seq(seq) { }
104 operator uint64() { return seq; } 100 operator uint64() { return seq; }
105 void operator =(uint64 seq) { this->seq = seq; } 101 void operator =(uint64 seq) { this->seq = seq; }
106 102
107 typedef char BUF [32];
108
109 bool parse (const char *s) 103 bool parse (const char *s);
110 { 104 char *append (char *buf) const;
111 return sscanf (s, "<1.%" SCNx64 ">", &seq) == 1;
112 }
113
114 const char *c_str (char *buf, int len) const
115 {
116 snprintf (buf, len, "<1.%" PRIx64 ">", seq);
117
118 return buf;
119 }
120
121 const char *c_str () const 105 char *c_str () const;
122 {
123 static BUF buf;
124
125 return c_str (buf, sizeof (buf));
126 }
127}; 106};
128 107
129//+GPL 108//+GPL
130 109
131/* Definition for WILL_APPLY values. Replaces having harcoded values 110/* Definition for WILL_APPLY values. Replaces having harcoded values
139#define WILL_APPLY_DOOR 0x08 118#define WILL_APPLY_DOOR 0x08
140#define WILL_APPLY_FOOD 0x10 119#define WILL_APPLY_FOOD 0x10
141 120
142struct body_slot 121struct body_slot
143{ 122{
123 signed char used:4; /* Calculated value based on items equipped */
144 signed char info:4; /* body info as loaded from the file */ 124 signed char info:4; /* body info as loaded from the file */
145 signed char used:4; /* Calculated value based on items equipped */
146}; 125};
147 126
148typedef struct oblnk 127typedef struct oblnk
149{ /* Used to link together several objects */ 128{ /* Used to link together several objects */
150 object_ptr ob; 129 object_ptr ob;
180 flags_t flag; /* various flags */ 159 flags_t flag; /* various flags */
181#if FOR_PERL 160#if FOR_PERL
182 bool ACC (RW, flag[NUM_FLAGS]); 161 bool ACC (RW, flag[NUM_FLAGS]);
183#endif 162#endif
184 163
185 shstr ACC (RW, materialname); /* specific material name */ 164 materialtype_t *material; // What material this object consists of //TODO, make perl-accessible
186 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */ 165 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */
187// materialtype_t *ACC (RW, material); /* What material this object consists of */
188 object_ptr ACC (RW, owner); /* Pointer to the object which controls this one */ 166 object_ptr ACC (RW, owner); /* Pointer to the object which controls this one */
189 object_ptr ACC (RW, enemy); /* Monster/player to follow even if not closest */ 167 object_ptr ACC (RW, enemy); /* Monster/player to follow even if not closest */
190 object_ptr ACC (RW, attacked_by); /* This object start to attack us! only player & monster */ 168 object_ptr ACC (RW, attacked_by); /* This object start to attack us! only player & monster */
191 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */ 169 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */
192 object_ptr ACC (RW, spellitem); /* Spell ability monster is choosing to use */ 170 object_ptr ACC (RW, spellitem); /* Spell ability monster is choosing to use */
227 uint8 ACC (RW, pick_up); /* See crossfire.doc */ 205 uint8 ACC (RW, pick_up); /* See crossfire.doc */
228 sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */ 206 sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */
229 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */ 207 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */
230 uint8 ACC (RW, weapontype); /* type of weapon */ 208 uint8 ACC (RW, weapontype); /* type of weapon */
231 209
210 body_slot slot [NUM_BODY_LOCATIONS];
211
232 faceidx ACC (RW, face); /* the graphical face */ 212 faceidx ACC (RW, face); /* the graphical face */
233 213
234 faceidx ACC (RW, sound); /* the sound face */ 214 faceidx ACC (RW, sound); /* the sound face */
235 faceidx ACC (RW, sound_destroy); /* played on destroy */ 215 faceidx ACC (RW, sound_destroy); /* played on destroy */
236
237 body_slot slot [NUM_BODY_LOCATIONS];
238 216
239 sint32 ACC (RW, weight); /* Attributes of the object */ 217 sint32 ACC (RW, weight); /* Attributes of the object */
240 sint32 ACC (RW, weight_limit);/* Weight-limit of object */ 218 sint32 ACC (RW, weight_limit);/* Weight-limit of object */
241 219
242 sint32 ACC (RW, carrying); /* How much weight this object contains, must be 0 if nrof == 0 */ 220 sint32 ACC (RW, carrying); /* How much weight this object contains, must be 0 if nrof == 0 */
301 shstr ACC (RW, lore); /* Obscure information about this object, */ 279 shstr ACC (RW, lore); /* Obscure information about this object, */
302 /* To get put into books and the like. */ 280 /* To get put into books and the like. */
303 shstr ACC (RW, custom_name); /* Custom name assigned by player */ 281 shstr ACC (RW, custom_name); /* Custom name assigned by player */
304}; 282};
305 283
306const char *query_weight (const object *op); 284const_utf8_string query_weight (const object *op);
307const char *query_short_name (const object *op); 285const_utf8_string query_short_name (const object *op);
308const char *query_name (const object *op); 286const_utf8_string query_name (const object *op);
309const char *query_base_name (const object *op, int plural); 287const_utf8_string query_base_name (const object *op, int plural);
310 288
311struct object : zero_initialised, object_copy 289struct object : zero_initialised, object_copy
312{ 290{
313 // These variables are not changed by ->copy_to 291 // These variables are not changed by ->copy_to
314 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */ 292 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */
376 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all 354 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
377 MTH void post_load_check (); // do some adjustments after parsing 355 MTH void post_load_check (); // do some adjustments after parsing
378 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go. 356 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
379 bool write (object_freezer &f); 357 bool write (object_freezer &f);
380 358
381 MTH int slottype () const;
382 MTH static object *create (); 359 MTH static object *create ();
383 const mapxy &operator =(const mapxy &pos); 360 const mapxy &operator =(const mapxy &pos);
384 MTH void copy_to (object *dst); 361 MTH void copy_to (object *dst);
385 MTH object *clone (); // create + copy_to a single object 362 MTH object *clone (); // create + copy_to a single object
386 MTH object *deep_clone (); // copy whole more chain and inventory 363 MTH object *deep_clone (); // copy whole more chain and inventory
395 372
396 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 373 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
397 MTH void destroy_inv (bool drop_to_ground = false); 374 MTH void destroy_inv (bool drop_to_ground = false);
398 MTH object *insert (object *item); // insert into inventory 375 MTH object *insert (object *item); // insert into inventory
399 MTH void play_sound (faceidx sound) const; 376 MTH void play_sound (faceidx sound) const;
400 MTH void say_msg (const char *msg) const; 377 MTH void say_msg (const_utf8_string msg) const;
401 378
402 void do_remove (); 379 void do_remove ();
403 MTH void remove () 380 MTH void remove ()
404 { 381 {
405 if (!flag [FLAG_REMOVED]) 382 if (!flag [FLAG_REMOVED])
413 remove (); 390 remove ();
414 *this = pos; 391 *this = pos;
415 insert_at (this, this); 392 insert_at (this, this);
416 } 393 }
417 394
418 // high-level move functions, return true if successful 395 // high-level move method.
396 // object op is trying to move in direction dir.
397 // originator is typically the same as op, but
398 // can be different if originator is causing op to
399 // move (originator is pushing op)
400 // returns 0 if the object is not able to move to the
401 // desired space, 1 otherwise (in which case we also
402 // move the object accordingly. This function is
403 // very similiar to move_object.
419 int move (int dir, object *originator); 404 int move (int dir, object *originator);
420 405
421 int move (int dir) 406 int move (int dir)
422 { 407 {
423 return move (dir, this); 408 return move (dir, this);
424 } 409 }
410
411 // changes move_type to a new value - handles move_on/move_off effects
412 MTH void change_move_type (MoveType mt);
425 413
426 static bool can_merge_slow (object *op1, object *op2); 414 static bool can_merge_slow (object *op1, object *op2);
427 415
428 // this is often used in time-critical code, so optimise 416 // this is often used in time-critical code, so optimise
429 MTH static bool can_merge (object *op1, object *op2) 417 MTH static bool can_merge (object *op1, object *op2)
434 } 422 }
435 423
436 MTH void set_owner (object *owner); 424 MTH void set_owner (object *owner);
437 MTH void set_speed (float speed); 425 MTH void set_speed (float speed);
438 MTH void set_glow_radius (sint8 rad); 426 MTH void set_glow_radius (sint8 rad);
439 MTH bool change_weapon (object *ob);
440 MTH bool change_skill (object *ob); 427 MTH bool change_skill (object *ob); // deprecated?
441 428
442 MTH void open_container (object *new_container); 429 MTH void open_container (object *new_container);
443 MTH void close_container () 430 MTH void close_container ()
444 { 431 {
445 open_container (0); 432 open_container (0);
484 MTH void drain_stat (); 471 MTH void drain_stat ();
485 MTH void drain_specific_stat (int deplete_stats); 472 MTH void drain_specific_stat (int deplete_stats);
486 MTH void change_luck (int value); 473 MTH void change_luck (int value);
487 474
488 // info must hold 256 * 3 bytes currently 475 // info must hold 256 * 3 bytes currently
489 const char *debug_desc (char *info) const; 476 const_utf8_string debug_desc (char *info) const;
490 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers 477 MTH const_utf8_string debug_desc () const; // uses at least 3 round-robin buffers
491 const char *flag_desc (char *desc, int len) const; 478 const_utf8_string flag_desc (char *desc, int len) const;
492 479
493 MTH bool decrease (sint32 nr = 1); // returns true if anything is left 480 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
494 MTH object *split (sint32 nr = 1); // return 0 on failure 481 MTH object *split (sint32 nr = 1); // return 0 on failure
495 482
496 MTH int number_of () const 483 MTH int number_of () const
504 } 491 }
505 492
506 MTH void update_weight (); 493 MTH void update_weight ();
507 494
508 // return the dominant material of this item, always return something 495 // return the dominant material of this item, always return something
509 const materialtype_t *dominant_material () const; 496 const materialtype_t *dominant_material () const
497 {
498 return material;
499 }
510 500
511 // return the volume of this object in cm³ 501 // return the volume of this object in cm³
512 MTH uint64 volume () const 502 MTH uint64 volume () const
513 { 503 {
514 return (uint64)total_weight () 504 return (uint64)total_weight ()
515 * 1000 505 * 1024 // 1000 actually
516 * (type == CONTAINER ? 1000 : 1) 506 * (type == CONTAINER ? 128 : 1)
517 / dominant_material ()->density; 507 / dominant_material ()->density; // ugh, division
518 } 508 }
519 509
520 MTH bool is_arch () const { return this == (const object *)(const archetype *)arch; } 510 MTH bool is_arch () const { return this == (const object *)(const archetype *)arch; }
521 511
522 MTH bool is_wiz () const { return flag [FLAG_WIZ]; } 512 MTH bool is_wiz () const { return flag [FLAG_WIZ]; }
531 MTH bool is_arrow () const { return type == ARROW 521 MTH bool is_arrow () const { return type == ARROW
532 || (type == SPELL_EFFECT 522 || (type == SPELL_EFFECT
533 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); } 523 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }
534 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; } 524 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; }
535 525
526 MTH bool is_dragon () const;
527
536 MTH bool has_active_speed () const { return fabs (speed) >= MIN_ACTIVE_SPEED; } 528 MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; }
537 529
538 // temporary: wether the object can be saved in a map file 530 // temporary: wether the object can be saved in a map file
539 // contr => is a player 531 // contr => is a player
540 // head => only save head of a multitile object 532 // head => only save head of a multitile object
541 // owner => can not reference owner yet 533 // owner => can not reference owner yet
629 MTH std::string long_desc (object *who = 0); // query_name . " " . describe 621 MTH std::string long_desc (object *who = 0); // query_name . " " . describe
630 MTH std::string describe_monster (object *who = 0); 622 MTH std::string describe_monster (object *who = 0);
631 MTH std::string describe_item (object *who = 0); 623 MTH std::string describe_item (object *who = 0);
632 MTH std::string describe (object *who = 0); // long description, without name 624 MTH std::string describe (object *who = 0); // long description, without name
633 625
634 MTH const char *query_weight () { return ::query_weight (this); } 626 MTH const_utf8_string query_weight () { return ::query_weight (this); }
635 MTH const char *query_name () { return ::query_name (this); } 627 MTH const_utf8_string query_name () { return ::query_name (this); }
636 MTH const char *query_short_name () { return ::query_short_name (this); } 628 MTH const_utf8_string query_short_name () { return ::query_short_name (this); }
637 MTH const char *query_base_name (bool plural) { return ::query_base_name (this, plural); } 629 MTH const_utf8_string query_base_name (bool plural) { return ::query_base_name (this, plural); }
638 630
639 // If this object has no extra parts but should have them, 631 // If this object has no extra parts but should have them,
640 // add them, effectively expanding heads into multipart 632 // add them, effectively expanding heads into multipart
641 // objects. This method only works on objects not inserted 633 // objects. This method only works on objects not inserted
642 // anywhere. 634 // anywhere.
659 // set the given flag on all objects in the inventory recursively 651 // set the given flag on all objects in the inventory recursively
660 MTH void set_flag_inv (int flag, int value = 1); 652 MTH void set_flag_inv (int flag, int value = 1);
661 653
662 void enter_exit (object *exit);//Perl 654 void enter_exit (object *exit);//Perl
663 MTH void enter_map (maptile *newmap, int x, int y); 655 MTH void enter_map (maptile *newmap, int x, int y);
664 void player_goto (const char *path, int x, int y); // only for players 656 void player_goto (const_utf8_string path, int x, int y); // only for players
657 MTH bool apply (object *ob, int aflags = AP_APPLY); // ob may be 0
665 658
666 // returns the mapspace this object is in 659 // returns the mapspace this object is in
667 mapspace &ms () const; 660 mapspace &ms () const;
668 661
669 // fully recursive iterator 662 // fully recursive iterator
720 return weight + carrying; 713 return weight + carrying;
721 } 714 }
722 715
723 MTH struct region *region () const; 716 MTH struct region *region () const;
724 717
725 void statusmsg (const char *msg, int color = NDI_BLACK); 718 void statusmsg (const_utf8_string msg, int color = NDI_BLACK);
726 void failmsg (const char *msg, int color = NDI_RED); 719 void failmsg (const_utf8_string msg, int color = NDI_RED);
727 720
728 const char *query_inventory (object *who = 0, const char *indent = ""); 721 const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = "");
729 722
730 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference 723 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
731 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible 724 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
732 725
733 // make some noise with given item into direction dir, 726 // make some noise with given item into direction dir,
746 * range from 0 through 7. 739 * range from 0 through 7.
747 */ 740 */
748 MTH int anim_frames () const { return anim ().num_animations; } 741 MTH int anim_frames () const { return anim ().num_animations; }
749 MTH int anim_facings () const { return anim ().facings; } 742 MTH int anim_facings () const { return anim ().facings; }
750 743
751 MTH char *as_string (); 744 MTH utf8_string as_string ();
752 745
753protected: 746protected:
754 void link (); 747 void link ();
755 void unlink (); 748 void unlink ();
756 749
781 return ob; 774 return ob;
782} 775}
783 776
784//+GPL 777//+GPL
785 778
786object *find_skill_by_name_fuzzy (object *who, const char *name); 779object *find_skill_by_name_fuzzy (object *who, const_utf8_string name);
787object *find_skill_by_name (object *who, shstr_cmp sh); 780object *find_skill_by_name (object *who, shstr_cmp sh);
788object *find_skill_by_number (object *who, int skillno); 781object *find_skill_by_number (object *who, int skillno);
789 782
790/* 783/*
791 * The archetype structure is a set of rules on how to generate and manipulate 784 * The archetype structure is a set of rules on how to generate and manipulate
802struct archetype : object 795struct archetype : object
803{ 796{
804 static arch_ptr empty; // the empty_archetype 797 static arch_ptr empty; // the empty_archetype
805 MTH static void gc (); 798 MTH static void gc ();
806 799
807 archetype (const char *name); 800 archetype (const_utf8_string name);
808 ~archetype (); 801 ~archetype ();
809 void gather_callbacks (AV *&callbacks, event_type event) const; 802 void gather_callbacks (AV *&callbacks, event_type event) const;
810 803
811 MTH static archetype *find (const_utf8_string name); 804 MTH static archetype *find (const_utf8_string name);
812 805
813 MTH void link (); 806 MTH void link ();
814 MTH void unlink (); 807 MTH void unlink ();
815 808
816 MTH static object *get (const char *name); // (find() || singularity)->instance() 809 MTH static object *get (const_utf8_string name); // (find() || singularity)->instance()
817 MTH object *instance (); 810 MTH object *instance ();
811
812 MTH void post_load_check (); // do some adjustments after parsing
818 813
819 object_vector_index ACC (RW, archid); // index in archvector 814 object_vector_index ACC (RW, archid); // index in archvector
820 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 815 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
821 816
822 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ 817 sint8 ACC (RW, max_x); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
823 sint8 ACC (RW, max_x), ACC (RW, max_y);
824 818
825 // support for archetype loading 819 // support for archetype loading
826 static archetype *read (object_thawer &f); 820 static archetype *read (object_thawer &f);
827 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more 821 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
828 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */ 822 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
829}; 823};
830 824
831// compatbiility, remove once replaced by ->instance 825// returns whether the object is a dragon player, which are often specialcased
832inline object * 826inline bool
833arch_to_object (archetype *at) 827object::is_dragon () const
834{ 828{
835 return at->instance (); 829 return arch->race == shstr_dragon && is_player ();
836} 830}
837 831
838inline void 832inline void
839object_freezer::put (keyword k, archetype *v) 833object_freezer::put (const keyword_string k, archetype *v)
840{ 834{
841 put (k, v ? &v->archname : (const char *)0); 835 if (expect_true (v))
836 put (k, v->archname);
837 else
838 put (k);
842} 839}
843 840
844typedef object_vector<object, &object::index > objectvec; 841typedef object_vector<object, &object::index > objectvec;
845typedef object_vector<object, &object::active> activevec; 842typedef object_vector<object, &object::active> activevec;
846typedef object_vector<archetype, &archetype::archid> archvec; 843typedef object_vector<archetype, &archetype::archid> archvec;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines