| 1 | /* |
1 | /* |
| 2 | * This file is part of Crossfire TRT, the Roguelike Realtime MORPG. |
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 |
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 3 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, |
| … | |
… | |
| 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, see <http://www.gnu.org/licenses/>. |
19 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 20 | * |
20 | * |
| 21 | * 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> |
| 22 | */ |
22 | */ |
| 23 | |
23 | |
| 24 | #ifndef OBJECT_H |
24 | #ifndef OBJECT_H |
| 25 | #define OBJECT_H |
25 | #define OBJECT_H |
| 26 | |
26 | |
| … | |
… | |
| 65 | 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 */ |
| 66 | } Body_Locations; |
66 | } Body_Locations; |
| 67 | |
67 | |
| 68 | extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; |
68 | extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; |
| 69 | |
69 | |
|
|
70 | #define NUM_COINS 4 /* number of coin types */ |
|
|
71 | extern const char *const coins[NUM_COINS + 1]; |
|
|
72 | |
| 70 | /* |
73 | /* |
| 71 | * 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 |
| 72 | * "dangling" from it; this could also end up containing 'parse errors'. |
75 | * "dangling" from it; this could also end up containing 'parse errors'. |
| 73 | * |
76 | * |
| 74 | * key and value are shared-strings. |
77 | * key and value are shared-strings. |
| … | |
… | |
| 85 | |
88 | |
| 86 | struct UUID |
89 | struct UUID |
| 87 | { |
90 | { |
| 88 | uint64 seq; |
91 | uint64 seq; |
| 89 | |
92 | |
|
|
93 | static UUID cur; // last uuid generated |
|
|
94 | static void init (); |
|
|
95 | static UUID gen (); |
|
|
96 | |
| 90 | UUID () { } |
97 | UUID () { } |
| 91 | UUID (uint64 seq) : seq(seq) { } |
98 | UUID (uint64 seq) : seq(seq) { } |
| 92 | operator uint64() { return seq; } |
99 | operator uint64() { return seq; } |
| 93 | void operator =(uint64 seq) { this->seq = seq; } |
100 | void operator =(uint64 seq) { this->seq = seq; } |
| 94 | }; |
|
|
| 95 | |
101 | |
| 96 | extern void init_uuid (); |
102 | typedef char BUF [32]; |
| 97 | extern UUID gen_uuid (); |
103 | |
| 98 | extern 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 | }; |
| 99 | |
123 | |
| 100 | /* Definition for WILL_APPLY values. Replaces having harcoded values |
124 | /* Definition for WILL_APPLY values. Replaces having harcoded values |
| 101 | * 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 |
| 102 | * 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 |
| 103 | * can_apply and will_apply? |
127 | * can_apply and will_apply? |
| … | |
… | |
| 131 | shstr ACC (RW, name_pl); /* The plural name of the object */ |
155 | shstr ACC (RW, name_pl); /* The plural name of the object */ |
| 132 | shstr ACC (RW, title); /* Of foo, etc */ |
156 | shstr ACC (RW, title); /* Of foo, etc */ |
| 133 | shstr ACC (RW, race); /* human, goblin, dragon, etc */ |
157 | shstr ACC (RW, race); /* human, goblin, dragon, etc */ |
| 134 | shstr ACC (RW, slaying); /* Which race to do double damage to */ |
158 | shstr ACC (RW, slaying); /* Which race to do double damage to */ |
| 135 | /* 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 |
| 136 | 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 */ |
| 137 | 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 */ |
| 138 | shstr ACC (RW, lore); /* Obscure information about this object, */ |
163 | shstr ACC (RW, lore); /* Obscure information about this object, */ |
| 139 | /* To get put into books and the like. */ |
164 | /* To get put into books and the like. */ |
| 140 | shstr ACC (RW, materialname); /* specific material name */ |
165 | shstr ACC (RW, materialname); /* specific material name */ |
| … | |
… | |
| 184 | sint32 ACC (RW, carrying); /* How much weight this object contains */ |
209 | sint32 ACC (RW, carrying); /* How much weight this object contains */ |
| 185 | sint64 ACC (RW, perm_exp); /* Permanent exp */ |
210 | sint64 ACC (RW, perm_exp); /* Permanent exp */ |
| 186 | uint32 ACC (RW, weapontype); /* type of weapon */ |
211 | uint32 ACC (RW, weapontype); /* type of weapon */ |
| 187 | uint32 ACC (RW, tooltype); /* type of tool or build facility */ |
212 | uint32 ACC (RW, tooltype); /* type of tool or build facility */ |
| 188 | body_slot slot [NUM_BODY_LOCATIONS]; |
213 | body_slot slot [NUM_BODY_LOCATIONS]; |
| 189 | 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 */ |
| 190 | living ACC (RO, stats); /* Str, Con, Dex, etc */ |
217 | living ACC (RO, stats); /* Str, Con, Dex, etc */ |
| 191 | /* See the pod/objects.pod for more info about body locations */ |
218 | /* See the pod/objects.pod for more info about body locations */ |
| 192 | |
219 | |
| 193 | /* Following mostly refers to fields only used for monsters */ |
220 | /* Following mostly refers to fields only used for monsters */ |
| 194 | uint32 ACC (RW, hide); /* The object is hidden, not invisible */ |
221 | uint32 ACC (RW, hide); /* The object is hidden, not invisible */ |
| … | |
… | |
| 248 | UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. |
275 | UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. |
| 249 | int ACC (RO, count); |
276 | int ACC (RO, count); |
| 250 | object_vector_index ACC (RO, index); // index into objects |
277 | object_vector_index ACC (RO, index); // index into objects |
| 251 | object_vector_index ACC (RO, active); // index into actives |
278 | object_vector_index ACC (RO, active); // index into actives |
| 252 | |
279 | |
| 253 | 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 */ |
| 254 | |
281 | |
| 255 | 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 */ |
| 256 | 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 */ |
| 257 | /* Note: stacked in the *same* environment */ |
284 | /* Note: stacked in the *same* environment */ |
| 258 | object *inv; /* Pointer to the first object in the inventory */ |
285 | object *inv; /* Pointer to the first object in the inventory */ |
| … | |
… | |
| 268 | 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 |
| 269 | client_container *seen_by; // seen by which player/container currently? |
296 | client_container *seen_by; // seen by which player/container currently? |
| 270 | key_value *key_values; /* Fields not explictly known by the loader. */ |
297 | key_value *key_values; /* Fields not explictly known by the loader. */ |
| 271 | |
298 | |
| 272 | 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 |
| 273 | void post_load_check (); // do some adjustments after parsing |
300 | MTH void post_load_check (); // do some adjustments after parsing |
| 274 | 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. |
| 275 | bool write (object_freezer &f); |
302 | bool write (object_freezer &f); |
| 276 | |
303 | |
| 277 | MTH int slottype () const; |
304 | MTH int slottype () const; |
| 278 | MTH static object *create (); |
305 | MTH static object *create (); |
|
|
306 | const mapxy &operator =(const mapxy &pos); |
| 279 | object &operator =(const object &src); |
307 | object &operator =(const object &src); |
| 280 | MTH void copy_to (object *dst); |
308 | MTH void copy_to (object *dst); |
| 281 | MTH object *clone (); // create + copy_to |
309 | MTH object *clone (); // create + copy_to |
| 282 | void do_destroy (); |
310 | void do_destroy (); |
| 283 | void gather_callbacks (AV *&callbacks, event_type event) const; |
311 | void gather_callbacks (AV *&callbacks, event_type event) const; |
| 284 | MTH void destroy (bool destroy_inventory = false); |
312 | MTH void destroy (bool destroy_inventory = false); |
| 285 | |
313 | |
| 286 | // 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 |
| 287 | MTH void destroy_inv (bool drop_to_ground = false); |
315 | MTH void destroy_inv (bool drop_to_ground = false); |
| 288 | 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 | |
| 289 | void do_remove (); |
319 | void do_remove (); |
| 290 | MTH void remove () |
320 | MTH void remove () |
| 291 | { |
321 | { |
| 292 | if (!flag [FLAG_REMOVED]) |
322 | if (!flag [FLAG_REMOVED]) |
| 293 | 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); |
| 294 | } |
333 | } |
| 295 | |
334 | |
| 296 | static bool can_merge_slow (object *op1, object *op2); |
335 | static bool can_merge_slow (object *op1, object *op2); |
| 297 | |
336 | |
| 298 | // this is often used in time-critical code, so optimise |
337 | // this is often used in time-critical code, so optimise |
| … | |
… | |
| 379 | |
418 | |
| 380 | // temporary: wether the object can be saved in a map file |
419 | // temporary: wether the object can be saved in a map file |
| 381 | // contr => is a player |
420 | // contr => is a player |
| 382 | // head => only save head of a multitile object |
421 | // head => only save head of a multitile object |
| 383 | // owner => can not reference owner yet |
422 | // owner => can not reference owner yet |
| 384 | 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]; } |
| 385 | |
424 | |
| 386 | /* This return true if object has still randomitems which |
425 | /* This return true if object has still randomitems which |
| 387 | * could be expanded. |
426 | * could be expanded. |
| 388 | */ |
427 | */ |
| 389 | 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]; } |
| … | |
… | |
| 430 | MTH void activate (); |
469 | MTH void activate (); |
| 431 | MTH void deactivate (); |
470 | MTH void deactivate (); |
| 432 | MTH void activate_recursive (); |
471 | MTH void activate_recursive (); |
| 433 | MTH void deactivate_recursive (); |
472 | MTH void deactivate_recursive (); |
| 434 | |
473 | |
| 435 | // set the givne flag on all objects in the inventory recursively |
474 | // set the given flag on all objects in the inventory recursively |
| 436 | MTH void set_flag_inv (int flag, int value = 1); |
475 | MTH void set_flag_inv (int flag, int value = 1); |
| 437 | |
476 | |
| 438 | void enter_exit (object *exit);//Perl |
477 | void enter_exit (object *exit);//Perl |
| 439 | MTH void enter_map (maptile *newmap, int x, int y); |
478 | MTH void enter_map (maptile *newmap, int x, int y); |
| 440 | |
479 | |
| … | |
… | |
| 489 | return !invisible && type != PLAYER; |
528 | return !invisible && type != PLAYER; |
| 490 | } |
529 | } |
| 491 | |
530 | |
| 492 | MTH struct region *region () const; |
531 | MTH struct region *region () const; |
| 493 | |
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 | |
| 494 | protected: |
541 | protected: |
| 495 | void link (); |
542 | void link (); |
| 496 | void unlink (); |
543 | void unlink (); |
| 497 | |
544 | |
| 498 | object (); |
545 | object (); |
| … | |
… | |
| 525 | } objectlink; |
572 | } objectlink; |
| 526 | |
573 | |
| 527 | typedef struct oblinkpt |
574 | typedef struct oblinkpt |
| 528 | { /* Used to link together several object links */ |
575 | { /* Used to link together several object links */ |
| 529 | struct oblnk *link; |
576 | struct oblnk *link; |
| 530 | long value; /* Used as connected value in buttons/gates */ |
577 | sint32 value; /* Used as connected value in buttons/gates */ |
| 531 | struct oblinkpt *next; |
578 | struct oblinkpt *next; |
| 532 | } oblinkpt; |
579 | } oblinkpt; |
| 533 | |
580 | |
| 534 | object *find_skill_by_name (object *who, const char *name); |
581 | object *find_skill_by_name (object *who, const char *name); |
| 535 | object *find_skill_by_name (object *who, const shstr &sh); |
582 | object *find_skill_by_name (object *who, const shstr &sh); |
| … | |
… | |
| 545 | */ |
592 | */ |
| 546 | |
593 | |
| 547 | INTERFACE_CLASS (archetype) |
594 | INTERFACE_CLASS (archetype) |
| 548 | struct archetype : object |
595 | struct archetype : object |
| 549 | { |
596 | { |
|
|
597 | static arch_ptr empty; // the empty_archetype |
|
|
598 | MTH static void gc (); |
|
|
599 | |
| 550 | archetype (const char *name); |
600 | archetype (const char *name); |
| 551 | ~archetype (); |
601 | ~archetype (); |
| 552 | void gather_callbacks (AV *&callbacks, event_type event) const; |
602 | void gather_callbacks (AV *&callbacks, event_type event) const; |
| 553 | |
603 | |
| 554 | static archetype *read (object_thawer &f); |
|
|
| 555 | static archetype *get (const char *name); // find or create |
|
|
| 556 | static archetype *find (const char *name); |
604 | MTH static archetype *find (const_utf8_string name); |
| 557 | |
605 | |
| 558 | void link (); |
606 | MTH void link (); |
| 559 | void unlink (); |
607 | MTH void unlink (); |
|
|
608 | |
|
|
609 | MTH object *instance (); |
| 560 | |
610 | |
| 561 | object_vector_index ACC (RW, archid); // index in archvector |
611 | object_vector_index ACC (RW, archid); // index in archvector |
| 562 | shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ |
612 | shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ |
| 563 | bool ACC (RW, stub); // if true, this is an invalid archetype |
|
|
| 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 | }; |
| 569 | |
622 | |
| 570 | inline void |
623 | inline void |
| 571 | object_freezer::put (keyword k, archetype *v) |
624 | object_freezer::put (keyword k, archetype *v) |
| 572 | { |
625 | { |
| … | |
… | |
| 616 | * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - |
669 | * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - |
| 617 | * 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 |
| 618 | * beneath the player, but not actually above it. Note - the |
671 | * beneath the player, but not actually above it. Note - the |
| 619 | * 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 |
| 620 | * match the originator. |
673 | * match the originator. |
| 621 | * INS_MAP_LOAD: disable lots of checkings done at insertion to |
|
|
| 622 | * speed up map loading process, as we assume the ordering in |
|
|
| 623 | * loaded map is correct. |
|
|
| 624 | * |
674 | * |
| 625 | * 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 |
| 626 | * are mutually exclusive. The behaviour for passing more than one |
676 | * are mutually exclusive. The behaviour for passing more than one |
| 627 | * should be considered undefined - while you may notice what happens |
677 | * should be considered undefined - while you may notice what happens |
| 628 | * 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 |
| … | |
… | |
| 631 | #define INS_NO_MERGE 0x0001 |
681 | #define INS_NO_MERGE 0x0001 |
| 632 | #define INS_ABOVE_FLOOR_ONLY 0x0002 |
682 | #define INS_ABOVE_FLOOR_ONLY 0x0002 |
| 633 | #define INS_NO_WALK_ON 0x0004 |
683 | #define INS_NO_WALK_ON 0x0004 |
| 634 | #define INS_ON_TOP 0x0008 |
684 | #define INS_ON_TOP 0x0008 |
| 635 | #define INS_BELOW_ORIGINATOR 0x0010 |
685 | #define INS_BELOW_ORIGINATOR 0x0010 |
| 636 | #define INS_MAP_LOAD 0x0020 |
|
|
| 637 | |
686 | |
| 638 | #define ARCH_DEPLETION "depletion" |
687 | #define ARCH_DEPLETION "depletion" |
| 639 | |
688 | |
| 640 | #endif |
689 | #endif |
| 641 | |
690 | |
