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.131 by root, Tue Jun 5 13:05:02 2007 UTC vs.
Revision 1.155 by root, Thu Apr 10 15:35:16 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}; 101};
96
97extern void init_uuid ();
98extern UUID gen_uuid ();
99extern const uint64 UUID_SKIP;
100 102
101/* Definition for WILL_APPLY values. Replaces having harcoded values 103/* Definition for WILL_APPLY values. Replaces having harcoded values
102 * sprinkled in the code. Note that some of these also replace fields 104 * 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 105 * that were in the can_apply area. What is the point of having both
104 * can_apply and will_apply? 106 * can_apply and will_apply?
132 shstr ACC (RW, name_pl); /* The plural name of the object */ 134 shstr ACC (RW, name_pl); /* The plural name of the object */
133 shstr ACC (RW, title); /* Of foo, etc */ 135 shstr ACC (RW, title); /* Of foo, etc */
134 shstr ACC (RW, race); /* human, goblin, dragon, etc */ 136 shstr ACC (RW, race); /* human, goblin, dragon, etc */
135 shstr ACC (RW, slaying); /* Which race to do double damage to */ 137 shstr ACC (RW, slaying); /* Which race to do double damage to */
136 /* If this is an exit, this is the filename */ 138 /* If this is an exit, this is the filename */
139 shstr ACC (RW, tag); // a tag used to tracking this object
137 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */ 140 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 */ 141 shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */
139 shstr ACC (RW, lore); /* Obscure information about this object, */ 142 shstr ACC (RW, lore); /* Obscure information about this object, */
140 /* To get put into books and the like. */ 143 /* To get put into books and the like. */
141 shstr ACC (RW, materialname); /* specific material name */ 144 shstr ACC (RW, materialname); /* specific material name */
185 sint32 ACC (RW, carrying); /* How much weight this object contains */ 188 sint32 ACC (RW, carrying); /* How much weight this object contains */
186 sint64 ACC (RW, perm_exp); /* Permanent exp */ 189 sint64 ACC (RW, perm_exp); /* Permanent exp */
187 uint32 ACC (RW, weapontype); /* type of weapon */ 190 uint32 ACC (RW, weapontype); /* type of weapon */
188 uint32 ACC (RW, tooltype); /* type of tool or build facility */ 191 uint32 ACC (RW, tooltype); /* type of tool or build facility */
189 body_slot slot [NUM_BODY_LOCATIONS]; 192 body_slot slot [NUM_BODY_LOCATIONS];
190 faceidx ACC (RW, face); /* Face with colors */ 193 faceidx ACC (RW, face); /* the graphical face */
194 faceidx ACC (RW, sound); /* the sound face */
195 faceidx ACC (RW, sound_destroy); /* played on destroy */
191 living ACC (RO, stats); /* Str, Con, Dex, etc */ 196 living ACC (RO, stats); /* Str, Con, Dex, etc */
192 /* See the pod/objects.pod for more info about body locations */ 197 /* See the pod/objects.pod for more info about body locations */
193 198
194 /* Following mostly refers to fields only used for monsters */ 199 /* Following mostly refers to fields only used for monsters */
195 uint32 ACC (RW, hide); /* The object is hidden, not invisible */ 200 uint32 ACC (RW, hide); /* The object is hidden, not invisible */
246 // These variables are not changed by ->copy_to 251 // These variables are not changed by ->copy_to
247 maptile_ptr ACC (RW, map); /* Pointer to the map in which this object is present */ 252 maptile_ptr ACC (RW, map); /* Pointer to the map in which this object is present */
248 253
249 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 254 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
250 int ACC (RO, count); 255 int ACC (RO, count);
251 int ACC (RO, index); // index into objects 256 object_vector_index ACC (RO, index); // index into objects
252 int ACC (RO, active); // index into actives 257 object_vector_index ACC (RO, active); // index into actives
253 258
254 player_ptr ACC (RW, contr); /* Pointer to the player which control this object */ 259 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */
255 260
256 object *ACC (RW, below); /* Pointer to the object stacked below this one */ 261 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 */ 262 object *ACC (RW, above); /* Pointer to the object stacked above this one */
258 /* Note: stacked in the *same* environment */ 263 /* Note: stacked in the *same* environment */
259 object *inv; /* Pointer to the first object in the inventory */ 264 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 274 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? 275 client_container *seen_by; // seen by which player/container currently?
271 key_value *key_values; /* Fields not explictly known by the loader. */ 276 key_value *key_values; /* Fields not explictly known by the loader. */
272 277
273 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all 278 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 279 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. 280 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
276 bool write (object_freezer &f); 281 bool write (object_freezer &f);
277 282
278 MTH int slottype () const; 283 MTH int slottype () const;
279 MTH static object *create (); 284 MTH static object *create ();
285 const mapxy &operator =(const mapxy &pos);
280 object &operator =(const object &src); 286 object &operator =(const object &src);
281 MTH void copy_to (object *dst); 287 MTH void copy_to (object *dst);
282 MTH object *clone (); // create + copy_to 288 MTH object *clone (); // create + copy_to
283 void do_destroy (); 289 void do_destroy ();
284 void gather_callbacks (AV *&callbacks, event_type event) const; 290 void gather_callbacks (AV *&callbacks, event_type event) const;
285 MTH void destroy (bool destroy_inventory = false); 291 MTH void destroy (bool destroy_inventory = false);
286 292
287 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 293 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
288 MTH void destroy_inv (bool drop_to_ground = false); 294 MTH void destroy_inv (bool drop_to_ground = false);
289 MTH object *insert (object *item); // insert into inventory 295 MTH object *insert (object *item); // insert into inventory
296 MTH void play_sound (faceidx sound) const;
297
290 void do_remove (); 298 void do_remove ();
291 MTH void remove () 299 MTH void remove ()
292 { 300 {
293 if (!flag [FLAG_REMOVED]) 301 if (!flag [FLAG_REMOVED])
294 do_remove (); 302 do_remove ();
303 }
304
305 MTH bool blocked (maptile *m, int x, int y) const;
306
307 void move_to (const mapxy &pos)
308 {
309 remove ();
310 *this = pos;
311 insert_at (this, this);
295 } 312 }
296 313
297 static bool can_merge_slow (object *op1, object *op2); 314 static bool can_merge_slow (object *op1, object *op2);
298 315
299 // this is often used in time-critical code, so optimise 316 // this is often used in time-critical code, so optimise
312 MTH void open_container (object *new_container); 329 MTH void open_container (object *new_container);
313 MTH void close_container () 330 MTH void close_container ()
314 { 331 {
315 open_container (0); 332 open_container (0);
316 } 333 }
334
335 MTH object *force_find (const shstr name);
336 MTH void force_add (const shstr name, int duration = 0);
317 337
318 // overwrite the attachable should_invoke function with a version that also checks ev_want_type 338 // overwrite the attachable should_invoke function with a version that also checks ev_want_type
319 bool should_invoke (event_type event) 339 bool should_invoke (event_type event)
320 { 340 {
321 return ev_want_event [event] || ev_want_type [type] || cb; 341 return ev_want_event [event] || ev_want_type [type] || cb;
377 397
378 // temporary: wether the object can be saved in a map file 398 // temporary: wether the object can be saved in a map file
379 // contr => is a player 399 // contr => is a player
380 // head => only save head of a multitile object 400 // head => only save head of a multitile object
381 // owner => can not reference owner yet 401 // owner => can not reference owner yet
382 MTH bool can_map_save () const { return !contr && !head && !owner && !flag [FLAG_NO_MAP_SAVE]; } 402 MTH bool can_map_save () const { return !head && (!owner || owner->contr) && !contr && !flag [FLAG_NO_MAP_SAVE]; }
383 403
384 /* This return true if object has still randomitems which 404 /* This return true if object has still randomitems which
385 * could be expanded. 405 * could be expanded.
386 */ 406 */
387 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } 407 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
421 MTH void create_treasure (treasurelist *tl, int flags = 0); 441 MTH void create_treasure (treasurelist *tl, int flags = 0);
422 442
423 // insert object at same map position as 'where' 443 // insert object at same map position as 'where'
424 // handles both inventory and map "positions" 444 // handles both inventory and map "positions"
425 MTH object *insert_at (object *where, object *originator = 0, int flags = 0); 445 MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
446 MTH void drop_unpaid_items ();
426 447
427 MTH void activate (); 448 MTH void activate ();
428 MTH void deactivate (); 449 MTH void deactivate ();
429 MTH void activate_recursive (); 450 MTH void activate_recursive ();
430 MTH void deactivate_recursive (); 451 MTH void deactivate_recursive ();
485 { 506 {
486 return !invisible && type != PLAYER; 507 return !invisible && type != PLAYER;
487 } 508 }
488 509
489 MTH struct region *region () const; 510 MTH struct region *region () const;
511
512 void statusmsg (const char *msg, int color = NDI_BLACK);
513 void failmsg (const char *msg, int color = NDI_RED);
514
515 const char *query_inventory (object *who = 0, const char *indent = "");
516
517 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
518 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
490 519
491protected: 520protected:
492 void link (); 521 void link ();
493 void unlink (); 522 void unlink ();
494 523
547 archetype (const char *name); 576 archetype (const char *name);
548 ~archetype (); 577 ~archetype ();
549 void gather_callbacks (AV *&callbacks, event_type event) const; 578 void gather_callbacks (AV *&callbacks, event_type event) const;
550 579
551 static archetype *read (object_thawer &f); 580 static archetype *read (object_thawer &f);
581
552 static archetype *get (const char *name); // find or create 582 MTH static archetype *get (const_utf8_string name); // find or create
553 static archetype *find (const char *name); 583 MTH static archetype *find (const_utf8_string name);
554 584
555 void link (); 585 MTH void link ();
556 void unlink (); 586 MTH void unlink ();
557 587
588 MTH object *instance ();
589
558 int ACC (RW, archid); // index in archvector 590 object_vector_index ACC (RW, archid); // index in archvector
559 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 591 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
560 bool ACC (RW, stub); // if true, this is an invalid archetype 592 bool ACC (RW, stub); // if true, this is an invalid archetype
561 uint32 ACC (RW, editable); /* editable flags (mainly for editor) */
562 593
563 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ 594 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
564 sint8 ACC (RW, max_x), ACC (RW, max_y); 595 sint8 ACC (RW, max_x), ACC (RW, max_y);
565}; 596};
597
598inline void
599object_freezer::put (keyword k, archetype *v)
600{
601 put (k, v ? &v->archname : (const char *)0);
602}
566 603
567typedef object_vector<object, &object::index > objectvec; 604typedef object_vector<object, &object::index > objectvec;
568typedef object_vector<object, &object::active> activevec; 605typedef object_vector<object, &object::active> activevec;
569typedef object_vector<archetype, &archetype::archid> archvec; 606typedef object_vector<archetype, &archetype::archid> archvec;
570 607
607 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - 644 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
608 * Use for treasure chests so the new object is the highest thing 645 * Use for treasure chests so the new object is the highest thing
609 * beneath the player, but not actually above it. Note - the 646 * beneath the player, but not actually above it. Note - the
610 * map and x,y coordinates for the object to be inserted must 647 * map and x,y coordinates for the object to be inserted must
611 * match the originator. 648 * match the originator.
612 * INS_MAP_LOAD: disable lots of checkings done at insertion to
613 * speed up map loading process, as we assume the ordering in
614 * loaded map is correct.
615 * 649 *
616 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY 650 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
617 * are mutually exclusive. The behaviour for passing more than one 651 * are mutually exclusive. The behaviour for passing more than one
618 * should be considered undefined - while you may notice what happens 652 * should be considered undefined - while you may notice what happens
619 * right now if you pass more than one, that could very well change 653 * right now if you pass more than one, that could very well change
622#define INS_NO_MERGE 0x0001 656#define INS_NO_MERGE 0x0001
623#define INS_ABOVE_FLOOR_ONLY 0x0002 657#define INS_ABOVE_FLOOR_ONLY 0x0002
624#define INS_NO_WALK_ON 0x0004 658#define INS_NO_WALK_ON 0x0004
625#define INS_ON_TOP 0x0008 659#define INS_ON_TOP 0x0008
626#define INS_BELOW_ORIGINATOR 0x0010 660#define INS_BELOW_ORIGINATOR 0x0010
627#define INS_MAP_LOAD 0x0020
628 661
629#define ARCH_SINGULARITY "singularity"
630#define ARCH_DETECT_MAGIC "detect_magic"
631#define ARCH_DEPLETION "depletion" 662#define ARCH_DEPLETION "depletion"
632#define ARCH_SYMPTOM "symptom"
633 663
634#endif 664#endif
635 665

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines