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 MapDrawControl &control
215 The name of the local player should already be set when
216 calling this, as it is sent in the initialization.
218 void connect(Address address);
221 m_con.Connected() == true
222 AND m_server_ser_ver != SER_FMT_VER_INVALID
223 throws con::PeerNotFoundException if connection has been deleted,
226 bool connectedAndInitialized();
228 Stuff that references the environment is valid only as
229 long as this is not called. (eg. Players)
230 If this throws a PeerNotFoundException, the connection has
233 void step(float dtime);
235 // Called from updater thread
239 void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
240 // Returns true if something was received
241 bool AsyncProcessPacket();
242 bool AsyncProcessData();
243 void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
245 // Pops out a packet from the packet queue
246 //IncomingPacket getPacket();
248 void groundAction(u8 action, v3s16 nodepos_undersurface,
249 v3s16 nodepos_oversurface, u16 item);
250 void clickObject(u8 button, v3s16 blockpos, s16 id, u16 item);
251 void clickActiveObject(u8 button, u16 id, u16 item);
253 void sendSignText(v3s16 blockpos, s16 id, std::string text);
254 void sendSignNodeText(v3s16 p, std::string text);
255 void sendInventoryAction(InventoryAction *a);
256 void sendChatMessage(const std::wstring &message);
257 void sendDamage(u8 damage);
260 void removeNode(v3s16 p);
262 void addNode(v3s16 p, MapNode n);
264 void updateCamera(v3f pos, v3f dir);
266 // Returns InvalidPositionException if not found
267 MapNode getNode(v3s16 p);
269 NodeMetadata* getNodeMetadata(v3s16 p);
271 v3f getPlayerPosition();
273 void setPlayerControl(PlayerControl &control);
275 // Returns true if the inventory of the local player has been
276 // updated from the server. If it is true, it is set to false.
277 bool getLocalInventoryUpdated();
278 // Copies the inventory of the local player to parameter
279 void getLocalInventory(Inventory &dst);
281 InventoryContext *getInventoryContext();
283 Inventory* getInventory(InventoryContext *c, std::string id);
284 void inventoryAction(InventoryAction *a);
286 // Gets closest object pointed by the shootline
287 // Returns NULL if not found
288 MapBlockObject * getSelectedObject(
290 v3f from_pos_f_on_map,
291 core::line3d<f32> shootline_on_map
294 // Gets closest object pointed by the shootline
295 // Returns NULL if not found
296 ClientActiveObject * getSelectedActiveObject(
298 v3f from_pos_f_on_map,
299 core::line3d<f32> shootline_on_map
302 // Prints a line or two of info
303 void printDebugInfo(std::ostream &os);
305 u32 getDayNightRatio();
309 //void updateSomeExpiredMeshes();
311 void setTempMod(v3s16 p, NodeMod mod)
313 //JMutexAutoLock envlock(m_env_mutex); //bulk comment-out
314 assert(m_env.getMap().mapType() == MAPTYPE_CLIENT);
316 core::map<v3s16, MapBlock*> affected_blocks;
317 ((ClientMap&)m_env.getMap()).setTempMod(p, mod,
320 for(core::map<v3s16, MapBlock*>::Iterator
321 i = affected_blocks.getIterator();
322 i.atEnd() == false; i++)
324 i.getNode()->getValue()->updateMesh(m_env.getDayNightRatio());
327 void clearTempMod(v3s16 p)
329 //JMutexAutoLock envlock(m_env_mutex); //bulk comment-out
330 assert(m_env.getMap().mapType() == MAPTYPE_CLIENT);
332 core::map<v3s16, MapBlock*> affected_blocks;
333 ((ClientMap&)m_env.getMap()).clearTempMod(p,
336 for(core::map<v3s16, MapBlock*>::Iterator
337 i = affected_blocks.getIterator();
338 i.atEnd() == false; i++)
340 i.getNode()->getValue()->updateMesh(m_env.getDayNightRatio());
346 //JMutexAutoLock lock(m_con_mutex); //bulk comment-out
347 con::Peer *peer = m_con.GetPeerNoEx(PEER_ID_SERVER);
350 return peer->avg_rtt;
353 bool getChatMessage(std::wstring &message)
355 if(m_chat_queue.size() == 0)
357 message = m_chat_queue.pop_front();
361 void addChatMessage(const std::wstring &message)
363 //JMutexAutoLock envlock(m_env_mutex); //bulk comment-out
364 LocalPlayer *player = m_env.getLocalPlayer();
365 assert(player != NULL);
366 std::wstring name = narrow_to_wide(player->getName());
367 m_chat_queue.push_back(
368 (std::wstring)L"<"+name+L"> "+message);
371 u64 getMapSeed(){ return m_map_seed; }
373 void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false);
374 // Including blocks at appropriate edges
375 void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false);
377 // Get event from queue. CE_NONE is returned if queue is empty.
378 ClientEvent getClientEvent();
382 // Virtual methods from con::PeerHandler
383 void peerAdded(con::Peer *peer);
384 void deletingPeer(con::Peer *peer, bool timeout);
389 void sendPlayerPos();
390 // This sends the player's current name etc to the server
391 void sendPlayerInfo();
393 float m_packetcounter_timer;
394 float m_delete_unused_sectors_timer;
395 float m_connection_reinit_timer;
396 float m_avg_rtt_timer;
397 float m_playerpos_send_timer;
398 float m_ignore_damage_timer; // Used after server moves player
400 MeshUpdateThread m_mesh_update_thread;
402 ClientEnvironment m_env;
404 con::Connection m_con;
406 IrrlichtDevice *m_device;
409 v3f camera_direction;
411 // Server serialization version
414 // This is behind m_env_mutex.
415 bool m_inventory_updated;
417 core::map<v3s16, bool> m_active_blocks;
419 PacketCounter m_packetcounter;
421 // Received from the server. 0-23999
424 // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
426 //u32 m_daynight_ratio;
428 Queue<std::wstring> m_chat_queue;
430 // The seed returned by the server in TOCLIENT_INIT is stored here
433 InventoryContext m_inventory_context;
435 Queue<ClientEvent> m_client_event_queue;
440 #endif // !CLIENT_HEADER