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;
52 struct QueuedMeshUpdate
56 bool ack_block_to_server;
62 enum LocalClientState {
69 A thread-safe queue of mesh update tasks
79 peer_id=0 adds with nobody to send to
81 void addBlock(v3s16 p, MeshMakeData *data,
82 bool ack_block_to_server, bool urgent);
84 // Returned pointer must be deleted
85 // Returns NULL if queue is empty
86 QueuedMeshUpdate * pop();
90 JMutexAutoLock lock(m_mutex);
91 return m_queue.size();
95 std::vector<QueuedMeshUpdate*> m_queue;
96 std::set<v3s16> m_urgents;
100 struct MeshUpdateResult
104 bool ack_block_to_server;
107 p(-1338,-1338,-1338),
109 ack_block_to_server(false)
114 class MeshUpdateThread : public JThread
118 MeshUpdateThread(IGameDef *gamedef):
125 MeshUpdateQueue m_queue_in;
127 MutexedQueue<MeshUpdateResult> m_queue_out;
131 v3s16 m_camera_offset;
138 CE_PLAYER_FORCE_MOVE,
142 CE_ADD_PARTICLESPAWNER,
143 CE_DELETE_PARTICLESPAWNER,
148 CE_OVERRIDE_DAY_NIGHT_RATIO,
153 ClientEventType type;
165 bool set_camera_point_target;
166 f32 camera_point_target_x;
167 f32 camera_point_target_y;
168 f32 camera_point_target_z;
171 std::string *formspec;
172 std::string *formname;
175 //} textures_updated;
182 bool collisiondetection;
184 std::string *texture;
199 bool collisiondetection;
201 std::string *texture;
203 } add_particlespawner;
206 } delete_particlespawner;
235 video::SColor *bgcolor;
237 std::vector<std::string> *params;
242 } override_day_night_ratio;
257 void add(u16 command)
259 std::map<u16, u16>::iterator n = m_packets.find(command);
260 if(n == m_packets.end())
262 m_packets[command] = 1;
272 for(std::map<u16, u16>::iterator
273 i = m_packets.begin();
274 i != m_packets.end(); ++i)
280 void print(std::ostream &o)
282 for(std::map<u16, u16>::iterator
283 i = m_packets.begin();
284 i != m_packets.end(); ++i)
287 <<" count "<<i->second
294 std::map<u16, u16> m_packets;
297 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
301 NOTE: Nothing is thread-safe here.
305 IrrlichtDevice *device,
306 const char *playername,
307 std::string password,
308 MapDrawControl &control,
309 IWritableTextureSource *tsrc,
310 IWritableShaderSource *shsrc,
311 IWritableItemDefManager *itemdef,
312 IWritableNodeDefManager *nodedef,
313 ISoundManager *sound,
314 MtEventManager *event,
321 request all threads managed by client to be stopped
329 The name of the local player should already be set when
330 calling this, as it is sent in the initialization.
332 void connect(Address address,
333 const std::string &address_name,
334 bool is_local_server);
337 Stuff that references the environment is valid only as
338 long as this is not called. (eg. Players)
339 If this throws a PeerNotFoundException, the connection has
342 void step(float dtime);
344 void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
345 // Returns true if something was received
346 bool AsyncProcessPacket();
347 bool AsyncProcessData();
348 void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
350 void interact(u8 action, const PointedThing& pointed);
352 void sendNodemetaFields(v3s16 p, const std::string &formname,
353 const std::map<std::string, std::string> &fields);
354 void sendInventoryFields(const std::string &formname,
355 const std::map<std::string, std::string> &fields);
356 void sendInventoryAction(InventoryAction *a);
357 void sendChatMessage(const std::wstring &message);
358 void sendChangePassword(const std::wstring &oldpassword,
359 const std::wstring &newpassword);
360 void sendDamage(u8 damage);
361 void sendBreath(u16 breath);
365 ClientEnvironment& getEnv()
368 // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
369 void removeNode(v3s16 p);
370 void addNode(v3s16 p, MapNode n, bool remove_metadata = true);
372 void setPlayerControl(PlayerControl &control);
374 void selectPlayerItem(u16 item);
375 u16 getPlayerItem() const
376 { return m_playeritem; }
378 // Returns true if the inventory of the local player has been
379 // updated from the server. If it is true, it is set to false.
380 bool getLocalInventoryUpdated();
381 // Copies the inventory of the local player to parameter
382 void getLocalInventory(Inventory &dst);
384 /* InventoryManager interface */
385 Inventory* getInventory(const InventoryLocation &loc);
386 void inventoryAction(InventoryAction *a);
388 // Gets closest object pointed by the shootline
389 // Returns NULL if not found
390 ClientActiveObject * getSelectedActiveObject(
392 v3f from_pos_f_on_map,
393 core::line3d<f32> shootline_on_map
396 std::list<std::string> getConnectedPlayerNames();
398 float getAnimationTime();
401 void setCrack(int level, v3s16 pos);
403 void setHighlighted(v3s16 pos, bool show_higlighted);
404 v3s16 getHighlighted(){ return m_highlighted_pos; }
409 bool checkPrivilege(const std::string &priv)
410 { return (m_privileges.count(priv) != 0); }
412 bool getChatMessage(std::wstring &message);
413 void typeChatMessage(const std::wstring& message);
415 u64 getMapSeed(){ return m_map_seed; }
417 void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
418 // Including blocks at appropriate edges
419 void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
420 void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
422 void updateCameraOffset(v3s16 camera_offset)
423 { m_mesh_update_thread.m_camera_offset = camera_offset; }
425 // Get event from queue. CE_NONE is returned if queue is empty.
426 ClientEvent getClientEvent();
429 { return m_access_denied; }
431 std::wstring accessDeniedReason()
432 { return m_access_denied_reason; }
434 bool itemdefReceived()
435 { return m_itemdef_received; }
436 bool nodedefReceived()
437 { return m_nodedef_received; }
439 { return m_media_downloader == NULL; }
441 float mediaReceiveProgress();
443 void afterContentReceived(IrrlichtDevice *device, gui::IGUIFont* font);
446 float getCurRate(void);
447 float getAvgRate(void);
449 // IGameDef interface
450 virtual IItemDefManager* getItemDefManager();
451 virtual INodeDefManager* getNodeDefManager();
452 virtual ICraftDefManager* getCraftDefManager();
453 virtual ITextureSource* getTextureSource();
454 virtual IShaderSource* getShaderSource();
455 virtual scene::ISceneManager* getSceneManager();
456 virtual u16 allocateUnknownNodeId(const std::string &name);
457 virtual ISoundManager* getSoundManager();
458 virtual MtEventManager* getEventManager();
459 virtual ParticleManager* getParticleManager();
460 virtual bool checkLocalPrivilege(const std::string &priv)
461 { return checkPrivilege(priv); }
462 virtual scene::IAnimatedMesh* getMesh(const std::string &filename);
464 // The following set of functions is used by ClientMediaDownloader
465 // Insert a media file appropriately into the appropriate manager
466 bool loadMedia(const std::string &data, const std::string &filename);
467 // Send a request for conventional media transfer
468 void request_media(const std::list<std::string> &file_requests);
469 // Send a notification that no conventional media transfer is needed
470 void received_media();
472 LocalClientState getState() { return m_state; }
474 void makeScreenshot(IrrlichtDevice *device);
478 // Virtual methods from con::PeerHandler
479 void peerAdded(con::Peer *peer);
480 void deletingPeer(con::Peer *peer, bool timeout);
482 void initLocalMapSaving(const Address &address,
483 const std::string &hostname,
484 bool is_local_server);
489 void sendPlayerPos();
490 // Send the item number 'item' as player item to the server
491 void sendPlayerItem(u16 item);
493 float m_packetcounter_timer;
494 float m_connection_reinit_timer;
495 float m_avg_rtt_timer;
496 float m_playerpos_send_timer;
497 float m_ignore_damage_timer; // Used after server moves player
498 IntervalLimiter m_map_timer_and_unload_interval;
500 IWritableTextureSource *m_tsrc;
501 IWritableShaderSource *m_shsrc;
502 IWritableItemDefManager *m_itemdef;
503 IWritableNodeDefManager *m_nodedef;
504 ISoundManager *m_sound;
505 MtEventManager *m_event;
508 MeshUpdateThread m_mesh_update_thread;
509 ClientEnvironment m_env;
510 ParticleManager m_particle_manager;
511 con::Connection m_con;
512 IrrlichtDevice *m_device;
513 // Server serialization version
516 bool m_inventory_updated;
517 Inventory *m_inventory_from_server;
518 float m_inventory_from_server_age;
519 std::set<v3s16> m_active_blocks;
520 PacketCounter m_packetcounter;
521 bool m_show_highlighted;
522 // Block mesh animation parameters
523 float m_animation_time;
526 v3s16 m_highlighted_pos;
527 // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
529 //u32 m_daynight_ratio;
530 Queue<std::wstring> m_chat_queue;
531 // The seed returned by the server in TOCLIENT_INIT is stored here
533 std::string m_password;
534 bool m_access_denied;
535 std::wstring m_access_denied_reason;
536 Queue<ClientEvent> m_client_event_queue;
537 bool m_itemdef_received;
538 bool m_nodedef_received;
539 ClientMediaDownloader *m_media_downloader;
541 // time_of_day speed approximation for old protocol
542 bool m_time_of_day_set;
543 float m_last_time_of_day_f;
544 float m_time_of_day_update_timer;
546 // An interval for generally sending object positions and stuff
547 float m_recommended_send_interval;
550 float m_removed_sounds_check_timer;
551 // Mapping from server sound ids to our sound ids
552 std::map<s32, int> m_sounds_server_to_client;
553 // And the other way!
554 std::map<int, s32> m_sounds_client_to_server;
555 // And relations to objects
556 std::map<int, u16> m_sounds_to_objects;
559 std::set<std::string> m_privileges;
561 // Detached inventories
563 std::map<std::string, Inventory*> m_detached_inventories;
565 // Storage for mesh data for creating multiple instances of the same mesh
566 std::map<std::string, std::string> m_mesh_data;
569 LocalClientState m_state;
571 // Used for saving server map to disk client-side
575 // TODO: Add callback to update this when g_settings changes
576 bool m_cache_smooth_lighting;
579 #endif // !CLIENT_HEADER