1 | /* |
1 | /* |
2 | * This file is part of Deliantra, the Roguelike Realtime MMORPG. |
2 | * This file is part of Deliantra, the Roguelike Realtime MMORPG. |
3 | * |
3 | * |
4 | * Copyright (©) 2005,2006,2007,2008,2009 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
4 | * Copyright (©) 2005,2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
5 | * Copyright (©) 2001,2007 Mark Wedel & Crossfire Development Team |
5 | * Copyright (©) 2001 Mark Wedel & Crossfire Development Team |
6 | * Copyright (©) 1992,2007 Frank Tore Johansen |
6 | * Copyright (©) 1992 Frank Tore Johansen |
7 | * |
7 | * |
8 | * Deliantra is free software: you can redistribute it and/or modify it under |
8 | * Deliantra is free software: you can redistribute it and/or modify it under |
9 | * the terms of the Affero GNU General Public License as published by the |
9 | * the terms of the Affero GNU General Public License as published by the |
10 | * Free Software Foundation, either version 3 of the License, or (at your |
10 | * Free Software Foundation, either version 3 of the License, or (at your |
11 | * option) any later version. |
11 | * option) any later version. |
… | |
… | |
23 | */ |
23 | */ |
24 | |
24 | |
25 | #ifndef OBJECT_H |
25 | #ifndef OBJECT_H |
26 | #define OBJECT_H |
26 | #define OBJECT_H |
27 | |
27 | |
28 | #include <bitset> |
|
|
29 | |
|
|
30 | #include "cfperl.h" |
28 | #include "cfperl.h" |
31 | #include "shstr.h" |
29 | #include "shstr.h" |
32 | |
30 | |
33 | //+GPL |
31 | //+GPL |
34 | |
32 | |
35 | typedef int tag_t; |
33 | typedef int tag_t; |
36 | |
34 | |
|
|
35 | // also see common/item.C |
37 | enum { |
36 | enum |
|
|
37 | { |
38 | body_skill, |
38 | body_skill, |
39 | body_combat, |
39 | body_combat, |
40 | body_range, |
40 | body_range, |
41 | body_shield, |
41 | body_shield, |
42 | body_arm, |
42 | body_arm, |
… | |
… | |
50 | body_wrist, |
50 | body_wrist, |
51 | body_waist, |
51 | body_waist, |
52 | NUM_BODY_LOCATIONS |
52 | NUM_BODY_LOCATIONS |
53 | }; |
53 | }; |
54 | |
54 | |
55 | enum slottype_t |
|
|
56 | { |
|
|
57 | slot_none, |
|
|
58 | slot_combat, |
|
|
59 | slot_ranged, |
|
|
60 | }; |
|
|
61 | |
|
|
62 | /* See common/item.c */ |
55 | /* See common/item.c */ |
63 | |
56 | |
64 | typedef struct Body_Locations |
57 | typedef struct Body_Locations |
65 | { |
58 | { |
66 | keyword save_name; /* Name used to load/save it to disk */ |
59 | keyword save_name; /* Name used to load/save it to disk */ |
… | |
… | |
285 | shstr ACC (RW, lore); /* Obscure information about this object, */ |
278 | shstr ACC (RW, lore); /* Obscure information about this object, */ |
286 | /* To get put into books and the like. */ |
279 | /* To get put into books and the like. */ |
287 | shstr ACC (RW, custom_name); /* Custom name assigned by player */ |
280 | shstr ACC (RW, custom_name); /* Custom name assigned by player */ |
288 | }; |
281 | }; |
289 | |
282 | |
290 | const char *query_weight (const object *op); |
283 | const_utf8_string query_weight (const object *op); |
291 | const char *query_short_name (const object *op); |
284 | const_utf8_string query_short_name (const object *op); |
292 | const char *query_name (const object *op); |
285 | const_utf8_string query_name (const object *op); |
293 | const char *query_base_name (const object *op, int plural); |
286 | const_utf8_string query_base_name (const object *op, int plural); |
|
|
287 | sint64 query_cost (const object *tmp, object *who, int flag); |
|
|
288 | const char *query_cost_string (const object *tmp, object *who, int flag); |
|
|
289 | |
|
|
290 | int change_ability_duration (object *spell, object *caster); |
|
|
291 | int min_casting_level (object *caster, object *spell); |
|
|
292 | int casting_level (object *caster, object *spell); |
|
|
293 | sint16 SP_level_spellpoint_cost (object *caster, object *spell, int flags); |
|
|
294 | int SP_level_dam_adjust (object *caster, object *spob); |
|
|
295 | int SP_level_duration_adjust (object *caster, object *spob); |
|
|
296 | int SP_level_range_adjust (object *caster, object *spob); |
294 | |
297 | |
295 | struct object : zero_initialised, object_copy |
298 | struct object : zero_initialised, object_copy |
296 | { |
299 | { |
297 | // These variables are not changed by ->copy_to |
300 | // These variables are not changed by ->copy_to |
298 | maptile *ACC (RW, map); /* Pointer to the map in which this object is present */ |
301 | maptile *ACC (RW, map); /* Pointer to the map in which this object is present */ |
… | |
… | |
360 | bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all |
363 | bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all |
361 | MTH void post_load_check (); // do some adjustments after parsing |
364 | MTH void post_load_check (); // do some adjustments after parsing |
362 | static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go. |
365 | static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go. |
363 | bool write (object_freezer &f); |
366 | bool write (object_freezer &f); |
364 | |
367 | |
365 | MTH int slottype () const; |
|
|
366 | MTH static object *create (); |
368 | MTH static object *create (); |
367 | const mapxy &operator =(const mapxy &pos); |
369 | const mapxy &operator =(const mapxy &pos); |
368 | MTH void copy_to (object *dst); |
370 | MTH void copy_to (object *dst); |
369 | MTH object *clone (); // create + copy_to a single object |
371 | MTH object *clone (); // create + copy_to a single object |
370 | MTH object *deep_clone (); // copy whole more chain and inventory |
372 | MTH object *deep_clone (); // copy whole more chain and inventory |
… | |
… | |
377 | destroy (); |
379 | destroy (); |
378 | } |
380 | } |
379 | |
381 | |
380 | // recursively destroy all objects in inventory, optionally dropping them to the ground instead |
382 | // recursively destroy all objects in inventory, optionally dropping them to the ground instead |
381 | MTH void destroy_inv (bool drop_to_ground = false); |
383 | MTH void destroy_inv (bool drop_to_ground = false); |
|
|
384 | MTH void destroy_inv_fast (); // like destroy_inv (false), but only works when *this is destroyed, too |
382 | MTH object *insert (object *item); // insert into inventory |
385 | MTH object *insert (object *item); // insert into inventory |
383 | MTH void play_sound (faceidx sound) const; |
386 | MTH void play_sound (faceidx sound) const; |
384 | MTH void say_msg (const char *msg) const; |
387 | MTH void say_msg (const_utf8_string msg) const; |
385 | |
388 | |
386 | void do_remove (); |
389 | void do_remove (); |
387 | MTH void remove () |
390 | MTH void remove () |
388 | { |
391 | { |
389 | if (!flag [FLAG_REMOVED]) |
392 | if (!flag [FLAG_REMOVED]) |
… | |
… | |
397 | remove (); |
400 | remove (); |
398 | *this = pos; |
401 | *this = pos; |
399 | insert_at (this, this); |
402 | insert_at (this, this); |
400 | } |
403 | } |
401 | |
404 | |
402 | // high-level move functions, return true if successful |
405 | // high-level move method. |
|
|
406 | // object op is trying to move in direction dir. |
|
|
407 | // originator is typically the same as op, but |
|
|
408 | // can be different if originator is causing op to |
|
|
409 | // move (originator is pushing op) |
|
|
410 | // returns 0 if the object is not able to move to the |
|
|
411 | // desired space, 1 otherwise (in which case we also |
|
|
412 | // move the object accordingly. This function is |
|
|
413 | // very similiar to move_object. |
403 | int move (int dir, object *originator); |
414 | int move (int dir, object *originator); |
404 | |
415 | |
405 | int move (int dir) |
416 | int move (int dir) |
406 | { |
417 | { |
407 | return move (dir, this); |
418 | return move (dir, this); |
408 | } |
419 | } |
|
|
420 | |
|
|
421 | // changes move_type to a new value - handles move_on/move_off effects |
|
|
422 | MTH void change_move_type (MoveType mt); |
409 | |
423 | |
410 | static bool can_merge_slow (object *op1, object *op2); |
424 | static bool can_merge_slow (object *op1, object *op2); |
411 | |
425 | |
412 | // this is often used in time-critical code, so optimise |
426 | // this is often used in time-critical code, so optimise |
413 | MTH static bool can_merge (object *op1, object *op2) |
427 | MTH static bool can_merge (object *op1, object *op2) |
… | |
… | |
418 | } |
432 | } |
419 | |
433 | |
420 | MTH void set_owner (object *owner); |
434 | MTH void set_owner (object *owner); |
421 | MTH void set_speed (float speed); |
435 | MTH void set_speed (float speed); |
422 | MTH void set_glow_radius (sint8 rad); |
436 | MTH void set_glow_radius (sint8 rad); |
423 | MTH bool change_weapon (object *ob); |
|
|
424 | MTH bool change_skill (object *ob); |
437 | MTH bool change_skill (object *ob); // deprecated? |
425 | |
438 | |
426 | MTH void open_container (object *new_container); |
439 | MTH void open_container (object *new_container); |
427 | MTH void close_container () |
440 | MTH void close_container () |
428 | { |
441 | { |
429 | open_container (0); |
442 | open_container (0); |
… | |
… | |
468 | MTH void drain_stat (); |
481 | MTH void drain_stat (); |
469 | MTH void drain_specific_stat (int deplete_stats); |
482 | MTH void drain_specific_stat (int deplete_stats); |
470 | MTH void change_luck (int value); |
483 | MTH void change_luck (int value); |
471 | |
484 | |
472 | // info must hold 256 * 3 bytes currently |
485 | // info must hold 256 * 3 bytes currently |
473 | const char *debug_desc (char *info) const; |
486 | const_utf8_string debug_desc (char *info) const; |
474 | MTH const char *debug_desc () const; // uses at least 3 round-robin buffers |
487 | MTH const_utf8_string debug_desc () const; // uses at least 3 round-robin buffers |
475 | const char *flag_desc (char *desc, int len) const; |
488 | const_utf8_string flag_desc (char *desc, int len) const; |
476 | |
489 | |
477 | MTH bool decrease (sint32 nr = 1); // returns true if anything is left |
490 | MTH bool decrease (sint32 nr = 1); // returns true if anything is left |
478 | MTH object *split (sint32 nr = 1); // return 0 on failure |
491 | MTH object *split (sint32 nr = 1); // return 0 on failure |
479 | |
492 | |
480 | MTH int number_of () const |
493 | MTH int number_of () const |
… | |
… | |
497 | |
510 | |
498 | // return the volume of this object in cm³ |
511 | // return the volume of this object in cm³ |
499 | MTH uint64 volume () const |
512 | MTH uint64 volume () const |
500 | { |
513 | { |
501 | return (uint64)total_weight () |
514 | return (uint64)total_weight () |
502 | * 1000 |
515 | * 1024 // 1000 actually |
503 | * (type == CONTAINER ? 1000 : 1) |
516 | * (type == CONTAINER ? 128 : 1) |
504 | / dominant_material ()->density; |
517 | / dominant_material ()->density; // ugh, division |
505 | } |
518 | } |
506 | |
519 | |
507 | MTH bool is_arch () const { return this == (const object *)(const archetype *)arch; } |
520 | MTH bool is_arch () const { return this == (const object *)(const archetype *)arch; } |
508 | |
521 | |
509 | MTH bool is_wiz () const { return flag [FLAG_WIZ]; } |
522 | MTH bool is_wiz () const { return flag [FLAG_WIZ]; } |
… | |
… | |
518 | MTH bool is_arrow () const { return type == ARROW |
531 | MTH bool is_arrow () const { return type == ARROW |
519 | || (type == SPELL_EFFECT |
532 | || (type == SPELL_EFFECT |
520 | && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); } |
533 | && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); } |
521 | MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; } |
534 | MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; } |
522 | |
535 | |
|
|
536 | MTH bool is_dragon () const; |
|
|
537 | |
|
|
538 | MTH bool is_immunity () const { return invisible && type == SIGN; } |
|
|
539 | |
523 | MTH bool has_active_speed () const { return fabs (speed) >= MIN_ACTIVE_SPEED; } |
540 | MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; } |
524 | |
541 | |
525 | // temporary: wether the object can be saved in a map file |
542 | // temporary: wether the object can be saved in a map file |
526 | // contr => is a player |
543 | // contr => is a player |
527 | // head => only save head of a multitile object |
544 | // head => only save head of a multitile object |
528 | // owner => can not reference owner yet |
545 | // owner => can not reference owner yet |
… | |
… | |
598 | MTH bool is_player () const |
615 | MTH bool is_player () const |
599 | { |
616 | { |
600 | return !!contr; |
617 | return !!contr; |
601 | } |
618 | } |
602 | |
619 | |
|
|
620 | /* elmex: this method checks whether the object is in a shop */ |
|
|
621 | MTH bool is_in_shop () const; |
|
|
622 | |
603 | MTH bool affects_los () const |
623 | MTH bool affects_los () const |
604 | { |
624 | { |
605 | return glow_radius || flag [FLAG_BLOCKSVIEW]; |
625 | return glow_radius || flag [FLAG_BLOCKSVIEW]; |
606 | } |
626 | } |
607 | |
627 | |
… | |
… | |
616 | MTH std::string long_desc (object *who = 0); // query_name . " " . describe |
636 | MTH std::string long_desc (object *who = 0); // query_name . " " . describe |
617 | MTH std::string describe_monster (object *who = 0); |
637 | MTH std::string describe_monster (object *who = 0); |
618 | MTH std::string describe_item (object *who = 0); |
638 | MTH std::string describe_item (object *who = 0); |
619 | MTH std::string describe (object *who = 0); // long description, without name |
639 | MTH std::string describe (object *who = 0); // long description, without name |
620 | |
640 | |
621 | MTH const char *query_weight () { return ::query_weight (this); } |
641 | MTH const_utf8_string query_weight () { return ::query_weight (this); } |
622 | MTH const char *query_name () { return ::query_name (this); } |
642 | MTH const_utf8_string query_name () { return ::query_name (this); } |
623 | MTH const char *query_short_name () { return ::query_short_name (this); } |
643 | MTH const_utf8_string query_short_name () { return ::query_short_name (this); } |
624 | MTH const char *query_base_name (bool plural) { return ::query_base_name (this, plural); } |
644 | MTH const_utf8_string query_base_name (bool plural) { return ::query_base_name (this, plural); } |
625 | |
645 | |
626 | // If this object has no extra parts but should have them, |
646 | // If this object has no extra parts but should have them, |
627 | // add them, effectively expanding heads into multipart |
647 | // add them, effectively expanding heads into multipart |
628 | // objects. This method only works on objects not inserted |
648 | // objects. This method only works on objects not inserted |
629 | // anywhere. |
649 | // anywhere. |
… | |
… | |
646 | // set the given flag on all objects in the inventory recursively |
666 | // set the given flag on all objects in the inventory recursively |
647 | MTH void set_flag_inv (int flag, int value = 1); |
667 | MTH void set_flag_inv (int flag, int value = 1); |
648 | |
668 | |
649 | void enter_exit (object *exit);//Perl |
669 | void enter_exit (object *exit);//Perl |
650 | MTH void enter_map (maptile *newmap, int x, int y); |
670 | MTH void enter_map (maptile *newmap, int x, int y); |
651 | void player_goto (const char *path, int x, int y); // only for players |
671 | void player_goto (const_utf8_string path, int x, int y); // only for players |
|
|
672 | MTH bool apply (object *ob, int aflags = AP_APPLY); // ob may be 0 |
652 | |
673 | |
653 | // returns the mapspace this object is in |
674 | // returns the mapspace this object is in |
654 | mapspace &ms () const; |
675 | mapspace &ms () const; |
655 | |
676 | |
656 | // fully recursive iterator |
677 | // fully recursive iterator |
… | |
… | |
707 | return weight + carrying; |
728 | return weight + carrying; |
708 | } |
729 | } |
709 | |
730 | |
710 | MTH struct region *region () const; |
731 | MTH struct region *region () const; |
711 | |
732 | |
712 | void statusmsg (const char *msg, int color = NDI_BLACK); |
733 | void statusmsg (const_utf8_string msg, int color = NDI_BLACK); |
713 | void failmsg (const char *msg, int color = NDI_RED); |
734 | void failmsg (const_utf8_string msg, int color = NDI_RED); |
714 | |
735 | |
715 | const char *query_inventory (object *who = 0, const char *indent = ""); |
736 | const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = ""); |
716 | |
737 | |
717 | MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference |
738 | MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference |
718 | static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible |
739 | static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible |
719 | |
740 | |
720 | // make some noise with given item into direction dir, |
741 | // make some noise with given item into direction dir, |
… | |
… | |
733 | * range from 0 through 7. |
754 | * range from 0 through 7. |
734 | */ |
755 | */ |
735 | MTH int anim_frames () const { return anim ().num_animations; } |
756 | MTH int anim_frames () const { return anim ().num_animations; } |
736 | MTH int anim_facings () const { return anim ().facings; } |
757 | MTH int anim_facings () const { return anim ().facings; } |
737 | |
758 | |
738 | MTH char *as_string (); |
759 | MTH utf8_string as_string (); |
739 | |
760 | |
740 | protected: |
761 | protected: |
741 | void link (); |
762 | void link (); |
742 | void unlink (); |
763 | void unlink (); |
743 | |
764 | |
… | |
… | |
768 | return ob; |
789 | return ob; |
769 | } |
790 | } |
770 | |
791 | |
771 | //+GPL |
792 | //+GPL |
772 | |
793 | |
773 | object *find_skill_by_name_fuzzy (object *who, const char *name); |
794 | object *find_skill_by_name_fuzzy (object *who, const_utf8_string name); |
774 | object *find_skill_by_name (object *who, shstr_cmp sh); |
795 | object *find_skill_by_name (object *who, shstr_cmp sh); |
775 | object *find_skill_by_number (object *who, int skillno); |
796 | object *find_skill_by_number (object *who, int skillno); |
776 | |
797 | |
777 | /* |
798 | /* |
778 | * The archetype structure is a set of rules on how to generate and manipulate |
799 | * The archetype structure is a set of rules on how to generate and manipulate |
… | |
… | |
789 | struct archetype : object |
810 | struct archetype : object |
790 | { |
811 | { |
791 | static arch_ptr empty; // the empty_archetype |
812 | static arch_ptr empty; // the empty_archetype |
792 | MTH static void gc (); |
813 | MTH static void gc (); |
793 | |
814 | |
794 | archetype (const char *name); |
815 | archetype (const_utf8_string name); |
795 | ~archetype (); |
816 | ~archetype (); |
796 | void gather_callbacks (AV *&callbacks, event_type event) const; |
817 | void gather_callbacks (AV *&callbacks, event_type event) const; |
797 | |
818 | |
798 | MTH static archetype *find (const_utf8_string name); |
819 | MTH static archetype *find (const_utf8_string name); |
799 | |
820 | |
800 | MTH void link (); |
821 | MTH void link (); |
801 | MTH void unlink (); |
822 | MTH void unlink (); |
802 | |
823 | |
803 | MTH static object *get (const char *name); // (find() || singularity)->instance() |
824 | MTH static object *get (const_utf8_string name); // (find() || singularity)->instance() |
804 | MTH object *instance (); |
825 | MTH object *instance (); |
805 | |
826 | |
806 | MTH void post_load_check (); // do some adjustments after parsing |
827 | MTH void post_load_check (); // do some adjustments after parsing |
807 | |
828 | |
808 | object_vector_index ACC (RW, archid); // index in archvector |
829 | object_vector_index ACC (RW, archid); // index in archvector |
809 | shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ |
830 | shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ |
810 | |
831 | |
811 | sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ |
832 | sint8 ACC (RW, max_x); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ |
812 | sint8 ACC (RW, max_x), ACC (RW, max_y); |
|
|
813 | |
833 | |
814 | // support for archetype loading |
834 | // support for archetype loading |
815 | static archetype *read (object_thawer &f); |
835 | static archetype *read (object_thawer &f); |
816 | MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more |
836 | MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more |
817 | static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */ |
837 | static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */ |
818 | }; |
838 | }; |
819 | |
839 | |
820 | // compatbiility, remove once replaced by ->instance |
840 | // returns whether the object is a dragon player, which are often specialcased |
821 | inline object * |
841 | inline bool |
822 | arch_to_object (archetype *at) |
842 | object::is_dragon () const |
823 | { |
843 | { |
824 | return at->instance (); |
844 | return arch->race == shstr_dragon && is_player (); |
825 | } |
845 | } |
826 | |
846 | |
827 | inline void |
847 | inline void |
828 | object_freezer::put (keyword k, archetype *v) |
848 | object_freezer::put (const keyword_string k, archetype *v) |
829 | { |
849 | { |
830 | put (k, v ? &v->archname : (const char *)0); |
850 | if (expect_true (v)) |
|
|
851 | put (k, v->archname); |
|
|
852 | else |
|
|
853 | put (k); |
831 | } |
854 | } |
832 | |
855 | |
833 | typedef object_vector<object, &object::index > objectvec; |
856 | typedef object_vector<object, &object::index > objectvec; |
834 | typedef object_vector<object, &object::active> activevec; |
857 | typedef object_vector<object, &object::active> activevec; |
835 | typedef object_vector<archetype, &archetype::archid> archvec; |
858 | typedef object_vector<archetype, &archetype::archid> archvec; |