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.217 by root, Sun Nov 8 22:28:10 2009 UTC vs.
Revision 1.240 by root, Sun Apr 11 00:34:05 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 */
… …
93 86
94struct UUID 87struct UUID
95{ 88{
96 uint64 seq; 89 uint64 seq;
97 90
91 enum { MAX_LEN = 3 + 16 + 1 + 1 }; // <1. + hex + > + \0
92
98 static UUID cur; // last uuid generated 93 static UUID cur; // last uuid generated
99 static void init (); 94 static void init ();
100 static UUID gen (); 95 static UUID gen ();
101 96
102 UUID () { } 97 UUID () { }
103 UUID (uint64 seq) : seq(seq) { } 98 UUID (uint64 seq) : seq(seq) { }
104 operator uint64() { return seq; } 99 operator uint64() { return seq; }
105 void operator =(uint64 seq) { this->seq = seq; } 100 void operator =(uint64 seq) { this->seq = seq; }
106 101
107 typedef char BUF [32];
108
109 bool parse (const char *s) 102 bool parse (const char *s);
110 { 103 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 104 char *c_str () const;
122 {
123 static BUF buf;
124
125 return c_str (buf, sizeof (buf));
126 }
127}; 105};
128 106
129//+GPL 107//+GPL
130 108
131/* Definition for WILL_APPLY values. Replaces having harcoded values 109/* Definition for WILL_APPLY values. Replaces having harcoded values
… …
180 flags_t flag; /* various flags */ 158 flags_t flag; /* various flags */
181#if FOR_PERL 159#if FOR_PERL
182 bool ACC (RW, flag[NUM_FLAGS]); 160 bool ACC (RW, flag[NUM_FLAGS]);
183#endif 161#endif
184 162
185 shstr ACC (RW, materialname); /* specific material name */ 163 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 */ 164 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 */ 165 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 */ 166 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 */ 167 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 */ 168 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */
192 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 */
… …
301 shstr ACC (RW, lore); /* Obscure information about this object, */ 278 shstr ACC (RW, lore); /* Obscure information about this object, */
302 /* To get put into books and the like. */ 279 /* To get put into books and the like. */
303 shstr ACC (RW, custom_name); /* Custom name assigned by player */ 280 shstr ACC (RW, custom_name); /* Custom name assigned by player */
304}; 281};
305 282
306const char *query_weight (const object *op); 283const_utf8_string query_weight (const object *op);
307const char *query_short_name (const object *op); 284const_utf8_string query_short_name (const object *op);
308const char *query_name (const object *op); 285const_utf8_string query_name (const object *op);
309const 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);
310 297
311struct object : zero_initialised, object_copy 298struct object : zero_initialised, object_copy
312{ 299{
313 // These variables are not changed by ->copy_to 300 // These variables are not changed by ->copy_to
314 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 */
… …
334 */ 321 */
335 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */ 322 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */
336 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different 323 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different
337 key_value *key_values; /* Fields not explictly known by the loader. */ 324 key_value *key_values; /* Fields not explictly known by the loader. */
338 325
326 MTH void set_flag (int flagnum)
327 {
328 flag [flagnum] = true;
329 }
330
331 MTH void clr_flag (int flagnum)
332 {
333 flag [flagnum] = false;
334 }
335
339 // privates / perl 336 // privates / perl
340 shstr_tmp kv_get (shstr_tmp key) const; 337 shstr_tmp kv_get (shstr_tmp key) const;
341 void kv_del (shstr_tmp key); 338 void kv_del (shstr_tmp key);
342 void kv_set (shstr_tmp key, shstr_tmp value); 339 void kv_set (shstr_tmp key, shstr_tmp value);
343 340
… …
376 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all 373 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 374 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. 375 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
379 bool write (object_freezer &f); 376 bool write (object_freezer &f);
380 377
381 MTH int slottype () const;
382 MTH static object *create (); 378 MTH static object *create ();
383 const mapxy &operator =(const mapxy &pos); 379 const mapxy &operator =(const mapxy &pos);
384 MTH void copy_to (object *dst); 380 MTH void copy_to (object *dst);
385 MTH object *clone (); // create + copy_to a single object 381 MTH object *clone (); // create + copy_to a single object
386 MTH object *deep_clone (); // copy whole more chain and inventory 382 MTH object *deep_clone (); // copy whole more chain and inventory
… …
393 destroy (); 389 destroy ();
394 } 390 }
395 391
396 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 392 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
397 MTH void destroy_inv (bool drop_to_ground = false); 393 MTH void destroy_inv (bool drop_to_ground = false);
394 MTH void destroy_inv_fast (); // like destroy_inv (false), but only works when *this is destroyed, too
398 MTH object *insert (object *item); // insert into inventory 395 MTH object *insert (object *item); // insert into inventory
399 MTH void play_sound (faceidx sound) const; 396 MTH void play_sound (faceidx sound) const;
400 MTH void say_msg (const char *msg) const; 397 MTH void say_msg (const_utf8_string msg) const;
401 398
402 void do_remove (); 399 void do_remove ();
403 MTH void remove () 400 MTH void remove ()
404 { 401 {
405 if (!flag [FLAG_REMOVED]) 402 if (!flag [FLAG_REMOVED])
… …
413 remove (); 410 remove ();
414 *this = pos; 411 *this = pos;
415 insert_at (this, this); 412 insert_at (this, this);
416 } 413 }
417 414
418 // high-level move functions, return true if successful 415 // high-level move method.
416 // object op is trying to move in direction dir.
417 // originator is typically the same as op, but
418 // can be different if originator is causing op to
419 // move (originator is pushing op)
420 // returns 0 if the object is not able to move to the
421 // desired space, 1 otherwise (in which case we also
422 // move the object accordingly. This function is
423 // very similiar to move_object.
419 int move (int dir, object *originator); 424 int move (int dir, object *originator);
420 425
421 int move (int dir) 426 int move (int dir)
422 { 427 {
423 return move (dir, this); 428 return move (dir, this);
424 } 429 }
430
431 // changes move_type to a new value - handles move_on/move_off effects
432 MTH void change_move_type (MoveType mt);
425 433
426 static bool can_merge_slow (object *op1, object *op2); 434 static bool can_merge_slow (object *op1, object *op2);
427 435
428 // this is often used in time-critical code, so optimise 436 // this is often used in time-critical code, so optimise
429 MTH static bool can_merge (object *op1, object *op2) 437 MTH static bool can_merge (object *op1, object *op2)
… …
434 } 442 }
435 443
436 MTH void set_owner (object *owner); 444 MTH void set_owner (object *owner);
437 MTH void set_speed (float speed); 445 MTH void set_speed (float speed);
438 MTH void set_glow_radius (sint8 rad); 446 MTH void set_glow_radius (sint8 rad);
439 MTH bool change_weapon (object *ob);
440 MTH bool change_skill (object *ob);
441 447
442 MTH void open_container (object *new_container); 448 MTH void open_container (object *new_container);
443 MTH void close_container () 449 MTH void close_container ()
444 { 450 {
445 open_container (0); 451 open_container (0);
… …
484 MTH void drain_stat (); 490 MTH void drain_stat ();
485 MTH void drain_specific_stat (int deplete_stats); 491 MTH void drain_specific_stat (int deplete_stats);
486 MTH void change_luck (int value); 492 MTH void change_luck (int value);
487 493
488 // info must hold 256 * 3 bytes currently 494 // info must hold 256 * 3 bytes currently
489 const char *debug_desc (char *info) const; 495 const_utf8_string debug_desc (char *info) const;
490 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers 496 MTH const_utf8_string debug_desc () const; // uses at least 3 round-robin buffers
491 const char *flag_desc (char *desc, int len) const; 497 const_utf8_string flag_desc (char *desc, int len) const;
492 498
493 MTH bool decrease (sint32 nr = 1); // returns true if anything is left 499 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
494 MTH object *split (sint32 nr = 1); // return 0 on failure 500 MTH object *split (sint32 nr = 1); // return 0 on failure
495 501
496 MTH int number_of () const 502 MTH int number_of () const
… …
504 } 510 }
505 511
506 MTH void update_weight (); 512 MTH void update_weight ();
507 513
508 // return the dominant material of this item, always return something 514 // return the dominant material of this item, always return something
509 const materialtype_t *dominant_material () const; 515 const materialtype_t *dominant_material () const
516 {
517 return material;
518 }
510 519
511 // return the volume of this object in cm³ 520 // return the volume of this object in cm³
512 MTH uint64 volume () const 521 MTH uint64 volume () const
513 { 522 {
514 return (uint64)total_weight () 523 return (uint64)total_weight ()
515 * 1000 524 * 1024 // 1000 actually
516 * (type == CONTAINER ? 1000 : 1) 525 * (type == CONTAINER ? 128 : 1)
517 / dominant_material ()->density; 526 / dominant_material ()->density; // ugh, division
518 } 527 }
519 528
520 MTH bool is_arch () const { return this == (const object *)(const archetype *)arch; } 529 MTH bool is_arch () const { return this == (const object *)(const archetype *)arch; }
521 530
522 MTH bool is_wiz () const { return flag [FLAG_WIZ]; } 531 MTH bool is_wiz () const { return flag [FLAG_WIZ]; }
… …
531 MTH bool is_arrow () const { return type == ARROW 540 MTH bool is_arrow () const { return type == ARROW
532 || (type == SPELL_EFFECT 541 || (type == SPELL_EFFECT
533 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); } 542 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }
534 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; } 543 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; }
535 544
545 MTH bool is_dragon () const;
546
547 MTH bool is_immunity () const { return invisible && type == SIGN; }
548
536 MTH bool has_active_speed () const { return fabs (speed) >= MIN_ACTIVE_SPEED; } 549 MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; }
537 550
538 // temporary: wether the object can be saved in a map file 551 // temporary: wether the object can be saved in a map file
539 // contr => is a player 552 // contr => is a player
540 // head => only save head of a multitile object 553 // head => only save head of a multitile object
541 // owner => can not reference owner yet 554 // owner => can not reference owner yet
… …
611 MTH bool is_player () const 624 MTH bool is_player () const
612 { 625 {
613 return !!contr; 626 return !!contr;
614 } 627 }
615 628
629 /* elmex: this method checks whether the object is in a shop */
630 MTH bool is_in_shop () const;
631
616 MTH bool affects_los () const 632 MTH bool affects_los () const
617 { 633 {
618 return glow_radius || flag [FLAG_BLOCKSVIEW]; 634 return glow_radius || flag [FLAG_BLOCKSVIEW];
619 } 635 }
620 636
… …
629 MTH std::string long_desc (object *who = 0); // query_name . " " . describe 645 MTH std::string long_desc (object *who = 0); // query_name . " " . describe
630 MTH std::string describe_monster (object *who = 0); 646 MTH std::string describe_monster (object *who = 0);
631 MTH std::string describe_item (object *who = 0); 647 MTH std::string describe_item (object *who = 0);
632 MTH std::string describe (object *who = 0); // long description, without name 648 MTH std::string describe (object *who = 0); // long description, without name
633 649
634 MTH const char *query_weight () { return ::query_weight (this); } 650 MTH const_utf8_string query_weight () { return ::query_weight (this); }
635 MTH const char *query_name () { return ::query_name (this); } 651 MTH const_utf8_string query_name () { return ::query_name (this); }
636 MTH const char *query_short_name () { return ::query_short_name (this); } 652 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); } 653 MTH const_utf8_string query_base_name (bool plural) { return ::query_base_name (this, plural); }
638 654
639 // If this object has no extra parts but should have them, 655 // If this object has no extra parts but should have them,
640 // add them, effectively expanding heads into multipart 656 // add them, effectively expanding heads into multipart
641 // objects. This method only works on objects not inserted 657 // objects. This method only works on objects not inserted
642 // anywhere. 658 // anywhere.
… …
659 // set the given flag on all objects in the inventory recursively 675 // set the given flag on all objects in the inventory recursively
660 MTH void set_flag_inv (int flag, int value = 1); 676 MTH void set_flag_inv (int flag, int value = 1);
661 677
662 void enter_exit (object *exit);//Perl 678 void enter_exit (object *exit);//Perl
663 MTH void enter_map (maptile *newmap, int x, int y); 679 MTH void enter_map (maptile *newmap, int x, int y);
664 void player_goto (const char *path, int x, int y); // only for players 680 void player_goto (const_utf8_string path, int x, int y); // only for players
681 MTH bool apply (object *ob, int aflags = AP_APPLY); // ob may be 0
665 682
666 // returns the mapspace this object is in 683 // returns the mapspace this object is in
667 mapspace &ms () const; 684 mapspace &ms () const;
668 685
669 // fully recursive iterator 686 // fully recursive iterator
… …
720 return weight + carrying; 737 return weight + carrying;
721 } 738 }
722 739
723 MTH struct region *region () const; 740 MTH struct region *region () const;
724 741
725 void statusmsg (const char *msg, int color = NDI_BLACK); 742 void statusmsg (const_utf8_string msg, int color = NDI_BLACK);
726 void failmsg (const char *msg, int color = NDI_RED); 743 void failmsg (const_utf8_string msg, int color = NDI_RED);
744 void failmsgf (const_utf8_string format, ...); // always NDI_RED...
727 745
728 const char *query_inventory (object *who = 0, const char *indent = ""); 746 const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = "");
729 747
730 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference 748 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 749 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
732 750
733 // make some noise with given item into direction dir, 751 // make some noise with given item into direction dir,
… …
746 * range from 0 through 7. 764 * range from 0 through 7.
747 */ 765 */
748 MTH int anim_frames () const { return anim ().num_animations; } 766 MTH int anim_frames () const { return anim ().num_animations; }
749 MTH int anim_facings () const { return anim ().facings; } 767 MTH int anim_facings () const { return anim ().facings; }
750 768
751 MTH char *as_string (); 769 MTH utf8_string as_string ();
752 770
753protected: 771protected:
754 void link (); 772 void link ();
755 void unlink (); 773 void unlink ();
756 774
… …
781 return ob; 799 return ob;
782} 800}
783 801
784//+GPL 802//+GPL
785 803
786object *find_skill_by_name_fuzzy (object *who, const char *name); 804object *find_skill_by_name_fuzzy (object *who, const_utf8_string name);
787object *find_skill_by_name (object *who, shstr_cmp sh); 805object *find_skill_by_name (object *who, shstr_cmp sh);
788object *find_skill_by_number (object *who, int skillno); 806object *find_skill_by_number (object *who, int skillno);
789 807
790/* 808/*
791 * The archetype structure is a set of rules on how to generate and manipulate 809 * The archetype structure is a set of rules on how to generate and manipulate
… …
802struct archetype : object 820struct archetype : object
803{ 821{
804 static arch_ptr empty; // the empty_archetype 822 static arch_ptr empty; // the empty_archetype
805 MTH static void gc (); 823 MTH static void gc ();
806 824
807 archetype (const char *name); 825 archetype (const_utf8_string name);
808 ~archetype (); 826 ~archetype ();
809 void gather_callbacks (AV *&callbacks, event_type event) const; 827 void gather_callbacks (AV *&callbacks, event_type event) const;
810 828
811 MTH static archetype *find (const_utf8_string name); 829 MTH static archetype *find (const_utf8_string name);
812 830
813 MTH void link (); 831 MTH void link ();
814 MTH void unlink (); 832 MTH void unlink ();
815 833
816 MTH static object *get (const char *name); // (find() || singularity)->instance() 834 MTH static object *get (const_utf8_string name); // (find() || singularity)->instance()
817 MTH object *instance (); 835 MTH object *instance ();
818 836
819 MTH void post_load_check (); // do some adjustments after parsing 837 MTH void post_load_check (); // do some adjustments after parsing
820 838
821 object_vector_index ACC (RW, archid); // index in archvector 839 object_vector_index ACC (RW, archid); // index in archvector
822 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 840 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
823 841
824 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ 842 sint8 ACC (RW, max_x); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
825 sint8 ACC (RW, max_x), ACC (RW, max_y);
826 843
827 // support for archetype loading 844 // support for archetype loading
828 static archetype *read (object_thawer &f); 845 static archetype *read (object_thawer &f);
829 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more 846 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
830 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */ 847 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
831}; 848};
832 849
833// compatbiility, remove once replaced by ->instance 850// returns whether the object is a dragon player, which are often specialcased
834inline object * 851inline bool
835arch_to_object (archetype *at) 852object::is_dragon () const
836{ 853{
837 return at->instance (); 854 return arch->race == shstr_dragon && is_player ();
838} 855}
839 856
840inline void 857inline void
841object_freezer::put (keyword k, archetype *v) 858object_freezer::put (const keyword_string k, archetype *v)
842{ 859{
843 put (k, v ? &v->archname : (const char *)0); 860 if (expect_true (v))
861 put (k, v->archname);
862 else
863 put (k);
844} 864}
845 865
846typedef object_vector<object, &object::index > objectvec; 866typedef object_vector<object, &object::index > objectvec;
847typedef object_vector<object, &object::active> activevec; 867typedef object_vector<object, &object::active> activevec;
848typedef object_vector<archetype, &archetype::archid> archvec; 868typedef object_vector<archetype, &archetype::archid> archvec;

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines