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.235 by root, Tue Apr 6 21:11:48 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.
23 */ 23 */
24 24
25#ifndef OBJECT_H 25#ifndef OBJECT_H
26#define OBJECT_H 26#define OBJECT_H
27 27
28#include <bitset>
29
30#include "cfperl.h" 28#include "cfperl.h"
31#include "shstr.h" 29#include "shstr.h"
32 30
33//+GPL 31//+GPL
34 32
35typedef int tag_t; 33typedef int tag_t;
36 34
35// also see common/item.C
37enum { 36enum
37{
38 body_skill, 38 body_skill,
39 body_combat, 39 body_combat,
40 body_range, 40 body_range,
41 body_shield, 41 body_shield,
42 body_arm, 42 body_arm,
50 body_wrist, 50 body_wrist,
51 body_waist, 51 body_waist,
52 NUM_BODY_LOCATIONS 52 NUM_BODY_LOCATIONS
53}; 53};
54 54
55enum slottype_t
56{
57 slot_none,
58 slot_combat,
59 slot_ranged,
60};
61
62/* See common/item.c */ 55/* See common/item.c */
63 56
64typedef struct Body_Locations 57typedef struct Body_Locations
65{ 58{
66 keyword save_name; /* Name used to load/save it to disk */ 59 keyword save_name; /* Name used to load/save it to disk */
165 flags_t flag; /* various flags */ 158 flags_t flag; /* various flags */
166#if FOR_PERL 159#if FOR_PERL
167 bool ACC (RW, flag[NUM_FLAGS]); 160 bool ACC (RW, flag[NUM_FLAGS]);
168#endif 161#endif
169 162
170 shstr ACC (RW, materialname); /* specific material name */ 163 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 */ 164 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 */ 165 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 */ 166 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 */ 167 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 */ 168 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */
177 object_ptr ACC (RW, spellitem); /* Spell ability monster is choosing to use */ 169 object_ptr ACC (RW, spellitem); /* Spell ability monster is choosing to use */
286 shstr ACC (RW, lore); /* Obscure information about this object, */ 278 shstr ACC (RW, lore); /* Obscure information about this object, */
287 /* To get put into books and the like. */ 279 /* To get put into books and the like. */
288 shstr ACC (RW, custom_name); /* Custom name assigned by player */ 280 shstr ACC (RW, custom_name); /* Custom name assigned by player */
289}; 281};
290 282
291const char *query_weight (const object *op); 283const_utf8_string query_weight (const object *op);
292const char *query_short_name (const object *op); 284const_utf8_string query_short_name (const object *op);
293const char *query_name (const object *op); 285const_utf8_string query_name (const object *op);
294const char *query_base_name (const object *op, int plural); 286const_utf8_string query_base_name (const object *op, int plural);
287sint64 query_cost (const object *tmp, object *who, int flag);
288const char *query_cost_string (const object *tmp, object *who, int flag);
289
290int change_ability_duration (object *spell, object *caster);
291int min_casting_level (object *caster, object *spell);
292int casting_level (object *caster, object *spell);
293sint16 SP_level_spellpoint_cost (object *caster, object *spell, int flags);
294int SP_level_dam_adjust (object *caster, object *spob);
295int SP_level_duration_adjust (object *caster, object *spob);
296int SP_level_range_adjust (object *caster, object *spob);
295 297
296struct object : zero_initialised, object_copy 298struct object : zero_initialised, object_copy
297{ 299{
298 // These variables are not changed by ->copy_to 300 // These variables are not changed by ->copy_to
299 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */ 301 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 363 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 364 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. 365 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
364 bool write (object_freezer &f); 366 bool write (object_freezer &f);
365 367
366 MTH int slottype () const;
367 MTH static object *create (); 368 MTH static object *create ();
368 const mapxy &operator =(const mapxy &pos); 369 const mapxy &operator =(const mapxy &pos);
369 MTH void copy_to (object *dst); 370 MTH void copy_to (object *dst);
370 MTH object *clone (); // create + copy_to a single object 371 MTH object *clone (); // create + copy_to a single object
371 MTH object *deep_clone (); // copy whole more chain and inventory 372 MTH object *deep_clone (); // copy whole more chain and inventory
380 381
381 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 382 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
382 MTH void destroy_inv (bool drop_to_ground = false); 383 MTH void destroy_inv (bool drop_to_ground = false);
383 MTH object *insert (object *item); // insert into inventory 384 MTH object *insert (object *item); // insert into inventory
384 MTH void play_sound (faceidx sound) const; 385 MTH void play_sound (faceidx sound) const;
385 MTH void say_msg (const char *msg) const; 386 MTH void say_msg (const_utf8_string msg) const;
386 387
387 void do_remove (); 388 void do_remove ();
388 MTH void remove () 389 MTH void remove ()
389 { 390 {
390 if (!flag [FLAG_REMOVED]) 391 if (!flag [FLAG_REMOVED])
398 remove (); 399 remove ();
399 *this = pos; 400 *this = pos;
400 insert_at (this, this); 401 insert_at (this, this);
401 } 402 }
402 403
403 // high-level move functions, return true if successful 404 // high-level move method.
405 // object op is trying to move in direction dir.
406 // originator is typically the same as op, but
407 // can be different if originator is causing op to
408 // move (originator is pushing op)
409 // returns 0 if the object is not able to move to the
410 // desired space, 1 otherwise (in which case we also
411 // move the object accordingly. This function is
412 // very similiar to move_object.
404 int move (int dir, object *originator); 413 int move (int dir, object *originator);
405 414
406 int move (int dir) 415 int move (int dir)
407 { 416 {
408 return move (dir, this); 417 return move (dir, this);
409 } 418 }
419
420 // changes move_type to a new value - handles move_on/move_off effects
421 MTH void change_move_type (MoveType mt);
410 422
411 static bool can_merge_slow (object *op1, object *op2); 423 static bool can_merge_slow (object *op1, object *op2);
412 424
413 // this is often used in time-critical code, so optimise 425 // this is often used in time-critical code, so optimise
414 MTH static bool can_merge (object *op1, object *op2) 426 MTH static bool can_merge (object *op1, object *op2)
419 } 431 }
420 432
421 MTH void set_owner (object *owner); 433 MTH void set_owner (object *owner);
422 MTH void set_speed (float speed); 434 MTH void set_speed (float speed);
423 MTH void set_glow_radius (sint8 rad); 435 MTH void set_glow_radius (sint8 rad);
424 MTH bool change_weapon (object *ob);
425 MTH bool change_skill (object *ob); 436 MTH bool change_skill (object *ob); // deprecated?
426 437
427 MTH void open_container (object *new_container); 438 MTH void open_container (object *new_container);
428 MTH void close_container () 439 MTH void close_container ()
429 { 440 {
430 open_container (0); 441 open_container (0);
469 MTH void drain_stat (); 480 MTH void drain_stat ();
470 MTH void drain_specific_stat (int deplete_stats); 481 MTH void drain_specific_stat (int deplete_stats);
471 MTH void change_luck (int value); 482 MTH void change_luck (int value);
472 483
473 // info must hold 256 * 3 bytes currently 484 // info must hold 256 * 3 bytes currently
474 const char *debug_desc (char *info) const; 485 const_utf8_string debug_desc (char *info) const;
475 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers 486 MTH const_utf8_string debug_desc () const; // uses at least 3 round-robin buffers
476 const char *flag_desc (char *desc, int len) const; 487 const_utf8_string flag_desc (char *desc, int len) const;
477 488
478 MTH bool decrease (sint32 nr = 1); // returns true if anything is left 489 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
479 MTH object *split (sint32 nr = 1); // return 0 on failure 490 MTH object *split (sint32 nr = 1); // return 0 on failure
480 491
481 MTH int number_of () const 492 MTH int number_of () const
489 } 500 }
490 501
491 MTH void update_weight (); 502 MTH void update_weight ();
492 503
493 // return the dominant material of this item, always return something 504 // return the dominant material of this item, always return something
494 const materialtype_t *dominant_material () const; 505 const materialtype_t *dominant_material () const
506 {
507 return material;
508 }
495 509
496 // return the volume of this object in cm³ 510 // return the volume of this object in cm³
497 MTH uint64 volume () const 511 MTH uint64 volume () const
498 { 512 {
499 return (uint64)total_weight () 513 return (uint64)total_weight ()
500 * 1000 514 * 1024 // 1000 actually
501 * (type == CONTAINER ? 1000 : 1) 515 * (type == CONTAINER ? 128 : 1)
502 / dominant_material ()->density; 516 / dominant_material ()->density; // ugh, division
503 } 517 }
504 518
505 MTH bool is_arch () const { return this == (const object *)(const archetype *)arch; } 519 MTH bool is_arch () const { return this == (const object *)(const archetype *)arch; }
506 520
507 MTH bool is_wiz () const { return flag [FLAG_WIZ]; } 521 MTH bool is_wiz () const { return flag [FLAG_WIZ]; }
516 MTH bool is_arrow () const { return type == ARROW 530 MTH bool is_arrow () const { return type == ARROW
517 || (type == SPELL_EFFECT 531 || (type == SPELL_EFFECT
518 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); } 532 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }
519 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; } 533 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; }
520 534
535 MTH bool is_dragon () const;
536
521 MTH bool has_active_speed () const { return fabs (speed) >= MIN_ACTIVE_SPEED; } 537 MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; }
522 538
523 // temporary: wether the object can be saved in a map file 539 // temporary: wether the object can be saved in a map file
524 // contr => is a player 540 // contr => is a player
525 // head => only save head of a multitile object 541 // head => only save head of a multitile object
526 // owner => can not reference owner yet 542 // owner => can not reference owner yet
596 MTH bool is_player () const 612 MTH bool is_player () const
597 { 613 {
598 return !!contr; 614 return !!contr;
599 } 615 }
600 616
617 /* elmex: this method checks whether the object is in a shop */
618 MTH bool is_in_shop () const;
619
601 MTH bool affects_los () const 620 MTH bool affects_los () const
602 { 621 {
603 return glow_radius || flag [FLAG_BLOCKSVIEW]; 622 return glow_radius || flag [FLAG_BLOCKSVIEW];
604 } 623 }
605 624
614 MTH std::string long_desc (object *who = 0); // query_name . " " . describe 633 MTH std::string long_desc (object *who = 0); // query_name . " " . describe
615 MTH std::string describe_monster (object *who = 0); 634 MTH std::string describe_monster (object *who = 0);
616 MTH std::string describe_item (object *who = 0); 635 MTH std::string describe_item (object *who = 0);
617 MTH std::string describe (object *who = 0); // long description, without name 636 MTH std::string describe (object *who = 0); // long description, without name
618 637
619 MTH const char *query_weight () { return ::query_weight (this); } 638 MTH const_utf8_string query_weight () { return ::query_weight (this); }
620 MTH const char *query_name () { return ::query_name (this); } 639 MTH const_utf8_string query_name () { return ::query_name (this); }
621 MTH const char *query_short_name () { return ::query_short_name (this); } 640 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); } 641 MTH const_utf8_string query_base_name (bool plural) { return ::query_base_name (this, plural); }
623 642
624 // If this object has no extra parts but should have them, 643 // If this object has no extra parts but should have them,
625 // add them, effectively expanding heads into multipart 644 // add them, effectively expanding heads into multipart
626 // objects. This method only works on objects not inserted 645 // objects. This method only works on objects not inserted
627 // anywhere. 646 // anywhere.
644 // set the given flag on all objects in the inventory recursively 663 // set the given flag on all objects in the inventory recursively
645 MTH void set_flag_inv (int flag, int value = 1); 664 MTH void set_flag_inv (int flag, int value = 1);
646 665
647 void enter_exit (object *exit);//Perl 666 void enter_exit (object *exit);//Perl
648 MTH void enter_map (maptile *newmap, int x, int y); 667 MTH void enter_map (maptile *newmap, int x, int y);
649 void player_goto (const char *path, int x, int y); // only for players 668 void player_goto (const_utf8_string path, int x, int y); // only for players
669 MTH bool apply (object *ob, int aflags = AP_APPLY); // ob may be 0
650 670
651 // returns the mapspace this object is in 671 // returns the mapspace this object is in
652 mapspace &ms () const; 672 mapspace &ms () const;
653 673
654 // fully recursive iterator 674 // fully recursive iterator
705 return weight + carrying; 725 return weight + carrying;
706 } 726 }
707 727
708 MTH struct region *region () const; 728 MTH struct region *region () const;
709 729
710 void statusmsg (const char *msg, int color = NDI_BLACK); 730 void statusmsg (const_utf8_string msg, int color = NDI_BLACK);
711 void failmsg (const char *msg, int color = NDI_RED); 731 void failmsg (const_utf8_string msg, int color = NDI_RED);
712 732
713 const char *query_inventory (object *who = 0, const char *indent = ""); 733 const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = "");
714 734
715 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference 735 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 736 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
717 737
718 // make some noise with given item into direction dir, 738 // make some noise with given item into direction dir,
731 * range from 0 through 7. 751 * range from 0 through 7.
732 */ 752 */
733 MTH int anim_frames () const { return anim ().num_animations; } 753 MTH int anim_frames () const { return anim ().num_animations; }
734 MTH int anim_facings () const { return anim ().facings; } 754 MTH int anim_facings () const { return anim ().facings; }
735 755
736 MTH char *as_string (); 756 MTH utf8_string as_string ();
737 757
738protected: 758protected:
739 void link (); 759 void link ();
740 void unlink (); 760 void unlink ();
741 761
766 return ob; 786 return ob;
767} 787}
768 788
769//+GPL 789//+GPL
770 790
771object *find_skill_by_name_fuzzy (object *who, const char *name); 791object *find_skill_by_name_fuzzy (object *who, const_utf8_string name);
772object *find_skill_by_name (object *who, shstr_cmp sh); 792object *find_skill_by_name (object *who, shstr_cmp sh);
773object *find_skill_by_number (object *who, int skillno); 793object *find_skill_by_number (object *who, int skillno);
774 794
775/* 795/*
776 * The archetype structure is a set of rules on how to generate and manipulate 796 * The archetype structure is a set of rules on how to generate and manipulate
787struct archetype : object 807struct archetype : object
788{ 808{
789 static arch_ptr empty; // the empty_archetype 809 static arch_ptr empty; // the empty_archetype
790 MTH static void gc (); 810 MTH static void gc ();
791 811
792 archetype (const char *name); 812 archetype (const_utf8_string name);
793 ~archetype (); 813 ~archetype ();
794 void gather_callbacks (AV *&callbacks, event_type event) const; 814 void gather_callbacks (AV *&callbacks, event_type event) const;
795 815
796 MTH static archetype *find (const_utf8_string name); 816 MTH static archetype *find (const_utf8_string name);
797 817
798 MTH void link (); 818 MTH void link ();
799 MTH void unlink (); 819 MTH void unlink ();
800 820
801 MTH static object *get (const char *name); // (find() || singularity)->instance() 821 MTH static object *get (const_utf8_string name); // (find() || singularity)->instance()
802 MTH object *instance (); 822 MTH object *instance ();
803 823
804 MTH void post_load_check (); // do some adjustments after parsing 824 MTH void post_load_check (); // do some adjustments after parsing
805 825
806 object_vector_index ACC (RW, archid); // index in archvector 826 object_vector_index ACC (RW, archid); // index in archvector
807 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 827 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
808 828
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...) */ 829 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 830
812 // support for archetype loading 831 // support for archetype loading
813 static archetype *read (object_thawer &f); 832 static archetype *read (object_thawer &f);
814 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more 833 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 */ 834 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
816}; 835};
817 836
818// compatbiility, remove once replaced by ->instance 837// returns whether the object is a dragon player, which are often specialcased
819inline object * 838inline bool
820arch_to_object (archetype *at) 839object::is_dragon () const
821{ 840{
822 return at->instance (); 841 return arch->race == shstr_dragon && is_player ();
823} 842}
824 843
825inline void 844inline void
826object_freezer::put (keyword k, archetype *v) 845object_freezer::put (const keyword_string k, archetype *v)
827{ 846{
828 put (k, v ? &v->archname : (const char *)0); 847 if (expect_true (v))
848 put (k, v->archname);
849 else
850 put (k);
829} 851}
830 852
831typedef object_vector<object, &object::index > objectvec; 853typedef object_vector<object, &object::index > objectvec;
832typedef object_vector<object, &object::active> activevec; 854typedef object_vector<object, &object::active> activevec;
833typedef object_vector<archetype, &archetype::archid> archvec; 855typedef object_vector<archetype, &archetype::archid> archvec;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines