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
36 class IWritableToolDefManager;
37 class IWritableNodeDefManager;
39 class ClientNotReadyException : public BaseException
42 ClientNotReadyException(const char *s):
47 struct QueuedMeshUpdate
51 bool ack_block_to_server;
58 A thread-safe queue of mesh update tasks
68 peer_id=0 adds with nobody to send to
70 void addBlock(v3s16 p, MeshMakeData *data, bool ack_block_to_server);
72 // Returned pointer must be deleted
73 // Returns NULL if queue is empty
74 QueuedMeshUpdate * pop();
78 JMutexAutoLock lock(m_mutex);
79 return m_queue.size();
83 core::list<QueuedMeshUpdate*> m_queue;
87 struct MeshUpdateResult
91 bool ack_block_to_server;
96 ack_block_to_server(false)
101 class MeshUpdateThread : public SimpleThread
105 MeshUpdateThread(IGameDef *gamedef):
112 MeshUpdateQueue m_queue_in;
114 MutexedQueue<MeshUpdateResult> m_queue_out;
123 CE_PLAYER_FORCE_MOVE,
130 ClientEventType type;
142 bool set_camera_point_target;
143 f32 camera_point_target_x;
144 f32 camera_point_target_y;
145 f32 camera_point_target_z;
152 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
156 NOTE: Nothing is thread-safe here.
160 IrrlichtDevice *device,
161 const char *playername,
162 std::string password,
163 MapDrawControl &control,
164 IWritableTextureSource *tsrc,
165 IWritableToolDefManager *tooldef,
166 IWritableNodeDefManager *nodedef
171 The name of the local player should already be set when
172 calling this, as it is sent in the initialization.
174 void connect(Address address);
177 m_con.Connected() == true
178 AND m_server_ser_ver != SER_FMT_VER_INVALID
179 throws con::PeerNotFoundException if connection has been deleted,
182 bool connectedAndInitialized();
184 Stuff that references the environment is valid only as
185 long as this is not called. (eg. Players)
186 If this throws a PeerNotFoundException, the connection has
189 void step(float dtime);
191 // Called from updater thread
195 void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
196 // Returns true if something was received
197 bool AsyncProcessPacket();
198 bool AsyncProcessData();
199 void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
201 // Pops out a packet from the packet queue
202 //IncomingPacket getPacket();
204 void groundAction(u8 action, v3s16 nodepos_undersurface,
205 v3s16 nodepos_oversurface, u16 item);
206 void clickActiveObject(u8 button, u16 id, u16 item_i);
208 void sendSignNodeText(v3s16 p, std::string text);
209 void sendInventoryAction(InventoryAction *a);
210 void sendChatMessage(const std::wstring &message);
211 void sendChangePassword(const std::wstring oldpassword,
212 const std::wstring newpassword);
213 void sendDamage(u8 damage);
217 void removeNode(v3s16 p);
219 void addNode(v3s16 p, MapNode n);
221 void updateCamera(v3f pos, v3f dir, f32 fov);
225 // Returns InvalidPositionException if not found
226 MapNode getNode(v3s16 p);
228 NodeMetadata* getNodeMetadata(v3s16 p);
230 LocalPlayer* getLocalPlayer();
232 void setPlayerControl(PlayerControl &control);
234 void selectPlayerItem(u16 item);
236 // Returns true if the inventory of the local player has been
237 // updated from the server. If it is true, it is set to false.
238 bool getLocalInventoryUpdated();
239 // Copies the inventory of the local player to parameter
240 void getLocalInventory(Inventory &dst);
242 InventoryContext *getInventoryContext();
244 Inventory* getInventory(InventoryContext *c, std::string id);
245 void inventoryAction(InventoryAction *a);
247 // Gets closest object pointed by the shootline
248 // Returns NULL if not found
249 ClientActiveObject * getSelectedActiveObject(
251 v3f from_pos_f_on_map,
252 core::line3d<f32> shootline_on_map
255 // Prints a line or two of info
256 void printDebugInfo(std::ostream &os);
258 u32 getDayNightRatio();
262 void setTempMod(v3s16 p, NodeMod mod);
263 void clearTempMod(v3s16 p);
268 return m_con.GetPeerAvgRTT(PEER_ID_SERVER);
269 } catch(con::PeerNotFoundException){
274 bool getChatMessage(std::wstring &message)
276 if(m_chat_queue.size() == 0)
278 message = m_chat_queue.pop_front();
282 void addChatMessage(const std::wstring &message)
284 if (message[0] == L'/') {
285 m_chat_queue.push_back(
286 (std::wstring)L"issued command: "+message);
290 //JMutexAutoLock envlock(m_env_mutex); //bulk comment-out
291 LocalPlayer *player = m_env.getLocalPlayer();
292 assert(player != NULL);
293 std::wstring name = narrow_to_wide(player->getName());
294 m_chat_queue.push_back(
295 (std::wstring)L"<"+name+L"> "+message);
298 u64 getMapSeed(){ return m_map_seed; }
300 void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false);
301 // Including blocks at appropriate edges
302 void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false);
304 // Get event from queue. CE_NONE is returned if queue is empty.
305 ClientEvent getClientEvent();
307 inline bool accessDenied()
308 { return m_access_denied; }
310 inline std::wstring accessDeniedReason()
311 { return m_access_denied_reason; }
315 // IGameDef interface
317 virtual IToolDefManager* getToolDefManager();
318 virtual INodeDefManager* getNodeDefManager();
319 virtual ITextureSource* getTextureSource();
323 // Virtual methods from con::PeerHandler
324 void peerAdded(con::Peer *peer);
325 void deletingPeer(con::Peer *peer, bool timeout);
330 void sendPlayerPos();
331 // This sends the player's current name etc to the server
332 void sendPlayerInfo();
333 // Send the item number 'item' as player item to the server
334 void sendPlayerItem(u16 item);
336 float m_packetcounter_timer;
337 float m_connection_reinit_timer;
338 float m_avg_rtt_timer;
339 float m_playerpos_send_timer;
340 float m_ignore_damage_timer; // Used after server moves player
341 IntervalLimiter m_map_timer_and_unload_interval;
343 IWritableTextureSource *m_tsrc;
344 IWritableToolDefManager *m_tooldef;
345 IWritableNodeDefManager *m_nodedef;
346 MeshUpdateThread m_mesh_update_thread;
347 ClientEnvironment m_env;
348 con::Connection m_con;
349 IrrlichtDevice *m_device;
350 // Server serialization version
352 // This is behind m_env_mutex.
353 bool m_inventory_updated;
354 core::map<v3s16, bool> m_active_blocks;
355 PacketCounter m_packetcounter;
356 // Received from the server. 0-23999
358 // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
360 //u32 m_daynight_ratio;
361 Queue<std::wstring> m_chat_queue;
362 // The seed returned by the server in TOCLIENT_INIT is stored here
364 std::string m_password;
365 bool m_access_denied;
366 std::wstring m_access_denied_reason;
367 InventoryContext m_inventory_context;
368 Queue<ClientEvent> m_client_event_queue;
369 friend class FarMesh;
374 #endif // !CLIENT_HEADER