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.123 by root, Thu May 17 20:27:01 2007 UTC vs.
Revision 1.156 by root, Fri Apr 11 13:59:06 2008 UTC

1/* 1/*
2 * CrossFire, A Multiplayer Online RPG 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team 4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (C) 2001 Mark Wedel & Crossfire Development Team 5 * Copyright (©) 2001,2007 Mark Wedel & Crossfire Development Team
6 * Copyright (C) 1992 Frank Tore Johansen 6 * Copyright (©) 1992,2007 Frank Tore Johansen
7 * 7 *
8 * This program is free software; you can redistribute it and/or modify 8 * Deliantra is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by 9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or 10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) 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, 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 GNU General Public License 18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * 20 *
22 * The authors can be reached via e-mail at 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
… …
59 58
60/* See common/item.c */ 59/* See common/item.c */
61 60
62typedef struct Body_Locations 61typedef struct Body_Locations
63{ 62{
64 const char *save_name; /* Name used to load/save it to disk */ 63 keyword save_name; /* Name used to load/save it to disk */
65 const char *use_name; /* Name used when describing an item we can use */ 64 const char *use_name; /* Name used when describing an item we can use */
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];
69
70#define NUM_COINS 4 /* number of coin types */
71extern const char *const coins[NUM_COINS + 1];
70 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 *
… …
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?
… …
107#define WILL_APPLY_TREASURE 0x02 130#define WILL_APPLY_TREASURE 0x02
108#define WILL_APPLY_EARTHWALL 0x04 131#define WILL_APPLY_EARTHWALL 0x04
109#define WILL_APPLY_DOOR 0x08 132#define WILL_APPLY_DOOR 0x08
110#define WILL_APPLY_FOOD 0x10 133#define WILL_APPLY_FOOD 0x10
111 134
112/* However, if you're keeping a pointer of some sort, you probably
113 * don't just want it copied, so you'll need to add to common/object.C,
114 * e.g. ->copy_to ()
115 */
116
117struct body_slot 135struct body_slot
118{ 136{
119 signed char info:4; /* body info as loaded from the file */ 137 signed char info:4; /* body info as loaded from the file */
120 signed char used:4; /* Calculated value based on items equipped */ 138 signed char used:4; /* Calculated value based on items equipped */
121}; 139};
… …
137 shstr ACC (RW, name_pl); /* The plural name of the object */ 155 shstr ACC (RW, name_pl); /* The plural name of the object */
138 shstr ACC (RW, title); /* Of foo, etc */ 156 shstr ACC (RW, title); /* Of foo, etc */
139 shstr ACC (RW, race); /* human, goblin, dragon, etc */ 157 shstr ACC (RW, race); /* human, goblin, dragon, etc */
140 shstr ACC (RW, slaying); /* Which race to do double damage to */ 158 shstr ACC (RW, slaying); /* Which race to do double damage to */
141 /* 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
142 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 */
143 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 */
144 shstr ACC (RW, lore); /* Obscure information about this object, */ 163 shstr ACC (RW, lore); /* Obscure information about this object, */
145 /* To get put into books and the like. */ 164 /* To get put into books and the like. */
146 shstr ACC (RW, materialname); /* specific material name */ 165 shstr ACC (RW, materialname); /* specific material name */
… …
190 sint32 ACC (RW, carrying); /* How much weight this object contains */ 209 sint32 ACC (RW, carrying); /* How much weight this object contains */
191 sint64 ACC (RW, perm_exp); /* Permanent exp */ 210 sint64 ACC (RW, perm_exp); /* Permanent exp */
192 uint32 ACC (RW, weapontype); /* type of weapon */ 211 uint32 ACC (RW, weapontype); /* type of weapon */
193 uint32 ACC (RW, tooltype); /* type of tool or build facility */ 212 uint32 ACC (RW, tooltype); /* type of tool or build facility */
194 body_slot slot [NUM_BODY_LOCATIONS]; 213 body_slot slot [NUM_BODY_LOCATIONS];
195 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 */
196 living ACC (RO, stats); /* Str, Con, Dex, etc */ 217 living ACC (RO, stats); /* Str, Con, Dex, etc */
197 /* See the pod/objects.pod for more info about body locations */ 218 /* See the pod/objects.pod for more info about body locations */
198 219
199 /* Following mostly refers to fields only used for monsters */ 220 /* Following mostly refers to fields only used for monsters */
200 uint32 ACC (RW, hide); /* The object is hidden, not invisible */ 221 uint32 ACC (RW, hide); /* The object is hidden, not invisible */
… …
251 // These variables are not changed by ->copy_to 272 // These variables are not changed by ->copy_to
252 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 */
253 274
254 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 275 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
255 int ACC (RO, count); 276 int ACC (RO, count);
256 int ACC (RO, index); // index into objects 277 object_vector_index ACC (RO, index); // index into objects
257 int ACC (RO, active); // index into actives 278 object_vector_index ACC (RO, active); // index into actives
258 279
259 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 */
260 281
261 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 */
262 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 */
263 /* Note: stacked in the *same* environment */ 284 /* Note: stacked in the *same* environment */
264 object *inv; /* Pointer to the first object in the inventory */ 285 object *inv; /* Pointer to the first object in the inventory */
… …
274 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
275 client_container *seen_by; // seen by which player/container currently? 296 client_container *seen_by; // seen by which player/container currently?
276 key_value *key_values; /* Fields not explictly known by the loader. */ 297 key_value *key_values; /* Fields not explictly known by the loader. */
277 298
278 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
279 void post_load_check (); // do some adjustments after parsing 300 MTH void post_load_check (); // do some adjustments after parsing
280 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.
281 bool write (object_freezer &f); 302 bool write (object_freezer &f);
282 303
283 MTH int slottype () const; 304 MTH int slottype () const;
284 MTH static object *create (); 305 MTH static object *create ();
306 const mapxy &operator =(const mapxy &pos);
285 object &operator =(const object &src); 307 object &operator =(const object &src);
286 MTH void copy_to (object *dst); 308 MTH void copy_to (object *dst);
287 MTH object *clone (); // create + copy_to 309 MTH object *clone (); // create + copy_to
288 void do_destroy (); 310 void do_destroy ();
289 void gather_callbacks (AV *&callbacks, event_type event) const; 311 void gather_callbacks (AV *&callbacks, event_type event) const;
290 MTH void destroy (bool destroy_inventory = false); 312 MTH void destroy (bool destroy_inventory = false);
291 313
292 // 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
293 MTH void destroy_inv (bool drop_to_ground = false); 315 MTH void destroy_inv (bool drop_to_ground = false);
294 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
295 void do_remove (); 319 void do_remove ();
296 MTH void remove () 320 MTH void remove ()
297 { 321 {
298 if (!flag [FLAG_REMOVED]) 322 if (!flag [FLAG_REMOVED])
299 do_remove (); 323 do_remove ();
300 } 324 }
301 325
302 // move this object to the top of its env's inventory to speed up 326 MTH bool blocked (maptile *m, int x, int y) const;
303 // searches for it.
304 MTH object *inv_splay ()
305 {
306 if (env && env->inv != this)
307 {
308 if (above) above->below = below;
309 if (below) below->above = above;
310 327
311 above = 0; 328 void move_to (const mapxy &pos)
312 below = env->inv; 329 {
313 below->above = this; 330 remove ();
314 env->inv = this; 331 *this = pos;
315 } 332 insert_at (this, this);
316
317 return this;
318 } 333 }
319 334
320 static bool can_merge_slow (object *op1, object *op2); 335 static bool can_merge_slow (object *op1, object *op2);
321 336
322 // this is often used in time-critical code, so optimise 337 // this is often used in time-critical code, so optimise
… …
334 349
335 MTH void open_container (object *new_container); 350 MTH void open_container (object *new_container);
336 MTH void close_container () 351 MTH void close_container ()
337 { 352 {
338 open_container (0); 353 open_container (0);
354 }
355
356 MTH object *force_find (const shstr name);
357 MTH void force_add (const shstr name, int duration = 0);
358
359 // overwrite the attachable should_invoke function with a version that also checks ev_want_type
360 bool should_invoke (event_type event)
361 {
362 return ev_want_event [event] || ev_want_type [type] || cb;
339 } 363 }
340 364
341 MTH void instantiate (); 365 MTH void instantiate ();
342 366
343 // recalculate all stats 367 // recalculate all stats
… …
394 418
395 // temporary: wether the object can be saved in a map file 419 // temporary: wether the object can be saved in a map file
396 // contr => is a player 420 // contr => is a player
397 // head => only save head of a multitile object 421 // head => only save head of a multitile object
398 // owner => can not reference owner yet 422 // owner => can not reference owner yet
399 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]; }
400 424
401 /* This return true if object has still randomitems which 425 /* This return true if object has still randomitems which
402 * could be expanded. 426 * could be expanded.
403 */ 427 */
404 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]; }
… …
415 439
416 // "temporary" helper function 440 // "temporary" helper function
417 MTH object *head_ () 441 MTH object *head_ ()
418 { 442 {
419 return head ? head : this; 443 return head ? head : this;
444 }
445
446 MTH bool is_head ()
447 {
448 return head_ () == this;
420 } 449 }
421 450
422 MTH std::string long_desc (object *who = 0); 451 MTH std::string long_desc (object *who = 0);
423 MTH std::string describe_monster (object *who = 0); 452 MTH std::string describe_monster (object *who = 0);
424 MTH std::string describe_item (object *who = 0); 453 MTH std::string describe_item (object *who = 0);
… …
433 MTH void create_treasure (treasurelist *tl, int flags = 0); 462 MTH void create_treasure (treasurelist *tl, int flags = 0);
434 463
435 // insert object at same map position as 'where' 464 // insert object at same map position as 'where'
436 // handles both inventory and map "positions" 465 // handles both inventory and map "positions"
437 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 ();
438 468
439 MTH void activate (); 469 MTH void activate ();
440 MTH void deactivate (); 470 MTH void deactivate ();
441 MTH void activate_recursive (); 471 MTH void activate_recursive ();
442 MTH void deactivate_recursive (); 472 MTH void deactivate_recursive ();
… …
498 return !invisible && type != PLAYER; 528 return !invisible && type != PLAYER;
499 } 529 }
500 530
501 MTH struct region *region () const; 531 MTH struct region *region () const;
502 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
503protected: 541protected:
504 friend struct archetype;
505
506 void link (); 542 void link ();
507 void unlink (); 543 void unlink ();
508 544
509 object (); 545 object ();
510 ~object (); 546 ~object ();
511}; 547};
512 548
513typedef object_vector<object, &object::index > objectvec; 549// move this object to the top of its env's inventory to speed up
514typedef object_vector<object, &object::active> activevec; 550// searches for it.
551static object *
552splay (object *ob)
553{
554 if (ob->env && ob->env->inv != ob)
555 {
556 if (ob->above) ob->above->below = ob->below;
557 if (ob->below) ob->below->above = ob->above;
515 558
516extern objectvec objects; 559 ob->above = 0;
517extern activevec actives; 560 ob->below = ob->env->inv;
561 ob->below->above = ob;
562 ob->env->inv = ob;
563 }
518 564
519#define for_all_objects(var) \ 565 return ob;
520 for (unsigned _i = 0; _i < objects.size (); ++_i) \ 566}
521 declvar (object *, var, objects [_i])
522
523#define for_all_actives(var) \
524 for (unsigned _i = 0; _i < actives.size (); ++_i) \
525 declvar (object *, var, actives [_i])
526 567
527typedef struct oblnk 568typedef struct oblnk
528{ /* Used to link together several objects */ 569{ /* Used to link together several objects */
529 object_ptr ob; 570 object_ptr ob;
530 struct oblnk *next; 571 struct oblnk *next;
… …
549 * object and pointers. This structure should get removed, and just replaced 590 * object and pointers. This structure should get removed, and just replaced
550 * by the object structure 591 * by the object structure
551 */ 592 */
552 593
553INTERFACE_CLASS (archetype) 594INTERFACE_CLASS (archetype)
554struct archetype : zero_initialised, attachable 595struct archetype : object
555{ 596{
556 archetype (); 597 archetype (const char *name);
557 ~archetype (); 598 ~archetype ();
558 void gather_callbacks (AV *&callbacks, event_type event) const; 599 void gather_callbacks (AV *&callbacks, event_type event) const;
559 600
560 static archetype *read (object_thawer &f); 601 static archetype *read (object_thawer &f);
602
561 static archetype *get (const char *name); // find or create 603 MTH static archetype *get (const_utf8_string name); // find or create
562 static archetype *find (const char *name); 604 MTH static archetype *find (const_utf8_string name);
563 605
564 void hash_add (); // add to hashtable 606 MTH void link ();
565 void hash_del (); // remove from hashtable 607 MTH void unlink ();
566 608
609 MTH object *instance ();
610
611 object_vector_index ACC (RW, archid); // index in archvector
567 shstr ACC (RW, name); /* More definite name, like "generate_kobold" */ 612 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
568 struct archetype *ACC (RW, next); /* Next archetype in a linked list */ 613 bool ACC (RW, stub); // if true, this is an invalid archetype
569 struct archetype *ACC (RW, head); /* The main part of a linked object */ 614
570 struct archetype *ACC (RW, more); /* Next part of a linked object */ 615 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
571 object ACC (RO, clone); /* An object from which to do ->copy_to () */ 616 sint8 ACC (RW, max_x), ACC (RW, max_y);
572 uint32 ACC (RW, editable); /* editable flags (mainly for editor) */
573 bool ACC (RW, linked); // linked into list of heads
574 sint8 ACC (RW, tail_x), ACC (RW, tail_y); /* Where the lower right most portion of the object is
575 * in comparison to the head.
576 */
577}; 617};
618
619inline void
620object_freezer::put (keyword k, archetype *v)
621{
622 put (k, v ? &v->archname : (const char *)0);
623}
624
625typedef object_vector<object, &object::index > objectvec;
626typedef object_vector<object, &object::active> activevec;
627typedef object_vector<archetype, &archetype::archid> archvec;
628
629extern objectvec objects;
630extern activevec actives;
631extern archvec archetypes;
632
633#define for_all_objects(var) \
634 for (unsigned _i = 0; _i < objects.size (); ++_i) \
635 statementvar (object *, var, objects [_i])
636
637#define for_all_actives(var) \
638 for (unsigned _i = 0; _i < actives.size (); ++_i) \
639 statementvar (object *, var, actives [_i])
640
641#define for_all_archetypes(var) \
642 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \
643 statementvar (archetype *, var, archetypes [_i])
578 644
579/* Used by update_object to know if the object being passed is 645/* Used by update_object to know if the object being passed is
580 * being added or removed. 646 * being added or removed.
581 */ 647 */
582#define UP_OBJ_INSERT 1 648#define UP_OBJ_INSERT 1
… …
599 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - 665 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
600 * Use for treasure chests so the new object is the highest thing 666 * Use for treasure chests so the new object is the highest thing
601 * beneath the player, but not actually above it. Note - the 667 * beneath the player, but not actually above it. Note - the
602 * map and x,y coordinates for the object to be inserted must 668 * map and x,y coordinates for the object to be inserted must
603 * match the originator. 669 * match the originator.
604 * INS_MAP_LOAD: disable lots of checkings done at insertion to
605 * speed up map loading process, as we assume the ordering in
606 * loaded map is correct.
607 * 670 *
608 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY 671 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
609 * are mutually exclusive. The behaviour for passing more than one 672 * are mutually exclusive. The behaviour for passing more than one
610 * should be considered undefined - while you may notice what happens 673 * should be considered undefined - while you may notice what happens
611 * right now if you pass more than one, that could very well change 674 * right now if you pass more than one, that could very well change
… …
614#define INS_NO_MERGE 0x0001 677#define INS_NO_MERGE 0x0001
615#define INS_ABOVE_FLOOR_ONLY 0x0002 678#define INS_ABOVE_FLOOR_ONLY 0x0002
616#define INS_NO_WALK_ON 0x0004 679#define INS_NO_WALK_ON 0x0004
617#define INS_ON_TOP 0x0008 680#define INS_ON_TOP 0x0008
618#define INS_BELOW_ORIGINATOR 0x0010 681#define INS_BELOW_ORIGINATOR 0x0010
619#define INS_MAP_LOAD 0x0020
620 682
621#define ARCH_SINGULARITY "singularity"
622#define ARCH_DETECT_MAGIC "detect_magic"
623#define ARCH_DEPLETION "depletion" 683#define ARCH_DEPLETION "depletion"
624#define ARCH_SYMPTOM "symptom"
625 684
626#endif 685#endif
627 686

Diff Legend

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