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.243 by root, Tue Apr 13 22:05:42 2010 UTC vs.
Revision 1.275 by root, Sun Nov 18 16:32:27 2018 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 (©) 2018 Marc Alexander Lehmann / the Deliantra team
4 * Copyright (©) 2005,2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team 5 * 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 6 * Copyright (©) 2001 Mark Wedel & Crossfire Development Team
6 * Copyright (©) 1992 Frank Tore Johansen 7 * Copyright (©) 1992 Frank Tore Johansen
7 * 8 *
8 * Deliantra is free software: you can redistribute it and/or modify it under 9 * 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 10 * 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 11 * Free Software Foundation, either version 3 of the License, or (at your
11 * option) any later version. 12 * option) any later version.
12 * 13 *
13 * This program is distributed in the hope that it will be useful, 14 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details. 17 * GNU General Public License for more details.
17 * 18 *
18 * You should have received a copy of the Affero GNU General Public License 19 * 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 20 * and the GNU General Public License along with this program. If not, see
20 * <http://www.gnu.org/licenses/>. 21 * <http://www.gnu.org/licenses/>.
21 * 22 *
22 * The authors can be reached via e-mail to <support@deliantra.net> 23 * The authors can be reached via e-mail to <support@deliantra.net>
23 */ 24 */
24 25
25#ifndef OBJECT_H 26#ifndef OBJECT_H
26#define OBJECT_H 27#define OBJECT_H
33typedef int tag_t; 34typedef int tag_t;
34 35
35// also see common/item.C 36// also see common/item.C
36enum 37enum
37{ 38{
38 body_skill, 39# define def(name, use, nonuse) body_ ## name,
39 body_combat, 40# include "slotinc.h"
40 body_range, 41# 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 42 NUM_BODY_LOCATIONS
53}; 43};
54 44
55/* See common/item.c */ 45/* See common/item.c */
56 46
57typedef struct Body_Locations 47struct Body_Locations
58{ 48{
49 const char *name; /* Short name/identifier */
59 keyword save_name; /* Name used to load/save it to disk */ 50 keyword kw; /* Name used to load/save it to disk */
60 const char *use_name; /* Name used when describing an item we can use */ 51 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 */ 52 const char *nonuse_name; /* Name to describe objects we can't use */
62} Body_Locations; 53};
63 54
64extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; 55extern Body_Locations body_locations[NUM_BODY_LOCATIONS];
56
57// for each set of directions (1 == up, 2 == right, 4 == down, 8 == left)
58// contains the wall suffix (0, 1_3, 1_4 and so on).
59extern const char *wall_suffix[16];
65 60
66#define NUM_COINS 4 /* number of coin types */ 61#define NUM_COINS 4 /* number of coin types */
67extern const char *const coins[NUM_COINS + 1]; 62extern const char *const coins[NUM_COINS + 1];
63
64// restart server when object_count reaches this value
65#define RESTART_COUNT 0xe0000000
68 66
69/* 67/*
70 * Each object (this also means archetypes!) could have a few of these 68 * Each object (this also means archetypes!) could have a few of these
71 * "dangling" from it; this could also end up containing 'parse errors'. 69 * "dangling" from it; this could also end up containing 'parse errors'.
72 * 70 *
76 * accessing the list directly. 74 * accessing the list directly.
77 * Exception is if you want to walk this list for some reason. 75 * Exception is if you want to walk this list for some reason.
78 */ 76 */
79struct key_value : slice_allocated 77struct key_value : slice_allocated
80{ 78{
81 key_value *next; 79 key_value *next; // must be first element
82 shstr key, value; 80 shstr key, value;
81};
82
83// "crossfires version of a perl hash."
84struct key_values
85{
86 key_value *first; // must be first element
87
88 bool empty() const
89 {
90 return !first;
91 }
92
93 void clear ();
94 shstr_tmp get (shstr_tmp key) const;
95 void del (shstr_tmp key);
96 void set (shstr_tmp key, shstr_tmp value);
97
98 void add (shstr_tmp key, shstr_tmp value); // liek set, but doesn't check for duplicates
99 void reverse (); // reverses the ordering, to be used after loading an object
100 key_values &operator =(const key_values &kv);
101
102 // custom extra fields management
103 struct access_proxy
104 {
105 key_values &kv;
106 shstr_tmp key;
107
108 access_proxy (key_values &kv, shstr_tmp key)
109 : kv (kv), key (key)
110 {
111 }
112
113 const access_proxy &operator =(shstr_tmp value) const
114 {
115 kv.set (key, value);
116 return *this;
117 }
118
119 operator const shstr_tmp () const { return kv.get (key); }
120 operator const char *() const { return kv.get (key); }
121
122 private:
123 void operator =(int);
124 };
125
126 const access_proxy operator [](shstr_tmp key)
127 {
128 return access_proxy (*this, key);
129 }
83}; 130};
84 131
85//-GPL 132//-GPL
86 133
87struct UUID 134struct UUID
248 295
249 // 8 free bits 296 // 8 free bits
250 297
251 //float ACC (RW, expmul) = 1.0; /* needed experience = (calc_exp*expmul) - means some */ 298 //float ACC (RW, expmul) = 1.0; /* needed experience = (calc_exp*expmul) - means some */
252 // /* races/classes can need less/more exp to gain levels */ 299 // /* races/classes can need less/more exp to gain levels */
253 static const float expmul = 1.0;//D 300 constexpr static const float expmul = 1.0;//D
254 float ACC (RW, move_slow_penalty); /* How much this slows down the object */ 301 float ACC (RW, move_slow_penalty); /* How much this slows down the object */
255 302
256 /* Following are values used by any object */ 303 /* Following are values used by any object */
257 /* this objects turns into or what this object creates */ 304 /* this objects turns into or what this object creates */
258 treasurelist *ACC (RW, randomitems); /* Items to be generated */ 305 treasurelist *ACC (RW, randomitems); /* Items to be generated */
325 object *ACC (RW, env); /* Pointer to the object which is the environment. 372 object *ACC (RW, env); /* Pointer to the object which is the environment.
326 * This is typically the container that the object is in. 373 * This is typically the container that the object is in.
327 */ 374 */
328 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */ 375 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 376 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 377
332 MTH void set_flag (int flagnum) 378 MTH void set_flag (int flagnum)
333 { 379 {
334 flag [flagnum] = true; 380 flag [flagnum] = true;
335 } 381 }
337 MTH void clr_flag (int flagnum) 383 MTH void clr_flag (int flagnum)
338 { 384 {
339 flag [flagnum] = false; 385 flag [flagnum] = false;
340 } 386 }
341 387
342 // privates / perl 388 // extra key value pairs
343 shstr_tmp kv_get (shstr_tmp key) const; 389 key_values kv;
344 void kv_del (shstr_tmp key);
345 void kv_set (shstr_tmp key, shstr_tmp value);
346 390
347//-GPL 391//-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 392
379 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all 393 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 394 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. 395 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
382 bool write (object_freezer &f); 396 bool write (object_freezer &f);
422 // object op is trying to move in direction dir. 436 // object op is trying to move in direction dir.
423 // originator is typically the same as op, but 437 // originator is typically the same as op, but
424 // can be different if originator is causing op to 438 // can be different if originator is causing op to
425 // move (originator is pushing op) 439 // move (originator is pushing op)
426 // returns 0 if the object is not able to move to the 440 // returns 0 if the object is not able to move to the
427 // desired space, 1 otherwise (in which case we also 441 // desired space, 1 otherwise (in which case we also
428 // move the object accordingly. This function is 442 // move the object accordingly. This function is
429 // very similiar to move_object. 443 // very similiar to move_object.
430 int move (int dir, object *originator); 444 int move (int dir, object *originator);
431 445
432 int move (int dir) 446 int move (int dir)
445 return op1->value == op2->value 459 return op1->value == op2->value
446 && op1->name == op2->name 460 && op1->name == op2->name
447 && can_merge_slow (op1, op2); 461 && can_merge_slow (op1, op2);
448 } 462 }
449 463
450 MTH void set_owner (object *owner); 464 MTH void set_owner (object_ornull *owner);
451 MTH void set_speed (float speed); 465 MTH void set_speed (float speed);
452 MTH void set_glow_radius (sint8 rad); 466 MTH void set_glow_radius (sint8 rad);
453 467
454 MTH void open_container (object *new_container); 468 MTH void open_container (object *new_container);
455 MTH void close_container () 469 MTH void close_container ()
468 // strangely enough, using ?: here causes code to inflate 482 // strangely enough, using ?: here causes code to inflate
469 return type == CONTAINER 483 return type == CONTAINER
470 && ((env && env->container_ () == this) 484 && ((env && env->container_ () == this)
471 || (!env && flag [FLAG_APPLIED])); 485 || (!env && flag [FLAG_APPLIED]));
472 } 486 }
487
488 MTH object *find_spell (const_utf8_string prefix) const;
473 489
474 MTH object *force_find (shstr_tmp name); 490 MTH object *force_find (shstr_tmp name);
475 MTH void force_set_timer (int duration); 491 MTH void force_set_timer (int duration);
476 MTH object *force_add (shstr_tmp name, int duration = 0); 492 MTH object *force_add (shstr_tmp name, int duration = 0);
477 493
508 MTH int number_of () const 524 MTH int number_of () const
509 { 525 {
510 return nrof ? nrof : 1; 526 return nrof ? nrof : 1;
511 } 527 }
512 528
513 MTH sint32 total_weight () const 529 MTH weight_t total_weight () const
514 { 530 {
515 return (weight + carrying) * number_of (); 531 return sint64 (weight + carrying) * number_of ();
516 } 532 }
517 533
518 MTH void update_weight (); 534 MTH void update_weight ();
519 535
520 // return the dominant material of this item, always return something 536 // return the dominant material of this item, always return something
522 { 538 {
523 return material; 539 return material;
524 } 540 }
525 541
526 // return the volume of this object in cm³ 542 // return the volume of this object in cm³
527 MTH uint64 volume () const 543 MTH volume_t volume () const
528 { 544 {
529 return (uint64)total_weight () 545 return (volume_t)total_weight ()
530 * 1024 // 1000 actually 546 * 1024 // 1000 actually
531 * (type == CONTAINER ? 128 : 1) 547 * (type == CONTAINER ? 128 : 1)
532 / dominant_material ()->density; // ugh, division 548 / dominant_material ()->density; // ugh, division
533 } 549 }
534 550
567 583
568 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; } 584 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; }
569 585
570 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); } 586 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); }
571 587
588 /* need_identify returns true if the item should be identified. This
589 * function really should not exist - by default, any item not identified
590 * should need it.
591 */
592 MTH bool need_identify () const;
593
572 // returns the outermost owner, never returns 0 594 // returns the outermost owner, never returns 0
573 MTH object *outer_owner () 595 MTH object *outer_owner ()
574 { 596 {
575 object *op; 597 object *op;
576 598
643 MTH bool has_carried_lights () const 665 MTH bool has_carried_lights () const
644 { 666 {
645 return glow_radius; 667 return glow_radius;
646 } 668 }
647 669
648 // returns the player that cna see this object, if any 670 // returns the player that can see this object, if any
649 MTH object *visible_to () const; 671 MTH object *visible_to () const;
650 672
651 MTH std::string long_desc (object *who = 0); // query_name . " " . describe 673 MTH std::string long_desc (object *who = 0); // query_name . " " . describe
652 MTH std::string describe_monster (object *who = 0); 674 MTH std::string describe_monster (object *who = 0);
653 MTH std::string describe_item (object *who = 0); 675 MTH std::string describe_item (object *who = 0);
682 MTH void activate (); 704 MTH void activate ();
683 MTH void deactivate (); 705 MTH void deactivate ();
684 MTH void activate_recursive (); 706 MTH void activate_recursive ();
685 MTH void deactivate_recursive (); 707 MTH void deactivate_recursive ();
686 708
709 // prefetch and activate the surrounding area
710 MTH void prefetch_surrounding_maps ();
711
687 // set the given flag on all objects in the inventory recursively 712 // set the given flag on all objects in the inventory recursively
688 MTH void set_flag_inv (int flag, int value = 1); 713 MTH void set_flag_inv (int flag, int value = 1);
689 714
690 void enter_exit (object *exit);//Perl 715 void enter_exit (object *exit); // perl
691 MTH void enter_map (maptile *newmap, int x, int y); 716 MTH bool enter_map (maptile *newmap, int x, int y);
692 void player_goto (const_utf8_string path, int x, int y); // only for players 717 void player_goto (const_utf8_string path, int x, int y); // only for players
693 MTH bool apply (object *ob, int aflags = AP_APPLY); // ob may be 0 718 MTH bool apply (object *ob, int aflags = AP_APPLY); // ob may be 0
719
720 MTH object *mark () const;
721 MTH void splay_marked ();
694 722
695 // returns the mapspace this object is in 723 // returns the mapspace this object is in
696 mapspace &ms () const; 724 mapspace &ms () const;
697 725
698 // fully recursive iterator 726 // fully recursive iterator
749 return weight + carrying; 777 return weight + carrying;
750 } 778 }
751 779
752 MTH struct region *region () const; 780 MTH struct region *region () const;
753 781
754 void statusmsg (const_utf8_string msg, int color = NDI_BLACK); 782 MTH void statusmsg (const_utf8_string msg, int color = NDI_BLACK);
755 void failmsg (const_utf8_string msg, int color = NDI_RED); 783 MTH void failmsg (const_utf8_string msg, int color = NDI_RED);
756 void failmsgf (const_utf8_string format, ...); // always NDI_RED... 784 void failmsgf (const_utf8_string format, ...); // always NDI_RED...
757 785
758 const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = ""); 786 MTH const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = "");
759 787
760 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference 788 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
761 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible 789 static object *deref (const_octet_string ref); // returns the object from the generated reference, if possible
762 790
763 // make some noise with given item into direction dir, 791 // make some noise with given item into direction dir,
764 // currently only used for players to make them temporarily visible 792 // currently only used for players to make them temporarily visible
765 // when they are invisible. 793 // when they are invisible.
766 MTH void make_noise (); 794 MTH void make_noise ();
776 * range from 0 through 7. 804 * range from 0 through 7.
777 */ 805 */
778 MTH int anim_frames () const { return anim ().num_animations; } 806 MTH int anim_frames () const { return anim ().num_animations; }
779 MTH int anim_facings () const { return anim ().facings; } 807 MTH int anim_facings () const { return anim ().facings; }
780 808
809 // sets a new animation frame, if the object has animation frames,
810 // and updates the face
811 MTH void update_anim_frame (int frame);
812
781 MTH utf8_string as_string (); 813 MTH utf8_string as_string ();
782 814
783 // low-level management, statistics, ... 815 // low-level management, statistics, ...
784 static uint32_t ACC (RW, object_count); 816 static uint32_t ACC (RW, object_count);
785 static uint32_t ACC (RW, free_count); 817 static uint32_t ACC (RW, free_count);
857 MTH object *instance (); 889 MTH object *instance ();
858 890
859 MTH void post_load_check (); // do some adjustments after parsing 891 MTH void post_load_check (); // do some adjustments after parsing
860 892
861 object_vector_index ACC (RW, archid); // index in archvector 893 object_vector_index ACC (RW, archid); // index in archvector
862 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 894 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
863 895
864 sint8 ACC (RW, max_x); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ 896 sint8 ACC (RW, max_x); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
865 897
866 // support for archetype loading 898 // support for archetype loading
867 static archetype *read (object_thawer &f); 899 static archetype *read (object_thawer &f);
899// "safely" iterate over inv in a way such that the current item is removable 931// "safely" iterate over inv in a way such that the current item is removable
900// quite horrible, that's why its hidden in some macro 932// quite horrible, that's why its hidden in some macro
901#define for_inv_removable(op,var) \ 933#define for_inv_removable(op,var) \
902 for (object *var, *next_ = (op)->inv; (var = next_), var && (next_ = var->below), var; ) 934 for (object *var, *next_ = (op)->inv; (var = next_), var && (next_ = var->below), var; )
903 935
904#define for_all_objects(var) \ 936#define for_all_objects(var) \
905 for (unsigned _i = 0; _i < objects.size (); ++_i) \ 937 for (unsigned _i = 0; _i < objects.size (); ++_i) \
906 statementvar (object *, var, objects [_i]) 938 statementvar (object *, var, objects [_i])
907 939
908#define for_all_actives(var) \ 940#define for_all_actives(var) \
909 for (unsigned _i = 0; _i < actives.size (); ++_i) \ 941 for (unsigned _i = 0; _i < actives.size (); ++_i) \
910 statementvar (object *, var, actives [_i]) 942 statementvar (object *, var, actives [_i])
911 943
912#define for_all_archetypes(var) \ 944#define for_all_archetypes(var) \
913 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \ 945 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \
914 statementvar (archetype *, var, archetypes [_i]) 946 statementvar (archetype *, var, archetypes [_i])
915 947
916//+GPL 948//+GPL
917 949
918/* Used by update_object to know if the object being passed is 950/* Used by update_object to know if the object being passed is
919 * being added or removed. 951 * being added or removed.
920 */ 952 */
921#define UP_OBJ_INSERT 1 953#define UP_OBJ_INSERT 1 // object was inserted
922#define UP_OBJ_REMOVE 2 954#define UP_OBJ_REMOVE 2 // object was removed
923#define UP_OBJ_CHANGE 3 955#define UP_OBJ_CHANGE 3 // object has changed in some unspecified way
924#define UP_OBJ_FACE 4 /* Only thing that changed was the face */ 956#define UP_OBJ_FACE 4 // only thing that changed was the face
925 957
926/* These are flags passed to insert_ob_in_map and 958/* These are flags passed to insert_ob_in_map and
927 * insert_ob_in_ob. Note that all flags may not be meaningful 959 * insert_ob_in_ob. Note that all flags may not be meaningful
928 * for both functions. 960 * for both functions.
929 * Most are fairly explanatory: 961 * Most are fairly explanatory:
930 * INS_NO_MERGE: don't try to merge inserted object with ones alrady 962 * INS_NO_MERGE: don't try to merge inserted object with ones alrady
931 * on space. 963 * on space.
932 * INS_ABOVE_FLOOR_ONLY: Put object immediatly above the floor. 964 * INS_ABOVE_FLOOR_ONLY: Put object immediatly above the floor.
933 * INS_NO_WALK_ON: Don't call check_walk_on against the 965 * INS_NO_WALK_ON: Don't call check_walk_on against the
934 * originator - saves cpu time if you know the inserted object 966 * originator - saves cpu time if you know the inserted object
935 * is not meaningful in terms of having an effect. 967 * is not meaningful in terms of having an effect.
936 * INS_ON_TOP: Always put object on top. Generally only needed when loading 968 * INS_ON_TOP: Always put object on top. Generally only needed when loading
937 * files from disk and ordering needs to be preserved. 969 * files from disk and ordering needs to be preserved.
938 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - 970 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
939 * Use for treasure chests so the new object is the highest thing 971 * Use for treasure chests so the new object is the highest thing
940 * beneath the player, but not actually above it. Note - the 972 * beneath the player, but not actually above it. Note - the
941 * map and x,y coordinates for the object to be inserted must 973 * map and x,y coordinates for the object to be inserted must
942 * match the originator. 974 * match the originator.
950#define INS_NO_MERGE 0x0001 982#define INS_NO_MERGE 0x0001
951#define INS_ABOVE_FLOOR_ONLY 0x0002 983#define INS_ABOVE_FLOOR_ONLY 0x0002
952#define INS_NO_WALK_ON 0x0004 984#define INS_NO_WALK_ON 0x0004
953#define INS_ON_TOP 0x0008 985#define INS_ON_TOP 0x0008
954#define INS_BELOW_ORIGINATOR 0x0010 986#define INS_BELOW_ORIGINATOR 0x0010
987#define INS_NO_AUTO_EXIT 0x0020 // temporary, fix exits instead
955 988
956//-GPL 989//-GPL
957 990
958#endif 991#endif
959 992

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines