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.130 by root, Mon Jun 4 13:04:00 2007 UTC vs.
Revision 1.161 by root, Sun Apr 20 05:24:55 2008 UTC

1/* 1/*
2 * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game. 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team 4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (©) 2001,2007 Mark Wedel & Crossfire Development Team 5 * Copyright (©) 2001,2007 Mark Wedel & Crossfire Development Team
6 * Copyright (©) 1992,2007 Frank Tore Johansen 6 * Copyright (©) 1992,2007 Frank Tore Johansen
7 * 7 *
8 * Crossfire TRT is free software; you can redistribute it and/or modify it 8 * Deliantra is free software: you can redistribute it and/or modify
9 * under the terms of the GNU General Public License as published by the Free 9 * it under the terms of the GNU General Public License as published by
10 * Software Foundation; either version 2 of the License, or (at your option) 10 * the Free Software Foundation, either version 3 of the License, or
11 * any later version. 11 * (at your option) any later version.
12 * 12 *
13 * This program is distributed in the hope that it will be useful, but 13 * This program is distributed in the hope that it will be useful,
14 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * for more details. 16 * GNU General Public License for more details.
17 * 17 *
18 * You should have received a copy of the GNU General Public License along 18 * You should have received a copy of the GNU General Public License
19 * with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 * 20 *
22 * The authors can be reached via e-mail to <crossfire@schmorp.de> 21 * The authors can be reached via e-mail to <support@deliantra.net>
23 */ 22 */
24 23
25#ifndef OBJECT_H 24#ifndef OBJECT_H
26#define OBJECT_H 25#define OBJECT_H
27 26
… …
66 const char *nonuse_name; /* Name to describe objects we can't use */ 65 const char *nonuse_name; /* Name to describe objects we can't use */
67} Body_Locations; 66} Body_Locations;
68 67
69extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; 68extern Body_Locations body_locations[NUM_BODY_LOCATIONS];
70 69
70#define NUM_COINS 4 /* number of coin types */
71extern const char *const coins[NUM_COINS + 1];
72
71/* 73/*
72 * Each object (this also means archetypes!) could have a few of these 74 * Each object (this also means archetypes!) could have a few of these
73 * "dangling" from it; this could also end up containing 'parse errors'. 75 * "dangling" from it; this could also end up containing 'parse errors'.
74 * 76 *
75 * key and value are shared-strings. 77 * key and value are shared-strings.
… …
86 88
87struct UUID 89struct UUID
88{ 90{
89 uint64 seq; 91 uint64 seq;
90 92
93 static UUID cur; // last uuid generated
94 static void init ();
95 static UUID gen ();
96
91 UUID () { } 97 UUID () { }
92 UUID (uint64 seq) : seq(seq) { } 98 UUID (uint64 seq) : seq(seq) { }
93 operator uint64() { return seq; } 99 operator uint64() { return seq; }
94 void operator =(uint64 seq) { this->seq = seq; } 100 void operator =(uint64 seq) { this->seq = seq; }
95};
96 101
97extern void init_uuid (); 102 typedef char BUF [32];
98extern UUID gen_uuid (); 103
99extern const uint64 UUID_SKIP; 104 bool parse (const char *s)
105 {
106 return sscanf (s, "<1.%" SCNx64 ">", &seq) == 1;
107 }
108
109 const char *c_str (char *buf, int len) const
110 {
111 snprintf (buf, len, "<1.%" PRIx64 ">", seq);
112
113 return buf;
114 }
115
116 const char *c_str () const
117 {
118 static BUF buf;
119
120 return c_str (buf, sizeof (buf));
121 }
122};
100 123
101/* Definition for WILL_APPLY values. Replaces having harcoded values 124/* Definition for WILL_APPLY values. Replaces having harcoded values
102 * sprinkled in the code. Note that some of these also replace fields 125 * sprinkled in the code. Note that some of these also replace fields
103 * that were in the can_apply area. What is the point of having both 126 * that were in the can_apply area. What is the point of having both
104 * can_apply and will_apply? 127 * can_apply and will_apply?
… …
132 shstr ACC (RW, name_pl); /* The plural name of the object */ 155 shstr ACC (RW, name_pl); /* The plural name of the object */
133 shstr ACC (RW, title); /* Of foo, etc */ 156 shstr ACC (RW, title); /* Of foo, etc */
134 shstr ACC (RW, race); /* human, goblin, dragon, etc */ 157 shstr ACC (RW, race); /* human, goblin, dragon, etc */
135 shstr ACC (RW, slaying); /* Which race to do double damage to */ 158 shstr ACC (RW, slaying); /* Which race to do double damage to */
136 /* If this is an exit, this is the filename */ 159 /* If this is an exit, this is the filename */
160 shstr ACC (RW, tag); // a tag used to tracking this object
137 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */ 161 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */
138 shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */ 162 shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */
139 shstr ACC (RW, lore); /* Obscure information about this object, */ 163 shstr ACC (RW, lore); /* Obscure information about this object, */
140 /* To get put into books and the like. */ 164 /* To get put into books and the like. */
141 shstr ACC (RW, materialname); /* specific material name */ 165 shstr ACC (RW, materialname); /* specific material name */
… …
185 sint32 ACC (RW, carrying); /* How much weight this object contains */ 209 sint32 ACC (RW, carrying); /* How much weight this object contains */
186 sint64 ACC (RW, perm_exp); /* Permanent exp */ 210 sint64 ACC (RW, perm_exp); /* Permanent exp */
187 uint32 ACC (RW, weapontype); /* type of weapon */ 211 uint32 ACC (RW, weapontype); /* type of weapon */
188 uint32 ACC (RW, tooltype); /* type of tool or build facility */ 212 uint32 ACC (RW, tooltype); /* type of tool or build facility */
189 body_slot slot [NUM_BODY_LOCATIONS]; 213 body_slot slot [NUM_BODY_LOCATIONS];
190 faceidx ACC (RW, face); /* Face with colors */ 214 faceidx ACC (RW, face); /* the graphical face */
215 faceidx ACC (RW, sound); /* the sound face */
216 faceidx ACC (RW, sound_destroy); /* played on destroy */
191 living ACC (RO, stats); /* Str, Con, Dex, etc */ 217 living ACC (RO, stats); /* Str, Con, Dex, etc */
192 /* See the pod/objects.pod for more info about body locations */ 218 /* See the pod/objects.pod for more info about body locations */
193 219
194 /* Following mostly refers to fields only used for monsters */ 220 /* Following mostly refers to fields only used for monsters */
195 uint32 ACC (RW, hide); /* The object is hidden, not invisible */ 221 uint32 ACC (RW, hide); /* The object is hidden, not invisible */
… …
246 // These variables are not changed by ->copy_to 272 // These variables are not changed by ->copy_to
247 maptile_ptr ACC (RW, map); /* Pointer to the map in which this object is present */ 273 maptile_ptr ACC (RW, map); /* Pointer to the map in which this object is present */
248 274
249 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 275 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
250 int ACC (RO, count); 276 int ACC (RO, count);
251 int ACC (RO, index); // index into objects 277 object_vector_index ACC (RO, index); // index into objects
252 int ACC (RO, active); // index into actives 278 object_vector_index ACC (RO, active); // index into actives
253 279
254 player_ptr ACC (RW, contr); /* Pointer to the player which control this object */ 280 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */
255 281
256 object *ACC (RW, below); /* Pointer to the object stacked below this one */ 282 object *ACC (RW, below); /* Pointer to the object stacked below this one */
257 object *ACC (RW, above); /* Pointer to the object stacked above this one */ 283 object *ACC (RW, above); /* Pointer to the object stacked above this one */
258 /* Note: stacked in the *same* environment */ 284 /* Note: stacked in the *same* environment */
259 object *inv; /* Pointer to the first object in the inventory */ 285 object *inv; /* Pointer to the first object in the inventory */
… …
269 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different 295 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different
270 client_container *seen_by; // seen by which player/container currently? 296 client_container *seen_by; // seen by which player/container currently?
271 key_value *key_values; /* Fields not explictly known by the loader. */ 297 key_value *key_values; /* Fields not explictly known by the loader. */
272 298
273 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all 299 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
274 void post_load_check (); // do some adjustments after parsing 300 MTH void post_load_check (); // do some adjustments after parsing
275 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go. 301 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
276 bool write (object_freezer &f); 302 bool write (object_freezer &f);
277 303
278 MTH int slottype () const; 304 MTH int slottype () const;
279 MTH static object *create (); 305 MTH static object *create ();
306 const mapxy &operator =(const mapxy &pos);
280 object &operator =(const object &src); 307 object &operator =(const object &src);
281 MTH void copy_to (object *dst); 308 MTH void copy_to (object *dst);
282 MTH object *clone (); // create + copy_to 309 MTH object *clone (); // create + copy_to
283 void do_destroy (); 310 void do_destroy ();
284 void gather_callbacks (AV *&callbacks, event_type event) const; 311 void gather_callbacks (AV *&callbacks, event_type event) const;
285 MTH void destroy (bool destroy_inventory = false); 312 MTH void destroy (bool destroy_inventory = false);
286 313
287 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 314 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
288 MTH void destroy_inv (bool drop_to_ground = false); 315 MTH void destroy_inv (bool drop_to_ground = false);
289 MTH object *insert (object *item); // insert into inventory 316 MTH object *insert (object *item); // insert into inventory
317 MTH void play_sound (faceidx sound) const;
318
290 void do_remove (); 319 void do_remove ();
291 MTH void remove () 320 MTH void remove ()
292 { 321 {
293 if (!flag [FLAG_REMOVED]) 322 if (!flag [FLAG_REMOVED])
294 do_remove (); 323 do_remove ();
324 }
325
326 MTH bool blocked (maptile *m, int x, int y) const;
327
328 void move_to (const mapxy &pos)
329 {
330 remove ();
331 *this = pos;
332 insert_at (this, this);
295 } 333 }
296 334
297 static bool can_merge_slow (object *op1, object *op2); 335 static bool can_merge_slow (object *op1, object *op2);
298 336
299 // this is often used in time-critical code, so optimise 337 // this is often used in time-critical code, so optimise
… …
312 MTH void open_container (object *new_container); 350 MTH void open_container (object *new_container);
313 MTH void close_container () 351 MTH void close_container ()
314 { 352 {
315 open_container (0); 353 open_container (0);
316 } 354 }
355
356 MTH object *force_find (const shstr name);
357 MTH void force_add (const shstr name, int duration = 0);
317 358
318 // overwrite the attachable should_invoke function with a version that also checks ev_want_type 359 // overwrite the attachable should_invoke function with a version that also checks ev_want_type
319 bool should_invoke (event_type event) 360 bool should_invoke (event_type event)
320 { 361 {
321 return ev_want_event [event] || ev_want_type [type] || cb; 362 return ev_want_event [event] || ev_want_type [type] || cb;
… …
377 418
378 // temporary: wether the object can be saved in a map file 419 // temporary: wether the object can be saved in a map file
379 // contr => is a player 420 // contr => is a player
380 // head => only save head of a multitile object 421 // head => only save head of a multitile object
381 // owner => can not reference owner yet 422 // owner => can not reference owner yet
382 MTH bool can_map_save () const { return !contr && !head && !owner && !flag [FLAG_NO_MAP_SAVE]; } 423 MTH bool can_map_save () const { return !head && (!owner || owner->contr) && !contr && !flag [FLAG_NO_MAP_SAVE]; }
383 424
384 /* This return true if object has still randomitems which 425 /* This return true if object has still randomitems which
385 * could be expanded. 426 * could be expanded.
386 */ 427 */
387 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } 428 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
… …
421 MTH void create_treasure (treasurelist *tl, int flags = 0); 462 MTH void create_treasure (treasurelist *tl, int flags = 0);
422 463
423 // insert object at same map position as 'where' 464 // insert object at same map position as 'where'
424 // handles both inventory and map "positions" 465 // handles both inventory and map "positions"
425 MTH object *insert_at (object *where, object *originator = 0, int flags = 0); 466 MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
467 MTH void drop_unpaid_items ();
426 468
427 MTH void activate (); 469 MTH void activate ();
428 MTH void deactivate (); 470 MTH void deactivate ();
429 MTH void activate_recursive (); 471 MTH void activate_recursive ();
430 MTH void deactivate_recursive (); 472 MTH void deactivate_recursive ();
431 473
432 // set the givne flag on all objects in the inventory recursively 474 // set the given flag on all objects in the inventory recursively
433 MTH void set_flag_inv (int flag, int value = 1); 475 MTH void set_flag_inv (int flag, int value = 1);
434 476
435 void enter_exit (object *exit);//Perl 477 void enter_exit (object *exit);//Perl
436 MTH void enter_map (maptile *newmap, int x, int y); 478 MTH void enter_map (maptile *newmap, int x, int y);
437 479
… …
486 return !invisible && type != PLAYER; 528 return !invisible && type != PLAYER;
487 } 529 }
488 530
489 MTH struct region *region () const; 531 MTH struct region *region () const;
490 532
533 void statusmsg (const char *msg, int color = NDI_BLACK);
534 void failmsg (const char *msg, int color = NDI_RED);
535
536 const char *query_inventory (object *who = 0, const char *indent = "");
537
538 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
539 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
540
491protected: 541protected:
492 void link (); 542 void link ();
493 void unlink (); 543 void unlink ();
494 544
495 object (); 545 object ();
… …
522} objectlink; 572} objectlink;
523 573
524typedef struct oblinkpt 574typedef struct oblinkpt
525{ /* Used to link together several object links */ 575{ /* Used to link together several object links */
526 struct oblnk *link; 576 struct oblnk *link;
527 long value; /* Used as connected value in buttons/gates */ 577 sint32 value; /* Used as connected value in buttons/gates */
528 struct oblinkpt *next; 578 struct oblinkpt *next;
529} oblinkpt; 579} oblinkpt;
530 580
531object *find_skill_by_name (object *who, const char *name); 581object *find_skill_by_name (object *who, const char *name);
532object *find_skill_by_name (object *who, const shstr &sh); 582object *find_skill_by_name (object *who, const shstr &sh);
… …
542 */ 592 */
543 593
544INTERFACE_CLASS (archetype) 594INTERFACE_CLASS (archetype)
545struct archetype : object 595struct archetype : object
546{ 596{
597 static arch_ptr empty; // the empty_archetype
598 MTH static void gc ();
599
547 archetype (const char *name); 600 archetype (const char *name);
548 ~archetype (); 601 ~archetype ();
549 void gather_callbacks (AV *&callbacks, event_type event) const; 602 void gather_callbacks (AV *&callbacks, event_type event) const;
550 603
551 static archetype *read (object_thawer &f);
552 static archetype *get (const char *name); // find or create
553 static archetype *find (const char *name); 604 MTH static archetype *find (const_utf8_string name);
554 605
555 void link (); 606 MTH void link ();
556 void unlink (); 607 MTH void unlink ();
557 608
609 MTH object *instance ();
610
558 int ACC (RW, archid); // index in archvector 611 object_vector_index ACC (RW, archid); // index in archvector
559 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 612 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
560 bool ACC (RW, stub); // if true, this is an invalid archetype
561 struct archetype *ACC (RW, next); /* Next archetype in a linked list */
562 struct archetype *ACC (RW, head); /* The main part of a linked object */
563 struct archetype *ACC (RW, more); /* Next part of a linked object */
564 uint32 ACC (RW, editable); /* editable flags (mainly for editor) */
565 613
566 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ 614 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
567 sint8 ACC (RW, max_x), ACC (RW, max_y); 615 sint8 ACC (RW, max_x), ACC (RW, max_y);
616
617 // support for archetype loading
618 static archetype *read (object_thawer &f);
619 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
620 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
568}; 621};
622
623inline void
624object_freezer::put (keyword k, archetype *v)
625{
626 put (k, v ? &v->archname : (const char *)0);
627}
569 628
570typedef object_vector<object, &object::index > objectvec; 629typedef object_vector<object, &object::index > objectvec;
571typedef object_vector<object, &object::active> activevec; 630typedef object_vector<object, &object::active> activevec;
572typedef object_vector<archetype, &archetype::archid> archvec; 631typedef object_vector<archetype, &archetype::archid> archvec;
573 632
… …
610 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - 669 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
611 * Use for treasure chests so the new object is the highest thing 670 * Use for treasure chests so the new object is the highest thing
612 * beneath the player, but not actually above it. Note - the 671 * beneath the player, but not actually above it. Note - the
613 * map and x,y coordinates for the object to be inserted must 672 * map and x,y coordinates for the object to be inserted must
614 * match the originator. 673 * match the originator.
615 * INS_MAP_LOAD: disable lots of checkings done at insertion to
616 * speed up map loading process, as we assume the ordering in
617 * loaded map is correct.
618 * 674 *
619 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY 675 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
620 * are mutually exclusive. The behaviour for passing more than one 676 * are mutually exclusive. The behaviour for passing more than one
621 * should be considered undefined - while you may notice what happens 677 * should be considered undefined - while you may notice what happens
622 * right now if you pass more than one, that could very well change 678 * right now if you pass more than one, that could very well change
… …
625#define INS_NO_MERGE 0x0001 681#define INS_NO_MERGE 0x0001
626#define INS_ABOVE_FLOOR_ONLY 0x0002 682#define INS_ABOVE_FLOOR_ONLY 0x0002
627#define INS_NO_WALK_ON 0x0004 683#define INS_NO_WALK_ON 0x0004
628#define INS_ON_TOP 0x0008 684#define INS_ON_TOP 0x0008
629#define INS_BELOW_ORIGINATOR 0x0010 685#define INS_BELOW_ORIGINATOR 0x0010
630#define INS_MAP_LOAD 0x0020
631 686
632#define ARCH_SINGULARITY "singularity"
633#define ARCH_DETECT_MAGIC "detect_magic"
634#define ARCH_DEPLETION "depletion" 687#define ARCH_DEPLETION "depletion"
635#define ARCH_SYMPTOM "symptom"
636 688
637#endif 689#endif
638 690

Diff Legend

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