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
271 The name of the local player should already be set when
272 calling this, as it is sent in the initialization.
274 void connect(Address address);
277 m_con.Connected() == true
278 AND m_server_ser_ver != SER_FMT_VER_INVALID
279 throws con::PeerNotFoundException if connection has been deleted,
282 bool connectedAndInitialized();
284 Stuff that references the environment is valid only as
285 long as this is not called. (eg. Players)
286 If this throws a PeerNotFoundException, the connection has
289 void step(float dtime);
291 void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
292 // Returns true if something was received
293 bool AsyncProcessPacket();
294 bool AsyncProcessData();
295 void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
297 void interact(u8 action, const PointedThing& pointed);
299 void sendNodemetaFields(v3s16 p, const std::string &formname,
300 const std::map<std::string, std::string> &fields);
301 void sendInventoryFields(const std::string &formname,
302 const std::map<std::string, std::string> &fields);
303 void sendInventoryAction(InventoryAction *a);
304 void sendChatMessage(const std::wstring &message);
305 void sendChangePassword(const std::wstring oldpassword,
306 const std::wstring newpassword);
307 void sendDamage(u8 damage);
310 ClientEnvironment& getEnv()
313 // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
314 void removeNode(v3s16 p);
315 void addNode(v3s16 p, MapNode n);
317 void setPlayerControl(PlayerControl &control);
319 void selectPlayerItem(u16 item);
320 u16 getPlayerItem() const
321 { return m_playeritem; }
323 // Returns true if the inventory of the local player has been
324 // updated from the server. If it is true, it is set to false.
325 bool getLocalInventoryUpdated();
326 // Copies the inventory of the local player to parameter
327 void getLocalInventory(Inventory &dst);
329 /* InventoryManager interface */
330 Inventory* getInventory(const InventoryLocation &loc);
331 void inventoryAction(InventoryAction *a);
333 // Gets closest object pointed by the shootline
334 // Returns NULL if not found
335 ClientActiveObject * getSelectedActiveObject(
337 v3f from_pos_f_on_map,
338 core::line3d<f32> shootline_on_map
341 // Prints a line or two of info
342 void printDebugInfo(std::ostream &os);
344 std::list<std::string> getConnectedPlayerNames();
346 float getAnimationTime();
349 void setCrack(int level, v3s16 pos);
354 bool checkPrivilege(const std::string &priv)
355 { return (m_privileges.count(priv) != 0); }
357 bool getChatMessage(std::wstring &message);
358 void typeChatMessage(const std::wstring& message);
360 u64 getMapSeed(){ return m_map_seed; }
362 void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
363 // Including blocks at appropriate edges
364 void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
365 void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
367 // Get event from queue. CE_NONE is returned if queue is empty.
368 ClientEvent getClientEvent();
371 { return m_access_denied; }
373 std::wstring accessDeniedReason()
374 { return m_access_denied_reason; }
376 float mediaReceiveProgress()
378 if (!m_media_receive_started) return 0;
379 return 1.0 * m_media_received_count / m_media_count;
382 bool texturesReceived()
383 { return m_media_receive_started && m_media_received_count == m_media_count; }
384 bool itemdefReceived()
385 { return m_itemdef_received; }
386 bool nodedefReceived()
387 { return m_nodedef_received; }
389 void afterContentReceived(IrrlichtDevice *device, gui::IGUIFont* font);
393 // IGameDef interface
394 virtual IItemDefManager* getItemDefManager();
395 virtual INodeDefManager* getNodeDefManager();
396 virtual ICraftDefManager* getCraftDefManager();
397 virtual ITextureSource* getTextureSource();
398 virtual IShaderSource* getShaderSource();
399 virtual u16 allocateUnknownNodeId(const std::string &name);
400 virtual ISoundManager* getSoundManager();
401 virtual MtEventManager* getEventManager();
402 virtual bool checkLocalPrivilege(const std::string &priv)
403 { return checkPrivilege(priv); }
407 // Insert a media file appropriately into the appropriate manager
408 bool loadMedia(const std::string &data, const std::string &filename);
410 void request_media(const std::list<MediaRequest> &file_requests);
412 // Virtual methods from con::PeerHandler
413 void peerAdded(con::Peer *peer);
414 void deletingPeer(con::Peer *peer, bool timeout);
419 void sendPlayerPos();
420 // This sends the player's current name etc to the server
421 void sendPlayerInfo();
422 // Send the item number 'item' as player item to the server
423 void sendPlayerItem(u16 item);
425 float m_packetcounter_timer;
426 float m_connection_reinit_timer;
427 float m_avg_rtt_timer;
428 float m_playerpos_send_timer;
429 float m_ignore_damage_timer; // Used after server moves player
430 IntervalLimiter m_map_timer_and_unload_interval;
432 IWritableTextureSource *m_tsrc;
433 IWritableShaderSource *m_shsrc;
434 IWritableItemDefManager *m_itemdef;
435 IWritableNodeDefManager *m_nodedef;
436 ISoundManager *m_sound;
437 MtEventManager *m_event;
439 MeshUpdateThread m_mesh_update_thread;
440 std::list<MediaFetchThread*> m_media_fetch_threads;
441 ClientEnvironment m_env;
442 con::Connection m_con;
443 IrrlichtDevice *m_device;
444 // Server serialization version
447 bool m_inventory_updated;
448 Inventory *m_inventory_from_server;
449 float m_inventory_from_server_age;
450 std::set<v3s16> m_active_blocks;
451 PacketCounter m_packetcounter;
452 // Block mesh animation parameters
453 float m_animation_time;
456 // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
458 //u32 m_daynight_ratio;
459 Queue<std::wstring> m_chat_queue;
460 // The seed returned by the server in TOCLIENT_INIT is stored here
462 std::string m_password;
463 bool m_access_denied;
464 std::wstring m_access_denied_reason;
465 Queue<ClientEvent> m_client_event_queue;
466 FileCache m_media_cache;
467 // Mapping from media file name to SHA1 checksum
468 std::map<std::string, std::string> m_media_name_sha1_map;
469 bool m_media_receive_started;
471 u32 m_media_received_count;
472 bool m_itemdef_received;
473 bool m_nodedef_received;
474 friend class FarMesh;
476 // time_of_day speed approximation for old protocol
477 bool m_time_of_day_set;
478 float m_last_time_of_day_f;
479 float m_time_of_day_update_timer;
481 // An interval for generally sending object positions and stuff
482 float m_recommended_send_interval;
485 float m_removed_sounds_check_timer;
486 // Mapping from server sound ids to our sound ids
487 std::map<s32, int> m_sounds_server_to_client;
488 // And the other way!
489 std::map<int, s32> m_sounds_client_to_server;
490 // And relations to objects
491 std::map<int, u16> m_sounds_to_objects;
494 std::set<std::string> m_privileges;
496 // Detached inventories
498 std::map<std::string, Inventory*> m_detached_inventories;
501 #endif // !CLIENT_HEADER