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.241 by root, Mon Apr 12 05:22:38 2010 UTC vs.
Revision 1.271 by root, Thu Nov 17 04:27:39 2016 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,2013,2014,2015,2016 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
248 294
249 // 8 free bits 295 // 8 free bits
250 296
251 //float ACC (RW, expmul) = 1.0; /* needed experience = (calc_exp*expmul) - means some */ 297 //float ACC (RW, expmul) = 1.0; /* needed experience = (calc_exp*expmul) - means some */
252 // /* races/classes can need less/more exp to gain levels */ 298 // /* races/classes can need less/more exp to gain levels */
253 static const float expmul = 1.0;//D 299 constexpr static const float expmul = 1.0;//D
254 float ACC (RW, move_slow_penalty); /* How much this slows down the object */ 300 float ACC (RW, move_slow_penalty); /* How much this slows down the object */
255 301
256 /* Following are values used by any object */ 302 /* Following are values used by any object */
257 /* this objects turns into or what this object creates */ 303 /* this objects turns into or what this object creates */
258 treasurelist *ACC (RW, randomitems); /* Items to be generated */ 304 treasurelist *ACC (RW, randomitems); /* Items to be generated */
325 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.
326 * This is typically the container that the object is in. 372 * This is typically the container that the object is in.
327 */ 373 */
328 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 */
329 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
330 key_value *key_values; /* Fields not explictly known by the loader. */
331 376
332 MTH void set_flag (int flagnum) 377 MTH void set_flag (int flagnum)
333 { 378 {
334 flag [flagnum] = true; 379 flag [flagnum] = true;
335 } 380 }
337 MTH void clr_flag (int flagnum) 382 MTH void clr_flag (int flagnum)
338 { 383 {
339 flag [flagnum] = false; 384 flag [flagnum] = false;
340 } 385 }
341 386
342 // privates / perl 387 // extra key value pairs
343 shstr_tmp kv_get (shstr_tmp key) const; 388 key_values kv;
344 void kv_del (shstr_tmp key);
345 void kv_set (shstr_tmp key, shstr_tmp value);
346 389
347//-GPL 390//-GPL
348
349 // custom extra fields management
350 struct key_value_access_proxy
351 {
352 object &ob;
353 shstr_tmp key;
354
355 key_value_access_proxy (object &ob, shstr_tmp key)
356 : ob (ob), key (key)
357 {
358 }
359
360 const key_value_access_proxy &operator =(shstr_tmp value) const
361 {
362 ob.kv_set (key, value);
363 return *this;
364 }
365
366 operator const shstr_tmp () const { return ob.kv_get (key); }
367 operator const char *() const { return ob.kv_get (key); }
368
369 private:
370 void operator =(int);
371 };
372
373 // operator [] is too annoying to use
374 const key_value_access_proxy kv (shstr_tmp key)
375 {
376 return key_value_access_proxy (*this, key);
377 }
378 391
379 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
380 MTH void post_load_check (); // do some adjustments after parsing 393 MTH void post_load_check (); // do some adjustments after parsing
381 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.
382 bool write (object_freezer &f); 395 bool write (object_freezer &f);
445 return op1->value == op2->value 458 return op1->value == op2->value
446 && op1->name == op2->name 459 && op1->name == op2->name
447 && can_merge_slow (op1, op2); 460 && can_merge_slow (op1, op2);
448 } 461 }
449 462
450 MTH void set_owner (object *owner); 463 MTH void set_owner (object_ornull *owner);
451 MTH void set_speed (float speed); 464 MTH void set_speed (float speed);
452 MTH void set_glow_radius (sint8 rad); 465 MTH void set_glow_radius (sint8 rad);
453 466
454 MTH void open_container (object *new_container); 467 MTH void open_container (object *new_container);
455 MTH void close_container () 468 MTH void close_container ()
468 // strangely enough, using ?: here causes code to inflate 481 // strangely enough, using ?: here causes code to inflate
469 return type == CONTAINER 482 return type == CONTAINER
470 && ((env && env->container_ () == this) 483 && ((env && env->container_ () == this)
471 || (!env && flag [FLAG_APPLIED])); 484 || (!env && flag [FLAG_APPLIED]));
472 } 485 }
486
487 MTH object *find_spell (const_utf8_string prefix) const;
473 488
474 MTH object *force_find (shstr_tmp name); 489 MTH object *force_find (shstr_tmp name);
475 MTH void force_set_timer (int duration); 490 MTH void force_set_timer (int duration);
476 MTH object *force_add (shstr_tmp name, int duration = 0); 491 MTH object *force_add (shstr_tmp name, int duration = 0);
477 492
508 MTH int number_of () const 523 MTH int number_of () const
509 { 524 {
510 return nrof ? nrof : 1; 525 return nrof ? nrof : 1;
511 } 526 }
512 527
513 MTH sint32 total_weight () const 528 MTH weight_t total_weight () const
514 { 529 {
515 return (weight + carrying) * number_of (); 530 return sint64 (weight + carrying) * number_of ();
516 } 531 }
517 532
518 MTH void update_weight (); 533 MTH void update_weight ();
519 534
520 // return the dominant material of this item, always return something 535 // return the dominant material of this item, always return something
522 { 537 {
523 return material; 538 return material;
524 } 539 }
525 540
526 // return the volume of this object in cm³ 541 // return the volume of this object in cm³
527 MTH uint64 volume () const 542 MTH volume_t volume () const
528 { 543 {
529 return (uint64)total_weight () 544 return (volume_t)total_weight ()
530 * 1024 // 1000 actually 545 * 1024 // 1000 actually
531 * (type == CONTAINER ? 128 : 1) 546 * (type == CONTAINER ? 128 : 1)
532 / dominant_material ()->density; // ugh, division 547 / dominant_material ()->density; // ugh, division
533 } 548 }
534 549
567 582
568 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; } 583 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; }
569 584
570 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); } 585 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); }
571 586
587 /* need_identify returns true if the item should be identified. This
588 * function really should not exist - by default, any item not identified
589 * should need it.
590 */
591 MTH bool need_identify () const;
592
572 // returns the outermost owner, never returns 0 593 // returns the outermost owner, never returns 0
573 MTH object *outer_owner () 594 MTH object *outer_owner ()
574 { 595 {
575 object *op; 596 object *op;
576 597
643 MTH bool has_carried_lights () const 664 MTH bool has_carried_lights () const
644 { 665 {
645 return glow_radius; 666 return glow_radius;
646 } 667 }
647 668
648 // returns the player that cna see this object, if any 669 // returns the player that can see this object, if any
649 MTH object *visible_to () const; 670 MTH object *visible_to () const;
650 671
651 MTH std::string long_desc (object *who = 0); // query_name . " " . describe 672 MTH std::string long_desc (object *who = 0); // query_name . " " . describe
652 MTH std::string describe_monster (object *who = 0); 673 MTH std::string describe_monster (object *who = 0);
653 MTH std::string describe_item (object *who = 0); 674 MTH std::string describe_item (object *who = 0);
663 // objects. This method only works on objects not inserted 684 // objects. This method only works on objects not inserted
664 // anywhere. 685 // anywhere.
665 MTH void expand_tail (); 686 MTH void expand_tail ();
666 687
667 MTH void create_treasure (treasurelist *tl, int flags = 0); 688 MTH void create_treasure (treasurelist *tl, int flags = 0);
689
690 // makes sure the player has the named skill,
691 // and also makes it innate if can_use is true.
692 // returns the new skill or 0 if no such skill exists.
693 MTH object *give_skill (shstr_cmp name, bool can_use = false);
694 MTH void become_follower (object *new_god);
668 695
669 // insert object at same map position as 'where' 696 // insert object at same map position as 'where'
670 // handles both inventory and map "positions" 697 // handles both inventory and map "positions"
671 MTH object *insert_at (object *where, object *originator = 0, int flags = 0); 698 MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
672 // check whether we can put this into the map, respect max_nrof, max_volume, max_items 699 // check whether we can put this into the map, respect max_nrof, max_volume, max_items
676 MTH void activate (); 703 MTH void activate ();
677 MTH void deactivate (); 704 MTH void deactivate ();
678 MTH void activate_recursive (); 705 MTH void activate_recursive ();
679 MTH void deactivate_recursive (); 706 MTH void deactivate_recursive ();
680 707
708 // prefetch and activate the surrounding area
709 MTH void prefetch_surrounding_maps ();
710
681 // set the given flag on all objects in the inventory recursively 711 // set the given flag on all objects in the inventory recursively
682 MTH void set_flag_inv (int flag, int value = 1); 712 MTH void set_flag_inv (int flag, int value = 1);
683 713
684 void enter_exit (object *exit);//Perl 714 void enter_exit (object *exit); // perl
685 MTH void enter_map (maptile *newmap, int x, int y); 715 MTH bool enter_map (maptile *newmap, int x, int y);
686 void player_goto (const_utf8_string path, int x, int y); // only for players 716 void player_goto (const_utf8_string path, int x, int y); // only for players
687 MTH bool apply (object *ob, int aflags = AP_APPLY); // ob may be 0 717 MTH bool apply (object *ob, int aflags = AP_APPLY); // ob may be 0
718
719 MTH object *mark () const;
720 MTH void splay_marked ();
688 721
689 // returns the mapspace this object is in 722 // returns the mapspace this object is in
690 mapspace &ms () const; 723 mapspace &ms () const;
691 724
692 // fully recursive iterator 725 // fully recursive iterator
743 return weight + carrying; 776 return weight + carrying;
744 } 777 }
745 778
746 MTH struct region *region () const; 779 MTH struct region *region () const;
747 780
748 void statusmsg (const_utf8_string msg, int color = NDI_BLACK); 781 MTH void statusmsg (const_utf8_string msg, int color = NDI_BLACK);
749 void failmsg (const_utf8_string msg, int color = NDI_RED); 782 MTH void failmsg (const_utf8_string msg, int color = NDI_RED);
750 void failmsgf (const_utf8_string format, ...); // always NDI_RED... 783 void failmsgf (const_utf8_string format, ...); // always NDI_RED...
751 784
752 const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = ""); 785 MTH const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = "");
753 786
754 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference 787 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
755 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible 788 static object *deref (const_octet_string ref); // returns the object from the generated reference, if possible
756 789
757 // make some noise with given item into direction dir, 790 // make some noise with given item into direction dir,
758 // currently only used for players to make them temporarily visible 791 // currently only used for players to make them temporarily visible
759 // when they are invisible. 792 // when they are invisible.
760 MTH void make_noise (); 793 MTH void make_noise ();
851 MTH object *instance (); 884 MTH object *instance ();
852 885
853 MTH void post_load_check (); // do some adjustments after parsing 886 MTH void post_load_check (); // do some adjustments after parsing
854 887
855 object_vector_index ACC (RW, archid); // index in archvector 888 object_vector_index ACC (RW, archid); // index in archvector
856 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 889 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
857 890
858 sint8 ACC (RW, max_x); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ 891 sint8 ACC (RW, max_x); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
859 892
860 // support for archetype loading 893 // support for archetype loading
861 static archetype *read (object_thawer &f); 894 static archetype *read (object_thawer &f);
893// "safely" iterate over inv in a way such that the current item is removable 926// "safely" iterate over inv in a way such that the current item is removable
894// quite horrible, that's why its hidden in some macro 927// quite horrible, that's why its hidden in some macro
895#define for_inv_removable(op,var) \ 928#define for_inv_removable(op,var) \
896 for (object *var, *next_ = (op)->inv; (var = next_), var && (next_ = var->below), var; ) 929 for (object *var, *next_ = (op)->inv; (var = next_), var && (next_ = var->below), var; )
897 930
898#define for_all_objects(var) \ 931#define for_all_objects(var) \
899 for (unsigned _i = 0; _i < objects.size (); ++_i) \ 932 for (unsigned _i = 0; _i < objects.size (); ++_i) \
900 statementvar (object *, var, objects [_i]) 933 statementvar (object *, var, objects [_i])
901 934
902#define for_all_actives(var) \ 935#define for_all_actives(var) \
903 for (unsigned _i = 0; _i < actives.size (); ++_i) \ 936 for (unsigned _i = 0; _i < actives.size (); ++_i) \
904 statementvar (object *, var, actives [_i]) 937 statementvar (object *, var, actives [_i])
905 938
906#define for_all_archetypes(var) \ 939#define for_all_archetypes(var) \
907 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \ 940 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \
908 statementvar (archetype *, var, archetypes [_i]) 941 statementvar (archetype *, var, archetypes [_i])
909 942
910//+GPL 943//+GPL
911 944
912/* Used by update_object to know if the object being passed is 945/* Used by update_object to know if the object being passed is
915#define UP_OBJ_INSERT 1 948#define UP_OBJ_INSERT 1
916#define UP_OBJ_REMOVE 2 949#define UP_OBJ_REMOVE 2
917#define UP_OBJ_CHANGE 3 950#define UP_OBJ_CHANGE 3
918#define UP_OBJ_FACE 4 /* Only thing that changed was the face */ 951#define UP_OBJ_FACE 4 /* Only thing that changed was the face */
919 952
920/* These are flags passed to insert_ob_in_map and 953/* These are flags passed to insert_ob_in_map and
921 * insert_ob_in_ob. Note that all flags may not be meaningful 954 * insert_ob_in_ob. Note that all flags may not be meaningful
922 * for both functions. 955 * for both functions.
923 * Most are fairly explanatory: 956 * Most are fairly explanatory:
924 * INS_NO_MERGE: don't try to merge inserted object with ones alrady 957 * INS_NO_MERGE: don't try to merge inserted object with ones alrady
925 * on space. 958 * on space.
926 * INS_ABOVE_FLOOR_ONLY: Put object immediatly above the floor. 959 * INS_ABOVE_FLOOR_ONLY: Put object immediatly above the floor.
927 * INS_NO_WALK_ON: Don't call check_walk_on against the 960 * INS_NO_WALK_ON: Don't call check_walk_on against the
928 * originator - saves cpu time if you know the inserted object 961 * originator - saves cpu time if you know the inserted object
929 * is not meaningful in terms of having an effect. 962 * is not meaningful in terms of having an effect.
930 * INS_ON_TOP: Always put object on top. Generally only needed when loading 963 * INS_ON_TOP: Always put object on top. Generally only needed when loading
931 * files from disk and ordering needs to be preserved. 964 * files from disk and ordering needs to be preserved.
932 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - 965 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
933 * Use for treasure chests so the new object is the highest thing 966 * Use for treasure chests so the new object is the highest thing
934 * beneath the player, but not actually above it. Note - the 967 * beneath the player, but not actually above it. Note - the
935 * map and x,y coordinates for the object to be inserted must 968 * map and x,y coordinates for the object to be inserted must
936 * match the originator. 969 * match the originator.
944#define INS_NO_MERGE 0x0001 977#define INS_NO_MERGE 0x0001
945#define INS_ABOVE_FLOOR_ONLY 0x0002 978#define INS_ABOVE_FLOOR_ONLY 0x0002
946#define INS_NO_WALK_ON 0x0004 979#define INS_NO_WALK_ON 0x0004
947#define INS_ON_TOP 0x0008 980#define INS_ON_TOP 0x0008
948#define INS_BELOW_ORIGINATOR 0x0010 981#define INS_BELOW_ORIGINATOR 0x0010
982#define INS_NO_AUTO_EXIT 0x0020 // temporary, fix exits instead
949 983
950//-GPL 984//-GPL
951 985
952#endif 986#endif
953 987

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines