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"
26 #include "jthread/jmutex.h"
31 #include "clientobject.h"
33 #include "inventorymanager.h"
34 #include "localplayer.h"
36 #include "particles.h"
40 class IWritableTextureSource;
41 class IWritableShaderSource;
42 class IWritableItemDefManager;
43 class IWritableNodeDefManager;
44 //class IWritableCraftDefManager;
45 class ClientMediaDownloader;
46 struct MapDrawControl;
50 struct QueuedMeshUpdate
54 bool ack_block_to_server;
61 A thread-safe queue of mesh update tasks
71 peer_id=0 adds with nobody to send to
73 void addBlock(v3s16 p, MeshMakeData *data,
74 bool ack_block_to_server, bool urgent);
76 // Returned pointer must be deleted
77 // Returns NULL if queue is empty
78 QueuedMeshUpdate * pop();
82 JMutexAutoLock lock(m_mutex);
83 return m_queue.size();
87 std::vector<QueuedMeshUpdate*> m_queue;
88 std::set<v3s16> m_urgents;
92 struct MeshUpdateResult
96 bool ack_block_to_server;
101 ack_block_to_server(false)
106 class MeshUpdateThread : public SimpleThread
110 MeshUpdateThread(IGameDef *gamedef):
117 MeshUpdateQueue m_queue_in;
119 MutexedQueue<MeshUpdateResult> m_queue_out;
128 CE_PLAYER_FORCE_MOVE,
132 CE_ADD_PARTICLESPAWNER,
133 CE_DELETE_PARTICLESPAWNER,
141 ClientEventType type;
153 bool set_camera_point_target;
154 f32 camera_point_target_x;
155 f32 camera_point_target_y;
156 f32 camera_point_target_z;
159 std::string *formspec;
160 std::string *formname;
170 bool collisiondetection;
171 std::string *texture;
186 bool collisiondetection;
187 std::string *texture;
189 } add_particlespawner;
192 } delete_particlespawner;
230 void add(u16 command)
232 std::map<u16, u16>::iterator n = m_packets.find(command);
233 if(n == m_packets.end())
235 m_packets[command] = 1;
245 for(std::map<u16, u16>::iterator
246 i = m_packets.begin();
247 i != m_packets.end(); ++i)
253 void print(std::ostream &o)
255 for(std::map<u16, u16>::iterator
256 i = m_packets.begin();
257 i != m_packets.end(); ++i)
260 <<" count "<<i->second
267 std::map<u16, u16> m_packets;
270 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
274 NOTE: Nothing is thread-safe here.
278 IrrlichtDevice *device,
279 const char *playername,
280 std::string password,
281 MapDrawControl &control,
282 IWritableTextureSource *tsrc,
283 IWritableShaderSource *shsrc,
284 IWritableItemDefManager *itemdef,
285 IWritableNodeDefManager *nodedef,
286 ISoundManager *sound,
287 MtEventManager *event,
293 The name of the local player should already be set when
294 calling this, as it is sent in the initialization.
296 void connect(Address address);
299 m_con.Connected() == true
300 AND m_server_ser_ver != SER_FMT_VER_INVALID
301 throws con::PeerNotFoundException if connection has been deleted,
304 bool connectedAndInitialized();
306 Stuff that references the environment is valid only as
307 long as this is not called. (eg. Players)
308 If this throws a PeerNotFoundException, the connection has
311 void step(float dtime);
313 void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
314 // Returns true if something was received
315 bool AsyncProcessPacket();
316 bool AsyncProcessData();
317 void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
319 void interact(u8 action, const PointedThing& pointed);
321 void sendNodemetaFields(v3s16 p, const std::string &formname,
322 const std::map<std::string, std::string> &fields);
323 void sendInventoryFields(const std::string &formname,
324 const std::map<std::string, std::string> &fields);
325 void sendInventoryAction(InventoryAction *a);
326 void sendChatMessage(const std::wstring &message);
327 void sendChangePassword(const std::wstring oldpassword,
328 const std::wstring newpassword);
329 void sendDamage(u8 damage);
330 void sendBreath(u16 breath);
333 ClientEnvironment& getEnv()
336 // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
337 void removeNode(v3s16 p);
338 void addNode(v3s16 p, MapNode n, bool remove_metadata = true);
340 void setPlayerControl(PlayerControl &control);
342 void selectPlayerItem(u16 item);
343 u16 getPlayerItem() const
344 { return m_playeritem; }
346 // Returns true if the inventory of the local player has been
347 // updated from the server. If it is true, it is set to false.
348 bool getLocalInventoryUpdated();
349 // Copies the inventory of the local player to parameter
350 void getLocalInventory(Inventory &dst);
352 /* InventoryManager interface */
353 Inventory* getInventory(const InventoryLocation &loc);
354 void inventoryAction(InventoryAction *a);
356 // Gets closest object pointed by the shootline
357 // Returns NULL if not found
358 ClientActiveObject * getSelectedActiveObject(
360 v3f from_pos_f_on_map,
361 core::line3d<f32> shootline_on_map
364 // Prints a line or two of info
365 void printDebugInfo(std::ostream &os);
367 std::list<std::string> getConnectedPlayerNames();
369 float getAnimationTime();
372 void setCrack(int level, v3s16 pos);
377 bool checkPrivilege(const std::string &priv)
378 { return (m_privileges.count(priv) != 0); }
380 bool getChatMessage(std::wstring &message);
381 void typeChatMessage(const std::wstring& message);
383 u64 getMapSeed(){ return m_map_seed; }
385 void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
386 // Including blocks at appropriate edges
387 void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
388 void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
390 // Get event from queue. CE_NONE is returned if queue is empty.
391 ClientEvent getClientEvent();
394 { return m_access_denied; }
396 std::wstring accessDeniedReason()
397 { return m_access_denied_reason; }
399 bool itemdefReceived()
400 { return m_itemdef_received; }
401 bool nodedefReceived()
402 { return m_nodedef_received; }
404 { return m_media_downloader == NULL; }
406 float mediaReceiveProgress();
408 void afterContentReceived(IrrlichtDevice *device, gui::IGUIFont* font);
412 // IGameDef interface
413 virtual IItemDefManager* getItemDefManager();
414 virtual INodeDefManager* getNodeDefManager();
415 virtual ICraftDefManager* getCraftDefManager();
416 virtual ITextureSource* getTextureSource();
417 virtual IShaderSource* getShaderSource();
418 virtual u16 allocateUnknownNodeId(const std::string &name);
419 virtual ISoundManager* getSoundManager();
420 virtual MtEventManager* getEventManager();
421 virtual bool checkLocalPrivilege(const std::string &priv)
422 { return checkPrivilege(priv); }
424 // The following set of functions is used by ClientMediaDownloader
425 // Insert a media file appropriately into the appropriate manager
426 bool loadMedia(const std::string &data, const std::string &filename);
427 // Send a request for conventional media transfer
428 void request_media(const std::list<std::string> &file_requests);
429 // Send a notification that no conventional media transfer is needed
430 void received_media();
434 // Virtual methods from con::PeerHandler
435 void peerAdded(con::Peer *peer);
436 void deletingPeer(con::Peer *peer, bool timeout);
441 void sendPlayerPos();
442 // Send the item number 'item' as player item to the server
443 void sendPlayerItem(u16 item);
445 float m_packetcounter_timer;
446 float m_connection_reinit_timer;
447 float m_avg_rtt_timer;
448 float m_playerpos_send_timer;
449 float m_ignore_damage_timer; // Used after server moves player
450 IntervalLimiter m_map_timer_and_unload_interval;
452 IWritableTextureSource *m_tsrc;
453 IWritableShaderSource *m_shsrc;
454 IWritableItemDefManager *m_itemdef;
455 IWritableNodeDefManager *m_nodedef;
456 ISoundManager *m_sound;
457 MtEventManager *m_event;
459 MeshUpdateThread m_mesh_update_thread;
460 ClientEnvironment m_env;
461 con::Connection m_con;
462 IrrlichtDevice *m_device;
463 // Server serialization version
466 bool m_inventory_updated;
467 Inventory *m_inventory_from_server;
468 float m_inventory_from_server_age;
469 std::set<v3s16> m_active_blocks;
470 PacketCounter m_packetcounter;
471 // Block mesh animation parameters
472 float m_animation_time;
475 // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
477 //u32 m_daynight_ratio;
478 Queue<std::wstring> m_chat_queue;
479 // The seed returned by the server in TOCLIENT_INIT is stored here
481 std::string m_password;
482 bool m_access_denied;
483 std::wstring m_access_denied_reason;
484 Queue<ClientEvent> m_client_event_queue;
485 bool m_itemdef_received;
486 bool m_nodedef_received;
487 ClientMediaDownloader *m_media_downloader;
489 // time_of_day speed approximation for old protocol
490 bool m_time_of_day_set;
491 float m_last_time_of_day_f;
492 float m_time_of_day_update_timer;
494 // An interval for generally sending object positions and stuff
495 float m_recommended_send_interval;
498 float m_removed_sounds_check_timer;
499 // Mapping from server sound ids to our sound ids
500 std::map<s32, int> m_sounds_server_to_client;
501 // And the other way!
502 std::map<int, s32> m_sounds_client_to_server;
503 // And relations to objects
504 std::map<int, u16> m_sounds_to_objects;
507 std::set<std::string> m_privileges;
509 // Detached inventories
511 std::map<std::string, Inventory*> m_detached_inventories;
514 #endif // !CLIENT_HEADER