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"
44 class IWritableTextureSource;
45 class IWritableShaderSource;
46 class IWritableItemDefManager;
47 class IWritableNodeDefManager;
48 //class IWritableCraftDefManager;
49 class ClientEnvironment;
50 struct MapDrawControl;
53 class ClientNotReadyException : public BaseException
56 ClientNotReadyException(const char *s):
61 struct QueuedMeshUpdate
65 bool ack_block_to_server;
72 A thread-safe queue of mesh update tasks
82 peer_id=0 adds with nobody to send to
84 void addBlock(v3s16 p, MeshMakeData *data,
85 bool ack_block_to_server, bool urgent);
87 // Returned pointer must be deleted
88 // Returns NULL if queue is empty
89 QueuedMeshUpdate * pop();
93 JMutexAutoLock lock(m_mutex);
94 return m_queue.size();
98 std::vector<QueuedMeshUpdate*> m_queue;
99 std::set<v3s16> m_urgents;
103 struct MeshUpdateResult
107 bool ack_block_to_server;
110 p(-1338,-1338,-1338),
112 ack_block_to_server(false)
117 class MeshUpdateThread : public SimpleThread
121 MeshUpdateThread(IGameDef *gamedef):
128 MeshUpdateQueue m_queue_in;
130 MutexedQueue<MeshUpdateResult> m_queue_out;
135 class MediaFetchThread : public SimpleThread
139 MediaFetchThread(IGameDef *gamedef):
146 std::list<MediaRequest> m_file_requests;
147 MutexedQueue<std::pair<std::string, std::string> > m_file_data;
148 std::list<MediaRequest> m_failed;
149 std::string m_remote_url;
157 CE_PLAYER_FORCE_MOVE,
162 CE_ADD_PARTICLESPAWNER,
163 CE_DELETE_PARTICLESPAWNER,
171 ClientEventType type;
183 bool set_camera_point_target;
184 f32 camera_point_target_x;
185 f32 camera_point_target_y;
186 f32 camera_point_target_z;
189 std::string *formspec;
190 std::string *formname;
200 bool collisiondetection;
201 std::string *texture;
216 bool collisiondetection;
217 std::string *texture;
219 } add_particlespawner;
222 } delete_particlespawner;
249 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
253 NOTE: Nothing is thread-safe here.
257 IrrlichtDevice *device,
258 const char *playername,
259 std::string password,
260 MapDrawControl &control,
261 IWritableTextureSource *tsrc,
262 IWritableShaderSource *shsrc,
263 IWritableItemDefManager *itemdef,
264 IWritableNodeDefManager *nodedef,
265 ISoundManager *sound,
266 MtEventManager *event,
272 The name of the local player should already be set when
273 calling this, as it is sent in the initialization.
275 void connect(Address address);
278 m_con.Connected() == true
279 AND m_server_ser_ver != SER_FMT_VER_INVALID
280 throws con::PeerNotFoundException if connection has been deleted,
283 bool connectedAndInitialized();
285 Stuff that references the environment is valid only as
286 long as this is not called. (eg. Players)
287 If this throws a PeerNotFoundException, the connection has
290 void step(float dtime);
292 void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
293 // Returns true if something was received
294 bool AsyncProcessPacket();
295 bool AsyncProcessData();
296 void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
298 void interact(u8 action, const PointedThing& pointed);
300 void sendNodemetaFields(v3s16 p, const std::string &formname,
301 const std::map<std::string, std::string> &fields);
302 void sendInventoryFields(const std::string &formname,
303 const std::map<std::string, std::string> &fields);
304 void sendInventoryAction(InventoryAction *a);
305 void sendChatMessage(const std::wstring &message);
306 void sendChangePassword(const std::wstring oldpassword,
307 const std::wstring newpassword);
308 void sendDamage(u8 damage);
311 ClientEnvironment& getEnv()
314 // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
315 void removeNode(v3s16 p);
316 void addNode(v3s16 p, MapNode n);
318 void setPlayerControl(PlayerControl &control);
320 void selectPlayerItem(u16 item);
321 u16 getPlayerItem() const
322 { return m_playeritem; }
324 // Returns true if the inventory of the local player has been
325 // updated from the server. If it is true, it is set to false.
326 bool getLocalInventoryUpdated();
327 // Copies the inventory of the local player to parameter
328 void getLocalInventory(Inventory &dst);
330 /* InventoryManager interface */
331 Inventory* getInventory(const InventoryLocation &loc);
332 void inventoryAction(InventoryAction *a);
334 // Gets closest object pointed by the shootline
335 // Returns NULL if not found
336 ClientActiveObject * getSelectedActiveObject(
338 v3f from_pos_f_on_map,
339 core::line3d<f32> shootline_on_map
342 // Prints a line or two of info
343 void printDebugInfo(std::ostream &os);
345 std::list<std::string> getConnectedPlayerNames();
347 float getAnimationTime();
350 void setCrack(int level, v3s16 pos);
355 bool checkPrivilege(const std::string &priv)
356 { return (m_privileges.count(priv) != 0); }
358 bool getChatMessage(std::wstring &message);
359 void typeChatMessage(const std::wstring& message);
361 u64 getMapSeed(){ return m_map_seed; }
363 void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
364 // Including blocks at appropriate edges
365 void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
366 void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
368 // Get event from queue. CE_NONE is returned if queue is empty.
369 ClientEvent getClientEvent();
372 { return m_access_denied; }
374 std::wstring accessDeniedReason()
375 { return m_access_denied_reason; }
377 float mediaReceiveProgress()
379 if (!m_media_receive_started) return 0;
380 return 1.0 * m_media_received_count / m_media_count;
383 bool texturesReceived()
384 { return m_media_receive_started && m_media_received_count == m_media_count; }
385 bool itemdefReceived()
386 { return m_itemdef_received; }
387 bool nodedefReceived()
388 { return m_nodedef_received; }
390 void afterContentReceived(IrrlichtDevice *device, gui::IGUIFont* font);
394 // IGameDef interface
395 virtual IItemDefManager* getItemDefManager();
396 virtual INodeDefManager* getNodeDefManager();
397 virtual ICraftDefManager* getCraftDefManager();
398 virtual ITextureSource* getTextureSource();
399 virtual IShaderSource* getShaderSource();
400 virtual u16 allocateUnknownNodeId(const std::string &name);
401 virtual ISoundManager* getSoundManager();
402 virtual MtEventManager* getEventManager();
403 virtual bool checkLocalPrivilege(const std::string &priv)
404 { return checkPrivilege(priv); }
408 // Insert a media file appropriately into the appropriate manager
409 bool loadMedia(const std::string &data, const std::string &filename);
411 void request_media(const std::list<MediaRequest> &file_requests);
413 // Virtual methods from con::PeerHandler
414 void peerAdded(con::Peer *peer);
415 void deletingPeer(con::Peer *peer, bool timeout);
420 void sendPlayerPos();
421 // This sends the player's current name etc to the server
422 void sendPlayerInfo();
423 // Send the item number 'item' as player item to the server
424 void sendPlayerItem(u16 item);
426 float m_packetcounter_timer;
427 float m_connection_reinit_timer;
428 float m_avg_rtt_timer;
429 float m_playerpos_send_timer;
430 float m_ignore_damage_timer; // Used after server moves player
431 IntervalLimiter m_map_timer_and_unload_interval;
433 IWritableTextureSource *m_tsrc;
434 IWritableShaderSource *m_shsrc;
435 IWritableItemDefManager *m_itemdef;
436 IWritableNodeDefManager *m_nodedef;
437 ISoundManager *m_sound;
438 MtEventManager *m_event;
440 MeshUpdateThread m_mesh_update_thread;
441 std::list<MediaFetchThread*> m_media_fetch_threads;
442 ClientEnvironment m_env;
443 con::Connection m_con;
444 IrrlichtDevice *m_device;
445 // Server serialization version
448 bool m_inventory_updated;
449 Inventory *m_inventory_from_server;
450 float m_inventory_from_server_age;
451 std::set<v3s16> m_active_blocks;
452 PacketCounter m_packetcounter;
453 // Block mesh animation parameters
454 float m_animation_time;
457 // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
459 //u32 m_daynight_ratio;
460 Queue<std::wstring> m_chat_queue;
461 // The seed returned by the server in TOCLIENT_INIT is stored here
463 std::string m_password;
464 bool m_access_denied;
465 std::wstring m_access_denied_reason;
466 Queue<ClientEvent> m_client_event_queue;
467 FileCache m_media_cache;
468 // Mapping from media file name to SHA1 checksum
469 std::map<std::string, std::string> m_media_name_sha1_map;
470 bool m_media_receive_started;
472 u32 m_media_received_count;
473 bool m_itemdef_received;
474 bool m_nodedef_received;
475 friend class FarMesh;
477 // time_of_day speed approximation for old protocol
478 bool m_time_of_day_set;
479 float m_last_time_of_day_f;
480 float m_time_of_day_update_timer;
482 // An interval for generally sending object positions and stuff
483 float m_recommended_send_interval;
486 float m_removed_sounds_check_timer;
487 // Mapping from server sound ids to our sound ids
488 std::map<s32, int> m_sounds_server_to_client;
489 // And the other way!
490 std::map<int, s32> m_sounds_client_to_server;
491 // And relations to objects
492 std::map<int, u16> m_sounds_to_objects;
495 std::set<std::string> m_privileges;
497 // Detached inventories
499 std::map<std::string, Inventory*> m_detached_inventories;
502 #endif // !CLIENT_HEADER