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.223 by root, Sun Nov 29 17:41:07 2009 UTC vs.
Revision 1.247 by root, Sat Apr 17 02:50:21 2010 UTC

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
35typedef int tag_t; 33typedef int tag_t;
36 34
35// also see common/item.C
37enum { 36enum
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
55enum 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
64typedef struct Body_Locations 57typedef 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 */
70 63
71extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; 64extern Body_Locations body_locations[NUM_BODY_LOCATIONS];
72 65
73#define NUM_COINS 4 /* number of coin types */ 66#define NUM_COINS 4 /* number of coin types */
74extern const char *const coins[NUM_COINS + 1]; 67extern const char *const coins[NUM_COINS + 1];
68
69// restart server when object_count reaches this value
70#define RESTART_COUNT 0xe0000000
75 71
76/* 72/*
77 * Each object (this also means archetypes!) could have a few of these 73 * Each object (this also means archetypes!) could have a few of these
78 * "dangling" from it; this could also end up containing 'parse errors'. 74 * "dangling" from it; this could also end up containing 'parse errors'.
79 * 75 *
285 shstr ACC (RW, lore); /* Obscure information about this object, */ 281 shstr ACC (RW, lore); /* Obscure information about this object, */
286 /* To get put into books and the like. */ 282 /* To get put into books and the like. */
287 shstr ACC (RW, custom_name); /* Custom name assigned by player */ 283 shstr ACC (RW, custom_name); /* Custom name assigned by player */
288}; 284};
289 285
290const char *query_weight (const object *op); 286const_utf8_string query_weight (const object *op);
291const char *query_short_name (const object *op); 287const_utf8_string query_short_name (const object *op);
292const char *query_name (const object *op); 288const_utf8_string query_name (const object *op);
293const char *query_base_name (const object *op, int plural); 289const_utf8_string query_base_name (const object *op, int plural);
290sint64 query_cost (const object *tmp, object *who, int flag);
291const char *query_cost_string (const object *tmp, object *who, int flag);
294 292
293int change_ability_duration (object *spell, object *caster);
294int min_casting_level (object *caster, object *spell);
295int casting_level (object *caster, object *spell);
296sint16 SP_level_spellpoint_cost (object *caster, object *spell, int flags);
297int SP_level_dam_adjust (object *caster, object *spob);
298int SP_level_duration_adjust (object *caster, object *spob);
299int SP_level_range_adjust (object *caster, object *spob);
300
301struct freelist_item
302{
303 freelist_item *next;
304 uint32_t count;
305};
306
295struct object : zero_initialised, object_copy 307struct object : object_copy
296{ 308{
297 // These variables are not changed by ->copy_to 309 // These variables are not changed by ->copy_to
298 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */ 310 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */
299 311
300 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 312 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
301 int ACC (RO, count); 313 uint32_t ACC (RO, count);
302 object_vector_index ACC (RO, index); // index into objects 314 object_vector_index ACC (RO, index); // index into objects
303 object_vector_index ACC (RO, active); // index into actives 315 object_vector_index ACC (RO, active); // index into actives
304 316
305 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */ 317 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */
306 318
318 */ 330 */
319 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */ 331 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */
320 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different 332 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different
321 key_value *key_values; /* Fields not explictly known by the loader. */ 333 key_value *key_values; /* Fields not explictly known by the loader. */
322 334
335 MTH void set_flag (int flagnum)
336 {
337 flag [flagnum] = true;
338 }
339
340 MTH void clr_flag (int flagnum)
341 {
342 flag [flagnum] = false;
343 }
344
323 // privates / perl 345 // privates / perl
324 shstr_tmp kv_get (shstr_tmp key) const; 346 shstr_tmp kv_get (shstr_tmp key) const;
325 void kv_del (shstr_tmp key); 347 void kv_del (shstr_tmp key);
326 void kv_set (shstr_tmp key, shstr_tmp value); 348 void kv_set (shstr_tmp key, shstr_tmp value);
327 349
360 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all 382 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 383 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. 384 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
363 bool write (object_freezer &f); 385 bool write (object_freezer &f);
364 386
365 MTH int slottype () const;
366 MTH static object *create (); 387 MTH static object *create ();
367 const mapxy &operator =(const mapxy &pos); 388 const mapxy &operator =(const mapxy &pos);
368 MTH void copy_to (object *dst); 389 MTH void copy_to (object *dst);
369 MTH object *clone (); // create + copy_to a single object 390 MTH object *clone (); // create + copy_to a single object
370 MTH object *deep_clone (); // copy whole more chain and inventory 391 MTH object *deep_clone (); // copy whole more chain and inventory
377 destroy (); 398 destroy ();
378 } 399 }
379 400
380 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 401 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
381 MTH void destroy_inv (bool drop_to_ground = false); 402 MTH void destroy_inv (bool drop_to_ground = false);
403 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 404 MTH object *insert (object *item); // insert into inventory
383 MTH void play_sound (faceidx sound) const; 405 MTH void play_sound (faceidx sound) const;
384 MTH void say_msg (const char *msg) const; 406 MTH void say_msg (const_utf8_string msg) const;
385 407
386 void do_remove (); 408 void do_remove ();
387 MTH void remove () 409 MTH void remove ()
388 { 410 {
389 if (!flag [FLAG_REMOVED]) 411 if (!flag [FLAG_REMOVED])
397 remove (); 419 remove ();
398 *this = pos; 420 *this = pos;
399 insert_at (this, this); 421 insert_at (this, this);
400 } 422 }
401 423
402 // high-level move functions, return true if successful 424 // high-level move method.
425 // object op is trying to move in direction dir.
426 // originator is typically the same as op, but
427 // can be different if originator is causing op to
428 // move (originator is pushing op)
429 // returns 0 if the object is not able to move to the
430 // desired space, 1 otherwise (in which case we also
431 // move the object accordingly. This function is
432 // very similiar to move_object.
403 int move (int dir, object *originator); 433 int move (int dir, object *originator);
404 434
405 int move (int dir) 435 int move (int dir)
406 { 436 {
407 return move (dir, this); 437 return move (dir, this);
408 } 438 }
439
440 // changes move_type to a new value - handles move_on/move_off effects
441 MTH void change_move_type (MoveType mt);
409 442
410 static bool can_merge_slow (object *op1, object *op2); 443 static bool can_merge_slow (object *op1, object *op2);
411 444
412 // this is often used in time-critical code, so optimise 445 // this is often used in time-critical code, so optimise
413 MTH static bool can_merge (object *op1, object *op2) 446 MTH static bool can_merge (object *op1, object *op2)
418 } 451 }
419 452
420 MTH void set_owner (object *owner); 453 MTH void set_owner (object *owner);
421 MTH void set_speed (float speed); 454 MTH void set_speed (float speed);
422 MTH void set_glow_radius (sint8 rad); 455 MTH void set_glow_radius (sint8 rad);
423 MTH bool change_weapon (object *ob);
424 MTH bool change_skill (object *ob);
425 456
426 MTH void open_container (object *new_container); 457 MTH void open_container (object *new_container);
427 MTH void close_container () 458 MTH void close_container ()
428 { 459 {
429 open_container (0); 460 open_container (0);
468 MTH void drain_stat (); 499 MTH void drain_stat ();
469 MTH void drain_specific_stat (int deplete_stats); 500 MTH void drain_specific_stat (int deplete_stats);
470 MTH void change_luck (int value); 501 MTH void change_luck (int value);
471 502
472 // info must hold 256 * 3 bytes currently 503 // info must hold 256 * 3 bytes currently
473 const char *debug_desc (char *info) const; 504 const_utf8_string debug_desc (char *info) const;
474 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers 505 MTH const_utf8_string debug_desc () const; // uses at least 3 round-robin buffers
475 const char *flag_desc (char *desc, int len) const; 506 const_utf8_string flag_desc (char *desc, int len) const;
476 507
477 MTH bool decrease (sint32 nr = 1); // returns true if anything is left 508 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
478 MTH object *split (sint32 nr = 1); // return 0 on failure 509 MTH object *split (sint32 nr = 1); // return 0 on failure
479 510
480 MTH int number_of () const 511 MTH int number_of () const
518 MTH bool is_arrow () const { return type == ARROW 549 MTH bool is_arrow () const { return type == ARROW
519 || (type == SPELL_EFFECT 550 || (type == SPELL_EFFECT
520 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); } 551 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }
521 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; } 552 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; }
522 553
554 MTH bool is_dragon () const;
555
556 MTH bool is_immunity () const { return invisible && type == SIGN; }
557
523 MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; } 558 MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; }
524 559
525 // temporary: wether the object can be saved in a map file 560 // temporary: wether the object can be saved in a map file
526 // contr => is a player 561 // contr => is a player
527 // head => only save head of a multitile object 562 // head => only save head of a multitile object
535 570
536 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; } 571 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; }
537 572
538 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); } 573 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); }
539 574
575 /* need_identify returns true if the item should be identified. This
576 * function really should not exist - by default, any item not identified
577 * should need it.
578 */
579 MTH bool need_identify () const;
580
540 // returns the outermost owner, never returns 0 581 // returns the outermost owner, never returns 0
541 MTH object *outer_owner () 582 MTH object *outer_owner ()
542 { 583 {
543 object *op; 584 object *op;
544 585
598 MTH bool is_player () const 639 MTH bool is_player () const
599 { 640 {
600 return !!contr; 641 return !!contr;
601 } 642 }
602 643
644 /* elmex: this method checks whether the object is in a shop */
645 MTH bool is_in_shop () const;
646
603 MTH bool affects_los () const 647 MTH bool affects_los () const
604 { 648 {
605 return glow_radius || flag [FLAG_BLOCKSVIEW]; 649 return glow_radius || flag [FLAG_BLOCKSVIEW];
606 } 650 }
607 651
608 MTH bool has_carried_lights () const 652 MTH bool has_carried_lights () const
609 { 653 {
610 return glow_radius; 654 return glow_radius;
611 } 655 }
612 656
613 // returns the player that cna see this object, if any 657 // returns the player that can see this object, if any
614 MTH object *visible_to () const; 658 MTH object *visible_to () const;
615 659
616 MTH std::string long_desc (object *who = 0); // query_name . " " . describe 660 MTH std::string long_desc (object *who = 0); // query_name . " " . describe
617 MTH std::string describe_monster (object *who = 0); 661 MTH std::string describe_monster (object *who = 0);
618 MTH std::string describe_item (object *who = 0); 662 MTH std::string describe_item (object *who = 0);
619 MTH std::string describe (object *who = 0); // long description, without name 663 MTH std::string describe (object *who = 0); // long description, without name
620 664
621 MTH const char *query_weight () { return ::query_weight (this); } 665 MTH const_utf8_string query_weight () { return ::query_weight (this); }
622 MTH const char *query_name () { return ::query_name (this); } 666 MTH const_utf8_string query_name () { return ::query_name (this); }
623 MTH const char *query_short_name () { return ::query_short_name (this); } 667 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); } 668 MTH const_utf8_string query_base_name (bool plural) { return ::query_base_name (this, plural); }
625 669
626 // If this object has no extra parts but should have them, 670 // If this object has no extra parts but should have them,
627 // add them, effectively expanding heads into multipart 671 // add them, effectively expanding heads into multipart
628 // objects. This method only works on objects not inserted 672 // objects. This method only works on objects not inserted
629 // anywhere. 673 // anywhere.
630 MTH void expand_tail (); 674 MTH void expand_tail ();
631 675
632 MTH void create_treasure (treasurelist *tl, int flags = 0); 676 MTH void create_treasure (treasurelist *tl, int flags = 0);
677
678 // makes sure the player has the named skill,
679 // and also makes it innate if can_use is true.
680 // returns the new skill or 0 if no such skill exists.
681 MTH object *give_skill (shstr_cmp name, bool can_use = false);
682 MTH void become_follower (object *new_god);
633 683
634 // insert object at same map position as 'where' 684 // insert object at same map position as 'where'
635 // handles both inventory and map "positions" 685 // handles both inventory and map "positions"
636 MTH object *insert_at (object *where, object *originator = 0, int flags = 0); 686 MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
637 // check whether we can put this into the map, respect max_nrof, max_volume, max_items 687 // check whether we can put this into the map, respect max_nrof, max_volume, max_items
646 // set the given flag on all objects in the inventory recursively 696 // set the given flag on all objects in the inventory recursively
647 MTH void set_flag_inv (int flag, int value = 1); 697 MTH void set_flag_inv (int flag, int value = 1);
648 698
649 void enter_exit (object *exit);//Perl 699 void enter_exit (object *exit);//Perl
650 MTH void enter_map (maptile *newmap, int x, int y); 700 MTH void enter_map (maptile *newmap, int x, int y);
651 void player_goto (const char *path, int x, int y); // only for players 701 void player_goto (const_utf8_string path, int x, int y); // only for players
702 MTH bool apply (object *ob, int aflags = AP_APPLY); // ob may be 0
703
704 MTH object *mark () const;
652 705
653 // returns the mapspace this object is in 706 // returns the mapspace this object is in
654 mapspace &ms () const; 707 mapspace &ms () const;
655 708
656 // fully recursive iterator 709 // fully recursive iterator
707 return weight + carrying; 760 return weight + carrying;
708 } 761 }
709 762
710 MTH struct region *region () const; 763 MTH struct region *region () const;
711 764
712 void statusmsg (const char *msg, int color = NDI_BLACK); 765 MTH void statusmsg (const_utf8_string msg, int color = NDI_BLACK);
713 void failmsg (const char *msg, int color = NDI_RED); 766 MTH void failmsg (const_utf8_string msg, int color = NDI_RED);
767 void failmsgf (const_utf8_string format, ...); // always NDI_RED...
714 768
715 const char *query_inventory (object *who = 0, const char *indent = ""); 769 MTH const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = "");
716 770
717 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference 771 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 772 static object *deref (const_octet_string ref); // returns the object from the generated reference, if possible
719 773
720 // make some noise with given item into direction dir, 774 // make some noise with given item into direction dir,
721 // currently only used for players to make them temporarily visible 775 // currently only used for players to make them temporarily visible
722 // when they are invisible. 776 // when they are invisible.
723 MTH void make_noise (); 777 MTH void make_noise ();
733 * range from 0 through 7. 787 * range from 0 through 7.
734 */ 788 */
735 MTH int anim_frames () const { return anim ().num_animations; } 789 MTH int anim_frames () const { return anim ().num_animations; }
736 MTH int anim_facings () const { return anim ().facings; } 790 MTH int anim_facings () const { return anim ().facings; }
737 791
738 MTH char *as_string (); 792 MTH utf8_string as_string ();
793
794 // low-level management, statistics, ...
795 static uint32_t ACC (RW, object_count);
796 static uint32_t ACC (RW, free_count);
797 static uint32_t ACC (RW, create_count);
798 static uint32_t ACC (RW, destroy_count);
799 static freelist_item *freelist;
800 MTH static void freelist_free (int count);
739 801
740protected: 802protected:
741 void link (); 803 void link ();
742 void unlink (); 804 void unlink ();
805
806 void do_delete ();
743 807
744 object (); 808 object ();
745 ~object (); 809 ~object ();
746 810
747private: 811private:
768 return ob; 832 return ob;
769} 833}
770 834
771//+GPL 835//+GPL
772 836
773object *find_skill_by_name_fuzzy (object *who, const char *name); 837object *find_skill_by_name_fuzzy (object *who, const_utf8_string name);
774object *find_skill_by_name (object *who, shstr_cmp sh); 838object *find_skill_by_name (object *who, shstr_cmp sh);
775object *find_skill_by_number (object *who, int skillno); 839object *find_skill_by_number (object *who, int skillno);
776 840
777/* 841/*
778 * The archetype structure is a set of rules on how to generate and manipulate 842 * The archetype structure is a set of rules on how to generate and manipulate
784 */ 848 */
785 849
786//-GPL 850//-GPL
787 851
788INTERFACE_CLASS (archetype) 852INTERFACE_CLASS (archetype)
789struct archetype : object 853struct archetype : object, zero_initialised
790{ 854{
791 static arch_ptr empty; // the empty_archetype 855 static arch_ptr empty; // the empty_archetype
792 MTH static void gc (); 856 MTH static void gc ();
793 857
794 archetype (const char *name); 858 archetype (const_utf8_string name);
795 ~archetype (); 859 ~archetype ();
796 void gather_callbacks (AV *&callbacks, event_type event) const; 860 void gather_callbacks (AV *&callbacks, event_type event) const;
797 861
798 MTH static archetype *find (const_utf8_string name); 862 MTH static archetype *find (const_utf8_string name);
799 863
800 MTH void link (); 864 MTH void link ();
801 MTH void unlink (); 865 MTH void unlink ();
802 866
803 MTH static object *get (const char *name); // (find() || singularity)->instance() 867 MTH static object *get (const_utf8_string name); // (find() || singularity)->instance()
804 MTH object *instance (); 868 MTH object *instance ();
805 869
806 MTH void post_load_check (); // do some adjustments after parsing 870 MTH void post_load_check (); // do some adjustments after parsing
807 871
808 object_vector_index ACC (RW, archid); // index in archvector 872 object_vector_index ACC (RW, archid); // index in archvector
809 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 873 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
810 874
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...) */ 875 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 876
814 // support for archetype loading 877 // support for archetype loading
815 static archetype *read (object_thawer &f); 878 static archetype *read (object_thawer &f);
816 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more 879 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 */ 880 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
881
882protected:
883 void do_delete ();
818}; 884};
885
886// returns whether the object is a dragon player, which are often specialcased
887inline bool
888object::is_dragon () const
889{
890 return arch->race == shstr_dragon && is_player ();
891}
819 892
820inline void 893inline void
821object_freezer::put (const keyword_string k, archetype *v) 894object_freezer::put (const keyword_string k, archetype *v)
822{ 895{
823 if (expect_true (v)) 896 if (expect_true (v))

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines