src/client.h

   1 /************************************************************************
   2 * Minetest-c55
   3 * Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
   4 *
   5 * client.h
   6 * voxelands - 3d voxel world sandbox game
   7 * Copyright (C) Lisa 'darkrose' Milne 2014 <lisa@ltmnet.com>
   8 *
   9 * This program is free software: you can redistribute it and/or modify
  10 * it under the terms of the GNU General Public License as published by
  11 * the Free Software Foundation, either version 3 of the License, or
  12 * (at your option) any later version.
  13 *
  14 * This program is distributed in the hope that it will be useful, but
  15 * WITHOUT ANY WARRANTY; without even the implied warranty of
  16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  17 * See the GNU General Public License for more details.
  18 *
  19 * You should have received a copy of the GNU General Public License
  20 * along with this program.  If not, see <http://www.gnu.org/licenses/>
  21 *
  22 * License updated from GPLv2 or later to GPLv3 or later by Lisa Milne
  23 * for Voxelands.
  24 ************************************************************************/
  25
  26 #ifndef CLIENT_HEADER
  27 #define CLIENT_HEADER
  28
  29 #ifndef SERVER
  30
  31 #include "connection.h"
  32 #include "environment.h"
  33 #include "common_irrlicht.h"
  34 #include "jmutex.h"
  35 #include <ostream>
  36 #include "clientobject.h"
  37 #include "particles.h"
  38 #include "utility.h" // For IntervalLimiter
  39 #include "sound.h"
  40
  41 struct MeshMakeData;
  42
  43 class ClientNotReadyException : public BaseException
  44 {
  45 public:
  46         ClientNotReadyException(const char *s):
  47                 BaseException(s)
  48         {}
  49 };
  50
  51 struct QueuedMeshUpdate
  52 {
  53         v3s16 p;
  54         MeshMakeData *data;
  55         bool ack_block_to_server;
  56
  57         QueuedMeshUpdate();
  58         ~QueuedMeshUpdate();
  59 };
  60
  61 /*
  62         A thread-safe queue of mesh update tasks
  63 */
  64 class MeshUpdateQueue
  65 {
  66 public:
  67         MeshUpdateQueue();
  68
  69         ~MeshUpdateQueue();
  70
  71         /*
  72                 peer_id=0 adds with nobody to send to
  73         */
  74         void addBlock(v3s16 p, MeshMakeData *data, bool ack_block_to_server);
  75
  76         // Returned pointer must be deleted
  77         // Returns NULL if queue is empty
  78         QueuedMeshUpdate * pop();
  79
  80         u32 size()
  81         {
  82                 JMutexAutoLock lock(m_mutex);
  83                 return m_queue.size();
  84         }
  85
  86 private:
  87         core::list<QueuedMeshUpdate*> m_queue;
  88         JMutex m_mutex;
  89 };
  90
  91 class MapBlockMesh;
  92
  93 struct MeshUpdateResult
  94 {
  95         v3s16 p;
  96         MapBlockMesh *mesh;
  97         bool ack_block_to_server;
  98
  99         MeshUpdateResult():
 100                 p(-1338,-1338,-1338),
 101                 mesh(NULL),
 102                 ack_block_to_server(false)
 103         {
 104         }
 105 };
 106
 107 class MeshUpdateThread : public SimpleThread
 108 {
 109 public:
 110
 111         MeshUpdateThread()
 112         {
 113         }
 114
 115         void * Thread();
 116
 117         MeshUpdateQueue m_queue_in;
 118
 119         MutexedQueue<MeshUpdateResult> m_queue_out;
 120
 121         v3s16 m_camera_offset;
 122         ClientEnvironment *m_env;
 123 };
 124
 125 enum ClientEventType
 126 {
 127         CE_NONE,
 128         CE_PLAYER_DAMAGE,
 129         CE_PLAYER_SUFFOCATE,
 130         CE_PLAYER_HUNGER,
 131         CE_PLAYER_FORCE_MOVE,
 132         CE_DEATHSCREEN,
 133 };
 134
 135 struct ClientEvent
 136 {
 137         ClientEventType type;
 138         union{
 139                 struct{
 140                 } none;
 141                 struct{
 142                         s8 amount;
 143                 } player_damage;
 144                 struct{
 145                         f32 pitch;
 146                         f32 yaw;
 147                 } player_force_move;
 148                 struct{
 149                         bool set_camera_point_target;
 150                         f32 camera_point_target_x;
 151                         f32 camera_point_target_y;
 152                         f32 camera_point_target_z;
 153                 } deathscreen;
 154         };
 155 };
 156
 157 class Client : public con::PeerHandler, public InventoryManager
 158 {
 159 public:
 160         /*
 161                 NOTE: Nothing is thread-safe here.
 162         */
 163
 164         Client(
 165                 IrrlichtDevice *device,
 166                 const char *playername,
 167                 std::string password,
 168                 MapDrawControl &control,
 169                 ISoundManager *sound
 170         );
 171
 172         ~Client();
 173         /*
 174                 The name of the local player should already be set when
 175                 calling this, as it is sent in the initialization.
 176         */
 177         void connect(Address address);
 178         /*
 179                 returns true when
 180                         m_con.Connected() == true
 181                         AND m_server_ser_ver != SER_FMT_VER_INVALID
 182                 throws con::PeerNotFoundException if connection has been deleted,
 183                 eg. timed out.
 184         */
 185         bool connectedAndInitialized();
 186         /*
 187                 Stuff that references the environment is valid only as
 188                 long as this is not called. (eg. Players)
 189                 If this throws a PeerNotFoundException, the connection has
 190                 timed out.
 191         */
 192         void step(float dtime);
 193
 194         // Called from updater thread
 195         // Returns dtime
 196         //float asyncStep();
 197
 198         void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
 199         // Returns true if something was received
 200         bool AsyncProcessPacket();
 201         bool AsyncProcessData();
 202         void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
 203
 204         // Pops out a packet from the packet queue
 205         //IncomingPacket getPacket();
 206
 207         void groundAction(u8 action, v3s16 nodepos_undersurface,
 208                         v3s16 nodepos_oversurface, u16 item);
 209         void throwItem(v3f dir, u16 item);
 210         void useItem();
 211         void clickActiveObject(u8 button, u16 id, u16 item_i);
 212
 213         void sendNodemetaFields(v3s16 p, const std::string &formname,
 214                         const std::map<std::string, std::wstring> &fields);
 215         void sendInventoryAction(InventoryAction *a);
 216         void sendChatMessage(const std::wstring &message);
 217         void sendChangePassword(const std::wstring oldpassword,
 218                 const std::wstring newpassword);
 219         void sendDamage(s8 damage, s8 suffocate, s8 hunger);
 220         void sendClothesWear(u16 wear);
 221         void sendRespawn();
 222
 223         ClientEnvironment& getEnv() { return m_env; }
 224
 225         // locks envlock
 226         void removeNode(v3s16 p);
 227         // locks envlock
 228         void addNode(v3s16 p, MapNode n);
 229
 230         void updateCamera(v3f pos, v3f dir, f32 fov, v3s16 camera_offset);
 231
 232         void renderPostFx();
 233
 234         // Returns InvalidPositionException if not found
 235         MapNode getNode(v3s16 p);
 236         // Wrapper to Map
 237         NodeMetadata* getNodeMetadata(v3s16 p);
 238
 239         Player* getPlayer(const char* name) { return m_env.getPlayer(name);}
 240         LocalPlayer* getLocalPlayer();
 241
 242         void setPlayerControl(PlayerControl &control);
 243
 244         void selectPlayerItem(u16 item);
 245
 246         // Returns true if the inventory of the local player has been
 247         // updated from the server. If it is true, it is set to false.
 248         bool getLocalInventoryUpdated();
 249         // Copies the inventory of the local player to parameter
 250         void getLocalInventory(Inventory &dst);
 251
 252         InventoryContext *getInventoryContext();
 253
 254         Inventory* getInventory(InventoryContext *c, std::string id);
 255         Inventory* getInventory(const InventoryLocation *loc);
 256         void inventoryAction(InventoryAction *a);
 257
 258         // Gets closest object pointed by the shootline
 259         // Returns NULL if not found
 260         ClientActiveObject * getSelectedActiveObject(
 261                         f32 max_d,
 262                         v3f from_pos_f_on_map,
 263                         core::line3d<f32> shootline_on_map
 264         );
 265
 266         // Prints a line or two of info
 267         void printDebugInfo(std::ostream &os);
 268
 269         u16 getHP();
 270         u16 getAir();
 271         u16 getHunger();
 272         float getEnergy();
 273
 274         bool getChatMessage(std::wstring &message)
 275         {
 276                 if(m_chat_queue.size() == 0)
 277                         return false;
 278                 message = m_chat_queue.pop_front();
 279                 return true;
 280         }
 281
 282         void addChatMessage(const std::wstring &message)
 283         {
 284                 if (message[0] == L'/') {
 285                         m_chat_queue.push_back(
 286                                 (std::wstring)L"issued command: "+message);
 287                         return;
 288                 }
 289
 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);
 296         }
 297
 298         uint64_t getMapSeed() {return m_map_seed;}
 299         MapGenType getMapType() {return m_map_type;}
 300
 301         void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool refresh_only=false);
 302         // Including blocks at appropriate edges
 303         void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false);
 304
 305         void updateCameraOffset(v3s16 camera_offset){ m_mesh_update_thread.m_camera_offset = camera_offset; }
 306
 307         // Get event from queue. CE_NONE is returned if queue is empty.
 308         ClientEvent getClientEvent();
 309
 310         inline bool accessDenied()
 311         {
 312                 return m_access_denied;
 313         }
 314
 315         inline std::wstring accessDeniedReason()
 316         {
 317                 return m_access_denied_reason;
 318         }
 319
 320         float getRTT(void);
 321         virtual ISoundManager* getSoundManager();
 322
 323         void playStepSound(int foot);
 324         void playDigSound(content_t c);
 325         void playPlaceSound(content_t c);
 326         void playSound(std::string &name, bool loop);
 327         void playSoundAt(std::string &name, v3f pos, bool loop);
 328
 329         void setPointedNode(v3s16 p) {m_pointed_node = p;}
 330         v3s16 getPointedNode() {return m_pointed_node;}
 331
 332         void setPointedContent(content_t c) {m_pointed_content = c;}
 333         content_t getPointedContent() {return m_pointed_content;}
 334
 335         bool getServerDamage() {return m_server_damage;}
 336         bool getServerSuffocation() {return m_server_suffocation;}
 337         bool getServerHunger() {return m_server_hunger;}
 338
 339         bool getFormState() {return m_form_open;}
 340         void setFormState(bool state) {m_form_open = state;}
 341
 342         u8 getSleepAlpha() {return m_sleep_state*255;}
 343
 344 private:
 345
 346         // Virtual methods from con::PeerHandler
 347         void peerAdded(con::Peer *peer);
 348         void deletingPeer(con::Peer *peer, bool timeout);
 349
 350         void ReceiveAll();
 351         void Receive();
 352
 353         void sendPlayerPos();
 354         // This sends the player's current name etc to the server
 355         void sendPlayerInfo();
 356         // Send the item number 'item' as player item to the server
 357         void sendPlayerItem(u16 item);
 358
 359         void setServerSettings(bool damage, bool suffocation, bool hunger);
 360
 361         float m_packetcounter_timer;
 362         float m_connection_reinit_timer;
 363         float m_avg_rtt_timer;
 364         float m_playerpos_send_timer;
 365         float m_ignore_damage_timer; // Used after server moves player
 366         IntervalLimiter m_map_timer_and_unload_interval;
 367
 368         MeshUpdateThread m_mesh_update_thread;
 369
 370         ClientEnvironment m_env;
 371
 372         // when connecting to a server it will give these via TOCLIENT_SERVERSETTINGS
 373         bool m_server_damage;
 374         bool m_server_suffocation;
 375         bool m_server_hunger;
 376
 377         con::Connection m_con;
 378         ISoundManager *m_sound;
 379
 380         IrrlichtDevice *m_device;
 381
 382         // Server serialization version
 383         u8 m_server_ser_ver;
 384
 385         // This is behind m_env_mutex.
 386         bool m_inventory_updated;
 387
 388         core::map<v3s16, bool> m_active_blocks;
 389         v3s16 m_pointed_node;
 390         content_t m_pointed_content;
 391
 392         PacketCounter m_packetcounter;
 393
 394         bool m_form_open;
 395
 396         Queue<std::wstring> m_chat_queue;
 397
 398         // The seed returned by the server in TOCLIENT_INIT is stored here
 399         uint64_t m_map_seed;
 400         MapGenType m_map_type;
 401
 402         std::string m_password;
 403         bool m_access_denied;
 404         std::wstring m_access_denied_reason;
 405
 406         InventoryContext m_inventory_context;
 407
 408         Queue<ClientEvent> m_client_event_queue;
 409
 410         // time_of_day speed approximation for old protocol
 411         bool m_time_of_day_set;
 412         float m_last_time_of_day_f;
 413         float m_time_of_day_update_timer;
 414
 415         // sleep effects
 416         bool m_sleeping;
 417         bool m_waking;
 418         float m_sleep_state;
 419 };
 420
 421 #endif // !SERVER
 422
 423 #endif // !CLIENT_HEADER
 424