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.236 by root, Wed Apr 7 19:54:45 2010 UTC vs.
Revision 1.263 by root, Mon Oct 29 23:55:53 2012 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,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team 4 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (©) 2001 Mark Wedel & Crossfire Development Team 5 * Copyright (©) 2001 Mark Wedel & Crossfire Development Team
6 * Copyright (©) 1992 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.
12 * 12 *
13 * This program is distributed in the hope that it will be useful, 13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details. 16 * GNU General Public License for more details.
17 * 17 *
18 * You should have received a copy of the Affero GNU General Public License 18 * You should have received a copy of the Affero GNU General Public License
19 * and the GNU General Public License along with this program. If not, see 19 * and the GNU General Public License along with this program. If not, see
20 * <http://www.gnu.org/licenses/>. 20 * <http://www.gnu.org/licenses/>.
21 * 21 *
22 * The authors can be reached via e-mail to <support@deliantra.net> 22 * The authors can be reached via e-mail to <support@deliantra.net>
23 */ 23 */
24 24
25#ifndef OBJECT_H 25#ifndef OBJECT_H
26#define OBJECT_H 26#define OBJECT_H
… …
33typedef int tag_t; 33typedef int tag_t;
34 34
35// also see common/item.C 35// also see common/item.C
36enum 36enum
37{ 37{
38 body_skill, 38# define def(name, use, nonuse) body_ ## name,
39 body_combat, 39# include "slotinc.h"
40 body_range, 40# undef def
41 body_shield,
42 body_arm,
43 body_torso,
44 body_head,
45 body_neck,
46 body_finger,
47 body_shoulder,
48 body_foot,
49 body_hand,
50 body_wrist,
51 body_waist,
52 NUM_BODY_LOCATIONS 41 NUM_BODY_LOCATIONS
53}; 42};
54 43
55/* See common/item.c */ 44/* See common/item.c */
56 45
57typedef struct Body_Locations 46struct Body_Locations
58{ 47{
48 const char *name; /* Short name/identifier */
59 keyword save_name; /* Name used to load/save it to disk */ 49 keyword kw; /* Name used to load/save it to disk */
60 const char *use_name; /* Name used when describing an item we can use */ 50 const char *use_name; /* Name used when describing an item we can use */
61 const char *nonuse_name; /* Name to describe objects we can't use */ 51 const char *nonuse_name; /* Name to describe objects we can't use */
62} Body_Locations; 52};
63 53
64extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; 54extern Body_Locations body_locations[NUM_BODY_LOCATIONS];
55
56// for each set of directions (1 == up, 2 == right, 4 == down, 8 == left)
57// contains the wall suffix (0, 1_3, 1_4 and so on).
58extern const char *wall_suffix[16];
65 59
66#define NUM_COINS 4 /* number of coin types */ 60#define NUM_COINS 4 /* number of coin types */
67extern const char *const coins[NUM_COINS + 1]; 61extern const char *const coins[NUM_COINS + 1];
62
63// restart server when object_count reaches this value
64#define RESTART_COUNT 0xe0000000
68 65
69/* 66/*
70 * Each object (this also means archetypes!) could have a few of these 67 * Each object (this also means archetypes!) could have a few of these
71 * "dangling" from it; this could also end up containing 'parse errors'. 68 * "dangling" from it; this could also end up containing 'parse errors'.
72 * 69 *
… …
76 * accessing the list directly. 73 * accessing the list directly.
77 * Exception is if you want to walk this list for some reason. 74 * Exception is if you want to walk this list for some reason.
78 */ 75 */
79struct key_value : slice_allocated 76struct key_value : slice_allocated
80{ 77{
81 key_value *next; 78 key_value *next; // must be first element
82 shstr key, value; 79 shstr key, value;
80};
81
82// "crossfires version of a perl hash."
83struct key_values
84{
85 key_value *first; // must be first element
86
87 bool empty() const
88 {
89 return !first;
90 }
91
92 void clear ();
93 shstr_tmp get (shstr_tmp key) const;
94 void del (shstr_tmp key);
95 void set (shstr_tmp key, shstr_tmp value);
96
97 void add (shstr_tmp key, shstr_tmp value); // liek set, but doesn't check for duplicates
98 void reverse (); // reverses the ordering, to be used after loading an object
99 key_values &operator =(const key_values &kv);
100
101 // custom extra fields management
102 struct access_proxy
103 {
104 key_values &kv;
105 shstr_tmp key;
106
107 access_proxy (key_values &kv, shstr_tmp key)
108 : kv (kv), key (key)
109 {
110 }
111
112 const access_proxy &operator =(shstr_tmp value) const
113 {
114 kv.set (key, value);
115 return *this;
116 }
117
118 operator const shstr_tmp () const { return kv.get (key); }
119 operator const char *() const { return kv.get (key); }
120
121 private:
122 void operator =(int);
123 };
124
125 const access_proxy operator [](shstr_tmp key)
126 {
127 return access_proxy (*this, key);
128 }
83}; 129};
84 130
85//-GPL 131//-GPL
86 132
87struct UUID 133struct UUID
… …
293sint16 SP_level_spellpoint_cost (object *caster, object *spell, int flags); 339sint16 SP_level_spellpoint_cost (object *caster, object *spell, int flags);
294int SP_level_dam_adjust (object *caster, object *spob); 340int SP_level_dam_adjust (object *caster, object *spob);
295int SP_level_duration_adjust (object *caster, object *spob); 341int SP_level_duration_adjust (object *caster, object *spob);
296int SP_level_range_adjust (object *caster, object *spob); 342int SP_level_range_adjust (object *caster, object *spob);
297 343
344struct freelist_item
345{
346 freelist_item *next;
347 uint32_t count;
348};
349
298struct object : zero_initialised, object_copy 350struct object : object_copy
299{ 351{
300 // These variables are not changed by ->copy_to 352 // These variables are not changed by ->copy_to
301 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */ 353 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */
302 354
303 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 355 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
304 int ACC (RO, count); 356 uint32_t ACC (RO, count);
305 object_vector_index ACC (RO, index); // index into objects 357 object_vector_index ACC (RO, index); // index into objects
306 object_vector_index ACC (RO, active); // index into actives 358 object_vector_index ACC (RO, active); // index into actives
307 359
308 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */ 360 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */
309 361
… …
319 object *ACC (RW, env); /* Pointer to the object which is the environment. 371 object *ACC (RW, env); /* Pointer to the object which is the environment.
320 * This is typically the container that the object is in. 372 * This is typically the container that the object is in.
321 */ 373 */
322 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */ 374 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */
323 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different 375 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different
324 key_value *key_values; /* Fields not explictly known by the loader. */
325 376
326 // privates / perl 377 MTH void set_flag (int flagnum)
327 shstr_tmp kv_get (shstr_tmp key) const; 378 {
328 void kv_del (shstr_tmp key); 379 flag [flagnum] = true;
329 void kv_set (shstr_tmp key, shstr_tmp value); 380 }
381
382 MTH void clr_flag (int flagnum)
383 {
384 flag [flagnum] = false;
385 }
386
387 // extra key value pairs
388 key_values kv;
330 389
331//-GPL 390//-GPL
332
333 // custom extra fields management
334 struct key_value_access_proxy
335 {
336 object &ob;
337 shstr_tmp key;
338
339 key_value_access_proxy (object &ob, shstr_tmp key)
340 : ob (ob), key (key)
341 {
342 }
343
344 const key_value_access_proxy &operator =(shstr_tmp value) const
345 {
346 ob.kv_set (key, value);
347 return *this;
348 }
349
350 operator const shstr_tmp () const { return ob.kv_get (key); }
351 operator const char *() const { return ob.kv_get (key); }
352
353 private:
354 void operator =(int);
355 };
356
357 // operator [] is too annoying to use
358 const key_value_access_proxy kv (shstr_tmp key)
359 {
360 return key_value_access_proxy (*this, key);
361 }
362 391
363 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all 392 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
364 MTH void post_load_check (); // do some adjustments after parsing 393 MTH void post_load_check (); // do some adjustments after parsing
365 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go. 394 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
366 bool write (object_freezer &f); 395 bool write (object_freezer &f);
… …
429 return op1->value == op2->value 458 return op1->value == op2->value
430 && op1->name == op2->name 459 && op1->name == op2->name
431 && can_merge_slow (op1, op2); 460 && can_merge_slow (op1, op2);
432 } 461 }
433 462
434 MTH void set_owner (object *owner); 463 MTH void set_owner (object_ornull *owner);
435 MTH void set_speed (float speed); 464 MTH void set_speed (float speed);
436 MTH void set_glow_radius (sint8 rad); 465 MTH void set_glow_radius (sint8 rad);
437 MTH bool change_skill (object *ob); // deprecated?
438 466
439 MTH void open_container (object *new_container); 467 MTH void open_container (object *new_container);
440 MTH void close_container () 468 MTH void close_container ()
441 { 469 {
442 open_container (0); 470 open_container (0);
… …
533 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); } 561 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }
534 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; } 562 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; }
535 563
536 MTH bool is_dragon () const; 564 MTH bool is_dragon () const;
537 565
566 MTH bool is_immunity () const { return invisible && type == SIGN; }
567
538 MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; } 568 MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; }
539 569
540 // temporary: wether the object can be saved in a map file 570 // temporary: wether the object can be saved in a map file
541 // contr => is a player 571 // contr => is a player
542 // head => only save head of a multitile object 572 // head => only save head of a multitile object
… …
550 580
551 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; } 581 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; }
552 582
553 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); } 583 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); }
554 584
585 /* need_identify returns true if the item should be identified. This
586 * function really should not exist - by default, any item not identified
587 * should need it.
588 */
589 MTH bool need_identify () const;
590
555 // returns the outermost owner, never returns 0 591 // returns the outermost owner, never returns 0
556 MTH object *outer_owner () 592 MTH object *outer_owner ()
557 { 593 {
558 object *op; 594 object *op;
559 595
… …
626 MTH bool has_carried_lights () const 662 MTH bool has_carried_lights () const
627 { 663 {
628 return glow_radius; 664 return glow_radius;
629 } 665 }
630 666
631 // returns the player that cna see this object, if any 667 // returns the player that can see this object, if any
632 MTH object *visible_to () const; 668 MTH object *visible_to () const;
633 669
634 MTH std::string long_desc (object *who = 0); // query_name . " " . describe 670 MTH std::string long_desc (object *who = 0); // query_name . " " . describe
635 MTH std::string describe_monster (object *who = 0); 671 MTH std::string describe_monster (object *who = 0);
636 MTH std::string describe_item (object *who = 0); 672 MTH std::string describe_item (object *who = 0);
… …
646 // objects. This method only works on objects not inserted 682 // objects. This method only works on objects not inserted
647 // anywhere. 683 // anywhere.
648 MTH void expand_tail (); 684 MTH void expand_tail ();
649 685
650 MTH void create_treasure (treasurelist *tl, int flags = 0); 686 MTH void create_treasure (treasurelist *tl, int flags = 0);
687
688 // makes sure the player has the named skill,
689 // and also makes it innate if can_use is true.
690 // returns the new skill or 0 if no such skill exists.
691 MTH object *give_skill (shstr_cmp name, bool can_use = false);
692 MTH void become_follower (object *new_god);
651 693
652 // insert object at same map position as 'where' 694 // insert object at same map position as 'where'
653 // handles both inventory and map "positions" 695 // handles both inventory and map "positions"
654 MTH object *insert_at (object *where, object *originator = 0, int flags = 0); 696 MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
655 // check whether we can put this into the map, respect max_nrof, max_volume, max_items 697 // check whether we can put this into the map, respect max_nrof, max_volume, max_items
… …
659 MTH void activate (); 701 MTH void activate ();
660 MTH void deactivate (); 702 MTH void deactivate ();
661 MTH void activate_recursive (); 703 MTH void activate_recursive ();
662 MTH void deactivate_recursive (); 704 MTH void deactivate_recursive ();
663 705
706 // prefetch and activate the surrounding area
707 MTH void prefetch_surrounding_maps ();
708
664 // set the given flag on all objects in the inventory recursively 709 // set the given flag on all objects in the inventory recursively
665 MTH void set_flag_inv (int flag, int value = 1); 710 MTH void set_flag_inv (int flag, int value = 1);
666 711
667 void enter_exit (object *exit);//Perl 712 void enter_exit (object *exit); // perl
668 MTH void enter_map (maptile *newmap, int x, int y); 713 MTH bool enter_map (maptile *newmap, int x, int y);
669 void player_goto (const_utf8_string path, int x, int y); // only for players 714 void player_goto (const_utf8_string path, int x, int y); // only for players
670 MTH bool apply (object *ob, int aflags = AP_APPLY); // ob may be 0 715 MTH bool apply (object *ob, int aflags = AP_APPLY); // ob may be 0
716
717 MTH object *mark () const;
718 MTH void splay_marked ();
671 719
672 // returns the mapspace this object is in 720 // returns the mapspace this object is in
673 mapspace &ms () const; 721 mapspace &ms () const;
674 722
675 // fully recursive iterator 723 // fully recursive iterator
… …
726 return weight + carrying; 774 return weight + carrying;
727 } 775 }
728 776
729 MTH struct region *region () const; 777 MTH struct region *region () const;
730 778
731 void statusmsg (const_utf8_string msg, int color = NDI_BLACK); 779 MTH void statusmsg (const_utf8_string msg, int color = NDI_BLACK);
732 void failmsg (const_utf8_string msg, int color = NDI_RED); 780 MTH void failmsg (const_utf8_string msg, int color = NDI_RED);
781 void failmsgf (const_utf8_string format, ...); // always NDI_RED...
733 782
734 const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = ""); 783 MTH const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = "");
735 784
736 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference 785 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
737 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible 786 static object *deref (const_octet_string ref); // returns the object from the generated reference, if possible
738 787
739 // make some noise with given item into direction dir, 788 // make some noise with given item into direction dir,
740 // currently only used for players to make them temporarily visible 789 // currently only used for players to make them temporarily visible
741 // when they are invisible. 790 // when they are invisible.
742 MTH void make_noise (); 791 MTH void make_noise ();
… …
754 MTH int anim_frames () const { return anim ().num_animations; } 803 MTH int anim_frames () const { return anim ().num_animations; }
755 MTH int anim_facings () const { return anim ().facings; } 804 MTH int anim_facings () const { return anim ().facings; }
756 805
757 MTH utf8_string as_string (); 806 MTH utf8_string as_string ();
758 807
808 // low-level management, statistics, ...
809 static uint32_t ACC (RW, object_count);
810 static uint32_t ACC (RW, free_count);
811 static uint32_t ACC (RW, create_count);
812 static uint32_t ACC (RW, destroy_count);
813 static freelist_item *freelist;
814 MTH static void freelist_free (int count);
815
759protected: 816protected:
760 void link (); 817 void link ();
761 void unlink (); 818 void unlink ();
819
820 void do_delete ();
762 821
763 object (); 822 object ();
764 ~object (); 823 ~object ();
765 824
766private: 825private:
… …
803 */ 862 */
804 863
805//-GPL 864//-GPL
806 865
807INTERFACE_CLASS (archetype) 866INTERFACE_CLASS (archetype)
808struct archetype : object 867struct archetype : object, zero_initialised
809{ 868{
810 static arch_ptr empty; // the empty_archetype 869 static arch_ptr empty; // the empty_archetype
811 MTH static void gc (); 870 MTH static void gc ();
812 871
813 archetype (const_utf8_string name); 872 archetype (const_utf8_string name);
… …
831 890
832 // support for archetype loading 891 // support for archetype loading
833 static archetype *read (object_thawer &f); 892 static archetype *read (object_thawer &f);
834 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more 893 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
835 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */ 894 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
895
896protected:
897 void do_delete ();
836}; 898};
837 899
838// returns whether the object is a dragon player, which are often specialcased 900// returns whether the object is a dragon player, which are often specialcased
839inline bool 901inline bool
840object::is_dragon () const 902object::is_dragon () const
… …
913#define INS_NO_MERGE 0x0001 975#define INS_NO_MERGE 0x0001
914#define INS_ABOVE_FLOOR_ONLY 0x0002 976#define INS_ABOVE_FLOOR_ONLY 0x0002
915#define INS_NO_WALK_ON 0x0004 977#define INS_NO_WALK_ON 0x0004
916#define INS_ON_TOP 0x0008 978#define INS_ON_TOP 0x0008
917#define INS_BELOW_ORIGINATOR 0x0010 979#define INS_BELOW_ORIGINATOR 0x0010
980#define INS_NO_AUTO_EXIT 0x0020 // temporary, fix exits instead
918 981
919//-GPL 982//-GPL
920 983
921#endif 984#endif
922 985

Diff Legend

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