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.231 by root, Sat Apr 3 02:27:24 2010 UTC vs.
Revision 1.262 by root, Mon Oct 1 01:43:39 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
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
37// also see common/item.C 35// also see common/item.C
38enum { 36enum
39 body_skill, 37{
40 body_combat, 38# define def(name, use, nonuse) body_ ## name,
41 body_range, 39# include "slotinc.h"
42 body_shield, 40# undef def
43 body_arm,
44 body_torso,
45 body_head,
46 body_neck,
47 body_finger,
48 body_shoulder,
49 body_foot,
50 body_hand,
51 body_wrist,
52 body_waist,
53 NUM_BODY_LOCATIONS 41 NUM_BODY_LOCATIONS
54}; 42};
55 43
56enum slottype_t
57{
58 slot_none,
59 slot_combat,
60 slot_ranged,
61};
62
63/* See common/item.c */ 44/* See common/item.c */
64 45
65typedef struct Body_Locations 46struct Body_Locations
66{ 47{
48 const char *name; /* Short name/identifier */
67 keyword save_name; /* Name used to load/save it to disk */ 49 keyword kw; /* Name used to load/save it to disk */
68 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 */
69 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 */
70} Body_Locations; 52};
71 53
72extern 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];
73 59
74#define NUM_COINS 4 /* number of coin types */ 60#define NUM_COINS 4 /* number of coin types */
75extern 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
76 65
77/* 66/*
78 * 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
79 * "dangling" from it; this could also end up containing 'parse errors'. 68 * "dangling" from it; this could also end up containing 'parse errors'.
80 * 69 *
84 * accessing the list directly. 73 * accessing the list directly.
85 * 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.
86 */ 75 */
87struct key_value : slice_allocated 76struct key_value : slice_allocated
88{ 77{
89 key_value *next; 78 key_value *next; // must be first element
90 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 }
91}; 129};
92 130
93//-GPL 131//-GPL
94 132
95struct UUID 133struct UUID
290 328
291const_utf8_string query_weight (const object *op); 329const_utf8_string query_weight (const object *op);
292const_utf8_string query_short_name (const object *op); 330const_utf8_string query_short_name (const object *op);
293const_utf8_string query_name (const object *op); 331const_utf8_string query_name (const object *op);
294const_utf8_string query_base_name (const object *op, int plural); 332const_utf8_string query_base_name (const object *op, int plural);
333sint64 query_cost (const object *tmp, object *who, int flag);
334const char *query_cost_string (const object *tmp, object *who, int flag);
295 335
336int change_ability_duration (object *spell, object *caster);
337int min_casting_level (object *caster, object *spell);
338int casting_level (object *caster, object *spell);
339sint16 SP_level_spellpoint_cost (object *caster, object *spell, int flags);
340int SP_level_dam_adjust (object *caster, object *spob);
341int SP_level_duration_adjust (object *caster, object *spob);
342int SP_level_range_adjust (object *caster, object *spob);
343
344struct freelist_item
345{
346 freelist_item *next;
347 uint32_t count;
348};
349
296struct object : zero_initialised, object_copy 350struct object : object_copy
297{ 351{
298 // These variables are not changed by ->copy_to 352 // These variables are not changed by ->copy_to
299 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 */
300 354
301 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 355 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
302 int ACC (RO, count); 356 uint32_t ACC (RO, count);
303 object_vector_index ACC (RO, index); // index into objects 357 object_vector_index ACC (RO, index); // index into objects
304 object_vector_index ACC (RO, active); // index into actives 358 object_vector_index ACC (RO, active); // index into actives
305 359
306 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 */
307 361
317 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.
318 * This is typically the container that the object is in. 372 * This is typically the container that the object is in.
319 */ 373 */
320 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 */
321 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
322 key_value *key_values; /* Fields not explictly known by the loader. */
323 376
324 // privates / perl 377 MTH void set_flag (int flagnum)
325 shstr_tmp kv_get (shstr_tmp key) const; 378 {
326 void kv_del (shstr_tmp key); 379 flag [flagnum] = true;
327 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;
328 389
329//-GPL 390//-GPL
330
331 // custom extra fields management
332 struct key_value_access_proxy
333 {
334 object &ob;
335 shstr_tmp key;
336
337 key_value_access_proxy (object &ob, shstr_tmp key)
338 : ob (ob), key (key)
339 {
340 }
341
342 const key_value_access_proxy &operator =(shstr_tmp value) const
343 {
344 ob.kv_set (key, value);
345 return *this;
346 }
347
348 operator const shstr_tmp () const { return ob.kv_get (key); }
349 operator const char *() const { return ob.kv_get (key); }
350
351 private:
352 void operator =(int);
353 };
354
355 // operator [] is too annoying to use
356 const key_value_access_proxy kv (shstr_tmp key)
357 {
358 return key_value_access_proxy (*this, key);
359 }
360 391
361 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
362 MTH void post_load_check (); // do some adjustments after parsing 393 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. 394 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
364 bool write (object_freezer &f); 395 bool write (object_freezer &f);
365 396
366 MTH int slottype () const;
367 MTH static object *create (); 397 MTH static object *create ();
368 const mapxy &operator =(const mapxy &pos); 398 const mapxy &operator =(const mapxy &pos);
369 MTH void copy_to (object *dst); 399 MTH void copy_to (object *dst);
370 MTH object *clone (); // create + copy_to a single object 400 MTH object *clone (); // create + copy_to a single object
371 MTH object *deep_clone (); // copy whole more chain and inventory 401 MTH object *deep_clone (); // copy whole more chain and inventory
378 destroy (); 408 destroy ();
379 } 409 }
380 410
381 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 411 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
382 MTH void destroy_inv (bool drop_to_ground = false); 412 MTH void destroy_inv (bool drop_to_ground = false);
413 MTH void destroy_inv_fast (); // like destroy_inv (false), but only works when *this is destroyed, too
383 MTH object *insert (object *item); // insert into inventory 414 MTH object *insert (object *item); // insert into inventory
384 MTH void play_sound (faceidx sound) const; 415 MTH void play_sound (faceidx sound) const;
385 MTH void say_msg (const_utf8_string msg) const; 416 MTH void say_msg (const_utf8_string msg) const;
386 417
387 void do_remove (); 418 void do_remove ();
427 return op1->value == op2->value 458 return op1->value == op2->value
428 && op1->name == op2->name 459 && op1->name == op2->name
429 && can_merge_slow (op1, op2); 460 && can_merge_slow (op1, op2);
430 } 461 }
431 462
432 MTH void set_owner (object *owner); 463 MTH void set_owner (object_ornull *owner);
433 MTH void set_speed (float speed); 464 MTH void set_speed (float speed);
434 MTH void set_glow_radius (sint8 rad); 465 MTH void set_glow_radius (sint8 rad);
435 MTH bool change_skill (object *ob); // deprecated?
436 466
437 MTH void open_container (object *new_container); 467 MTH void open_container (object *new_container);
438 MTH void close_container () 468 MTH void close_container ()
439 { 469 {
440 open_container (0); 470 open_container (0);
531 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); } 561 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }
532 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; }
533 563
534 MTH bool is_dragon () const; 564 MTH bool is_dragon () const;
535 565
566 MTH bool is_immunity () const { return invisible && type == SIGN; }
567
536 MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; } 568 MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; }
537 569
538 // temporary: wether the object can be saved in a map file 570 // temporary: wether the object can be saved in a map file
539 // contr => is a player 571 // contr => is a player
540 // head => only save head of a multitile object 572 // head => only save head of a multitile object
548 580
549 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; } 581 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; }
550 582
551 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); } 583 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); }
552 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
553 // returns the outermost owner, never returns 0 591 // returns the outermost owner, never returns 0
554 MTH object *outer_owner () 592 MTH object *outer_owner ()
555 { 593 {
556 object *op; 594 object *op;
557 595
611 MTH bool is_player () const 649 MTH bool is_player () const
612 { 650 {
613 return !!contr; 651 return !!contr;
614 } 652 }
615 653
654 /* elmex: this method checks whether the object is in a shop */
655 MTH bool is_in_shop () const;
656
616 MTH bool affects_los () const 657 MTH bool affects_los () const
617 { 658 {
618 return glow_radius || flag [FLAG_BLOCKSVIEW]; 659 return glow_radius || flag [FLAG_BLOCKSVIEW];
619 } 660 }
620 661
621 MTH bool has_carried_lights () const 662 MTH bool has_carried_lights () const
622 { 663 {
623 return glow_radius; 664 return glow_radius;
624 } 665 }
625 666
626 // returns the player that cna see this object, if any 667 // returns the player that can see this object, if any
627 MTH object *visible_to () const; 668 MTH object *visible_to () const;
628 669
629 MTH std::string long_desc (object *who = 0); // query_name . " " . describe 670 MTH std::string long_desc (object *who = 0); // query_name . " " . describe
630 MTH std::string describe_monster (object *who = 0); 671 MTH std::string describe_monster (object *who = 0);
631 MTH std::string describe_item (object *who = 0); 672 MTH std::string describe_item (object *who = 0);
641 // objects. This method only works on objects not inserted 682 // objects. This method only works on objects not inserted
642 // anywhere. 683 // anywhere.
643 MTH void expand_tail (); 684 MTH void expand_tail ();
644 685
645 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);
646 693
647 // insert object at same map position as 'where' 694 // insert object at same map position as 'where'
648 // handles both inventory and map "positions" 695 // handles both inventory and map "positions"
649 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);
650 // 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
654 MTH void activate (); 701 MTH void activate ();
655 MTH void deactivate (); 702 MTH void deactivate ();
656 MTH void activate_recursive (); 703 MTH void activate_recursive ();
657 MTH void deactivate_recursive (); 704 MTH void deactivate_recursive ();
658 705
706 // prefetch and activate the surrounding area
707 MTH void prefetch_surrounding_maps ();
708
659 // set the given flag on all objects in the inventory recursively 709 // set the given flag on all objects in the inventory recursively
660 MTH void set_flag_inv (int flag, int value = 1); 710 MTH void set_flag_inv (int flag, int value = 1);
661 711
662 void enter_exit (object *exit);//Perl 712 void enter_exit (object *exit); // perl
663 MTH void enter_map (maptile *newmap, int x, int y); 713 MTH bool enter_map (maptile *newmap, int x, int y);
664 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
665 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 ();
666 719
667 // returns the mapspace this object is in 720 // returns the mapspace this object is in
668 mapspace &ms () const; 721 mapspace &ms () const;
669 722
670 // fully recursive iterator 723 // fully recursive iterator
721 return weight + carrying; 774 return weight + carrying;
722 } 775 }
723 776
724 MTH struct region *region () const; 777 MTH struct region *region () const;
725 778
726 void statusmsg (const_utf8_string msg, int color = NDI_BLACK); 779 MTH void statusmsg (const_utf8_string msg, int color = NDI_BLACK);
727 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...
728 782
729 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 = "");
730 784
731 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
732 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
733 787
734 // make some noise with given item into direction dir, 788 // make some noise with given item into direction dir,
735 // currently only used for players to make them temporarily visible 789 // currently only used for players to make them temporarily visible
736 // when they are invisible. 790 // when they are invisible.
737 MTH void make_noise (); 791 MTH void make_noise ();
749 MTH int anim_frames () const { return anim ().num_animations; } 803 MTH int anim_frames () const { return anim ().num_animations; }
750 MTH int anim_facings () const { return anim ().facings; } 804 MTH int anim_facings () const { return anim ().facings; }
751 805
752 MTH utf8_string as_string (); 806 MTH utf8_string as_string ();
753 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
754protected: 816protected:
755 void link (); 817 void link ();
756 void unlink (); 818 void unlink ();
819
820 void do_delete ();
757 821
758 object (); 822 object ();
759 ~object (); 823 ~object ();
760 824
761private: 825private:
798 */ 862 */
799 863
800//-GPL 864//-GPL
801 865
802INTERFACE_CLASS (archetype) 866INTERFACE_CLASS (archetype)
803struct archetype : object 867struct archetype : object, zero_initialised
804{ 868{
805 static arch_ptr empty; // the empty_archetype 869 static arch_ptr empty; // the empty_archetype
806 MTH static void gc (); 870 MTH static void gc ();
807 871
808 archetype (const_utf8_string name); 872 archetype (const_utf8_string name);
826 890
827 // support for archetype loading 891 // support for archetype loading
828 static archetype *read (object_thawer &f); 892 static archetype *read (object_thawer &f);
829 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
830 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 ();
831}; 898};
832 899
833// 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
834inline bool 901inline bool
835object::is_dragon () const 902object::is_dragon () const
908#define INS_NO_MERGE 0x0001 975#define INS_NO_MERGE 0x0001
909#define INS_ABOVE_FLOOR_ONLY 0x0002 976#define INS_ABOVE_FLOOR_ONLY 0x0002
910#define INS_NO_WALK_ON 0x0004 977#define INS_NO_WALK_ON 0x0004
911#define INS_ON_TOP 0x0008 978#define INS_ON_TOP 0x0008
912#define INS_BELOW_ORIGINATOR 0x0010 979#define INS_BELOW_ORIGINATOR 0x0010
980#define INS_NO_AUTO_EXIT 0x0020 // temporary, fix exits instead
913 981
914//-GPL 982//-GPL
915 983
916#endif 984#endif
917 985

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines