server/include/player.h

/*
 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
 * 
 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
 * Copyright (©) 1992,2007 Frank Tore Johansen
 * 
 * Deliantra 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 3 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, see <http://www.gnu.org/licenses/>.
 * 
 * The authors can be reached via e-mail to <support@deliantra.net>
 */

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, ALWAYS valid when a player is on a map */
  object *ACC (RW, ob);               /* The object representing the player, ALWAYS valid */
  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. */

  int ACC (RW, digestion);          /* Any bonuses/penalties to digestion */
  int ACC (RW, gen_hp);             /* Bonuses to regeneration speed of hp */
  int ACC (RW, gen_sp);             /* Bonuses to regeneration speed of sp */
  int ACC (RW, gen_sp_armour);      /* Penalty to sp regen from armour */
  int ACC (RW, gen_grace);          /* Bonuses to regeneration speed of grace */
  int ACC (RW, item_power);        /* Total item power of objects equipped */
  uint8 ACC (RW, listening);          /* Which priority will be used in info_all */
  uint8 ACC (RW, gender);             /* 0 male, 1 female, others not yte defined */

  /* 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 */
  bool ACC (RW, dirty);               // set if player is dirty (not reliable yet!)

  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 */

  object_ptr ACC (RW, killer);            /* Who last tried to kill this player (this object is usually destroyed) */

  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 const char *killer_name () const; // makes a string out of ->killer

  MTH static player *create ();
  static player *find (const_utf8_string name);

  static player *load_pl (object_thawer &thawer);
  MTH static player *load_pl (object_thawer *thawer) { return load_pl (*thawer); }

  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 touch () { dirty = true; } // need to touch when logged out and changed

  MTH void play_sound (faceidx sound, int dx = 0, int dy = 0) const
  {
    if (ns)
      ns->play_sound (sound, dx, dy);
  }

  // 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_ornull *ob);

  void send_msg (int color, const char *type, const char *msg)
  {
    ns->send_msg (color, type, msg);
  }

  // a prominent box that can easily be escaped away or so
  // should be used for informative output such as who, maps etc.
  // will stay on-screen
  MTH void infobox (const char *title, const char *msg, int color = NDI_BLACK);

  // a prominent msg that signifies some important event,
  // an improvement potion effect potion. should not be long.
  // might time out after a while
  MTH void statusmsg (const char *msg, int color = NDI_BLACK);

  // a prominent box that signifies some error such as a failed
  // improvement potion. should not be long.
  MTH void failmsg (const char *msg, int color = NDI_RED);

  ~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])

inline void
object::statusmsg (const char *msg, int color)
{
  if (expect_true (contr)) contr->statusmsg (msg, color);
}

inline void
object::failmsg (const char *msg, int color)
{
  if (expect_true (contr)) contr->failmsg (msg, color);
}
Revision:	1.80
Committed:	Sat May 17 14:57:23 2008 UTC (16 years ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-2_6, rel-2_55, rel-2_56, rel-2_61
Changes since 1.79:	+1 -1 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.1	/*
2	root	1.74	* This file is part of Deliantra, the Roguelike Realtime MMORPG.
3	pippijn	1.45	*
4	root	1.79	* Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5	root	1.59	* Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
6			* Copyright (©) 1992,2007 Frank Tore Johansen
7	pippijn	1.45	*
8	root	1.74	* Deliantra is free software: you can redistribute it and/or modify
9	root	1.64	* it under the terms of the GNU General Public License as published by
10			* the Free Software Foundation, either version 3 of the License, or
11			* (at your option) any later version.
12	pippijn	1.45	*
13	root	1.64	* 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	pippijn	1.45	*
18	root	1.64	* You should have received a copy of the GNU General Public License
19			* along with this program. If not, see <http://www.gnu.org/licenses/>.
20	root	1.59	*
21	root	1.74	* The authors can be reached via e-mail to <support@deliantra.net>
22	pippijn	1.45	*/
23	root	1.1
24	root	1.16	enum bowtype_t
25			{
26	root	1.50	bow_normal = 0,
27			bow_threewide = 1,
28	root	1.16	bow_spreadshot = 2,
29	root	1.50	bow_n = 3, /* must stay at 3 */
30	root	1.16	bow_ne = 4,
31	root	1.50	bow_e = 5,
32	root	1.16	bow_se = 6,
33	root	1.50	bow_s = 7,
34	root	1.16	bow_sw = 8,
35	root	1.50	bow_w = 9,
36	root	1.16	bow_nw = 10, /* must stay at 10 */
37			bow_bestarrow = 11
38			};
39
40			enum petmode_t
41			{
42			pet_normal = 0,
43	root	1.50	pet_sad = 1,
44	root	1.16	pet_defend = 2,
45	root	1.50	pet_arena = 3,
46	root	1.16	};
47
48			enum usekeytype
49			{
50			key_inventory = 0,
51	root	1.50	keyrings = 1,
52			containers = 2,
53	root	1.16	};
54	root	1.1
55			/* This is used to control what to do when we need to unapply
56			* an object before we can apply another one.
57			*/
58	root	1.16	enum unapplymode
59			{
60			unapply_nochoice = 0, /* Will unapply objects when there no choice to unapply */
61			unapply_never = 1, /* will not unapply objects automatically */
62			unapply_always = 2 /* Will unapply whatever is necessary - this goes beyond */
63			/* no choice - if there are multiple ojbect of the same type */
64			/* that need to be unapplied, there is no way for the player */
65			/* to control which of these will be unapplied. */
66			};
67
68			/* not really the player, but tied pretty closely */
69	root	1.38	INTERFACE_CLASS (partylist)
70	root	1.16	struct partylist
71			{
72	root	1.38	char *ACC (RW, partyleader);
73			char ACC (RW, passwd)[9];
74			partylist *ACC (RW, next);
75			char *ACC (RW, partyname);
76	root	1.1
77	root	1.16	struct party_kill
78			{
79			char killer[MAX_NAME + 1], dead[MAX_NAME + 1];
80			sint64 exp;
81			} party_kills[PARTY_KILL_LOG];
82	root	1.38
83			sint64 ACC (RW, total_exp);
84			uint32 ACC (RW, kills);
85	root	1.16	};
86	root	1.1
87	root	1.55	// used for pet monster logic etc.
88			static bool
89			same_party (partylist a, partylist b)
90			{
91			return a == b && a;
92			}
93
94	root	1.35	INTERFACE_CLASS (player)
95			struct player : zero_initialised, attachable
96	root	1.6	{
97	root	1.67	client ACC (RO, ns); / Socket information for this player, ALWAYS valid when a player is on a map */
98			object ACC (RW, ob); / The object representing the player, ALWAYS valid */
99	root	1.62	object_vector_index ACC (RO, active);
100	root	1.43
101	root	1.51	bowtype_t ACC (RW, bowtype); /* which firemode? */
102			petmode_t ACC (RW, petmode); /* which petmode? */
103			usekeytype ACC (RW, usekeys); /* Method for finding keys for doors */
104			unapplymode ACC (RW, unapply); /* Method for auto unapply */
105			uint32 ACC (RW, count); /* Any numbers typed before a command */
106			uint32 ACC (RW, mode); /* Mode of player for pickup. */
107
108	root	1.66	int ACC (RW, digestion); /* Any bonuses/penalties to digestion */
109			int ACC (RW, gen_hp); /* Bonuses to regeneration speed of hp */
110			int ACC (RW, gen_sp); /* Bonuses to regeneration speed of sp */
111			int ACC (RW, gen_sp_armour); /* Penalty to sp regen from armour */
112			int ACC (RW, gen_grace); /* Bonuses to regeneration speed of grace */
113			int ACC (RW, item_power); /* Total item power of objects equipped */
114	root	1.51	uint8 ACC (RW, listening); /* Which priority will be used in info_all */
115	root	1.63	uint8 ACC (RW, gender); /* 0 male, 1 female, others not yte defined */
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.76	bool ACC (RW, dirty); // set if player is dirty (not reliable yet!)
126	root	1.16
127	root	1.18	float ACC (RW, weapon_sp); /* Penalties to speed when fighting w speed >ws/10 */
128	root	1.57	float ACC (RW, weapon_sp_left); // same as speed_left, but for attacks
129	root	1.18	living ACC (RO, orig_stats); /* Permanent real stats of player */
130	root	1.44	object_ptr last_skill_ob[NUM_SKILLS]; /* the exp object */
131	root	1.18	object_ptr ACC (RW, last_used); /* Pointer to object last picked or applied */
132	root	1.16
133	root	1.53	object_ptr ACC (RW, combat_ob); // which weapon/bow/skill to use for direct attacks
134			object_ptr ACC (RW, ranged_ob); // which skill/item/spell to use for ranged attacks
135	root	1.51	object_ptr ACC (RW, golem); // the currently controlled golem
136	root	1.60	object_ptr ACC (RW, observe); // the object that is being observed (or 0)
137	root	1.51
138	root	1.18	sint16 ACC (RW, bed_x), ACC (RW, bed_y); /* x,y - coordinates of respawn (savebed) */
139	root	1.39	shstr ACC (RW, savebed_map); /* map where player will respawn after death */
140			shstr ACC (RW, maplevel); /* On which level is the player? */
141	root	1.18	char ACC (RW, spellparam)[MAX_BUF]; /* What param to add to spells */
142	root	1.16
143	root	1.18	char ACC (RW, own_title)[MAX_NAME]; /* Title the player has chosen for themself */
144	root	1.16	/* Note that for dragon players, this is filled in for them */
145	root	1.19	char ACC (RW, title)[64]; /* Default title, like fighter, wizard, etc */
146	root	1.16
147	root	1.34	sint8 ACC (RW, levhp[11]); /* What the player gained on that level */
148			sint8 ACC (RW, levsp[11]); /* Same for sp */
149			sint8 ACC (RW, levgrace[11]); /* And same for grace */
150	root	1.16
151	root	1.77	object_ptr ACC (RW, killer); /* Who last tried to kill this player (this object is usually destroyed) */
152	root	1.16
153	root	1.31	char write_buf[MAX_BUF]; /* Holds arbitrary input from client / / should go */
154	root	1.18	char ACC (RW, password)[16]; /* 2 (seed) + 11 (crypted) + 1 (EOS) + 2 (safety) = 16 */
155	root	1.1
156	root	1.18	partylist ACC (RW, party); / Party this player is part of */
157			partylist ACC (RW, party_to_join); / used when player wants to join a party */
158	root	1.16	/* but we will have to get password first */
159			/* so we have to remember which party to */
160			/* join */
161	root	1.18	char ACC (RW, search_str)[MAX_BUF]; /* Item we are looking for */
162			sint16 ACC (RW, encumbrance); /* How much our player is encumbered */
163			uint16 ACC (RW, outputs_sync); /* How often to print, no matter what */
164			uint16 ACC (RW, outputs_count); /* Print if this count is exceeded */
165			object_ptr ACC (RW, mark); /* marked object */
166	root	1.16	/* Special DM fields */
167			tag_t stack_items; / Item stack for patch/dump/... commands */
168	root	1.18	int ACC (RW, stack_position); /* Current stack position, 0 for no item */
169			sint8 blocked_los[MAP_CLIENT_X][MAP_CLIENT_Y]; /* array showing what spaces */
170	root	1.32	/* the player can see. For maps smaller than */
171			/* MAP_CLIENT_.., the upper left is used */
172	root	1.16
173	root	1.31	shstr ACC (RW, invis_race); /* What race invisible to? */
174	root	1.13
175	root	1.77	MTH const char *killer_name () const; // makes a string out of ->killer
176
177	root	1.36	MTH static player *create ();
178	root	1.73	static player *find (const_utf8_string name);
179	root	1.43
180			static player *load_pl (object_thawer &thawer);
181	root	1.73	MTH static player load_pl (object_thawer thawer) { return load_pl (*thawer); }
182	root	1.43
183			bool save_pl (object_freezer &freezer);
184			MTH bool save_pl (const char *path);
185
186	root	1.35	void do_destroy ();
187			void gather_callbacks (AV *&callbacks, event_type event) const;
188	root	1.31
189	root	1.78	MTH void touch () { dirty = true; } // need to touch when logged out and changed
190
191	root	1.65	MTH void play_sound (faceidx sound, int dx = 0, int dy = 0) const
192			{
193			if (ns)
194			ns->play_sound (sound, dx, dy);
195			}
196
197	root	1.46	// wether the player can "see" this mapspace or not, decided by los
198			// 0 - nothing see, 100 - fully visible
199			MTH sint8 visibility_at (maptile *map, int x, int y) const;
200
201	root	1.36	MTH void connect (client *ns);
202			MTH void disconnect ();
203	root	1.31
204	root	1.43	MTH void activate ();
205			MTH void deactivate ();
206
207	root	1.48	MTH void chargen_race_done ();
208			MTH void chargen_race_next ();
209
210	root	1.80	MTH void set_observe (object_ornull *ob);
211	root	1.60
212	root	1.68	void send_msg (int color, const char type, const char msg)
213			{
214			ns->send_msg (color, type, msg);
215			}
216
217			// a prominent box that can easily be escaped away or so
218			// should be used for informative output such as who, maps etc.
219			// will stay on-screen
220	root	1.75	MTH void infobox (const char title, const char msg, int color = NDI_BLACK);
221	root	1.68
222			// a prominent msg that signifies some important event,
223			// an improvement potion effect potion. should not be long.
224			// might time out after a while
225	root	1.75	MTH void statusmsg (const char *msg, int color = NDI_BLACK);
226	root	1.68
227			// a prominent box that signifies some error such as a failed
228			// improvement potion. should not be long.
229	root	1.75	MTH void failmsg (const char *msg, int color = NDI_RED);
230	root	1.68
231	root	1.31	~player ();
232
233			private:
234			void set_object (object *op);
235			player ();
236	root	1.16	};
237	root	1.13
238	root	1.43	typedef object_vector<player, &player::active> playervec;
239
240			extern playervec players;
241
242			#define for_all_players(var) \
243	root	1.65	for (unsigned _i = 0; _i < ::players.size (); ++_i) \
244			statementvar (player *, var, ::players [_i])
245	root	1.43
246	root	1.68	inline void
247			object::statusmsg (const char *msg, int color)
248			{
249			if (expect_true (contr)) contr->statusmsg (msg, color);
250			}
251
252			inline void
253	root	1.69	object::failmsg (const char *msg, int color)
254	root	1.68	{
255	root	1.69	if (expect_true (contr)) contr->failmsg (msg, color);
256	root	1.68	}