3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 #include "connection.h"
24 #include "environment.h"
25 #include "irrlichttypes_extrabloated.h"
30 #include "clientobject.h"
32 #include "inventorymanager.h"
34 #include "filecache.h"
35 #include "localplayer.h"
37 #include "particles.h"
38 #include "util/pointedthing.h"
43 class IWritableTextureSource;
44 class IWritableShaderSource;
45 class IWritableItemDefManager;
46 class IWritableNodeDefManager;
47 //class IWritableCraftDefManager;
48 class ClientEnvironment;
49 struct MapDrawControl;
52 class ClientNotReadyException : public BaseException
55 ClientNotReadyException(const char *s):
60 struct QueuedMeshUpdate
64 bool ack_block_to_server;
71 A thread-safe queue of mesh update tasks
81 peer_id=0 adds with nobody to send to
83 void addBlock(v3s16 p, MeshMakeData *data,
84 bool ack_block_to_server, bool urgent);
86 // Returned pointer must be deleted
87 // Returns NULL if queue is empty
88 QueuedMeshUpdate * pop();
92 JMutexAutoLock lock(m_mutex);
93 return m_queue.size();
97 std::vector<QueuedMeshUpdate*> m_queue;
98 std::set<v3s16> m_urgents;
102 struct MeshUpdateResult
106 bool ack_block_to_server;
109 p(-1338,-1338,-1338),
111 ack_block_to_server(false)
116 class MeshUpdateThread : public SimpleThread
120 MeshUpdateThread(IGameDef *gamedef):
127 MeshUpdateQueue m_queue_in;
129 MutexedQueue<MeshUpdateResult> m_queue_out;
134 class MediaFetchThread : public SimpleThread
138 MediaFetchThread(IGameDef *gamedef):
145 core::list<MediaRequest> m_file_requests;
146 MutexedQueue<std::pair<std::string, std::string> > m_file_data;
147 core::list<MediaRequest> m_failed;
148 std::string m_remote_url;
156 CE_PLAYER_FORCE_MOVE,
164 ClientEventType type;
176 bool set_camera_point_target;
177 f32 camera_point_target_x;
178 f32 camera_point_target_y;
179 f32 camera_point_target_z;
182 std::string* formspec;
183 std::string* formname;
190 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
194 NOTE: Nothing is thread-safe here.
198 IrrlichtDevice *device,
199 const char *playername,
200 std::string password,
201 MapDrawControl &control,
202 IWritableTextureSource *tsrc,
203 IWritableShaderSource *shsrc,
204 IWritableItemDefManager *itemdef,
205 IWritableNodeDefManager *nodedef,
206 ISoundManager *sound,
207 MtEventManager *event
212 The name of the local player should already be set when
213 calling this, as it is sent in the initialization.
215 void connect(Address address);
218 m_con.Connected() == true
219 AND m_server_ser_ver != SER_FMT_VER_INVALID
220 throws con::PeerNotFoundException if connection has been deleted,
223 bool connectedAndInitialized();
225 Stuff that references the environment is valid only as
226 long as this is not called. (eg. Players)
227 If this throws a PeerNotFoundException, the connection has
230 void step(float dtime);
232 void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
233 // Returns true if something was received
234 bool AsyncProcessPacket();
235 bool AsyncProcessData();
236 void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
238 void interact(u8 action, const PointedThing& pointed);
240 void sendNodemetaFields(v3s16 p, const std::string &formname,
241 const std::map<std::string, std::string> &fields);
242 void sendInventoryFields(const std::string &formname,
243 const std::map<std::string, std::string> &fields);
244 void sendInventoryAction(InventoryAction *a);
245 void sendChatMessage(const std::wstring &message);
246 void sendChangePassword(const std::wstring oldpassword,
247 const std::wstring newpassword);
248 void sendDamage(u8 damage);
251 ClientEnvironment& getEnv()
254 // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
255 void removeNode(v3s16 p);
256 void addNode(v3s16 p, MapNode n);
258 void setPlayerControl(PlayerControl &control);
260 void selectPlayerItem(u16 item);
261 u16 getPlayerItem() const
262 { return m_playeritem; }
264 // Returns true if the inventory of the local player has been
265 // updated from the server. If it is true, it is set to false.
266 bool getLocalInventoryUpdated();
267 // Copies the inventory of the local player to parameter
268 void getLocalInventory(Inventory &dst);
270 /* InventoryManager interface */
271 Inventory* getInventory(const InventoryLocation &loc);
272 void inventoryAction(InventoryAction *a);
274 // Gets closest object pointed by the shootline
275 // Returns NULL if not found
276 ClientActiveObject * getSelectedActiveObject(
278 v3f from_pos_f_on_map,
279 core::line3d<f32> shootline_on_map
282 // Prints a line or two of info
283 void printDebugInfo(std::ostream &os);
285 core::list<std::wstring> getConnectedPlayerNames();
287 float getAnimationTime();
290 void setCrack(int level, v3s16 pos);
294 bool checkPrivilege(const std::string &priv)
295 { return (m_privileges.count(priv) != 0); }
297 bool getChatMessage(std::wstring &message);
298 void typeChatMessage(const std::wstring& message);
300 u64 getMapSeed(){ return m_map_seed; }
302 void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
303 // Including blocks at appropriate edges
304 void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
305 void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
307 // Get event from queue. CE_NONE is returned if queue is empty.
308 ClientEvent getClientEvent();
311 { return m_access_denied; }
313 std::wstring accessDeniedReason()
314 { return m_access_denied_reason; }
316 float mediaReceiveProgress()
318 if (!m_media_receive_started) return 0;
319 return 1.0 * m_media_received_count / m_media_count;
322 bool texturesReceived()
323 { return m_media_receive_started && m_media_received_count == m_media_count; }
324 bool itemdefReceived()
325 { return m_itemdef_received; }
326 bool nodedefReceived()
327 { return m_nodedef_received; }
329 void afterContentReceived();
333 // IGameDef interface
334 virtual IItemDefManager* getItemDefManager();
335 virtual INodeDefManager* getNodeDefManager();
336 virtual ICraftDefManager* getCraftDefManager();
337 virtual ITextureSource* getTextureSource();
338 virtual IShaderSource* getShaderSource();
339 virtual u16 allocateUnknownNodeId(const std::string &name);
340 virtual ISoundManager* getSoundManager();
341 virtual MtEventManager* getEventManager();
342 virtual bool checkLocalPrivilege(const std::string &priv)
343 { return checkPrivilege(priv); }
347 // Insert a media file appropriately into the appropriate manager
348 bool loadMedia(const std::string &data, const std::string &filename);
350 void request_media(const core::list<MediaRequest> &file_requests);
352 // Virtual methods from con::PeerHandler
353 void peerAdded(con::Peer *peer);
354 void deletingPeer(con::Peer *peer, bool timeout);
359 void sendPlayerPos();
360 // This sends the player's current name etc to the server
361 void sendPlayerInfo();
362 // Send the item number 'item' as player item to the server
363 void sendPlayerItem(u16 item);
365 float m_packetcounter_timer;
366 float m_connection_reinit_timer;
367 float m_avg_rtt_timer;
368 float m_playerpos_send_timer;
369 float m_ignore_damage_timer; // Used after server moves player
370 IntervalLimiter m_map_timer_and_unload_interval;
372 IWritableTextureSource *m_tsrc;
373 IWritableShaderSource *m_shsrc;
374 IWritableItemDefManager *m_itemdef;
375 IWritableNodeDefManager *m_nodedef;
376 ISoundManager *m_sound;
377 MtEventManager *m_event;
379 MeshUpdateThread m_mesh_update_thread;
380 core::list<MediaFetchThread*> m_media_fetch_threads;
381 ClientEnvironment m_env;
382 con::Connection m_con;
383 IrrlichtDevice *m_device;
384 // Server serialization version
387 bool m_inventory_updated;
388 Inventory *m_inventory_from_server;
389 float m_inventory_from_server_age;
390 core::map<v3s16, bool> m_active_blocks;
391 PacketCounter m_packetcounter;
392 // Block mesh animation parameters
393 float m_animation_time;
396 // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
398 //u32 m_daynight_ratio;
399 Queue<std::wstring> m_chat_queue;
400 // The seed returned by the server in TOCLIENT_INIT is stored here
402 std::string m_password;
403 bool m_access_denied;
404 std::wstring m_access_denied_reason;
405 Queue<ClientEvent> m_client_event_queue;
406 FileCache m_media_cache;
407 // Mapping from media file name to SHA1 checksum
408 core::map<std::string, std::string> m_media_name_sha1_map;
409 bool m_media_receive_started;
411 u32 m_media_received_count;
412 bool m_itemdef_received;
413 bool m_nodedef_received;
414 friend class FarMesh;
416 // time_of_day speed approximation for old protocol
417 bool m_time_of_day_set;
418 float m_last_time_of_day_f;
419 float m_time_of_day_update_timer;
421 // An interval for generally sending object positions and stuff
422 float m_recommended_send_interval;
425 float m_removed_sounds_check_timer;
426 // Mapping from server sound ids to our sound ids
427 std::map<s32, int> m_sounds_server_to_client;
428 // And the other way!
429 std::map<int, s32> m_sounds_client_to_server;
430 // And relations to objects
431 std::map<int, u16> m_sounds_to_objects;
434 std::set<std::string> m_privileges;
436 // Detached inventories
438 std::map<std::string, Inventory*> m_detached_inventories;
441 #endif // !CLIENT_HEADER