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.218 by root, Mon Nov 9 03:08:24 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 */
165 flags_t flag; /* various flags */ 159 flags_t flag; /* various flags */
166#if FOR_PERL 160#if FOR_PERL
167 bool ACC (RW, flag[NUM_FLAGS]); 161 bool ACC (RW, flag[NUM_FLAGS]);
168#endif 162#endif
169 163
170 shstr ACC (RW, materialname); /* specific material name */ 164 materialtype_t *material; // What material this object consists of //TODO, make perl-accessible
171 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 */
172// materialtype_t *ACC (RW, material); /* What material this object consists of */
173 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 */
174 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 */
175 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 */
176 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */ 169 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */
177 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 */
286 shstr ACC (RW, lore); /* Obscure information about this object, */ 279 shstr ACC (RW, lore); /* Obscure information about this object, */
287 /* To get put into books and the like. */ 280 /* To get put into books and the like. */
288 shstr ACC (RW, custom_name); /* Custom name assigned by player */ 281 shstr ACC (RW, custom_name); /* Custom name assigned by player */
289}; 282};
290 283
291const char *query_weight (const object *op); 284const_utf8_string query_weight (const object *op);
292const char *query_short_name (const object *op); 285const_utf8_string query_short_name (const object *op);
293const char *query_name (const object *op); 286const_utf8_string query_name (const object *op);
294const char *query_base_name (const object *op, int plural); 287const_utf8_string query_base_name (const object *op, int plural);
295 288
296struct object : zero_initialised, object_copy 289struct object : zero_initialised, object_copy
297{ 290{
298 // These variables are not changed by ->copy_to 291 // These variables are not changed by ->copy_to
299 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 */
361 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
362 MTH void post_load_check (); // do some adjustments after parsing 355 MTH void post_load_check (); // do some adjustments after parsing
363 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.
364 bool write (object_freezer &f); 357 bool write (object_freezer &f);
365 358
366 MTH int slottype () const;
367 MTH static object *create (); 359 MTH static object *create ();
368 const mapxy &operator =(const mapxy &pos); 360 const mapxy &operator =(const mapxy &pos);
369 MTH void copy_to (object *dst); 361 MTH void copy_to (object *dst);
370 MTH object *clone (); // create + copy_to a single object 362 MTH object *clone (); // create + copy_to a single object
371 MTH object *deep_clone (); // copy whole more chain and inventory 363 MTH object *deep_clone (); // copy whole more chain and inventory
380 372
381 // 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
382 MTH void destroy_inv (bool drop_to_ground = false); 374 MTH void destroy_inv (bool drop_to_ground = false);
383 MTH object *insert (object *item); // insert into inventory 375 MTH object *insert (object *item); // insert into inventory
384 MTH void play_sound (faceidx sound) const; 376 MTH void play_sound (faceidx sound) const;
385 MTH void say_msg (const char *msg) const; 377 MTH void say_msg (const_utf8_string msg) const;
386 378
387 void do_remove (); 379 void do_remove ();
388 MTH void remove () 380 MTH void remove ()
389 { 381 {
390 if (!flag [FLAG_REMOVED]) 382 if (!flag [FLAG_REMOVED])
398 remove (); 390 remove ();
399 *this = pos; 391 *this = pos;
400 insert_at (this, this); 392 insert_at (this, this);
401 } 393 }
402 394
403 // 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.
404 int move (int dir, object *originator); 404 int move (int dir, object *originator);
405 405
406 int move (int dir) 406 int move (int dir)
407 { 407 {
408 return move (dir, this); 408 return move (dir, this);
409 } 409 }
410
411 // changes move_type to a new value - handles move_on/move_off effects
412 MTH void change_move_type (MoveType mt);
410 413
411 static bool can_merge_slow (object *op1, object *op2); 414 static bool can_merge_slow (object *op1, object *op2);
412 415
413 // this is often used in time-critical code, so optimise 416 // this is often used in time-critical code, so optimise
414 MTH static bool can_merge (object *op1, object *op2) 417 MTH static bool can_merge (object *op1, object *op2)
419 } 422 }
420 423
421 MTH void set_owner (object *owner); 424 MTH void set_owner (object *owner);
422 MTH void set_speed (float speed); 425 MTH void set_speed (float speed);
423 MTH void set_glow_radius (sint8 rad); 426 MTH void set_glow_radius (sint8 rad);
424 MTH bool change_weapon (object *ob);
425 MTH bool change_skill (object *ob); 427 MTH bool change_skill (object *ob); // deprecated?
426 428
427 MTH void open_container (object *new_container); 429 MTH void open_container (object *new_container);
428 MTH void close_container () 430 MTH void close_container ()
429 { 431 {
430 open_container (0); 432 open_container (0);
469 MTH void drain_stat (); 471 MTH void drain_stat ();
470 MTH void drain_specific_stat (int deplete_stats); 472 MTH void drain_specific_stat (int deplete_stats);
471 MTH void change_luck (int value); 473 MTH void change_luck (int value);
472 474
473 // info must hold 256 * 3 bytes currently 475 // info must hold 256 * 3 bytes currently
474 const char *debug_desc (char *info) const; 476 const_utf8_string debug_desc (char *info) const;
475 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
476 const char *flag_desc (char *desc, int len) const; 478 const_utf8_string flag_desc (char *desc, int len) const;
477 479
478 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
479 MTH object *split (sint32 nr = 1); // return 0 on failure 481 MTH object *split (sint32 nr = 1); // return 0 on failure
480 482
481 MTH int number_of () const 483 MTH int number_of () const
489 } 491 }
490 492
491 MTH void update_weight (); 493 MTH void update_weight ();
492 494
493 // return the dominant material of this item, always return something 495 // return the dominant material of this item, always return something
494 const materialtype_t *dominant_material () const; 496 const materialtype_t *dominant_material () const
497 {
498 return material;
499 }
495 500
496 // return the volume of this object in cm³ 501 // return the volume of this object in cm³
497 MTH uint64 volume () const 502 MTH uint64 volume () const
498 { 503 {
499 return (uint64)total_weight () 504 return (uint64)total_weight ()
500 * 1000 505 * 1024 // 1000 actually
501 * (type == CONTAINER ? 1000 : 1) 506 * (type == CONTAINER ? 128 : 1)
502 / dominant_material ()->density; 507 / dominant_material ()->density; // ugh, division
503 } 508 }
504 509
505 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; }
506 511
507 MTH bool is_wiz () const { return flag [FLAG_WIZ]; } 512 MTH bool is_wiz () const { return flag [FLAG_WIZ]; }
516 MTH bool is_arrow () const { return type == ARROW 521 MTH bool is_arrow () const { return type == ARROW
517 || (type == SPELL_EFFECT 522 || (type == SPELL_EFFECT
518 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); } 523 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }
519 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; }
520 525
526 MTH bool is_dragon () const;
527
521 MTH bool has_active_speed () const { return fabs (speed) >= MIN_ACTIVE_SPEED; } 528 MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; }
522 529
523 // temporary: wether the object can be saved in a map file 530 // temporary: wether the object can be saved in a map file
524 // contr => is a player 531 // contr => is a player
525 // head => only save head of a multitile object 532 // head => only save head of a multitile object
526 // owner => can not reference owner yet 533 // owner => can not reference owner yet
614 MTH std::string long_desc (object *who = 0); // query_name . " " . describe 621 MTH std::string long_desc (object *who = 0); // query_name . " " . describe
615 MTH std::string describe_monster (object *who = 0); 622 MTH std::string describe_monster (object *who = 0);
616 MTH std::string describe_item (object *who = 0); 623 MTH std::string describe_item (object *who = 0);
617 MTH std::string describe (object *who = 0); // long description, without name 624 MTH std::string describe (object *who = 0); // long description, without name
618 625
619 MTH const char *query_weight () { return ::query_weight (this); } 626 MTH const_utf8_string query_weight () { return ::query_weight (this); }
620 MTH const char *query_name () { return ::query_name (this); } 627 MTH const_utf8_string query_name () { return ::query_name (this); }
621 MTH const char *query_short_name () { return ::query_short_name (this); } 628 MTH const_utf8_string query_short_name () { return ::query_short_name (this); }
622 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); }
623 630
624 // If this object has no extra parts but should have them, 631 // If this object has no extra parts but should have them,
625 // add them, effectively expanding heads into multipart 632 // add them, effectively expanding heads into multipart
626 // objects. This method only works on objects not inserted 633 // objects. This method only works on objects not inserted
627 // anywhere. 634 // anywhere.
644 // set the given flag on all objects in the inventory recursively 651 // set the given flag on all objects in the inventory recursively
645 MTH void set_flag_inv (int flag, int value = 1); 652 MTH void set_flag_inv (int flag, int value = 1);
646 653
647 void enter_exit (object *exit);//Perl 654 void enter_exit (object *exit);//Perl
648 MTH void enter_map (maptile *newmap, int x, int y); 655 MTH void enter_map (maptile *newmap, int x, int y);
649 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
650 658
651 // returns the mapspace this object is in 659 // returns the mapspace this object is in
652 mapspace &ms () const; 660 mapspace &ms () const;
653 661
654 // fully recursive iterator 662 // fully recursive iterator
705 return weight + carrying; 713 return weight + carrying;
706 } 714 }
707 715
708 MTH struct region *region () const; 716 MTH struct region *region () const;
709 717
710 void statusmsg (const char *msg, int color = NDI_BLACK); 718 void statusmsg (const_utf8_string msg, int color = NDI_BLACK);
711 void failmsg (const char *msg, int color = NDI_RED); 719 void failmsg (const_utf8_string msg, int color = NDI_RED);
712 720
713 const char *query_inventory (object *who = 0, const char *indent = ""); 721 const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = "");
714 722
715 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
716 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
717 725
718 // make some noise with given item into direction dir, 726 // make some noise with given item into direction dir,
731 * range from 0 through 7. 739 * range from 0 through 7.
732 */ 740 */
733 MTH int anim_frames () const { return anim ().num_animations; } 741 MTH int anim_frames () const { return anim ().num_animations; }
734 MTH int anim_facings () const { return anim ().facings; } 742 MTH int anim_facings () const { return anim ().facings; }
735 743
736 MTH char *as_string (); 744 MTH utf8_string as_string ();
737 745
738protected: 746protected:
739 void link (); 747 void link ();
740 void unlink (); 748 void unlink ();
741 749
766 return ob; 774 return ob;
767} 775}
768 776
769//+GPL 777//+GPL
770 778
771object *find_skill_by_name_fuzzy (object *who, const char *name); 779object *find_skill_by_name_fuzzy (object *who, const_utf8_string name);
772object *find_skill_by_name (object *who, shstr_cmp sh); 780object *find_skill_by_name (object *who, shstr_cmp sh);
773object *find_skill_by_number (object *who, int skillno); 781object *find_skill_by_number (object *who, int skillno);
774 782
775/* 783/*
776 * 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
787struct archetype : object 795struct archetype : object
788{ 796{
789 static arch_ptr empty; // the empty_archetype 797 static arch_ptr empty; // the empty_archetype
790 MTH static void gc (); 798 MTH static void gc ();
791 799
792 archetype (const char *name); 800 archetype (const_utf8_string name);
793 ~archetype (); 801 ~archetype ();
794 void gather_callbacks (AV *&callbacks, event_type event) const; 802 void gather_callbacks (AV *&callbacks, event_type event) const;
795 803
796 MTH static archetype *find (const_utf8_string name); 804 MTH static archetype *find (const_utf8_string name);
797 805
798 MTH void link (); 806 MTH void link ();
799 MTH void unlink (); 807 MTH void unlink ();
800 808
801 MTH static object *get (const char *name); // (find() || singularity)->instance() 809 MTH static object *get (const_utf8_string name); // (find() || singularity)->instance()
802 MTH object *instance (); 810 MTH object *instance ();
803 811
804 MTH void post_load_check (); // do some adjustments after parsing 812 MTH void post_load_check (); // do some adjustments after parsing
805 813
806 object_vector_index ACC (RW, archid); // index in archvector 814 object_vector_index ACC (RW, archid); // index in archvector
807 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 815 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
808 816
809 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...) */
810 sint8 ACC (RW, max_x), ACC (RW, max_y);
811 818
812 // support for archetype loading 819 // support for archetype loading
813 static archetype *read (object_thawer &f); 820 static archetype *read (object_thawer &f);
814 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
815 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 */
816}; 823};
817 824
818// compatbiility, remove once replaced by ->instance 825// returns whether the object is a dragon player, which are often specialcased
819inline object * 826inline bool
820arch_to_object (archetype *at) 827object::is_dragon () const
821{ 828{
822 return at->instance (); 829 return arch->race == shstr_dragon && is_player ();
823} 830}
824 831
825inline void 832inline void
826object_freezer::put (keyword k, archetype *v) 833object_freezer::put (const keyword_string k, archetype *v)
827{ 834{
828 put (k, v ? &v->archname : (const char *)0); 835 if (expect_true (v))
836 put (k, v->archname);
837 else
838 put (k);
829} 839}
830 840
831typedef object_vector<object, &object::index > objectvec; 841typedef object_vector<object, &object::index > objectvec;
832typedef object_vector<object, &object::active> activevec; 842typedef object_vector<object, &object::active> activevec;
833typedef object_vector<archetype, &archetype::archid> archvec; 843typedef object_vector<archetype, &archetype::archid> archvec;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines