Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
blob: dbcc1615d3a9dc720c2444d7c5e8e24b11dc7ff4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
/*
   core/player.h
   This file is part of the Osirion project and is distributed under
   the terms of the GNU General Public License version 2.
*/

#ifndef __INCLUDED_CORE_PLAYER_H__
#define __INCLUDED_CORE_PLAYER_H__

namespace core
{
class Player;
}

#include "core/entity.h"
#include "core/message.h"
#include "core/zone.h"
#include "math/mathlib.h"

#include <string>
#include <list>

namespace core
{

/// a player in the game
class Player
{
public:
	/// default constructor
	Player();
	/// default destructor
	virtual ~Player();

	/*----- inspectors ------------------------------------------------ */

	///  id of the player
	inline const int id() const {
		return player_id;
	}

	/// name of the player
	inline const std::string & name() const {
		return player_name;
	}

	/// dirty flag
	inline const bool dirty() const {
		return player_dirty;
	}

	/// the entity the Player is currently controling
	inline EntityControlable *control() const {
		return player_control;
	}

	/// the zone the player is currently in
	inline Zone *zone() const {
		return player_zone;
	}

	/// set the zone the player is currently in
	void set_zone(Zone *zone);

	inline const bool zonechange() const {
		return player_zonechange;
	}

	/// player primary color
	inline const math::Color & color() const {
		return player_color;
	}

	/// player secondary color
	inline const math::Color & color_second() const {
		return player_color_second;
	}

	/// player has been muted by admin or console
	inline const bool mute() const {
		return player_mute;
	}

	inline const std::string &rconpassword() const {
		return player_rconpassword;
	}

	/// mission target
	inline Entity *mission_target() {
		return player_mission_target;
	}

	/// view
	inline Entity *view() {
		return player_view;
	}

	/// credits
	inline long credits() const {
		return player_credits;
	}

	/// network ping
	inline long ping() const {
		return player_ping;
	}

	/// returns true of the player has enough credits to pay amount
	inline bool has_credits(const long amount) const {
		return (player_credits >= amount);
	}

	/// print player info to console
	virtual void print() const;

	/// player level
	const int level() const {
		return player_level;
	}
	
	/// player admin level
	const int admin_level() const {
		return player_admin_level;
	}
	
	/// player global unique id
	const std::string & guid() const {
		return player_guid;
	}

	/*----- messages -------------------------------------------------- */

	/// send a text message
	void send(const std::string text);

	/**
	 * @brief send a warning message
	 * Send the player a warning message abd set the warning
	 * message timestamp to the current application time
	 * @see last_warning()
	 */
	void send_warning(const std::string text);

	virtual void sound(const std::string name);

	virtual void message(core::Message::Channel channel, const std::string text);

	/// time of the last warning message
	float  last_warning() const {
		return player_warningtime;
	}

	/*----- mutators -------------------------------------------------- */

	/// serialize player info to a stream
	void serialize_server_update(std::ostream & os) const;

	/// receive player info from a stream
	void receive_server_update(std::istream &is);

	/// serialize player info to a stream
	void serialize_client_update(std::ostream & os);

	/// receive player info from a stream
	void receive_client_update(std::istream &is);

	/// serialize short player info to a stream
	void serialize_short_server_update(std::ostream & os) const;

	/// receive short player info from a stream
	void receive_short_server_update(std::istream &is);

	/// clear all the data
	void clear();

	/// clear assets
	void clear_assets();

	/// add an asset
	void add_asset(EntityControlable *entity);

	/// remove an asset
	void remove_asset(EntityControlable *entity);

	/// remove an asset
	void remove_asset(unsigned int id);

	/// update player info from client variables
	void update_info();

	/**
	 * @brief set the entity the player is currenty controlling
	 * This will automaticly set zone() to the zone the entity is in
	 */
	void set_control(EntityControlable *entitycontrolable);

	/// set mission target
	void set_mission_target(Entity *new_mission_target);

	/// set the current view
	void set_view(Entity *view);

	/// set the amount of credits the players has
	void set_credits(const long amount);

	/**
	 * @brief add an amount to the player's credits
	 * @param amount the amount of credits to add, can be negative
	 */
	void add_credits(const long amount);

	/**
	 * @brief set the player's network ping
	 */
	void set_ping(const long ping);


	/// set the player level
	void set_level(const int level);
	
	/// set the admin level
	void set_admin_level(const int admin_level);
	
	void set_guid(const std::string & guid);
	
	/// set the dirty bit
	inline void set_dirty(const bool dirty = true) {
		player_dirty = dirty;
	}

	/// set the zonechange bit
	inline void set_zonechange(const bool dirty = true) {
		player_zonechange = dirty;
	}

	/* -- should actually not be public --*/

	///  id of the player
	int player_id;

	/// name of the player
	std::string player_name;

	/// player primary color
	math::Color player_color;

	/// player secondary color
	math::Color player_color_second;

	/// player is muted by admin
	bool player_mute;

	std::list<EntityControlable *>	assets;

private:
	// entity the Player is currently controling
	EntityControlable *player_control;

	// entity the Player is currently looking at
	Entity *player_view;

	// current mission target
	Entity *player_mission_target;

	// the zone the player is currently in
	Zone 			*player_zone;

	long			player_credits;
	// in-game level
	int			player_level;
	
	long			player_ping;
	std::string		player_rconpassword;
	int			player_admin_level;
	
	// global unique id
	std::string		player_guid;
	
	// dirty bit
	bool 			player_dirty;
	// bit to indicate zone has changed
	bool 			player_zonechange;

	float			player_warningtime;

};

}

#endif // __INCLUDED_CORE_PLAYER_H__