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.219 by root, Tue Nov 10 04:38:45 2009 UTC vs.
Revision 1.243 by root, Tue Apr 13 22:05:42 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 */
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
290const char *query_weight (const object *op); 283const_utf8_string query_weight (const object *op);
291const char *query_short_name (const object *op); 284const_utf8_string query_short_name (const object *op);
292const char *query_name (const object *op); 285const_utf8_string query_name (const object *op);
293const char *query_base_name (const object *op, int plural); 286const_utf8_string query_base_name (const object *op, int plural);
287sint64 query_cost (const object *tmp, object *who, int flag);
288const char *query_cost_string (const object *tmp, object *who, int flag);
294 289
290int change_ability_duration (object *spell, object *caster);
291int min_casting_level (object *caster, object *spell);
292int casting_level (object *caster, object *spell);
293sint16 SP_level_spellpoint_cost (object *caster, object *spell, int flags);
294int SP_level_dam_adjust (object *caster, object *spob);
295int SP_level_duration_adjust (object *caster, object *spob);
296int SP_level_range_adjust (object *caster, object *spob);
297
298struct freelist_item
299{
300 freelist_item *next;
301 uint32_t count;
302};
303
295struct object : zero_initialised, object_copy 304struct object : object_copy
296{ 305{
297 // These variables are not changed by ->copy_to 306 // These variables are not changed by ->copy_to
298 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */ 307 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */
299 308
300 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 309 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
301 int ACC (RO, count); 310 uint32_t ACC (RO, count);
302 object_vector_index ACC (RO, index); // index into objects 311 object_vector_index ACC (RO, index); // index into objects
303 object_vector_index ACC (RO, active); // index into actives 312 object_vector_index ACC (RO, active); // index into actives
304 313
305 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */ 314 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */
306 315
318 */ 327 */
319 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */ 328 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 329 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. */ 330 key_value *key_values; /* Fields not explictly known by the loader. */
322 331
332 MTH void set_flag (int flagnum)
333 {
334 flag [flagnum] = true;
335 }
336
337 MTH void clr_flag (int flagnum)
338 {
339 flag [flagnum] = false;
340 }
341
323 // privates / perl 342 // privates / perl
324 shstr_tmp kv_get (shstr_tmp key) const; 343 shstr_tmp kv_get (shstr_tmp key) const;
325 void kv_del (shstr_tmp key); 344 void kv_del (shstr_tmp key);
326 void kv_set (shstr_tmp key, shstr_tmp value); 345 void kv_set (shstr_tmp key, shstr_tmp value);
327 346
360 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all 379 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 380 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. 381 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
363 bool write (object_freezer &f); 382 bool write (object_freezer &f);
364 383
365 MTH int slottype () const;
366 MTH static object *create (); 384 MTH static object *create ();
367 const mapxy &operator =(const mapxy &pos); 385 const mapxy &operator =(const mapxy &pos);
368 MTH void copy_to (object *dst); 386 MTH void copy_to (object *dst);
369 MTH object *clone (); // create + copy_to a single object 387 MTH object *clone (); // create + copy_to a single object
370 MTH object *deep_clone (); // copy whole more chain and inventory 388 MTH object *deep_clone (); // copy whole more chain and inventory
377 destroy (); 395 destroy ();
378 } 396 }
379 397
380 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 398 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
381 MTH void destroy_inv (bool drop_to_ground = false); 399 MTH void destroy_inv (bool drop_to_ground = false);
400 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 401 MTH object *insert (object *item); // insert into inventory
383 MTH void play_sound (faceidx sound) const; 402 MTH void play_sound (faceidx sound) const;
384 MTH void say_msg (const char *msg) const; 403 MTH void say_msg (const_utf8_string msg) const;
385 404
386 void do_remove (); 405 void do_remove ();
387 MTH void remove () 406 MTH void remove ()
388 { 407 {
389 if (!flag [FLAG_REMOVED]) 408 if (!flag [FLAG_REMOVED])
397 remove (); 416 remove ();
398 *this = pos; 417 *this = pos;
399 insert_at (this, this); 418 insert_at (this, this);
400 } 419 }
401 420
402 // high-level move functions, return true if successful 421 // high-level move method.
422 // object op is trying to move in direction dir.
423 // originator is typically the same as op, but
424 // can be different if originator is causing op to
425 // move (originator is pushing op)
426 // returns 0 if the object is not able to move to the
427 // desired space, 1 otherwise (in which case we also
428 // move the object accordingly. This function is
429 // very similiar to move_object.
403 int move (int dir, object *originator); 430 int move (int dir, object *originator);
404 431
405 int move (int dir) 432 int move (int dir)
406 { 433 {
407 return move (dir, this); 434 return move (dir, this);
408 } 435 }
436
437 // changes move_type to a new value - handles move_on/move_off effects
438 MTH void change_move_type (MoveType mt);
409 439
410 static bool can_merge_slow (object *op1, object *op2); 440 static bool can_merge_slow (object *op1, object *op2);
411 441
412 // this is often used in time-critical code, so optimise 442 // this is often used in time-critical code, so optimise
413 MTH static bool can_merge (object *op1, object *op2) 443 MTH static bool can_merge (object *op1, object *op2)
418 } 448 }
419 449
420 MTH void set_owner (object *owner); 450 MTH void set_owner (object *owner);
421 MTH void set_speed (float speed); 451 MTH void set_speed (float speed);
422 MTH void set_glow_radius (sint8 rad); 452 MTH void set_glow_radius (sint8 rad);
423 MTH bool change_weapon (object *ob);
424 MTH bool change_skill (object *ob);
425 453
426 MTH void open_container (object *new_container); 454 MTH void open_container (object *new_container);
427 MTH void close_container () 455 MTH void close_container ()
428 { 456 {
429 open_container (0); 457 open_container (0);
468 MTH void drain_stat (); 496 MTH void drain_stat ();
469 MTH void drain_specific_stat (int deplete_stats); 497 MTH void drain_specific_stat (int deplete_stats);
470 MTH void change_luck (int value); 498 MTH void change_luck (int value);
471 499
472 // info must hold 256 * 3 bytes currently 500 // info must hold 256 * 3 bytes currently
473 const char *debug_desc (char *info) const; 501 const_utf8_string debug_desc (char *info) const;
474 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers 502 MTH const_utf8_string debug_desc () const; // uses at least 3 round-robin buffers
475 const char *flag_desc (char *desc, int len) const; 503 const_utf8_string flag_desc (char *desc, int len) const;
476 504
477 MTH bool decrease (sint32 nr = 1); // returns true if anything is left 505 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
478 MTH object *split (sint32 nr = 1); // return 0 on failure 506 MTH object *split (sint32 nr = 1); // return 0 on failure
479 507
480 MTH int number_of () const 508 MTH int number_of () const
497 525
498 // return the volume of this object in cm³ 526 // return the volume of this object in cm³
499 MTH uint64 volume () const 527 MTH uint64 volume () const
500 { 528 {
501 return (uint64)total_weight () 529 return (uint64)total_weight ()
502 * 1000 530 * 1024 // 1000 actually
503 * (type == CONTAINER ? 1000 : 1) 531 * (type == CONTAINER ? 128 : 1)
504 / dominant_material ()->density; 532 / dominant_material ()->density; // ugh, division
505 } 533 }
506 534
507 MTH bool is_arch () const { return this == (const object *)(const archetype *)arch; } 535 MTH bool is_arch () const { return this == (const object *)(const archetype *)arch; }
508 536
509 MTH bool is_wiz () const { return flag [FLAG_WIZ]; } 537 MTH bool is_wiz () const { return flag [FLAG_WIZ]; }
518 MTH bool is_arrow () const { return type == ARROW 546 MTH bool is_arrow () const { return type == ARROW
519 || (type == SPELL_EFFECT 547 || (type == SPELL_EFFECT
520 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); } 548 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }
521 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; } 549 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; }
522 550
551 MTH bool is_dragon () const;
552
553 MTH bool is_immunity () const { return invisible && type == SIGN; }
554
523 MTH bool has_active_speed () const { return fabs (speed) >= MIN_ACTIVE_SPEED; } 555 MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; }
524 556
525 // temporary: wether the object can be saved in a map file 557 // temporary: wether the object can be saved in a map file
526 // contr => is a player 558 // contr => is a player
527 // head => only save head of a multitile object 559 // head => only save head of a multitile object
528 // owner => can not reference owner yet 560 // owner => can not reference owner yet
598 MTH bool is_player () const 630 MTH bool is_player () const
599 { 631 {
600 return !!contr; 632 return !!contr;
601 } 633 }
602 634
635 /* elmex: this method checks whether the object is in a shop */
636 MTH bool is_in_shop () const;
637
603 MTH bool affects_los () const 638 MTH bool affects_los () const
604 { 639 {
605 return glow_radius || flag [FLAG_BLOCKSVIEW]; 640 return glow_radius || flag [FLAG_BLOCKSVIEW];
606 } 641 }
607 642
616 MTH std::string long_desc (object *who = 0); // query_name . " " . describe 651 MTH std::string long_desc (object *who = 0); // query_name . " " . describe
617 MTH std::string describe_monster (object *who = 0); 652 MTH std::string describe_monster (object *who = 0);
618 MTH std::string describe_item (object *who = 0); 653 MTH std::string describe_item (object *who = 0);
619 MTH std::string describe (object *who = 0); // long description, without name 654 MTH std::string describe (object *who = 0); // long description, without name
620 655
621 MTH const char *query_weight () { return ::query_weight (this); } 656 MTH const_utf8_string query_weight () { return ::query_weight (this); }
622 MTH const char *query_name () { return ::query_name (this); } 657 MTH const_utf8_string query_name () { return ::query_name (this); }
623 MTH const char *query_short_name () { return ::query_short_name (this); } 658 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); } 659 MTH const_utf8_string query_base_name (bool plural) { return ::query_base_name (this, plural); }
625 660
626 // If this object has no extra parts but should have them, 661 // If this object has no extra parts but should have them,
627 // add them, effectively expanding heads into multipart 662 // add them, effectively expanding heads into multipart
628 // objects. This method only works on objects not inserted 663 // objects. This method only works on objects not inserted
629 // anywhere. 664 // anywhere.
630 MTH void expand_tail (); 665 MTH void expand_tail ();
631 666
632 MTH void create_treasure (treasurelist *tl, int flags = 0); 667 MTH void create_treasure (treasurelist *tl, int flags = 0);
668
669 // makes sure the player has the named skill,
670 // and also makes it innate if can_use is true.
671 // returns the new skill or 0 if no such skill exists.
672 MTH object *give_skill (shstr_cmp name, bool can_use = false);
673 MTH void become_follower (object *new_god);
633 674
634 // insert object at same map position as 'where' 675 // insert object at same map position as 'where'
635 // handles both inventory and map "positions" 676 // handles both inventory and map "positions"
636 MTH object *insert_at (object *where, object *originator = 0, int flags = 0); 677 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 678 // 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 687 // set the given flag on all objects in the inventory recursively
647 MTH void set_flag_inv (int flag, int value = 1); 688 MTH void set_flag_inv (int flag, int value = 1);
648 689
649 void enter_exit (object *exit);//Perl 690 void enter_exit (object *exit);//Perl
650 MTH void enter_map (maptile *newmap, int x, int y); 691 MTH void enter_map (maptile *newmap, int x, int y);
651 void player_goto (const char *path, int x, int y); // only for players 692 void player_goto (const_utf8_string path, int x, int y); // only for players
693 MTH bool apply (object *ob, int aflags = AP_APPLY); // ob may be 0
652 694
653 // returns the mapspace this object is in 695 // returns the mapspace this object is in
654 mapspace &ms () const; 696 mapspace &ms () const;
655 697
656 // fully recursive iterator 698 // fully recursive iterator
707 return weight + carrying; 749 return weight + carrying;
708 } 750 }
709 751
710 MTH struct region *region () const; 752 MTH struct region *region () const;
711 753
712 void statusmsg (const char *msg, int color = NDI_BLACK); 754 void statusmsg (const_utf8_string msg, int color = NDI_BLACK);
713 void failmsg (const char *msg, int color = NDI_RED); 755 void failmsg (const_utf8_string msg, int color = NDI_RED);
756 void failmsgf (const_utf8_string format, ...); // always NDI_RED...
714 757
715 const char *query_inventory (object *who = 0, const char *indent = ""); 758 const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = "");
716 759
717 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference 760 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 761 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
719 762
720 // make some noise with given item into direction dir, 763 // make some noise with given item into direction dir,
733 * range from 0 through 7. 776 * range from 0 through 7.
734 */ 777 */
735 MTH int anim_frames () const { return anim ().num_animations; } 778 MTH int anim_frames () const { return anim ().num_animations; }
736 MTH int anim_facings () const { return anim ().facings; } 779 MTH int anim_facings () const { return anim ().facings; }
737 780
738 MTH char *as_string (); 781 MTH utf8_string as_string ();
782
783 // low-level management, statistics, ...
784 static uint32_t ACC (RW, object_count);
785 static uint32_t ACC (RW, free_count);
786 static uint32_t ACC (RW, create_count);
787 static uint32_t ACC (RW, destroy_count);
788 static freelist_item *freelist;
789 MTH static void freelist_free (int count);
739 790
740protected: 791protected:
741 void link (); 792 void link ();
742 void unlink (); 793 void unlink ();
794
795 void do_delete ();
743 796
744 object (); 797 object ();
745 ~object (); 798 ~object ();
746 799
747private: 800private:
768 return ob; 821 return ob;
769} 822}
770 823
771//+GPL 824//+GPL
772 825
773object *find_skill_by_name_fuzzy (object *who, const char *name); 826object *find_skill_by_name_fuzzy (object *who, const_utf8_string name);
774object *find_skill_by_name (object *who, shstr_cmp sh); 827object *find_skill_by_name (object *who, shstr_cmp sh);
775object *find_skill_by_number (object *who, int skillno); 828object *find_skill_by_number (object *who, int skillno);
776 829
777/* 830/*
778 * The archetype structure is a set of rules on how to generate and manipulate 831 * The archetype structure is a set of rules on how to generate and manipulate
784 */ 837 */
785 838
786//-GPL 839//-GPL
787 840
788INTERFACE_CLASS (archetype) 841INTERFACE_CLASS (archetype)
789struct archetype : object 842struct archetype : object, zero_initialised
790{ 843{
791 static arch_ptr empty; // the empty_archetype 844 static arch_ptr empty; // the empty_archetype
792 MTH static void gc (); 845 MTH static void gc ();
793 846
794 archetype (const char *name); 847 archetype (const_utf8_string name);
795 ~archetype (); 848 ~archetype ();
796 void gather_callbacks (AV *&callbacks, event_type event) const; 849 void gather_callbacks (AV *&callbacks, event_type event) const;
797 850
798 MTH static archetype *find (const_utf8_string name); 851 MTH static archetype *find (const_utf8_string name);
799 852
800 MTH void link (); 853 MTH void link ();
801 MTH void unlink (); 854 MTH void unlink ();
802 855
803 MTH static object *get (const char *name); // (find() || singularity)->instance() 856 MTH static object *get (const_utf8_string name); // (find() || singularity)->instance()
804 MTH object *instance (); 857 MTH object *instance ();
805 858
806 MTH void post_load_check (); // do some adjustments after parsing 859 MTH void post_load_check (); // do some adjustments after parsing
807 860
808 object_vector_index ACC (RW, archid); // index in archvector 861 object_vector_index ACC (RW, archid); // index in archvector
809 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 862 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
810 863
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...) */ 864 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 865
814 // support for archetype loading 866 // support for archetype loading
815 static archetype *read (object_thawer &f); 867 static archetype *read (object_thawer &f);
816 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more 868 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 */ 869 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
870
871protected:
872 void do_delete ();
818}; 873};
819 874
820// compatbiility, remove once replaced by ->instance 875// returns whether the object is a dragon player, which are often specialcased
821inline object * 876inline bool
822arch_to_object (archetype *at) 877object::is_dragon () const
823{ 878{
824 return at->instance (); 879 return arch->race == shstr_dragon && is_player ();
825} 880}
826 881
827inline void 882inline void
828object_freezer::put (keyword k, archetype *v) 883object_freezer::put (const keyword_string k, archetype *v)
829{ 884{
830 put (k, v ? &v->archname : (const char *)0); 885 if (expect_true (v))
886 put (k, v->archname);
887 else
888 put (k);
831} 889}
832 890
833typedef object_vector<object, &object::index > objectvec; 891typedef object_vector<object, &object::index > objectvec;
834typedef object_vector<object, &object::active> activevec; 892typedef object_vector<object, &object::active> activevec;
835typedef object_vector<archetype, &archetype::archid> archvec; 893typedef object_vector<archetype, &archetype::archid> archvec;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines