3 Copyright (C) 2010 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 General Public License as published by
7 the Free Software Foundation; either version 2 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 General Public License for more details.
15 You should have received a copy of the GNU 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.
25 #include "connection.h"
26 #include "environment.h"
27 #include "common_irrlicht.h"
30 #include "clientobject.h"
32 class ClientNotReadyException : public BaseException
35 ClientNotReadyException(const char *s):
40 struct QueuedMeshUpdate
44 bool ack_block_to_server;
49 ack_block_to_server(false)
61 A thread-safe queue of mesh update tasks
73 JMutexAutoLock lock(m_mutex);
75 core::list<QueuedMeshUpdate*>::Iterator i;
76 for(i=m_queue.begin(); i!=m_queue.end(); i++)
78 QueuedMeshUpdate *q = *i;
84 peer_id=0 adds with nobody to send to
86 void addBlock(v3s16 p, MeshMakeData *data, bool ack_block_to_server)
88 DSTACK(__FUNCTION_NAME);
92 JMutexAutoLock lock(m_mutex);
95 Find if block is already in queue.
96 If it is, update the data and quit.
98 core::list<QueuedMeshUpdate*>::Iterator i;
99 for(i=m_queue.begin(); i!=m_queue.end(); i++)
101 QueuedMeshUpdate *q = *i;
107 if(ack_block_to_server)
108 q->ack_block_to_server = true;
116 QueuedMeshUpdate *q = new QueuedMeshUpdate;
119 q->ack_block_to_server = ack_block_to_server;
120 m_queue.push_back(q);
123 // Returned pointer must be deleted
124 // Returns NULL if queue is empty
125 QueuedMeshUpdate * pop()
127 JMutexAutoLock lock(m_mutex);
129 core::list<QueuedMeshUpdate*>::Iterator i = m_queue.begin();
130 if(i == m_queue.end())
132 QueuedMeshUpdate *q = *i;
139 JMutexAutoLock lock(m_mutex);
140 return m_queue.size();
144 core::list<QueuedMeshUpdate*> m_queue;
148 struct MeshUpdateResult
152 bool ack_block_to_server;
155 p(-1338,-1338,-1338),
157 ack_block_to_server(false)
162 class MeshUpdateThread : public SimpleThread
172 MeshUpdateQueue m_queue_in;
174 MutexedQueue<MeshUpdateResult> m_queue_out;
186 ClientEventType type;
200 class Client : public con::PeerHandler, public InventoryManager
204 NOTE: Nothing is thread-safe here.
208 IrrlichtDevice *device,
209 const char *playername,
210 std::string password,
211 MapDrawControl &control
216 The name of the local player should already be set when
217 calling this, as it is sent in the initialization.
219 void connect(Address address);
222 m_con.Connected() == true
223 AND m_server_ser_ver != SER_FMT_VER_INVALID
224 throws con::PeerNotFoundException if connection has been deleted,
227 bool connectedAndInitialized();
229 Stuff that references the environment is valid only as
230 long as this is not called. (eg. Players)
231 If this throws a PeerNotFoundException, the connection has
234 void step(float dtime);
236 // Called from updater thread
240 void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
241 // Returns true if something was received
242 bool AsyncProcessPacket();
243 bool AsyncProcessData();
244 void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
246 // Pops out a packet from the packet queue
247 //IncomingPacket getPacket();
249 void groundAction(u8 action, v3s16 nodepos_undersurface,
250 v3s16 nodepos_oversurface, u16 item);
251 void clickObject(u8 button, v3s16 blockpos, s16 id, u16 item);
252 void clickActiveObject(u8 button, u16 id, u16 item);
254 void sendSignText(v3s16 blockpos, s16 id, std::string text);
255 void sendSignNodeText(v3s16 p, std::string text);
256 void sendInventoryAction(InventoryAction *a);
257 void sendChatMessage(const std::wstring &message);
258 void sendChangePassword(const std::wstring oldpassword,
259 const std::wstring newpassword);
260 void sendDamage(u8 damage);
263 void removeNode(v3s16 p);
265 void addNode(v3s16 p, MapNode n);
267 void updateCamera(v3f pos, v3f dir);
269 // Returns InvalidPositionException if not found
270 MapNode getNode(v3s16 p);
272 NodeMetadata* getNodeMetadata(v3s16 p);
274 v3f getPlayerPosition();
276 void setPlayerControl(PlayerControl &control);
278 // Returns true if the inventory of the local player has been
279 // updated from the server. If it is true, it is set to false.
280 bool getLocalInventoryUpdated();
281 // Copies the inventory of the local player to parameter
282 void getLocalInventory(Inventory &dst);
284 InventoryContext *getInventoryContext();
286 Inventory* getInventory(InventoryContext *c, std::string id);
287 void inventoryAction(InventoryAction *a);
289 // Gets closest object pointed by the shootline
290 // Returns NULL if not found
291 MapBlockObject * getSelectedObject(
293 v3f from_pos_f_on_map,
294 core::line3d<f32> shootline_on_map
297 // Gets closest object pointed by the shootline
298 // Returns NULL if not found
299 ClientActiveObject * getSelectedActiveObject(
301 v3f from_pos_f_on_map,
302 core::line3d<f32> shootline_on_map
305 // Prints a line or two of info
306 void printDebugInfo(std::ostream &os);
308 u32 getDayNightRatio();
312 //void updateSomeExpiredMeshes();
314 void setTempMod(v3s16 p, NodeMod mod)
316 //JMutexAutoLock envlock(m_env_mutex); //bulk comment-out
317 assert(m_env.getMap().mapType() == MAPTYPE_CLIENT);
319 core::map<v3s16, MapBlock*> affected_blocks;
320 ((ClientMap&)m_env.getMap()).setTempMod(p, mod,
323 for(core::map<v3s16, MapBlock*>::Iterator
324 i = affected_blocks.getIterator();
325 i.atEnd() == false; i++)
327 i.getNode()->getValue()->updateMesh(m_env.getDayNightRatio());
330 void clearTempMod(v3s16 p)
332 //JMutexAutoLock envlock(m_env_mutex); //bulk comment-out
333 assert(m_env.getMap().mapType() == MAPTYPE_CLIENT);
335 core::map<v3s16, MapBlock*> affected_blocks;
336 ((ClientMap&)m_env.getMap()).clearTempMod(p,
339 for(core::map<v3s16, MapBlock*>::Iterator
340 i = affected_blocks.getIterator();
341 i.atEnd() == false; i++)
343 i.getNode()->getValue()->updateMesh(m_env.getDayNightRatio());
349 //JMutexAutoLock lock(m_con_mutex); //bulk comment-out
350 con::Peer *peer = m_con.GetPeerNoEx(PEER_ID_SERVER);
353 return peer->avg_rtt;
356 bool getChatMessage(std::wstring &message)
358 if(m_chat_queue.size() == 0)
360 message = m_chat_queue.pop_front();
364 void addChatMessage(const std::wstring &message)
366 //JMutexAutoLock envlock(m_env_mutex); //bulk comment-out
367 LocalPlayer *player = m_env.getLocalPlayer();
368 assert(player != NULL);
369 std::wstring name = narrow_to_wide(player->getName());
370 m_chat_queue.push_back(
371 (std::wstring)L"<"+name+L"> "+message);
374 u64 getMapSeed(){ return m_map_seed; }
376 void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false);
377 // Including blocks at appropriate edges
378 void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false);
380 // Get event from queue. CE_NONE is returned if queue is empty.
381 ClientEvent getClientEvent();
383 inline bool accessDenied()
385 return m_access_denied;
388 inline std::wstring accessDeniedReason()
390 return m_access_denied_reason;
395 // Virtual methods from con::PeerHandler
396 void peerAdded(con::Peer *peer);
397 void deletingPeer(con::Peer *peer, bool timeout);
402 void sendPlayerPos();
403 // This sends the player's current name etc to the server
404 void sendPlayerInfo();
406 float m_packetcounter_timer;
407 float m_delete_unused_sectors_timer;
408 float m_connection_reinit_timer;
409 float m_avg_rtt_timer;
410 float m_playerpos_send_timer;
411 float m_ignore_damage_timer; // Used after server moves player
413 MeshUpdateThread m_mesh_update_thread;
415 ClientEnvironment m_env;
417 con::Connection m_con;
419 IrrlichtDevice *m_device;
422 v3f camera_direction;
424 // Server serialization version
427 // This is behind m_env_mutex.
428 bool m_inventory_updated;
430 core::map<v3s16, bool> m_active_blocks;
432 PacketCounter m_packetcounter;
434 // Received from the server. 0-23999
437 // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
439 //u32 m_daynight_ratio;
441 Queue<std::wstring> m_chat_queue;
443 // The seed returned by the server in TOCLIENT_INIT is stored here
446 std::string m_password;
447 bool m_access_denied;
448 std::wstring m_access_denied_reason;
450 InventoryContext m_inventory_context;
452 Queue<ClientEvent> m_client_event_queue;
457 #endif // !CLIENT_HEADER