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.224 by root, Sat Jan 16 13:41:37 2010 UTC vs.
Revision 1.259 by root, Sun May 1 13:18:23 2011 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,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team 4 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011 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
38 body_skill, 37{
39 body_combat, 38# define def(name, use, nonuse) body_ ## name,
40 body_range, 39# include "slotinc.h"
41 body_shield, 40# undef def
42 body_arm,
43 body_torso,
44 body_head,
45 body_neck,
46 body_finger,
47 body_shoulder,
48 body_foot,
49 body_hand,
50 body_wrist,
51 body_waist,
52 NUM_BODY_LOCATIONS 41 NUM_BODY_LOCATIONS
53}; 42};
54 43
55enum slottype_t
56{
57 slot_none,
58 slot_combat,
59 slot_ranged,
60};
61
62/* See common/item.c */ 44/* See common/item.c */
63 45
64typedef struct Body_Locations 46struct Body_Locations
65{ 47{
48 const char *name; /* Short name/identifier */
66 keyword save_name; /* Name used to load/save it to disk */ 49 keyword kw; /* Name used to load/save it to disk */
67 const char *use_name; /* Name used when describing an item we can use */ 50 const char *use_name; /* Name used when describing an item we can use */
68 const char *nonuse_name; /* Name to describe objects we can't use */ 51 const char *nonuse_name; /* Name to describe objects we can't use */
69} Body_Locations; 52};
70 53
71extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; 54extern Body_Locations body_locations[NUM_BODY_LOCATIONS];
55
56// for each set of directions (1 == up, 2 == right, 4 == down, 8 == left)
57// contains the wall suffix (0, 1_3, 1_4 and so on).
58extern const char *wall_suffix[16];
72 59
73#define NUM_COINS 4 /* number of coin types */ 60#define NUM_COINS 4 /* number of coin types */
74extern const char *const coins[NUM_COINS + 1]; 61extern const char *const coins[NUM_COINS + 1];
62
63// restart server when object_count reaches this value
64#define RESTART_COUNT 0xe0000000
75 65
76/* 66/*
77 * Each object (this also means archetypes!) could have a few of these 67 * Each object (this also means archetypes!) could have a few of these
78 * "dangling" from it; this could also end up containing 'parse errors'. 68 * "dangling" from it; this could also end up containing 'parse errors'.
79 * 69 *
… …
83 * accessing the list directly. 73 * accessing the list directly.
84 * Exception is if you want to walk this list for some reason. 74 * Exception is if you want to walk this list for some reason.
85 */ 75 */
86struct key_value : slice_allocated 76struct key_value : slice_allocated
87{ 77{
88 key_value *next; 78 key_value *next; // must be first element
89 shstr key, value; 79 shstr key, value;
80};
81
82// "crossfires version of a perl hash."
83struct key_values
84{
85 key_value *first; // must be first element
86
87 bool empty() const
88 {
89 return !first;
90 }
91
92 void clear ();
93 shstr_tmp get (shstr_tmp key) const;
94 void del (shstr_tmp key);
95 void set (shstr_tmp key, shstr_tmp value);
96
97 void add (shstr_tmp key, shstr_tmp value); // liek set, but doesn't check for duplicates
98 void reverse (); // reverses the ordering, to be used after loading an object
99 key_values &operator =(const key_values &kv);
100
101 // custom extra fields management
102 struct access_proxy
103 {
104 key_values &kv;
105 shstr_tmp key;
106
107 access_proxy (key_values &kv, shstr_tmp key)
108 : kv (kv), key (key)
109 {
110 }
111
112 const access_proxy &operator =(shstr_tmp value) const
113 {
114 kv.set (key, value);
115 return *this;
116 }
117
118 operator const shstr_tmp () const { return kv.get (key); }
119 operator const char *() const { return kv.get (key); }
120
121 private:
122 void operator =(int);
123 };
124
125 const access_proxy operator [](shstr_tmp key)
126 {
127 return access_proxy (*this, key);
128 }
90}; 129};
91 130
92//-GPL 131//-GPL
93 132
94struct UUID 133struct UUID
… …
289 328
290const_utf8_string query_weight (const object *op); 329const_utf8_string query_weight (const object *op);
291const_utf8_string query_short_name (const object *op); 330const_utf8_string query_short_name (const object *op);
292const_utf8_string query_name (const object *op); 331const_utf8_string query_name (const object *op);
293const_utf8_string query_base_name (const object *op, int plural); 332const_utf8_string query_base_name (const object *op, int plural);
333sint64 query_cost (const object *tmp, object *who, int flag);
334const char *query_cost_string (const object *tmp, object *who, int flag);
294 335
336int change_ability_duration (object *spell, object *caster);
337int min_casting_level (object *caster, object *spell);
338int casting_level (object *caster, object *spell);
339sint16 SP_level_spellpoint_cost (object *caster, object *spell, int flags);
340int SP_level_dam_adjust (object *caster, object *spob);
341int SP_level_duration_adjust (object *caster, object *spob);
342int SP_level_range_adjust (object *caster, object *spob);
343
344struct freelist_item
345{
346 freelist_item *next;
347 uint32_t count;
348};
349
295struct object : zero_initialised, object_copy 350struct object : object_copy
296{ 351{
297 // These variables are not changed by ->copy_to 352 // These variables are not changed by ->copy_to
298 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */ 353 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */
299 354
300 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 355 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
301 int ACC (RO, count); 356 uint32_t ACC (RO, count);
302 object_vector_index ACC (RO, index); // index into objects 357 object_vector_index ACC (RO, index); // index into objects
303 object_vector_index ACC (RO, active); // index into actives 358 object_vector_index ACC (RO, active); // index into actives
304 359
305 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */ 360 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */
306 361
… …
316 object *ACC (RW, env); /* Pointer to the object which is the environment. 371 object *ACC (RW, env); /* Pointer to the object which is the environment.
317 * This is typically the container that the object is in. 372 * This is typically the container that the object is in.
318 */ 373 */
319 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */ 374 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 375 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. */
322 376
323 // privates / perl 377 MTH void set_flag (int flagnum)
324 shstr_tmp kv_get (shstr_tmp key) const; 378 {
325 void kv_del (shstr_tmp key); 379 flag [flagnum] = true;
326 void kv_set (shstr_tmp key, shstr_tmp value); 380 }
381
382 MTH void clr_flag (int flagnum)
383 {
384 flag [flagnum] = false;
385 }
386
387 // extra key value pairs
388 key_values kv;
327 389
328//-GPL 390//-GPL
329
330 // custom extra fields management
331 struct key_value_access_proxy
332 {
333 object &ob;
334 shstr_tmp key;
335
336 key_value_access_proxy (object &ob, shstr_tmp key)
337 : ob (ob), key (key)
338 {
339 }
340
341 const key_value_access_proxy &operator =(shstr_tmp value) const
342 {
343 ob.kv_set (key, value);
344 return *this;
345 }
346
347 operator const shstr_tmp () const { return ob.kv_get (key); }
348 operator const char *() const { return ob.kv_get (key); }
349
350 private:
351 void operator =(int);
352 };
353
354 // operator [] is too annoying to use
355 const key_value_access_proxy kv (shstr_tmp key)
356 {
357 return key_value_access_proxy (*this, key);
358 }
359 391
360 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all 392 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 393 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. 394 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
363 bool write (object_freezer &f); 395 bool write (object_freezer &f);
364 396
365 MTH int slottype () const;
366 MTH static object *create (); 397 MTH static object *create ();
367 const mapxy &operator =(const mapxy &pos); 398 const mapxy &operator =(const mapxy &pos);
368 MTH void copy_to (object *dst); 399 MTH void copy_to (object *dst);
369 MTH object *clone (); // create + copy_to a single object 400 MTH object *clone (); // create + copy_to a single object
370 MTH object *deep_clone (); // copy whole more chain and inventory 401 MTH object *deep_clone (); // copy whole more chain and inventory
… …
377 destroy (); 408 destroy ();
378 } 409 }
379 410
380 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 411 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
381 MTH void destroy_inv (bool drop_to_ground = false); 412 MTH void destroy_inv (bool drop_to_ground = false);
413 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 414 MTH object *insert (object *item); // insert into inventory
383 MTH void play_sound (faceidx sound) const; 415 MTH void play_sound (faceidx sound) const;
384 MTH void say_msg (const_utf8_string msg) const; 416 MTH void say_msg (const_utf8_string msg) const;
385 417
386 void do_remove (); 418 void do_remove ();
… …
397 remove (); 429 remove ();
398 *this = pos; 430 *this = pos;
399 insert_at (this, this); 431 insert_at (this, this);
400 } 432 }
401 433
402 // high-level move functions, return true if successful 434 // high-level move method.
435 // object op is trying to move in direction dir.
436 // originator is typically the same as op, but
437 // can be different if originator is causing op to
438 // move (originator is pushing op)
439 // returns 0 if the object is not able to move to the
440 // desired space, 1 otherwise (in which case we also
441 // move the object accordingly. This function is
442 // very similiar to move_object.
403 int move (int dir, object *originator); 443 int move (int dir, object *originator);
404 444
405 int move (int dir) 445 int move (int dir)
406 { 446 {
407 return move (dir, this); 447 return move (dir, this);
408 } 448 }
449
450 // changes move_type to a new value - handles move_on/move_off effects
451 MTH void change_move_type (MoveType mt);
409 452
410 static bool can_merge_slow (object *op1, object *op2); 453 static bool can_merge_slow (object *op1, object *op2);
411 454
412 // this is often used in time-critical code, so optimise 455 // this is often used in time-critical code, so optimise
413 MTH static bool can_merge (object *op1, object *op2) 456 MTH static bool can_merge (object *op1, object *op2)
… …
418 } 461 }
419 462
420 MTH void set_owner (object *owner); 463 MTH void set_owner (object *owner);
421 MTH void set_speed (float speed); 464 MTH void set_speed (float speed);
422 MTH void set_glow_radius (sint8 rad); 465 MTH void set_glow_radius (sint8 rad);
423 MTH bool change_weapon (object *ob);
424 MTH bool change_skill (object *ob);
425 466
426 MTH void open_container (object *new_container); 467 MTH void open_container (object *new_container);
427 MTH void close_container () 468 MTH void close_container ()
428 { 469 {
429 open_container (0); 470 open_container (0);
… …
518 MTH bool is_arrow () const { return type == ARROW 559 MTH bool is_arrow () const { return type == ARROW
519 || (type == SPELL_EFFECT 560 || (type == SPELL_EFFECT
520 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); } 561 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }
521 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; } 562 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; }
522 563
564 MTH bool is_dragon () const;
565
566 MTH bool is_immunity () const { return invisible && type == SIGN; }
567
523 MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; } 568 MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; }
524 569
525 // temporary: wether the object can be saved in a map file 570 // temporary: wether the object can be saved in a map file
526 // contr => is a player 571 // contr => is a player
527 // head => only save head of a multitile object 572 // head => only save head of a multitile object
… …
535 580
536 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; } 581 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; }
537 582
538 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); } 583 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); }
539 584
585 /* need_identify returns true if the item should be identified. This
586 * function really should not exist - by default, any item not identified
587 * should need it.
588 */
589 MTH bool need_identify () const;
590
540 // returns the outermost owner, never returns 0 591 // returns the outermost owner, never returns 0
541 MTH object *outer_owner () 592 MTH object *outer_owner ()
542 { 593 {
543 object *op; 594 object *op;
544 595
… …
598 MTH bool is_player () const 649 MTH bool is_player () const
599 { 650 {
600 return !!contr; 651 return !!contr;
601 } 652 }
602 653
654 /* elmex: this method checks whether the object is in a shop */
655 MTH bool is_in_shop () const;
656
603 MTH bool affects_los () const 657 MTH bool affects_los () const
604 { 658 {
605 return glow_radius || flag [FLAG_BLOCKSVIEW]; 659 return glow_radius || flag [FLAG_BLOCKSVIEW];
606 } 660 }
607 661
608 MTH bool has_carried_lights () const 662 MTH bool has_carried_lights () const
609 { 663 {
610 return glow_radius; 664 return glow_radius;
611 } 665 }
612 666
613 // returns the player that cna see this object, if any 667 // returns the player that can see this object, if any
614 MTH object *visible_to () const; 668 MTH object *visible_to () const;
615 669
616 MTH std::string long_desc (object *who = 0); // query_name . " " . describe 670 MTH std::string long_desc (object *who = 0); // query_name . " " . describe
617 MTH std::string describe_monster (object *who = 0); 671 MTH std::string describe_monster (object *who = 0);
618 MTH std::string describe_item (object *who = 0); 672 MTH std::string describe_item (object *who = 0);
… …
628 // objects. This method only works on objects not inserted 682 // objects. This method only works on objects not inserted
629 // anywhere. 683 // anywhere.
630 MTH void expand_tail (); 684 MTH void expand_tail ();
631 685
632 MTH void create_treasure (treasurelist *tl, int flags = 0); 686 MTH void create_treasure (treasurelist *tl, int flags = 0);
687
688 // makes sure the player has the named skill,
689 // and also makes it innate if can_use is true.
690 // returns the new skill or 0 if no such skill exists.
691 MTH object *give_skill (shstr_cmp name, bool can_use = false);
692 MTH void become_follower (object *new_god);
633 693
634 // insert object at same map position as 'where' 694 // insert object at same map position as 'where'
635 // handles both inventory and map "positions" 695 // handles both inventory and map "positions"
636 MTH object *insert_at (object *where, object *originator = 0, int flags = 0); 696 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 697 // check whether we can put this into the map, respect max_nrof, max_volume, max_items
… …
644 MTH void deactivate_recursive (); 704 MTH void deactivate_recursive ();
645 705
646 // set the given flag on all objects in the inventory recursively 706 // set the given flag on all objects in the inventory recursively
647 MTH void set_flag_inv (int flag, int value = 1); 707 MTH void set_flag_inv (int flag, int value = 1);
648 708
649 void enter_exit (object *exit);//Perl 709 void enter_exit (object *exit); // perl
650 MTH void enter_map (maptile *newmap, int x, int y); 710 MTH bool enter_map (maptile *newmap, int x, int y);
651 void player_goto (const_utf8_string path, int x, int y); // only for players 711 void player_goto (const_utf8_string path, int x, int y); // only for players
712 MTH bool apply (object *ob, int aflags = AP_APPLY); // ob may be 0
713
714 MTH object *mark () const;
715 MTH void splay_marked ();
652 716
653 // returns the mapspace this object is in 717 // returns the mapspace this object is in
654 mapspace &ms () const; 718 mapspace &ms () const;
655 719
656 // fully recursive iterator 720 // fully recursive iterator
… …
707 return weight + carrying; 771 return weight + carrying;
708 } 772 }
709 773
710 MTH struct region *region () const; 774 MTH struct region *region () const;
711 775
712 void statusmsg (const_utf8_string msg, int color = NDI_BLACK); 776 MTH void statusmsg (const_utf8_string msg, int color = NDI_BLACK);
713 void failmsg (const_utf8_string msg, int color = NDI_RED); 777 MTH void failmsg (const_utf8_string msg, int color = NDI_RED);
778 void failmsgf (const_utf8_string format, ...); // always NDI_RED...
714 779
715 const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = ""); 780 MTH const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = "");
716 781
717 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference 782 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 783 static object *deref (const_octet_string ref); // returns the object from the generated reference, if possible
719 784
720 // make some noise with given item into direction dir, 785 // make some noise with given item into direction dir,
721 // currently only used for players to make them temporarily visible 786 // currently only used for players to make them temporarily visible
722 // when they are invisible. 787 // when they are invisible.
723 MTH void make_noise (); 788 MTH void make_noise ();
… …
735 MTH int anim_frames () const { return anim ().num_animations; } 800 MTH int anim_frames () const { return anim ().num_animations; }
736 MTH int anim_facings () const { return anim ().facings; } 801 MTH int anim_facings () const { return anim ().facings; }
737 802
738 MTH utf8_string as_string (); 803 MTH utf8_string as_string ();
739 804
805 // low-level management, statistics, ...
806 static uint32_t ACC (RW, object_count);
807 static uint32_t ACC (RW, free_count);
808 static uint32_t ACC (RW, create_count);
809 static uint32_t ACC (RW, destroy_count);
810 static freelist_item *freelist;
811 MTH static void freelist_free (int count);
812
740protected: 813protected:
741 void link (); 814 void link ();
742 void unlink (); 815 void unlink ();
816
817 void do_delete ();
743 818
744 object (); 819 object ();
745 ~object (); 820 ~object ();
746 821
747private: 822private:
… …
784 */ 859 */
785 860
786//-GPL 861//-GPL
787 862
788INTERFACE_CLASS (archetype) 863INTERFACE_CLASS (archetype)
789struct archetype : object 864struct archetype : object, zero_initialised
790{ 865{
791 static arch_ptr empty; // the empty_archetype 866 static arch_ptr empty; // the empty_archetype
792 MTH static void gc (); 867 MTH static void gc ();
793 868
794 archetype (const_utf8_string name); 869 archetype (const_utf8_string name);
… …
806 MTH void post_load_check (); // do some adjustments after parsing 881 MTH void post_load_check (); // do some adjustments after parsing
807 882
808 object_vector_index ACC (RW, archid); // index in archvector 883 object_vector_index ACC (RW, archid); // index in archvector
809 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 884 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
810 885
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...) */ 886 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 887
814 // support for archetype loading 888 // support for archetype loading
815 static archetype *read (object_thawer &f); 889 static archetype *read (object_thawer &f);
816 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more 890 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 */ 891 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
892
893protected:
894 void do_delete ();
818}; 895};
896
897// returns whether the object is a dragon player, which are often specialcased
898inline bool
899object::is_dragon () const
900{
901 return arch->race == shstr_dragon && is_player ();
902}
819 903
820inline void 904inline void
821object_freezer::put (const keyword_string k, archetype *v) 905object_freezer::put (const keyword_string k, archetype *v)
822{ 906{
823 if (expect_true (v)) 907 if (expect_true (v))
… …
888#define INS_NO_MERGE 0x0001 972#define INS_NO_MERGE 0x0001
889#define INS_ABOVE_FLOOR_ONLY 0x0002 973#define INS_ABOVE_FLOOR_ONLY 0x0002
890#define INS_NO_WALK_ON 0x0004 974#define INS_NO_WALK_ON 0x0004
891#define INS_ON_TOP 0x0008 975#define INS_ON_TOP 0x0008
892#define INS_BELOW_ORIGINATOR 0x0010 976#define INS_BELOW_ORIGINATOR 0x0010
977#define INS_NO_AUTO_EXIT 0x0020 // temporary, fix exits instead
893 978
894//-GPL 979//-GPL
895 980
896#endif 981#endif
897 982

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines