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;
248 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
252 NOTE: Nothing is thread-safe here.
256 IrrlichtDevice *device,
257 const char *playername,
258 std::string password,
259 MapDrawControl &control,
260 IWritableTextureSource *tsrc,
261 IWritableShaderSource *shsrc,
262 IWritableItemDefManager *itemdef,
263 IWritableNodeDefManager *nodedef,
264 ISoundManager *sound,
265 MtEventManager *event
270 The name of the local player should already be set when
271 calling this, as it is sent in the initialization.
273 void connect(Address address);
276 m_con.Connected() == true
277 AND m_server_ser_ver != SER_FMT_VER_INVALID
278 throws con::PeerNotFoundException if connection has been deleted,
281 bool connectedAndInitialized();
283 Stuff that references the environment is valid only as
284 long as this is not called. (eg. Players)
285 If this throws a PeerNotFoundException, the connection has
288 void step(float dtime);
290 void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
291 // Returns true if something was received
292 bool AsyncProcessPacket();
293 bool AsyncProcessData();
294 void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
296 void interact(u8 action, const PointedThing& pointed);
298 void sendNodemetaFields(v3s16 p, const std::string &formname,
299 const std::map<std::string, std::string> &fields);
300 void sendInventoryFields(const std::string &formname,
301 const std::map<std::string, std::string> &fields);
302 void sendInventoryAction(InventoryAction *a);
303 void sendChatMessage(const std::wstring &message);
304 void sendChangePassword(const std::wstring oldpassword,
305 const std::wstring newpassword);
306 void sendDamage(u8 damage);
309 ClientEnvironment& getEnv()
312 // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
313 void removeNode(v3s16 p);
314 void addNode(v3s16 p, MapNode n);
316 void setPlayerControl(PlayerControl &control);
318 void selectPlayerItem(u16 item);
319 u16 getPlayerItem() const
320 { return m_playeritem; }
322 // Returns true if the inventory of the local player has been
323 // updated from the server. If it is true, it is set to false.
324 bool getLocalInventoryUpdated();
325 // Copies the inventory of the local player to parameter
326 void getLocalInventory(Inventory &dst);
328 /* InventoryManager interface */
329 Inventory* getInventory(const InventoryLocation &loc);
330 void inventoryAction(InventoryAction *a);
332 // Gets closest object pointed by the shootline
333 // Returns NULL if not found
334 ClientActiveObject * getSelectedActiveObject(
336 v3f from_pos_f_on_map,
337 core::line3d<f32> shootline_on_map
340 // Prints a line or two of info
341 void printDebugInfo(std::ostream &os);
343 std::list<std::string> getConnectedPlayerNames();
345 float getAnimationTime();
348 void setCrack(int level, v3s16 pos);
352 bool checkPrivilege(const std::string &priv)
353 { return (m_privileges.count(priv) != 0); }
355 bool getChatMessage(std::wstring &message);
356 void typeChatMessage(const std::wstring& message);
358 u64 getMapSeed(){ return m_map_seed; }
360 void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
361 // Including blocks at appropriate edges
362 void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
363 void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
365 // Get event from queue. CE_NONE is returned if queue is empty.
366 ClientEvent getClientEvent();
369 { return m_access_denied; }
371 std::wstring accessDeniedReason()
372 { return m_access_denied_reason; }
374 float mediaReceiveProgress()
376 if (!m_media_receive_started) return 0;
377 return 1.0 * m_media_received_count / m_media_count;
380 bool texturesReceived()
381 { return m_media_receive_started && m_media_received_count == m_media_count; }
382 bool itemdefReceived()
383 { return m_itemdef_received; }
384 bool nodedefReceived()
385 { return m_nodedef_received; }
387 void afterContentReceived();
391 // IGameDef interface
392 virtual IItemDefManager* getItemDefManager();
393 virtual INodeDefManager* getNodeDefManager();
394 virtual ICraftDefManager* getCraftDefManager();
395 virtual ITextureSource* getTextureSource();
396 virtual IShaderSource* getShaderSource();
397 virtual u16 allocateUnknownNodeId(const std::string &name);
398 virtual ISoundManager* getSoundManager();
399 virtual MtEventManager* getEventManager();
400 virtual bool checkLocalPrivilege(const std::string &priv)
401 { return checkPrivilege(priv); }
405 // Insert a media file appropriately into the appropriate manager
406 bool loadMedia(const std::string &data, const std::string &filename);
408 void request_media(const std::list<MediaRequest> &file_requests);
410 // Virtual methods from con::PeerHandler
411 void peerAdded(con::Peer *peer);
412 void deletingPeer(con::Peer *peer, bool timeout);
417 void sendPlayerPos();
418 // This sends the player's current name etc to the server
419 void sendPlayerInfo();
420 // Send the item number 'item' as player item to the server
421 void sendPlayerItem(u16 item);
423 float m_packetcounter_timer;
424 float m_connection_reinit_timer;
425 float m_avg_rtt_timer;
426 float m_playerpos_send_timer;
427 float m_ignore_damage_timer; // Used after server moves player
428 IntervalLimiter m_map_timer_and_unload_interval;
430 IWritableTextureSource *m_tsrc;
431 IWritableShaderSource *m_shsrc;
432 IWritableItemDefManager *m_itemdef;
433 IWritableNodeDefManager *m_nodedef;
434 ISoundManager *m_sound;
435 MtEventManager *m_event;
437 MeshUpdateThread m_mesh_update_thread;
438 std::list<MediaFetchThread*> m_media_fetch_threads;
439 ClientEnvironment m_env;
440 con::Connection m_con;
441 IrrlichtDevice *m_device;
442 // Server serialization version
445 bool m_inventory_updated;
446 Inventory *m_inventory_from_server;
447 float m_inventory_from_server_age;
448 std::set<v3s16> m_active_blocks;
449 PacketCounter m_packetcounter;
450 // Block mesh animation parameters
451 float m_animation_time;
454 // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
456 //u32 m_daynight_ratio;
457 Queue<std::wstring> m_chat_queue;
458 // The seed returned by the server in TOCLIENT_INIT is stored here
460 std::string m_password;
461 bool m_access_denied;
462 std::wstring m_access_denied_reason;
463 Queue<ClientEvent> m_client_event_queue;
464 FileCache m_media_cache;
465 // Mapping from media file name to SHA1 checksum
466 std::map<std::string, std::string> m_media_name_sha1_map;
467 bool m_media_receive_started;
469 u32 m_media_received_count;
470 bool m_itemdef_received;
471 bool m_nodedef_received;
472 friend class FarMesh;
474 // time_of_day speed approximation for old protocol
475 bool m_time_of_day_set;
476 float m_last_time_of_day_f;
477 float m_time_of_day_update_timer;
479 // An interval for generally sending object positions and stuff
480 float m_recommended_send_interval;
483 float m_removed_sounds_check_timer;
484 // Mapping from server sound ids to our sound ids
485 std::map<s32, int> m_sounds_server_to_client;
486 // And the other way!
487 std::map<int, s32> m_sounds_client_to_server;
488 // And relations to objects
489 std::map<int, u16> m_sounds_to_objects;
492 std::set<std::string> m_privileges;
494 // Detached inventories
496 std::map<std::string, Inventory*> m_detached_inventories;
499 #endif // !CLIENT_HEADER