src/client.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #ifndef CLIENT_HEADER
  21 #define CLIENT_HEADER
  22
  23 #ifndef SERVER
  24
  25 #include "connection.h"
  26 #include "environment.h"
  27 #include "common_irrlicht.h"
  28 #include "jmutex.h"
  29 #include <ostream>
  30 #include <set>
  31 #include <vector>
  32 #include "clientobject.h"
  33 #include "utility.h" // For IntervalLimiter
  34 #include "gamedef.h"
  35 #include "inventorymanager.h"
  36 #include "filesys.h"
  37
  38 struct MeshMakeData;
  39 class MapBlockMesh;
  40 class IGameDef;
  41 class IWritableTextureSource;
  42 class IWritableItemDefManager;
  43 class IWritableNodeDefManager;
  44 //class IWritableCraftDefManager;
  45 class ClientEnvironment;
  46
  47 class ClientNotReadyException : public BaseException
  48 {
  49 public:
  50         ClientNotReadyException(const char *s):
  51                 BaseException(s)
  52         {}
  53 };
  54
  55 struct QueuedMeshUpdate
  56 {
  57         v3s16 p;
  58         MeshMakeData *data;
  59         bool ack_block_to_server;
  60
  61         QueuedMeshUpdate();
  62         ~QueuedMeshUpdate();
  63 };
  64
  65 /*
  66         A thread-safe queue of mesh update tasks
  67 */
  68 class MeshUpdateQueue
  69 {
  70 public:
  71         MeshUpdateQueue();
  72
  73         ~MeshUpdateQueue();
  74
  75         /*
  76                 peer_id=0 adds with nobody to send to
  77         */
  78         void addBlock(v3s16 p, MeshMakeData *data,
  79                         bool ack_block_to_server, bool urgent);
  80
  81         // Returned pointer must be deleted
  82         // Returns NULL if queue is empty
  83         QueuedMeshUpdate * pop();
  84
  85         u32 size()
  86         {
  87                 JMutexAutoLock lock(m_mutex);
  88                 return m_queue.size();
  89         }
  90
  91 private:
  92         std::vector<QueuedMeshUpdate*> m_queue;
  93         std::set<v3s16> m_urgents;
  94         JMutex m_mutex;
  95 };
  96
  97 struct MeshUpdateResult
  98 {
  99         v3s16 p;
 100         MapBlockMesh *mesh;
 101         bool ack_block_to_server;
 102
 103         MeshUpdateResult():
 104                 p(-1338,-1338,-1338),
 105                 mesh(NULL),
 106                 ack_block_to_server(false)
 107         {
 108         }
 109 };
 110
 111 class MeshUpdateThread : public SimpleThread
 112 {
 113 public:
 114
 115         MeshUpdateThread(IGameDef *gamedef):
 116                 m_gamedef(gamedef)
 117         {
 118         }
 119
 120         void * Thread();
 121
 122         MeshUpdateQueue m_queue_in;
 123
 124         MutexedQueue<MeshUpdateResult> m_queue_out;
 125
 126         IGameDef *m_gamedef;
 127 };
 128
 129 enum ClientEventType
 130 {
 131         CE_NONE,
 132         CE_PLAYER_DAMAGE,
 133         CE_PLAYER_FORCE_MOVE,
 134         CE_DEATHSCREEN,
 135         CE_TEXTURES_UPDATED
 136 };
 137
 138 struct ClientEvent
 139 {
 140         ClientEventType type;
 141         union{
 142                 struct{
 143                 } none;
 144                 struct{
 145                         u8 amount;
 146                 } player_damage;
 147                 struct{
 148                         f32 pitch;
 149                         f32 yaw;
 150                 } player_force_move;
 151                 struct{
 152                         bool set_camera_point_target;
 153                         f32 camera_point_target_x;
 154                         f32 camera_point_target_y;
 155                         f32 camera_point_target_z;
 156                 } deathscreen;
 157                 struct{
 158                 } textures_updated;
 159         };
 160 };
 161
 162 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 163 {
 164 public:
 165         /*
 166                 NOTE: Nothing is thread-safe here.
 167         */
 168
 169         Client(
 170                         IrrlichtDevice *device,
 171                         const char *playername,
 172                         std::string password,
 173                         MapDrawControl &control,
 174                         IWritableTextureSource *tsrc,
 175                         IWritableItemDefManager *itemdef,
 176                         IWritableNodeDefManager *nodedef
 177         );
 178
 179         ~Client();
 180         /*
 181                 The name of the local player should already be set when
 182                 calling this, as it is sent in the initialization.
 183         */
 184         void connect(Address address);
 185         /*
 186                 returns true when
 187                         m_con.Connected() == true
 188                         AND m_server_ser_ver != SER_FMT_VER_INVALID
 189                 throws con::PeerNotFoundException if connection has been deleted,
 190                 eg. timed out.
 191         */
 192         bool connectedAndInitialized();
 193         /*
 194                 Stuff that references the environment is valid only as
 195                 long as this is not called. (eg. Players)
 196                 If this throws a PeerNotFoundException, the connection has
 197                 timed out.
 198         */
 199         void step(float dtime);
 200
 201         void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
 202         // Returns true if something was received
 203         bool AsyncProcessPacket();
 204         bool AsyncProcessData();
 205         void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
 206
 207         void interact(u8 action, const PointedThing& pointed);
 208
 209         void sendSignNodeText(v3s16 p, std::string text);
 210         void sendInventoryAction(InventoryAction *a);
 211         void sendChatMessage(const std::wstring &message);
 212         void sendChangePassword(const std::wstring oldpassword,
 213                 const std::wstring newpassword);
 214         void sendDamage(u8 damage);
 215         void sendRespawn();
 216
 217         ClientEnvironment& getEnv()
 218         { return m_env; }
 219
 220         // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
 221         void removeNode(v3s16 p);
 222         void addNode(v3s16 p, MapNode n);
 223
 224         void setPlayerControl(PlayerControl &control);
 225
 226         void selectPlayerItem(u16 item);
 227         u16 getPlayerItem() const
 228         { return m_playeritem; }
 229
 230         // Returns true if the inventory of the local player has been
 231         // updated from the server. If it is true, it is set to false.
 232         bool getLocalInventoryUpdated();
 233         // Copies the inventory of the local player to parameter
 234         void getLocalInventory(Inventory &dst);
 235
 236         /* InventoryManager interface */
 237         Inventory* getInventory(const InventoryLocation &loc);
 238         void inventoryAction(InventoryAction *a);
 239
 240         // Gets closest object pointed by the shootline
 241         // Returns NULL if not found
 242         ClientActiveObject * getSelectedActiveObject(
 243                         f32 max_d,
 244                         v3f from_pos_f_on_map,
 245                         core::line3d<f32> shootline_on_map
 246         );
 247
 248         // Prints a line or two of info
 249         void printDebugInfo(std::ostream &os);
 250
 251         core::list<std::wstring> getConnectedPlayerNames();
 252
 253         float getAnimationTime();
 254
 255         int getCrackLevel();
 256         void setCrack(int level, v3s16 pos);
 257
 258         u32 getDayNightRatio();
 259
 260         u16 getHP();
 261
 262         float getAvgRtt()
 263         {
 264                 try{
 265                         return m_con.GetPeerAvgRTT(PEER_ID_SERVER);
 266                 } catch(con::PeerNotFoundException){
 267                         return 1337;
 268                 }
 269         }
 270
 271         bool getChatMessage(std::wstring &message);
 272         void typeChatMessage(const std::wstring& message);
 273
 274         u64 getMapSeed(){ return m_map_seed; }
 275
 276         void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
 277         // Including blocks at appropriate edges
 278         void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
 279         void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
 280
 281         // Get event from queue. CE_NONE is returned if queue is empty.
 282         ClientEvent getClientEvent();
 283
 284         bool accessDenied()
 285         { return m_access_denied; }
 286
 287         std::wstring accessDeniedReason()
 288         { return m_access_denied_reason; }
 289
 290         float textureReceiveProgress()
 291         { return m_texture_receive_progress; }
 292
 293         bool texturesReceived()
 294         { return m_textures_received; }
 295         bool itemdefReceived()
 296         { return m_itemdef_received; }
 297         bool nodedefReceived()
 298         { return m_nodedef_received; }
 299
 300         void afterContentReceived();
 301
 302         float getRTT(void);
 303
 304         // IGameDef interface
 305         virtual IItemDefManager* getItemDefManager();
 306         virtual INodeDefManager* getNodeDefManager();
 307         virtual ICraftDefManager* getCraftDefManager();
 308         virtual ITextureSource* getTextureSource();
 309         virtual u16 allocateUnknownNodeId(const std::string &name);
 310
 311 private:
 312
 313         // Virtual methods from con::PeerHandler
 314         void peerAdded(con::Peer *peer);
 315         void deletingPeer(con::Peer *peer, bool timeout);
 316
 317         void ReceiveAll();
 318         void Receive();
 319
 320         void sendPlayerPos();
 321         // This sends the player's current name etc to the server
 322         void sendPlayerInfo();
 323         // Send the item number 'item' as player item to the server
 324         void sendPlayerItem(u16 item);
 325
 326         float m_packetcounter_timer;
 327         float m_connection_reinit_timer;
 328         float m_avg_rtt_timer;
 329         float m_playerpos_send_timer;
 330         float m_ignore_damage_timer; // Used after server moves player
 331         IntervalLimiter m_map_timer_and_unload_interval;
 332
 333         IWritableTextureSource *m_tsrc;
 334         IWritableItemDefManager *m_itemdef;
 335         IWritableNodeDefManager *m_nodedef;
 336         MeshUpdateThread m_mesh_update_thread;
 337         ClientEnvironment m_env;
 338         con::Connection m_con;
 339         IrrlichtDevice *m_device;
 340         // Server serialization version
 341         u8 m_server_ser_ver;
 342         u16 m_playeritem;
 343         bool m_inventory_updated;
 344         Inventory *m_inventory_from_server;
 345         float m_inventory_from_server_age;
 346         core::map<v3s16, bool> m_active_blocks;
 347         PacketCounter m_packetcounter;
 348         // Block mesh animation parameters
 349         float m_animation_time;
 350         int m_crack_level;
 351         v3s16 m_crack_pos;
 352         // Received from the server. 0-23999
 353         u32 m_time_of_day;
 354         // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
 355         //s32 m_daynight_i;
 356         //u32 m_daynight_ratio;
 357         Queue<std::wstring> m_chat_queue;
 358         // The seed returned by the server in TOCLIENT_INIT is stored here
 359         u64 m_map_seed;
 360         std::string m_password;
 361         bool m_access_denied;
 362         std::wstring m_access_denied_reason;
 363         Queue<ClientEvent> m_client_event_queue;
 364         float m_texture_receive_progress;
 365         bool m_textures_received;
 366         bool m_itemdef_received;
 367         bool m_nodedef_received;
 368         friend class FarMesh;
 369 };
 370
 371 #endif // !SERVER
 372
 373 #endif // !CLIENT_HEADER
 374