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"
31 #include "utility.h" // For IntervalLimiter
35 class ClientNotReadyException : public BaseException
38 ClientNotReadyException(const char *s):
43 struct QueuedMeshUpdate
47 bool ack_block_to_server;
54 A thread-safe queue of mesh update tasks
64 peer_id=0 adds with nobody to send to
66 void addBlock(v3s16 p, MeshMakeData *data, bool ack_block_to_server);
68 // Returned pointer must be deleted
69 // Returns NULL if queue is empty
70 QueuedMeshUpdate * pop();
74 JMutexAutoLock lock(m_mutex);
75 return m_queue.size();
79 core::list<QueuedMeshUpdate*> m_queue;
83 struct MeshUpdateResult
87 bool ack_block_to_server;
92 ack_block_to_server(false)
97 class MeshUpdateThread : public SimpleThread
107 MeshUpdateQueue m_queue_in;
109 MutexedQueue<MeshUpdateResult> m_queue_out;
121 ClientEventType type;
135 class Client : public con::PeerHandler, public InventoryManager
139 NOTE: Nothing is thread-safe here.
143 IrrlichtDevice *device,
144 const char *playername,
145 std::string password,
146 MapDrawControl &control
151 The name of the local player should already be set when
152 calling this, as it is sent in the initialization.
154 void connect(Address address);
157 m_con.Connected() == true
158 AND m_server_ser_ver != SER_FMT_VER_INVALID
159 throws con::PeerNotFoundException if connection has been deleted,
162 bool connectedAndInitialized();
164 Stuff that references the environment is valid only as
165 long as this is not called. (eg. Players)
166 If this throws a PeerNotFoundException, the connection has
169 void step(float dtime);
171 // Called from updater thread
175 void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
176 // Returns true if something was received
177 bool AsyncProcessPacket();
178 bool AsyncProcessData();
179 void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
181 // Pops out a packet from the packet queue
182 //IncomingPacket getPacket();
184 void groundAction(u8 action, v3s16 nodepos_undersurface,
185 v3s16 nodepos_oversurface, u16 item);
186 void clickObject(u8 button, v3s16 blockpos, s16 id, u16 item);
187 void clickActiveObject(u8 button, u16 id, u16 item);
189 void sendSignText(v3s16 blockpos, s16 id, std::string text);
190 void sendSignNodeText(v3s16 p, std::string text);
191 void sendInventoryAction(InventoryAction *a);
192 void sendChatMessage(const std::wstring &message);
193 void sendChangePassword(const std::wstring oldpassword,
194 const std::wstring newpassword);
195 void sendDamage(u8 damage);
198 void removeNode(v3s16 p);
200 void addNode(v3s16 p, MapNode n);
202 void updateCamera(v3f pos, v3f dir, f32 fov);
206 // Returns InvalidPositionException if not found
207 MapNode getNode(v3s16 p);
209 NodeMetadata* getNodeMetadata(v3s16 p);
211 LocalPlayer* getLocalPlayer();
213 void setPlayerControl(PlayerControl &control);
215 void selectPlayerItem(u16 item);
217 // Returns true if the inventory of the local player has been
218 // updated from the server. If it is true, it is set to false.
219 bool getLocalInventoryUpdated();
220 // Copies the inventory of the local player to parameter
221 void getLocalInventory(Inventory &dst);
223 InventoryContext *getInventoryContext();
225 Inventory* getInventory(InventoryContext *c, std::string id);
226 void inventoryAction(InventoryAction *a);
228 // Gets closest object pointed by the shootline
229 // Returns NULL if not found
230 MapBlockObject * getSelectedObject(
232 v3f from_pos_f_on_map,
233 core::line3d<f32> shootline_on_map
236 // Gets closest object pointed by the shootline
237 // Returns NULL if not found
238 ClientActiveObject * getSelectedActiveObject(
240 v3f from_pos_f_on_map,
241 core::line3d<f32> shootline_on_map
244 // Prints a line or two of info
245 void printDebugInfo(std::ostream &os);
247 u32 getDayNightRatio();
251 void setTempMod(v3s16 p, NodeMod mod);
252 void clearTempMod(v3s16 p);
256 //JMutexAutoLock lock(m_con_mutex); //bulk comment-out
257 con::Peer *peer = m_con.GetPeerNoEx(PEER_ID_SERVER);
260 return peer->avg_rtt;
263 bool getChatMessage(std::wstring &message)
265 if(m_chat_queue.size() == 0)
267 message = m_chat_queue.pop_front();
271 void addChatMessage(const std::wstring &message)
273 if (message[0] == L'/') {
274 m_chat_queue.push_back(
275 (std::wstring)L"issued command: "+message);
279 //JMutexAutoLock envlock(m_env_mutex); //bulk comment-out
280 LocalPlayer *player = m_env.getLocalPlayer();
281 assert(player != NULL);
282 std::wstring name = narrow_to_wide(player->getName());
283 m_chat_queue.push_back(
284 (std::wstring)L"<"+name+L"> "+message);
287 u64 getMapSeed(){ return m_map_seed; }
289 void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false);
290 // Including blocks at appropriate edges
291 void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false);
293 // Get event from queue. CE_NONE is returned if queue is empty.
294 ClientEvent getClientEvent();
296 inline bool accessDenied()
298 return m_access_denied;
301 inline std::wstring accessDeniedReason()
303 return m_access_denied_reason;
308 // Virtual methods from con::PeerHandler
309 void peerAdded(con::Peer *peer);
310 void deletingPeer(con::Peer *peer, bool timeout);
315 void sendPlayerPos();
316 // This sends the player's current name etc to the server
317 void sendPlayerInfo();
318 // Send the item number 'item' as player item to the server
319 void sendPlayerItem(u16 item);
321 float m_packetcounter_timer;
322 float m_connection_reinit_timer;
323 float m_avg_rtt_timer;
324 float m_playerpos_send_timer;
325 float m_ignore_damage_timer; // Used after server moves player
326 IntervalLimiter m_map_timer_and_unload_interval;
328 MeshUpdateThread m_mesh_update_thread;
330 ClientEnvironment m_env;
332 con::Connection m_con;
334 IrrlichtDevice *m_device;
336 // Server serialization version
339 // This is behind m_env_mutex.
340 bool m_inventory_updated;
342 core::map<v3s16, bool> m_active_blocks;
344 PacketCounter m_packetcounter;
346 // Received from the server. 0-23999
349 // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
351 //u32 m_daynight_ratio;
353 Queue<std::wstring> m_chat_queue;
355 // The seed returned by the server in TOCLIENT_INIT is stored here
358 std::string m_password;
359 bool m_access_denied;
360 std::wstring m_access_denied_reason;
362 InventoryContext m_inventory_context;
364 Queue<ClientEvent> m_client_event_queue;
366 friend class FarMesh;
371 #endif // !CLIENT_HEADER