Tooltips: Unify the tooltip[] and list[] description tooltip display functions (...
[oweals/minetest.git] / src / client.h
index dc4469350283b0f48aba91d01ea1fd7d11a97330..b4145c76ff207127c08084f2dfcdb9f29e72e053 100644 (file)
@@ -36,6 +36,9 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "particles.h"
 #include "mapnode.h"
 #include "tileanimation.h"
+#include "mesh_generator_thread.h"
+
+#define CLIENT_CHAT_MESSAGE_LIMIT_PER_10S 10.0f
 
 struct MeshMakeData;
 class MapBlockMesh;
@@ -48,93 +51,18 @@ class ClientMediaDownloader;
 struct MapDrawControl;
 class MtEventManager;
 struct PointedThing;
-class Database;
-class Mapper;
+class MapDatabase;
+class Minimap;
 struct MinimapMapblock;
 class Camera;
 class NetworkPacket;
 
-struct QueuedMeshUpdate
-{
-       v3s16 p;
-       MeshMakeData *data;
-       bool ack_block_to_server;
-
-       QueuedMeshUpdate();
-       ~QueuedMeshUpdate();
-};
-
 enum LocalClientState {
        LC_Created,
        LC_Init,
        LC_Ready
 };
 
-/*
-       A thread-safe queue of mesh update tasks
-*/
-class MeshUpdateQueue
-{
-public:
-       MeshUpdateQueue();
-
-       ~MeshUpdateQueue();
-
-       /*
-               peer_id=0 adds with nobody to send to
-       */
-       void addBlock(v3s16 p, MeshMakeData *data,
-                       bool ack_block_to_server, bool urgent);
-
-       // Returned pointer must be deleted
-       // Returns NULL if queue is empty
-       QueuedMeshUpdate * pop();
-
-       u32 size()
-       {
-               MutexAutoLock lock(m_mutex);
-               return m_queue.size();
-       }
-
-private:
-       std::vector<QueuedMeshUpdate*> m_queue;
-       std::set<v3s16> m_urgents;
-       Mutex m_mutex;
-};
-
-struct MeshUpdateResult
-{
-       v3s16 p;
-       MapBlockMesh *mesh;
-       bool ack_block_to_server;
-
-       MeshUpdateResult():
-               p(-1338,-1338,-1338),
-               mesh(NULL),
-               ack_block_to_server(false)
-       {
-       }
-};
-
-class MeshUpdateThread : public UpdateThread
-{
-private:
-       MeshUpdateQueue m_queue_in;
-
-protected:
-       virtual void doUpdate();
-
-public:
-
-       MeshUpdateThread() : UpdateThread("Mesh") {}
-
-       void enqueueUpdate(v3s16 p, MeshMakeData *data,
-                       bool ack_block_to_server, bool urgent);
-       MutexedQueue<MeshUpdateResult> m_queue_out;
-
-       v3s16 m_camera_offset;
-};
-
 enum ClientEventType
 {
        CE_NONE,
@@ -151,6 +79,7 @@ enum ClientEventType
        CE_HUDCHANGE,
        CE_SET_SKY,
        CE_OVERRIDE_DAY_NIGHT_RATIO,
+       CE_CLOUD_PARAMS,
 };
 
 struct ClientEvent
@@ -247,11 +176,21 @@ struct ClientEvent
                        video::SColor *bgcolor;
                        std::string *type;
                        std::vector<std::string> *params;
+                       bool clouds;
                } set_sky;
                struct{
                        bool do_override;
                        float ratio_f;
                } override_day_night_ratio;
+               struct {
+                       f32 density;
+                       u32 color_bright;
+                       u32 color_ambient;
+                       f32 height;
+                       f32 thickness;
+                       f32 speed_x;
+                       f32 speed_y;
+               } cloud_params;
        };
 };
 
@@ -307,6 +246,7 @@ private:
 };
 
 class ClientScripting;
+struct GameUIFlags;
 
 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 {
@@ -318,7 +258,8 @@ public:
        Client(
                        IrrlichtDevice *device,
                        const char *playername,
-                       std::string password,
+                       const std::string &password,
+                       const std::string &address_name,
                        MapDrawControl &control,
                        IWritableTextureSource *tsrc,
                        IWritableShaderSource *shsrc,
@@ -326,7 +267,8 @@ public:
                        IWritableNodeDefManager *nodedef,
                        ISoundManager *sound,
                        MtEventManager *event,
-                       bool ipv6
+                       bool ipv6,
+                       GameUIFlags *game_ui_flags
        );
 
        ~Client();
@@ -345,9 +287,7 @@ public:
                The name of the local player should already be set when
                calling this, as it is sent in the initialization.
        */
-       void connect(Address address,
-                       const std::string &address_name,
-                       bool is_local_server);
+       void connect(Address address, bool is_local_server);
 
        /*
                Stuff that references the environment is valid only as
@@ -383,16 +323,14 @@ public:
        void handleCommand_HP(NetworkPacket* pkt);
        void handleCommand_Breath(NetworkPacket* pkt);
        void handleCommand_MovePlayer(NetworkPacket* pkt);
-       void handleCommand_PlayerItem(NetworkPacket* pkt);
        void handleCommand_DeathScreen(NetworkPacket* pkt);
        void handleCommand_AnnounceMedia(NetworkPacket* pkt);
        void handleCommand_Media(NetworkPacket* pkt);
-       void handleCommand_ToolDef(NetworkPacket* pkt);
        void handleCommand_NodeDef(NetworkPacket* pkt);
-       void handleCommand_CraftItemDef(NetworkPacket* pkt);
        void handleCommand_ItemDef(NetworkPacket* pkt);
        void handleCommand_PlaySound(NetworkPacket* pkt);
        void handleCommand_StopSound(NetworkPacket* pkt);
+       void handleCommand_FadeSound(NetworkPacket *pkt);
        void handleCommand_Privileges(NetworkPacket* pkt);
        void handleCommand_InventoryFormSpec(NetworkPacket* pkt);
        void handleCommand_DetachedInventory(NetworkPacket* pkt);
@@ -406,6 +344,7 @@ public:
        void handleCommand_HudSetFlags(NetworkPacket* pkt);
        void handleCommand_HudSetParam(NetworkPacket* pkt);
        void handleCommand_HudSetSky(NetworkPacket* pkt);
+       void handleCommand_CloudParams(NetworkPacket* pkt);
        void handleCommand_OverrideDayNightRatio(NetworkPacket* pkt);
        void handleCommand_LocalPlayerAnimations(NetworkPacket* pkt);
        void handleCommand_EyeOffset(NetworkPacket* pkt);
@@ -423,6 +362,7 @@ public:
                const StringMap &fields);
        void sendInventoryAction(InventoryAction *a);
        void sendChatMessage(const std::wstring &message);
+       void clearOutChatQueue();
        void sendChangePassword(const std::string &oldpassword,
                const std::string &newpassword);
        void sendDamage(u8 damage);
@@ -468,6 +408,7 @@ public:
        float getAnimationTime();
 
        int getCrackLevel();
+       v3s16 getCrackPos();
        void setCrack(int level, v3s16 pos);
 
        u16 getHP();
@@ -488,7 +429,8 @@ public:
        void updateCameraOffset(v3s16 camera_offset)
        { m_mesh_update_thread.m_camera_offset = camera_offset; }
 
-       // Get event from queue. CE_NONE is returned if queue is empty.
+       bool hasClientEvents() const { return !m_client_event_queue.empty(); }
+       // Get event from queue. If queue is empty, it triggers an assertion failure.
        ClientEvent getClientEvent();
 
        bool accessDenied() const { return m_access_denied; }
@@ -522,21 +464,15 @@ public:
 
        void afterContentReceived(IrrlichtDevice *device);
 
-       float getRTT(void);
-       float getCurRate(void);
-       float getAvgRate(void);
+       float getRTT();
+       float getCurRate();
 
-       Mapper* getMapper ()
-       { return m_mapper; }
+       Minimap* getMinimap() { return m_minimap; }
+       void setCamera(Camera* camera) { m_camera = camera; }
 
-       void setCamera(Camera* camera)
-       { m_camera = camera; }
+       Camera* getCamera () { return m_camera; }
 
-       Camera* getCamera ()
-       { return m_camera; }
-
-       bool isMinimapDisabledByServer()
-       { return m_minimap_disabled_by_server; }
+       bool shouldShowMinimap() const;
 
        // IGameDef interface
        virtual IItemDefManager* getItemDefManager();
@@ -554,13 +490,15 @@ public:
        { return checkPrivilege(priv); }
        virtual scene::IAnimatedMesh* getMesh(const std::string &filename);
 
+       virtual std::string getModStoragePath() const;
+       virtual bool registerModStorage(ModMetadata *meta);
+       virtual void unregisterModStorage(const std::string &name);
+
        // The following set of functions is used by ClientMediaDownloader
        // Insert a media file appropriately into the appropriate manager
        bool loadMedia(const std::string &data, const std::string &filename);
        // Send a request for conventional media transfer
        void request_media(const std::vector<std::string> &file_requests);
-       // Send a notification that no conventional media transfer is needed
-       void received_media();
 
        LocalClientState getState() { return m_state; }
 
@@ -572,12 +510,32 @@ public:
        }
 
        ClientScripting *getScript() { return m_script; }
+       const bool moddingEnabled() const { return m_modding_enabled; }
 
        inline void pushToEventQueue(const ClientEvent &event)
        {
                m_client_event_queue.push(event);
        }
 
+       void showGameChat(const bool show = true);
+       void showGameHud(const bool show = true);
+       void showMinimap(const bool show = true);
+       void showProfiler(const bool show = true);
+       void showGameFog(const bool show = true);
+       void showGameDebug(const bool show = true);
+
+       IrrlichtDevice *getDevice() const { return m_device; }
+
+       const Address getServerAddress()
+       {
+               return m_con.GetPeerAddress(PEER_ID_SERVER);
+       }
+
+       const std::string &getAddressName() const
+       {
+               return m_address_name;
+       }
+
 private:
 
        // Virtual methods from con::PeerHandler
@@ -610,6 +568,8 @@ private:
        inline std::string getPlayerName()
        { return m_env.getLocalPlayer()->getName(); }
 
+       bool canSendChatMessage() const;
+
        float m_packetcounter_timer;
        float m_connection_reinit_timer;
        float m_avg_rtt_timer;
@@ -629,9 +589,10 @@ private:
        ClientEnvironment m_env;
        ParticleManager m_particle_manager;
        con::Connection m_con;
+       std::string m_address_name;
        IrrlichtDevice *m_device;
        Camera *m_camera;
-       Mapper *m_mapper;
+       Minimap *m_minimap;
        bool m_minimap_disabled_by_server;
        // Server serialization version
        u8 m_server_ser_ver;
@@ -656,6 +617,9 @@ private:
        //s32 m_daynight_i;
        //u32 m_daynight_ratio;
        std::queue<std::wstring> m_chat_queue;
+       std::queue<std::wstring> m_out_chat_queue;
+       u32 m_last_chat_message_sent;
+       float m_chat_message_allowance;
 
        // The authentication methods we can use to enter sudo mode (=change password)
        u32 m_sudo_auth_methods;
@@ -712,17 +676,17 @@ private:
        LocalClientState m_state;
 
        // Used for saving server map to disk client-side
-       Database *m_localdb;
+       MapDatabase *m_localdb;
        IntervalLimiter m_localdb_save_interval;
        u16 m_cache_save_interval;
 
-       // TODO: Add callback to update these when g_settings changes
-       bool m_cache_smooth_lighting;
-       bool m_cache_enable_shaders;
-       bool m_cache_use_tangent_vertices;
-
        ClientScripting *m_script;
+       bool m_modding_enabled;
+       UNORDERED_MAP<std::string, ModMetadata *> m_mod_storages;
+       float m_mod_storage_save_timer;
+       GameUIFlags *m_game_ui_flags;
 
+       bool m_shutdown;
        DISABLE_CLASS_COPY(Client);
 };