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 | |
62 | typedef struct Body_Locations |
61 | typedef 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 | |
69 | extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; |
68 | extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; |
… | |
… | |
132 | shstr ACC (RW, name_pl); /* The plural name of the object */ |
131 | shstr ACC (RW, name_pl); /* The plural name of the object */ |
133 | shstr ACC (RW, title); /* Of foo, etc */ |
132 | shstr ACC (RW, title); /* Of foo, etc */ |
134 | shstr ACC (RW, race); /* human, goblin, dragon, etc */ |
133 | shstr ACC (RW, race); /* human, goblin, dragon, etc */ |
135 | shstr ACC (RW, slaying); /* Which race to do double damage to */ |
134 | shstr ACC (RW, slaying); /* Which race to do double damage to */ |
136 | /* If this is an exit, this is the filename */ |
135 | /* If this is an exit, this is the filename */ |
|
|
136 | shstr ACC (RW, tag); // a tag used to tracking this object |
137 | shstr ACC (RW, skill); /* Name of the skill this object uses/grants */ |
137 | 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 */ |
138 | shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */ |
139 | shstr ACC (RW, lore); /* Obscure information about this object, */ |
139 | shstr ACC (RW, lore); /* Obscure information about this object, */ |
140 | /* To get put into books and the like. */ |
140 | /* To get put into books and the like. */ |
141 | shstr ACC (RW, materialname); /* specific material name */ |
141 | shstr ACC (RW, materialname); /* specific material name */ |
… | |
… | |
185 | sint32 ACC (RW, carrying); /* How much weight this object contains */ |
185 | sint32 ACC (RW, carrying); /* How much weight this object contains */ |
186 | sint64 ACC (RW, perm_exp); /* Permanent exp */ |
186 | sint64 ACC (RW, perm_exp); /* Permanent exp */ |
187 | uint32 ACC (RW, weapontype); /* type of weapon */ |
187 | uint32 ACC (RW, weapontype); /* type of weapon */ |
188 | uint32 ACC (RW, tooltype); /* type of tool or build facility */ |
188 | uint32 ACC (RW, tooltype); /* type of tool or build facility */ |
189 | body_slot slot [NUM_BODY_LOCATIONS]; |
189 | body_slot slot [NUM_BODY_LOCATIONS]; |
190 | faceidx ACC (RW, face); /* Face with colors */ |
190 | faceidx ACC (RW, face); /* the graphical face */ |
|
|
191 | faceidx ACC (RW, sound); /* the sound face */ |
|
|
192 | faceidx ACC (RW, sound_destroy); /* played on destroy */ |
191 | living ACC (RO, stats); /* Str, Con, Dex, etc */ |
193 | living ACC (RO, stats); /* Str, Con, Dex, etc */ |
192 | /* See the pod/objects.pod for more info about body locations */ |
194 | /* See the pod/objects.pod for more info about body locations */ |
193 | |
195 | |
194 | /* Following mostly refers to fields only used for monsters */ |
196 | /* Following mostly refers to fields only used for monsters */ |
195 | uint32 ACC (RW, hide); /* The object is hidden, not invisible */ |
197 | uint32 ACC (RW, hide); /* The object is hidden, not invisible */ |
… | |
… | |
246 | // These variables are not changed by ->copy_to |
248 | // These variables are not changed by ->copy_to |
247 | maptile_ptr ACC (RW, map); /* Pointer to the map in which this object is present */ |
249 | maptile_ptr ACC (RW, map); /* Pointer to the map in which this object is present */ |
248 | |
250 | |
249 | UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. |
251 | UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. |
250 | int ACC (RO, count); |
252 | int ACC (RO, count); |
251 | int ACC (RO, index); // index into objects |
253 | object_vector_index ACC (RO, index); // index into objects |
252 | int ACC (RO, active); // index into actives |
254 | object_vector_index ACC (RO, active); // index into actives |
253 | |
255 | |
254 | player_ptr ACC (RW, contr); /* Pointer to the player which control this object */ |
256 | player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */ |
255 | |
257 | |
256 | object *ACC (RW, below); /* Pointer to the object stacked below this one */ |
258 | 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 */ |
259 | object *ACC (RW, above); /* Pointer to the object stacked above this one */ |
258 | /* Note: stacked in the *same* environment */ |
260 | /* Note: stacked in the *same* environment */ |
259 | object *inv; /* Pointer to the first object in the inventory */ |
261 | 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 |
271 | 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? |
272 | client_container *seen_by; // seen by which player/container currently? |
271 | key_value *key_values; /* Fields not explictly known by the loader. */ |
273 | key_value *key_values; /* Fields not explictly known by the loader. */ |
272 | |
274 | |
273 | bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all |
275 | 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 |
276 | 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. |
277 | static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go. |
276 | bool write (object_freezer &f); |
278 | bool write (object_freezer &f); |
277 | |
279 | |
278 | MTH int slottype () const; |
280 | MTH int slottype () const; |
279 | MTH static object *create (); |
281 | MTH static object *create (); |
|
|
282 | const mapxy &operator =(const mapxy &pos); |
280 | object &operator =(const object &src); |
283 | object &operator =(const object &src); |
281 | MTH void copy_to (object *dst); |
284 | MTH void copy_to (object *dst); |
282 | MTH object *clone (); // create + copy_to |
285 | MTH object *clone (); // create + copy_to |
283 | void do_destroy (); |
286 | void do_destroy (); |
284 | void gather_callbacks (AV *&callbacks, event_type event) const; |
287 | void gather_callbacks (AV *&callbacks, event_type event) const; |
285 | MTH void destroy (bool destroy_inventory = false); |
288 | MTH void destroy (bool destroy_inventory = false); |
286 | |
289 | |
287 | // recursively destroy all objects in inventory, optionally dropping them to the ground instead |
290 | // recursively destroy all objects in inventory, optionally dropping them to the ground instead |
288 | MTH void destroy_inv (bool drop_to_ground = false); |
291 | MTH void destroy_inv (bool drop_to_ground = false); |
289 | MTH object *insert (object *item); // insert into inventory |
292 | MTH object *insert (object *item); // insert into inventory |
|
|
293 | MTH void play_sound (faceidx sound) const; |
|
|
294 | |
290 | void do_remove (); |
295 | void do_remove (); |
291 | MTH void remove () |
296 | MTH void remove () |
292 | { |
297 | { |
293 | if (!flag [FLAG_REMOVED]) |
298 | if (!flag [FLAG_REMOVED]) |
294 | do_remove (); |
299 | do_remove (); |
|
|
300 | } |
|
|
301 | |
|
|
302 | MTH bool blocked (maptile *m, int x, int y) const; |
|
|
303 | |
|
|
304 | void move_to (const mapxy &pos) |
|
|
305 | { |
|
|
306 | remove (); |
|
|
307 | *this = pos; |
|
|
308 | insert_at (this, this); |
295 | } |
309 | } |
296 | |
310 | |
297 | static bool can_merge_slow (object *op1, object *op2); |
311 | static bool can_merge_slow (object *op1, object *op2); |
298 | |
312 | |
299 | // this is often used in time-critical code, so optimise |
313 | // this is often used in time-critical code, so optimise |
… | |
… | |
312 | MTH void open_container (object *new_container); |
326 | MTH void open_container (object *new_container); |
313 | MTH void close_container () |
327 | MTH void close_container () |
314 | { |
328 | { |
315 | open_container (0); |
329 | open_container (0); |
316 | } |
330 | } |
|
|
331 | |
|
|
332 | MTH object *force_find (const shstr name); |
|
|
333 | MTH void force_add (const shstr name, int duration = 0); |
317 | |
334 | |
318 | // overwrite the attachable should_invoke function with a version that also checks ev_want_type |
335 | // overwrite the attachable should_invoke function with a version that also checks ev_want_type |
319 | bool should_invoke (event_type event) |
336 | bool should_invoke (event_type event) |
320 | { |
337 | { |
321 | return ev_want_event [event] || ev_want_type [type] || cb; |
338 | return ev_want_event [event] || ev_want_type [type] || cb; |
… | |
… | |
377 | |
394 | |
378 | // temporary: wether the object can be saved in a map file |
395 | // temporary: wether the object can be saved in a map file |
379 | // contr => is a player |
396 | // contr => is a player |
380 | // head => only save head of a multitile object |
397 | // head => only save head of a multitile object |
381 | // owner => can not reference owner yet |
398 | // owner => can not reference owner yet |
382 | MTH bool can_map_save () const { return !contr && !head && !owner && !flag [FLAG_NO_MAP_SAVE]; } |
399 | MTH bool can_map_save () const { return !head && (!owner || owner->contr) && !contr && !flag [FLAG_NO_MAP_SAVE]; } |
383 | |
400 | |
384 | /* This return true if object has still randomitems which |
401 | /* This return true if object has still randomitems which |
385 | * could be expanded. |
402 | * could be expanded. |
386 | */ |
403 | */ |
387 | MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } |
404 | MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } |
… | |
… | |
398 | |
415 | |
399 | // "temporary" helper function |
416 | // "temporary" helper function |
400 | MTH object *head_ () |
417 | MTH object *head_ () |
401 | { |
418 | { |
402 | return head ? head : this; |
419 | return head ? head : this; |
|
|
420 | } |
|
|
421 | |
|
|
422 | MTH bool is_head () |
|
|
423 | { |
|
|
424 | return head_ () == this; |
403 | } |
425 | } |
404 | |
426 | |
405 | MTH std::string long_desc (object *who = 0); |
427 | MTH std::string long_desc (object *who = 0); |
406 | MTH std::string describe_monster (object *who = 0); |
428 | MTH std::string describe_monster (object *who = 0); |
407 | MTH std::string describe_item (object *who = 0); |
429 | MTH std::string describe_item (object *who = 0); |
… | |
… | |
416 | MTH void create_treasure (treasurelist *tl, int flags = 0); |
438 | MTH void create_treasure (treasurelist *tl, int flags = 0); |
417 | |
439 | |
418 | // insert object at same map position as 'where' |
440 | // insert object at same map position as 'where' |
419 | // handles both inventory and map "positions" |
441 | // handles both inventory and map "positions" |
420 | MTH object *insert_at (object *where, object *originator = 0, int flags = 0); |
442 | MTH object *insert_at (object *where, object *originator = 0, int flags = 0); |
|
|
443 | MTH void drop_unpaid_items (); |
421 | |
444 | |
422 | MTH void activate (); |
445 | MTH void activate (); |
423 | MTH void deactivate (); |
446 | MTH void deactivate (); |
424 | MTH void activate_recursive (); |
447 | MTH void activate_recursive (); |
425 | MTH void deactivate_recursive (); |
448 | MTH void deactivate_recursive (); |
… | |
… | |
481 | return !invisible && type != PLAYER; |
504 | return !invisible && type != PLAYER; |
482 | } |
505 | } |
483 | |
506 | |
484 | MTH struct region *region () const; |
507 | MTH struct region *region () const; |
485 | |
508 | |
|
|
509 | void statusmsg (const char *msg, int color = NDI_BLACK); |
|
|
510 | void failmsg (const char *msg, int color = NDI_RED); |
|
|
511 | |
|
|
512 | const char *query_inventory (object *who = 0, const char *indent = ""); |
|
|
513 | |
|
|
514 | MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference |
|
|
515 | static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible |
|
|
516 | |
486 | protected: |
517 | protected: |
487 | friend struct archetype; |
|
|
488 | |
|
|
489 | void link (); |
518 | void link (); |
490 | void unlink (); |
519 | void unlink (); |
491 | |
520 | |
492 | object (); |
521 | object (); |
493 | ~object (); |
522 | ~object (); |
494 | }; |
523 | }; |
… | |
… | |
509 | ob->env->inv = ob; |
538 | ob->env->inv = ob; |
510 | } |
539 | } |
511 | |
540 | |
512 | return ob; |
541 | return ob; |
513 | } |
542 | } |
514 | |
|
|
515 | typedef object_vector<object, &object::index > objectvec; |
|
|
516 | typedef object_vector<object, &object::active> activevec; |
|
|
517 | |
|
|
518 | extern objectvec objects; |
|
|
519 | extern activevec actives; |
|
|
520 | |
|
|
521 | #define for_all_objects(var) \ |
|
|
522 | for (unsigned _i = 0; _i < objects.size (); ++_i) \ |
|
|
523 | declvar (object *, var, objects [_i]) |
|
|
524 | |
|
|
525 | #define for_all_actives(var) \ |
|
|
526 | for (unsigned _i = 0; _i < actives.size (); ++_i) \ |
|
|
527 | declvar (object *, var, actives [_i]) |
|
|
528 | |
543 | |
529 | typedef struct oblnk |
544 | typedef struct oblnk |
530 | { /* Used to link together several objects */ |
545 | { /* Used to link together several objects */ |
531 | object_ptr ob; |
546 | object_ptr ob; |
532 | struct oblnk *next; |
547 | struct oblnk *next; |
… | |
… | |
551 | * object and pointers. This structure should get removed, and just replaced |
566 | * object and pointers. This structure should get removed, and just replaced |
552 | * by the object structure |
567 | * by the object structure |
553 | */ |
568 | */ |
554 | |
569 | |
555 | INTERFACE_CLASS (archetype) |
570 | INTERFACE_CLASS (archetype) |
556 | struct archetype : zero_initialised, attachable |
571 | struct archetype : object |
557 | { |
572 | { |
558 | archetype (); |
573 | archetype (const char *name); |
559 | ~archetype (); |
574 | ~archetype (); |
560 | void gather_callbacks (AV *&callbacks, event_type event) const; |
575 | void gather_callbacks (AV *&callbacks, event_type event) const; |
561 | |
576 | |
562 | static archetype *read (object_thawer &f); |
577 | static archetype *read (object_thawer &f); |
|
|
578 | |
563 | static archetype *get (const char *name); // find or create |
579 | MTH static archetype *get (const_utf8_string name); // find or create |
564 | static archetype *find (const char *name); |
580 | MTH static archetype *find (const_utf8_string name); |
565 | |
581 | |
566 | void hash_add (); // add to hashtable |
582 | MTH void link (); |
567 | void hash_del (); // remove from hashtable |
583 | MTH void unlink (); |
568 | |
584 | |
|
|
585 | MTH object *instance (); |
|
|
586 | |
|
|
587 | object_vector_index ACC (RW, archid); // index in archvector |
569 | shstr ACC (RW, name); /* More definite name, like "generate_kobold" */ |
588 | shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ |
570 | struct archetype *ACC (RW, next); /* Next archetype in a linked list */ |
589 | bool ACC (RW, stub); // if true, this is an invalid archetype |
571 | struct archetype *ACC (RW, head); /* The main part of a linked object */ |
590 | |
572 | struct archetype *ACC (RW, more); /* Next part of a linked object */ |
591 | sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ |
573 | object ACC (RO, clone); /* An object from which to do ->copy_to () */ |
592 | sint8 ACC (RW, max_x), ACC (RW, max_y); |
574 | uint32 ACC (RW, editable); /* editable flags (mainly for editor) */ |
|
|
575 | bool ACC (RW, linked); // linked into list of heads |
|
|
576 | sint8 ACC (RW, tail_x), ACC (RW, tail_y); /* Where the lower right most portion of the object is |
|
|
577 | * in comparison to the head. |
|
|
578 | */ |
|
|
579 | }; |
593 | }; |
|
|
594 | |
|
|
595 | inline void |
|
|
596 | object_freezer::put (keyword k, archetype *v) |
|
|
597 | { |
|
|
598 | put (k, v ? &v->archname : (const char *)0); |
|
|
599 | } |
|
|
600 | |
|
|
601 | typedef object_vector<object, &object::index > objectvec; |
|
|
602 | typedef object_vector<object, &object::active> activevec; |
|
|
603 | typedef object_vector<archetype, &archetype::archid> archvec; |
|
|
604 | |
|
|
605 | extern objectvec objects; |
|
|
606 | extern activevec actives; |
|
|
607 | extern archvec archetypes; |
|
|
608 | |
|
|
609 | #define for_all_objects(var) \ |
|
|
610 | for (unsigned _i = 0; _i < objects.size (); ++_i) \ |
|
|
611 | statementvar (object *, var, objects [_i]) |
|
|
612 | |
|
|
613 | #define for_all_actives(var) \ |
|
|
614 | for (unsigned _i = 0; _i < actives.size (); ++_i) \ |
|
|
615 | statementvar (object *, var, actives [_i]) |
|
|
616 | |
|
|
617 | #define for_all_archetypes(var) \ |
|
|
618 | for (unsigned _i = 0; _i < archetypes.size (); ++_i) \ |
|
|
619 | statementvar (archetype *, var, archetypes [_i]) |
580 | |
620 | |
581 | /* Used by update_object to know if the object being passed is |
621 | /* Used by update_object to know if the object being passed is |
582 | * being added or removed. |
622 | * being added or removed. |
583 | */ |
623 | */ |
584 | #define UP_OBJ_INSERT 1 |
624 | #define UP_OBJ_INSERT 1 |
… | |
… | |
601 | * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - |
641 | * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - |
602 | * Use for treasure chests so the new object is the highest thing |
642 | * Use for treasure chests so the new object is the highest thing |
603 | * beneath the player, but not actually above it. Note - the |
643 | * beneath the player, but not actually above it. Note - the |
604 | * map and x,y coordinates for the object to be inserted must |
644 | * map and x,y coordinates for the object to be inserted must |
605 | * match the originator. |
645 | * match the originator. |
606 | * INS_MAP_LOAD: disable lots of checkings done at insertion to |
|
|
607 | * speed up map loading process, as we assume the ordering in |
|
|
608 | * loaded map is correct. |
|
|
609 | * |
646 | * |
610 | * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY |
647 | * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY |
611 | * are mutually exclusive. The behaviour for passing more than one |
648 | * are mutually exclusive. The behaviour for passing more than one |
612 | * should be considered undefined - while you may notice what happens |
649 | * should be considered undefined - while you may notice what happens |
613 | * right now if you pass more than one, that could very well change |
650 | * right now if you pass more than one, that could very well change |
… | |
… | |
616 | #define INS_NO_MERGE 0x0001 |
653 | #define INS_NO_MERGE 0x0001 |
617 | #define INS_ABOVE_FLOOR_ONLY 0x0002 |
654 | #define INS_ABOVE_FLOOR_ONLY 0x0002 |
618 | #define INS_NO_WALK_ON 0x0004 |
655 | #define INS_NO_WALK_ON 0x0004 |
619 | #define INS_ON_TOP 0x0008 |
656 | #define INS_ON_TOP 0x0008 |
620 | #define INS_BELOW_ORIGINATOR 0x0010 |
657 | #define INS_BELOW_ORIGINATOR 0x0010 |
621 | #define INS_MAP_LOAD 0x0020 |
|
|
622 | |
658 | |
623 | #define ARCH_SINGULARITY "singularity" |
|
|
624 | #define ARCH_DETECT_MAGIC "detect_magic" |
|
|
625 | #define ARCH_DEPLETION "depletion" |
659 | #define ARCH_DEPLETION "depletion" |
626 | #define ARCH_SYMPTOM "symptom" |
|
|
627 | |
660 | |
628 | #endif |
661 | #endif |
629 | |
662 | |