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