server/include/player.h

/*
 * CrossFire, A Multiplayer game for X-windows
 * 
 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
 * Copyright (C) 2002 Mark Wedel & Crossfire Development Team
 * Copyright (C) 1992 Frank Tore Johansen
 * 
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * The authors can be reached via e-mail at crossfire@schmorp.de
 */

#define NUM_OUTPUT_BUFS 5
struct Output_Buf
{
  shstr buf;                    /* Actual string pointer */
  uint32 first_update;          /* First time this message was stored  */
  uint16 count;                 /* How many times we got this message */
};

/* wand/rod/horn rolled into range_misc.  They all use the same body location
 * anyways.
 */
enum rangetype
{
  range_bottom = -1,
  range_none = 0,
  range_bow = 1,
  range_magic = 2,
  range_misc = 3,
  range_golem = 4,
  range_skill = 5,
  range_builder = 6,
  range_size = 7
};

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);
};

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 */
  int ACC (RO, active);

  rangetype ACC (RW, shoottype);       /* Which range-attack is being used by player */
  bowtype_t ACC (RW, bowtype);         /* which firemode? */
  petmode_t ACC (RW, petmode);         /* which petmode? */
  object_ptr ACC (RW, ranges[range_size]);   /* object for each range.  Set up in fix player.  Note */
                                             /* That not all are used, it is just nice to map this 1:1 */
                                             /* With the range names */
  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, has_hit);             /* If set, weapon_sp instead of speed will count */
  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 */
  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 */

  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? */
  Output_Buf outputs[NUM_OUTPUT_BUFS];  /* holds output strings to client */

  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;

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

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

  // enters the initial map, after login or creation
  MTH void enter_map ();

  ~player ();

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

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

extern playervec players;

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

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