server/include/player.h

/*
 * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game.
 * 
 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
 * Copyright (©) 1992,2007 Frank Tore Johansen
 * 
 * Crossfire TRT is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 * for more details.
 * 
 * You should have received a copy of the GNU General Public License along
 * with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 * 
 * The authors can be reached via e-mail to <crossfire@schmorp.de>
 */

enum bowtype_t
{
  bow_normal     = 0,
  bow_threewide  = 1,
  bow_spreadshot = 2,
  bow_n  = 3,                    /* must stay at 3 */
  bow_ne = 4,
  bow_e  = 5,
  bow_se = 6,
  bow_s  = 7,
  bow_sw = 8,
  bow_w  = 9,
  bow_nw = 10,                  /* must stay at 10 */
  bow_bestarrow = 11
};

enum petmode_t
{
  pet_normal = 0,
  pet_sad    = 1,
  pet_defend = 2,
  pet_arena  = 3,
};

enum usekeytype
{
  key_inventory = 0,
  keyrings      = 1,
  containers    = 2,
};

/* This is used to control what to do when we need to unapply
 * an object before we can apply another one.
 */
enum unapplymode
{
  unapply_nochoice = 0,         /* Will unapply objects when there no choice to unapply */
  unapply_never = 1,            /* will not unapply objects automatically */
  unapply_always = 2            /* Will unapply whatever is necessary - this goes beyond */
    /* no choice - if there are multiple ojbect of the same type */
    /* that need to be unapplied, there is no way for the player */
    /* to control which of these will be unapplied. */
};

/* not really the player, but tied pretty closely */
INTERFACE_CLASS (partylist)
struct partylist
{
  char *ACC (RW, partyleader);
  char ACC (RW, passwd)[9];
  partylist *ACC (RW, next);
  char *ACC (RW, partyname);

  struct party_kill
  {
    char killer[MAX_NAME + 1], dead[MAX_NAME + 1];
    sint64 exp;
  } party_kills[PARTY_KILL_LOG];

  sint64 ACC (RW, total_exp);
  uint32 ACC (RW, kills);
};

// used for pet monster logic etc.
static bool
same_party (partylist *a, partylist *b)
{
  return a == b && a;
}

INTERFACE_CLASS (player)
struct player : zero_initialised, attachable
{
  client *ACC (RO, ns);               /* Socket information for this player */
  object *ACC (RW, ob);               /* The object representing the player */
  object_vector_index ACC (RO, active);

  bowtype_t ACC (RW, bowtype);        /* which firemode? */
  petmode_t ACC (RW, petmode);        /* which petmode? */
  usekeytype ACC (RW, usekeys);       /* Method for finding keys for doors */
  unapplymode ACC (RW, unapply);      /* Method for auto unapply */
  uint32 ACC (RW, count);             /* Any numbers typed before a command */
  uint32 ACC (RW, mode);              /* Mode of player for pickup. */

  sint8 ACC (RW, digestion);          /* Any bonuses/penalties to digestion */
  sint8 ACC (RW, gen_hp);             /* Bonuses to regeneration speed of hp */
  sint8 ACC (RW, gen_sp);             /* Bonuses to regeneration speed of sp */
  sint8 ACC (RW, gen_sp_armour);      /* Penalty to sp regen from armour */
  sint8 ACC (RW, gen_grace);          /* Bonuses to regeneration speed of grace */
  sint16 ACC (RW, item_power);        /* Total item power of objects equipped */
  uint8 ACC (RW, listening);          /* Which priority will be used in info_all */

  /* Try to put all the bitfields together - saves some small amount of memory */
  bool ACC (RW, braced);              /* Will not move if braced, only attack */
  bool ACC (RW, tmp_invis);           /* Will invis go away when we attack ? */
  bool ACC (RW, do_los);              /* If true, need to call update_los() in draw(), and clear */
  bool ACC (RW, fire_on);             /* Player should fire object, not move */
  bool ACC (RW, run_on);              /* Player should keep moving in dir until run is off */
  bool ACC (RW, peaceful);            /* If set, won't attack friendly creatures */
  bool ACC (RW, hidden);              /* If True, player (DM) is hidden from view */

  float ACC (RW, weapon_sp);              /* Penalties to speed when fighting w speed >ws/10 */
  float ACC (RW, weapon_sp_left);         // same as speed_left, but for attacks
  living ACC (RO, orig_stats);            /* Permanent real stats of player */
  object_ptr last_skill_ob[NUM_SKILLS];   /* the exp object */
  object_ptr ACC (RW, last_used);            /* Pointer to object last picked or applied */

  object_ptr ACC (RW, combat_ob);     // which weapon/bow/skill to use for direct attacks
  object_ptr ACC (RW, ranged_ob);     // which skill/item/spell to use for ranged attacks
  object_ptr ACC (RW, golem);         // the currently controlled golem
  object_ptr ACC (RW, observe);       // the object that is being observed (or 0)

  sint16 ACC (RW, bed_x), ACC (RW, bed_y);          /* x,y - coordinates of respawn (savebed) */
  shstr ACC (RW, savebed_map);    /* map where player will respawn after death */
  shstr ACC (RW, maplevel);       /* On which level is the player? */
  char ACC (RW, spellparam)[MAX_BUF];     /* What param to add to spells */

  char ACC (RW, own_title)[MAX_NAME];     /* Title the player has chosen for themself */
  /* Note that for dragon players, this is filled in for them */
  char ACC (RW, title)[64];         /* Default title, like fighter, wizard, etc */

  sint8 ACC (RW, levhp[11]);              /* What the player gained on that level */
  sint8 ACC (RW, levsp[11]);              /* Same for sp */
  sint8 ACC (RW, levgrace[11]);           /* And same for grace */

  char ACC (RW, killer)[64];        /* Who killed this player. */

  char write_buf[MAX_BUF];      /* Holds arbitrary input from client */ /* should go */
  char ACC (RW, password)[16];            /* 2 (seed) + 11 (crypted) + 1 (EOS) + 2 (safety) = 16 */

  partylist *ACC (RW, party);             /* Party this player is part of */
  partylist *ACC (RW, party_to_join);     /* used when player wants to join a party */
  /* but we will have to get password first */
  /* so we have to remember which party to */
  /* join */
  char ACC (RW, search_str)[MAX_BUF];     /* Item we are looking for */
  sint16 ACC (RW, encumbrance);           /* How much our player is encumbered  */
  uint16 ACC (RW, outputs_sync);          /* How often to print, no matter what */
  uint16 ACC (RW, outputs_count);         /* Print if this count is exceeded */
  object_ptr ACC (RW, mark);                 /* marked object */
  /* Special DM fields */
  tag_t *stack_items;           /* Item stack for patch/dump/... commands */
  int ACC (RW, stack_position);           /* Current stack position, 0 for no item */
  sint8 blocked_los[MAP_CLIENT_X][MAP_CLIENT_Y];        /* array showing what spaces */
                                                        /* the player can see.  For maps smaller than */
                                                        /* MAP_CLIENT_.., the upper left is used */

  shstr ACC (RW, invis_race);             /* What race invisible to? */

  MTH static player *create ();

  static player *load_pl (object_thawer &thawer);
  MTH static player *load_pl (const char *path);

  bool save_pl (object_freezer &freezer);
  MTH bool save_pl (const char *path);

  void do_destroy ();
  void gather_callbacks (AV *&callbacks, event_type event) const;

  // wether the player can "see" this mapspace or not, decided by los
  // 0 - nothing see, 100 - fully visible
  MTH sint8 visibility_at (maptile *map, int x, int y) const;

  MTH void connect (client *ns);
  MTH void disconnect ();

  MTH void activate ();
  MTH void deactivate ();

  MTH void chargen_race_done ();
  MTH void chargen_race_next ();

  MTH void set_observe (object *ob);

  ~player ();

private:
  void set_object (object *op);
  player ();
};

typedef object_vector<player, &player::active> playervec;

extern playervec players;

#define for_all_players(var)                    \
  for (unsigned _i = 0; _i < players.size (); ++_i)     \
    statementvar (player *, var, players [_i])

Revision:	1.62
Committed:	Sun Jun 24 00:33:54 2007 UTC (19 years, 3 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.61:	+1 -1 lines
Log Message:	- pippijn unknowingly inspired the idea of documenting the type of the objetc_vector_index explicitly. - pippijn spotted a typoe, to, go figure!
#	User	Rev	Content
1	root	1.1	/*
2	root	1.59	* This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game.
3	pippijn	1.45	*
4	root	1.59	* Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
5			* Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
6			* Copyright (©) 1992,2007 Frank Tore Johansen
7	pippijn	1.45	*
8	root	1.59	* Crossfire TRT is free software; you can redistribute it and/or modify it
9			* under the terms of the GNU General Public License as published by the Free
10			* Software Foundation; either version 2 of the License, or (at your option)
11			* any later version.
12	pippijn	1.45	*
13	root	1.59	* This program is distributed in the hope that it will be useful, but
14			* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15			* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16			* for more details.
17	pippijn	1.45	*
18	root	1.59	* You should have received a copy of the GNU General Public License along
19			* with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51
20			* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21			*
22			* The authors can be reached via e-mail to <crossfire@schmorp.de>
23	pippijn	1.45	*/
24	root	1.1
25	root	1.16	enum bowtype_t
26			{
27	root	1.50	bow_normal = 0,
28			bow_threewide = 1,
29	root	1.16	bow_spreadshot = 2,
30	root	1.50	bow_n = 3, /* must stay at 3 */
31	root	1.16	bow_ne = 4,
32	root	1.50	bow_e = 5,
33	root	1.16	bow_se = 6,
34	root	1.50	bow_s = 7,
35	root	1.16	bow_sw = 8,
36	root	1.50	bow_w = 9,
37	root	1.16	bow_nw = 10, /* must stay at 10 */
38			bow_bestarrow = 11
39			};
40
41			enum petmode_t
42			{
43			pet_normal = 0,
44	root	1.50	pet_sad = 1,
45	root	1.16	pet_defend = 2,
46	root	1.50	pet_arena = 3,
47	root	1.16	};
48
49			enum usekeytype
50			{
51			key_inventory = 0,
52	root	1.50	keyrings = 1,
53			containers = 2,
54	root	1.16	};
55	root	1.1
56			/* This is used to control what to do when we need to unapply
57			* an object before we can apply another one.
58			*/
59	root	1.16	enum unapplymode
60			{
61			unapply_nochoice = 0, /* Will unapply objects when there no choice to unapply */
62			unapply_never = 1, /* will not unapply objects automatically */
63			unapply_always = 2 /* Will unapply whatever is necessary - this goes beyond */
64			/* no choice - if there are multiple ojbect of the same type */
65			/* that need to be unapplied, there is no way for the player */
66			/* to control which of these will be unapplied. */
67			};
68
69			/* not really the player, but tied pretty closely */
70	root	1.38	INTERFACE_CLASS (partylist)
71	root	1.16	struct partylist
72			{
73	root	1.38	char *ACC (RW, partyleader);
74			char ACC (RW, passwd)[9];
75			partylist *ACC (RW, next);
76			char *ACC (RW, partyname);
77	root	1.1
78	root	1.16	struct party_kill
79			{
80			char killer[MAX_NAME + 1], dead[MAX_NAME + 1];
81			sint64 exp;
82			} party_kills[PARTY_KILL_LOG];
83	root	1.38
84			sint64 ACC (RW, total_exp);
85			uint32 ACC (RW, kills);
86	root	1.16	};
87	root	1.1
88	root	1.55	// used for pet monster logic etc.
89			static bool
90			same_party (partylist a, partylist b)
91			{
92			return a == b && a;
93			}
94
95	root	1.35	INTERFACE_CLASS (player)
96			struct player : zero_initialised, attachable
97	root	1.6	{
98	root	1.51	client ACC (RO, ns); / Socket information for this player */
99			object ACC (RW, ob); / The object representing the player */
100	root	1.62	object_vector_index ACC (RO, active);
101	root	1.43
102	root	1.51	bowtype_t ACC (RW, bowtype); /* which firemode? */
103			petmode_t ACC (RW, petmode); /* which petmode? */
104			usekeytype ACC (RW, usekeys); /* Method for finding keys for doors */
105			unapplymode ACC (RW, unapply); /* Method for auto unapply */
106			uint32 ACC (RW, count); /* Any numbers typed before a command */
107			uint32 ACC (RW, mode); /* Mode of player for pickup. */
108
109			sint8 ACC (RW, digestion); /* Any bonuses/penalties to digestion */
110			sint8 ACC (RW, gen_hp); /* Bonuses to regeneration speed of hp */
111			sint8 ACC (RW, gen_sp); /* Bonuses to regeneration speed of sp */
112			sint8 ACC (RW, gen_sp_armour); /* Penalty to sp regen from armour */
113			sint8 ACC (RW, gen_grace); /* Bonuses to regeneration speed of grace */
114			sint16 ACC (RW, item_power); /* Total item power of objects equipped */
115			uint8 ACC (RW, listening); /* Which priority will be used in info_all */
116	root	1.16
117			/* Try to put all the bitfields together - saves some small amount of memory */
118	root	1.43	bool ACC (RW, braced); /* Will not move if braced, only attack */
119			bool ACC (RW, tmp_invis); /* Will invis go away when we attack ? */
120			bool ACC (RW, do_los); /* If true, need to call update_los() in draw(), and clear */
121			bool ACC (RW, fire_on); /* Player should fire object, not move */
122			bool ACC (RW, run_on); /* Player should keep moving in dir until run is off */
123			bool ACC (RW, peaceful); /* If set, won't attack friendly creatures */
124			bool ACC (RW, hidden); /* If True, player (DM) is hidden from view */
125	root	1.16
126	root	1.18	float ACC (RW, weapon_sp); /* Penalties to speed when fighting w speed >ws/10 */
127	root	1.57	float ACC (RW, weapon_sp_left); // same as speed_left, but for attacks
128	root	1.18	living ACC (RO, orig_stats); /* Permanent real stats of player */
129	root	1.44	object_ptr last_skill_ob[NUM_SKILLS]; /* the exp object */
130	root	1.18	object_ptr ACC (RW, last_used); /* Pointer to object last picked or applied */
131	root	1.16
132	root	1.53	object_ptr ACC (RW, combat_ob); // which weapon/bow/skill to use for direct attacks
133			object_ptr ACC (RW, ranged_ob); // which skill/item/spell to use for ranged attacks
134	root	1.51	object_ptr ACC (RW, golem); // the currently controlled golem
135	root	1.60	object_ptr ACC (RW, observe); // the object that is being observed (or 0)
136	root	1.51
137	root	1.18	sint16 ACC (RW, bed_x), ACC (RW, bed_y); /* x,y - coordinates of respawn (savebed) */
138	root	1.39	shstr ACC (RW, savebed_map); /* map where player will respawn after death */
139			shstr ACC (RW, maplevel); /* On which level is the player? */
140	root	1.18	char ACC (RW, spellparam)[MAX_BUF]; /* What param to add to spells */
141	root	1.16
142	root	1.18	char ACC (RW, own_title)[MAX_NAME]; /* Title the player has chosen for themself */
143	root	1.16	/* Note that for dragon players, this is filled in for them */
144	root	1.19	char ACC (RW, title)[64]; /* Default title, like fighter, wizard, etc */
145	root	1.16
146	root	1.34	sint8 ACC (RW, levhp[11]); /* What the player gained on that level */
147			sint8 ACC (RW, levsp[11]); /* Same for sp */
148			sint8 ACC (RW, levgrace[11]); /* And same for grace */
149	root	1.16
150	root	1.19	char ACC (RW, killer)[64]; /* Who killed this player. */
151	root	1.16
152	root	1.31	char write_buf[MAX_BUF]; /* Holds arbitrary input from client / / should go */
153	root	1.18	char ACC (RW, password)[16]; /* 2 (seed) + 11 (crypted) + 1 (EOS) + 2 (safety) = 16 */
154	root	1.1
155	root	1.18	partylist ACC (RW, party); / Party this player is part of */
156			partylist ACC (RW, party_to_join); / used when player wants to join a party */
157	root	1.16	/* but we will have to get password first */
158			/* so we have to remember which party to */
159			/* join */
160	root	1.18	char ACC (RW, search_str)[MAX_BUF]; /* Item we are looking for */
161			sint16 ACC (RW, encumbrance); /* How much our player is encumbered */
162			uint16 ACC (RW, outputs_sync); /* How often to print, no matter what */
163			uint16 ACC (RW, outputs_count); /* Print if this count is exceeded */
164			object_ptr ACC (RW, mark); /* marked object */
165	root	1.16	/* Special DM fields */
166			tag_t stack_items; / Item stack for patch/dump/... commands */
167	root	1.18	int ACC (RW, stack_position); /* Current stack position, 0 for no item */
168			sint8 blocked_los[MAP_CLIENT_X][MAP_CLIENT_Y]; /* array showing what spaces */
169	root	1.32	/* the player can see. For maps smaller than */
170			/* MAP_CLIENT_.., the upper left is used */
171	root	1.16
172	root	1.31	shstr ACC (RW, invis_race); /* What race invisible to? */
173	root	1.13
174	root	1.36	MTH static player *create ();
175	root	1.43
176			static player *load_pl (object_thawer &thawer);
177			MTH static player load_pl (const char path);
178
179			bool save_pl (object_freezer &freezer);
180			MTH bool save_pl (const char *path);
181
182	root	1.35	void do_destroy ();
183			void gather_callbacks (AV *&callbacks, event_type event) const;
184	root	1.31
185	root	1.46	// wether the player can "see" this mapspace or not, decided by los
186			// 0 - nothing see, 100 - fully visible
187			MTH sint8 visibility_at (maptile *map, int x, int y) const;
188
189	root	1.36	MTH void connect (client *ns);
190			MTH void disconnect ();
191	root	1.31
192	root	1.43	MTH void activate ();
193			MTH void deactivate ();
194
195	root	1.48	MTH void chargen_race_done ();
196			MTH void chargen_race_next ();
197
198	root	1.60	MTH void set_observe (object *ob);
199
200	root	1.31	~player ();
201
202			private:
203			void set_object (object *op);
204			player ();
205	root	1.16	};
206	root	1.13
207	root	1.43	typedef object_vector<player, &player::active> playervec;
208
209			extern playervec players;
210
211			#define for_all_players(var) \
212	pippijn	1.47	for (unsigned _i = 0; _i < players.size (); ++_i) \
213	root	1.61	statementvar (player *, var, players [_i])
214	root	1.43