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.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
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 ()
567 580
568 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; } 581 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; }
569 582
570 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); } 583 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); }
571 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
572 // returns the outermost owner, never returns 0 591 // returns the outermost owner, never returns 0
573 MTH object *outer_owner () 592 MTH object *outer_owner ()
574 { 593 {
575 object *op; 594 object *op;
576 595
643 MTH bool has_carried_lights () const 662 MTH bool has_carried_lights () const
644 { 663 {
645 return glow_radius; 664 return glow_radius;
646 } 665 }
647 666
648 // returns the player that cna see this object, if any 667 // returns the player that can see this object, if any
649 MTH object *visible_to () const; 668 MTH object *visible_to () const;
650 669
651 MTH std::string long_desc (object *who = 0); // query_name . " " . describe 670 MTH std::string long_desc (object *who = 0); // query_name . " " . describe
652 MTH std::string describe_monster (object *who = 0); 671 MTH std::string describe_monster (object *who = 0);
653 MTH std::string describe_item (object *who = 0); 672 MTH std::string describe_item (object *who = 0);
682 MTH void activate (); 701 MTH void activate ();
683 MTH void deactivate (); 702 MTH void deactivate ();
684 MTH void activate_recursive (); 703 MTH void activate_recursive ();
685 MTH void deactivate_recursive (); 704 MTH void deactivate_recursive ();
686 705
706 // prefetch and activate the surrounding area
707 MTH void prefetch_surrounding_maps ();
708
687 // set the given flag on all objects in the inventory recursively 709 // set the given flag on all objects in the inventory recursively
688 MTH void set_flag_inv (int flag, int value = 1); 710 MTH void set_flag_inv (int flag, int value = 1);
689 711
690 void enter_exit (object *exit);//Perl 712 void enter_exit (object *exit); // perl
691 MTH void enter_map (maptile *newmap, int x, int y); 713 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 714 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 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 ();
694 719
695 // returns the mapspace this object is in 720 // returns the mapspace this object is in
696 mapspace &ms () const; 721 mapspace &ms () const;
697 722
698 // fully recursive iterator 723 // fully recursive iterator
749 return weight + carrying; 774 return weight + carrying;
750 } 775 }
751 776
752 MTH struct region *region () const; 777 MTH struct region *region () const;
753 778
754 void statusmsg (const_utf8_string msg, int color = NDI_BLACK); 779 MTH void statusmsg (const_utf8_string msg, int color = NDI_BLACK);
755 void failmsg (const_utf8_string msg, int color = NDI_RED); 780 MTH void failmsg (const_utf8_string msg, int color = NDI_RED);
756 void failmsgf (const_utf8_string format, ...); // always NDI_RED... 781 void failmsgf (const_utf8_string format, ...); // always NDI_RED...
757 782
758 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 = "");
759 784
760 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
761 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
762 787
763 // make some noise with given item into direction dir, 788 // make some noise with given item into direction dir,
764 // currently only used for players to make them temporarily visible 789 // currently only used for players to make them temporarily visible
765 // when they are invisible. 790 // when they are invisible.
766 MTH void make_noise (); 791 MTH void make_noise ();
950#define INS_NO_MERGE 0x0001 975#define INS_NO_MERGE 0x0001
951#define INS_ABOVE_FLOOR_ONLY 0x0002 976#define INS_ABOVE_FLOOR_ONLY 0x0002
952#define INS_NO_WALK_ON 0x0004 977#define INS_NO_WALK_ON 0x0004
953#define INS_ON_TOP 0x0008 978#define INS_ON_TOP 0x0008
954#define INS_BELOW_ORIGINATOR 0x0010 979#define INS_BELOW_ORIGINATOR 0x0010
980#define INS_NO_AUTO_EXIT 0x0020 // temporary, fix exits instead
955 981
956//-GPL 982//-GPL
957 983
958#endif 984#endif
959 985

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines