]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - src/client.h
[CSM] Add minimap API modifiers (#5399)
[dragonfireclient.git] / src / client.h
index efd373e4266db7f707414f0082b73deb223ed182..5c8a0ae25d33128c11ea313a67fd395b9cc67178 100644 (file)
@@ -21,9 +21,9 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #define CLIENT_HEADER
 
 #include "network/connection.h"
-#include "environment.h"
+#include "clientenvironment.h"
 #include "irrlichttypes_extrabloated.h"
-#include "jthread/jmutex.h"
+#include "threading/mutex.h"
 #include <ostream>
 #include <map>
 #include <set>
@@ -34,7 +34,8 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "localplayer.h"
 #include "hud.h"
 #include "particles.h"
-#include "network/networkpacket.h"
+#include "mapnode.h"
+#include "tileanimation.h"
 
 struct MeshMakeData;
 class MapBlockMesh;
@@ -48,8 +49,10 @@ struct MapDrawControl;
 class MtEventManager;
 struct PointedThing;
 class Database;
-class Mapper;
+class Minimap;
 struct MinimapMapblock;
+class Camera;
+class NetworkPacket;
 
 struct QueuedMeshUpdate
 {
@@ -89,14 +92,14 @@ class MeshUpdateQueue
 
        u32 size()
        {
-               JMutexAutoLock lock(m_mutex);
+               MutexAutoLock lock(m_mutex);
                return m_queue.size();
        }
 
 private:
        std::vector<QueuedMeshUpdate*> m_queue;
        std::set<v3s16> m_urgents;
-       JMutex m_mutex;
+       Mutex m_mutex;
 };
 
 struct MeshUpdateResult
@@ -119,19 +122,14 @@ class MeshUpdateThread : public UpdateThread
        MeshUpdateQueue m_queue_in;
 
 protected:
-       const char *getName()
-       { return "MeshUpdateThread"; }
        virtual void doUpdate();
 
 public:
 
-       MeshUpdateThread()
-       {
-       }
+       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;
@@ -144,6 +142,7 @@ enum ClientEventType
        CE_PLAYER_FORCE_MOVE,
        CE_DEATHSCREEN,
        CE_SHOW_FORMSPEC,
+       CE_SHOW_LOCAL_FORMSPEC,
        CE_SPAWN_PARTICLE,
        CE_ADD_PARTICLESPAWNER,
        CE_DELETE_PARTICLESPAWNER,
@@ -186,8 +185,11 @@ struct ClientEvent
                        f32 expirationtime;
                        f32 size;
                        bool collisiondetection;
+                       bool collision_removal;
                        bool vertical;
                        std::string *texture;
+                       struct TileAnimationParams animation;
+                       u8 glow;
                } spawn_particle;
                struct{
                        u16 amount;
@@ -203,9 +205,13 @@ struct ClientEvent
                        f32 minsize;
                        f32 maxsize;
                        bool collisiondetection;
+                       bool collision_removal;
+                       u16 attached_id;
                        bool vertical;
                        std::string *texture;
                        u32 id;
+                       struct TileAnimationParams animation;
+                       u8 glow;
                } add_particlespawner;
                struct{
                        u32 id;
@@ -300,6 +306,8 @@ class PacketCounter
        std::map<u16, u16> m_packets;
 };
 
+class ClientScripting;
+
 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 {
 public:
@@ -323,6 +331,8 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 
        ~Client();
 
+       void initMods();
+
        /*
         request all threads managed by client to be stopped
         */
@@ -403,9 +413,6 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 
        void ProcessData(NetworkPacket *pkt);
 
-       // Returns true if something was received
-       bool AsyncProcessPacket();
-       bool AsyncProcessData();
        void Send(NetworkPacket* pkt);
 
        void interact(u8 action, const PointedThing& pointed);
@@ -423,11 +430,18 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
        void sendRespawn();
        void sendReady();
 
-       ClientEnvironment& getEnv()
-       { return m_env; }
+       ClientEnvironment& getEnv() { return m_env; }
+       ITextureSource *tsrc() { return getTextureSource(); }
+       ISoundManager *sound() { return getSoundManager(); }
+       static const std::string &getBuiltinLuaPath();
+       static const std::string &getClientModsLuaPath();
+
+       virtual const std::vector<ModSpec> &getMods() const;
+       virtual const ModSpec* getModSpec(const std::string &modname) const;
 
        // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
        void removeNode(v3s16 p);
+       MapNode getNode(v3s16 p, bool *is_valid_position);
        void addNode(v3s16 p, MapNode n, bool remove_metadata = true);
 
        void setPlayerControl(PlayerControl &control);
@@ -446,28 +460,19 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
        Inventory* getInventory(const InventoryLocation &loc);
        void inventoryAction(InventoryAction *a);
 
-       // Gets closest object pointed by the shootline
-       // Returns NULL if not found
-       ClientActiveObject * getSelectedActiveObject(
-                       f32 max_d,
-                       v3f from_pos_f_on_map,
-                       core::line3d<f32> shootline_on_map
-       );
-
-       std::list<std::string> getConnectedPlayerNames();
+       const std::list<std::string> &getConnectedPlayerNames()
+       {
+               return m_env.getPlayerNames();
+       }
 
        float getAnimationTime();
 
        int getCrackLevel();
        void setCrack(int level, v3s16 pos);
 
-       void setHighlighted(v3s16 pos, bool show_higlighted);
-       v3s16 getHighlighted(){ return m_highlighted_pos; }
-
        u16 getHP();
-       u16 getBreath();
 
-       bool checkPrivilege(const std::string &priv)
+       bool checkPrivilege(const std::string &priv) const
        { return (m_privileges.count(priv) != 0); }
 
        bool getChatMessage(std::wstring &message);
@@ -486,11 +491,19 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
        // Get event from queue. CE_NONE is returned if queue is empty.
        ClientEvent getClientEvent();
 
-       bool accessDenied()
-       { return m_access_denied; }
+       bool accessDenied() const { return m_access_denied; }
+
+       bool reconnectRequested() const { return m_access_denied_reconnect; }
+
+       void setFatalError(const std::string &reason)
+       {
+               m_access_denied = true;
+               m_access_denied_reason = reason;
+       }
 
-       std::string accessDeniedReason()
-       { return m_access_denied_reason; }
+       // Renaming accessDeniedReason to better name could be good as it's used to
+       // disconnect client when CSM failed.
+       const std::string &accessDeniedReason() const { return m_access_denied_reason; }
 
        bool itemdefReceived()
        { return m_itemdef_received; }
@@ -502,32 +515,45 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
        u8 getProtoVersion()
        { return m_proto_ver; }
 
+       bool connectedToServer()
+       { return m_con.Connected(); }
+
        float mediaReceiveProgress();
 
        void afterContentReceived(IrrlichtDevice *device);
 
-       float getRTT(void);
-       float getCurRate(void);
-       float getAvgRate(void);
+       float getRTT();
+       float getCurRate();
+
+       Minimap* getMinimap() { return m_minimap; }
+       void setCamera(Camera* camera) { m_camera = camera; }
 
-       Mapper* getMapper ()
-       { return m_mapper; }
+       Camera* getCamera ()
+       { return m_camera; }
+
+       bool shouldShowMinimap() const;
+       void setMinimapShownByMod(bool state) { m_minimap_shown_by_mod = state; }
 
        // IGameDef interface
        virtual IItemDefManager* getItemDefManager();
        virtual INodeDefManager* getNodeDefManager();
        virtual ICraftDefManager* getCraftDefManager();
-       virtual ITextureSource* getTextureSource();
+       ITextureSource* getTextureSource();
        virtual IShaderSource* getShaderSource();
-       virtual scene::ISceneManager* getSceneManager();
+       IShaderSource *shsrc() { return getShaderSource(); }
+       scene::ISceneManager* getSceneManager();
        virtual u16 allocateUnknownNodeId(const std::string &name);
        virtual ISoundManager* getSoundManager();
        virtual MtEventManager* getEventManager();
        virtual ParticleManager* getParticleManager();
-       virtual bool checkLocalPrivilege(const std::string &priv)
+       bool checkLocalPrivilege(const std::string &priv)
        { 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);
@@ -540,6 +566,19 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 
        void makeScreenshot(IrrlichtDevice *device);
 
+       inline void pushToChatQueue(const std::wstring &input)
+       {
+               m_chat_queue.push(input);
+       }
+
+       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);
+       }
+
 private:
 
        // Virtual methods from con::PeerHandler
@@ -592,22 +631,29 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
        ParticleManager m_particle_manager;
        con::Connection m_con;
        IrrlichtDevice *m_device;
-       Mapper *m_mapper;
+       Camera *m_camera;
+       Minimap *m_minimap;
+       bool m_minimap_disabled_by_server;
+       bool m_minimap_shown_by_mod;
        // Server serialization version
        u8 m_server_ser_ver;
+
        // Used version of the protocol with server
+       // Values smaller than 25 only mean they are smaller than 25,
+       // and aren't accurate. We simply just don't know, because
+       // the server didn't send the version back then.
+       // If 0, server init hasn't been received yet.
        u8 m_proto_ver;
+
        u16 m_playeritem;
        bool m_inventory_updated;
        Inventory *m_inventory_from_server;
        float m_inventory_from_server_age;
        PacketCounter m_packetcounter;
-       bool m_show_highlighted;
        // Block mesh animation parameters
        float m_animation_time;
        int m_crack_level;
        v3s16 m_crack_pos;
-       v3s16 m_highlighted_pos;
        // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
        //s32 m_daynight_i;
        //u32 m_daynight_ratio;
@@ -630,6 +676,7 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 
 
        bool m_access_denied;
+       bool m_access_denied_reconnect;
        std::string m_access_denied_reason;
        std::queue<ClientEvent> m_client_event_queue;
        bool m_itemdef_received;
@@ -647,18 +694,18 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
        // Sounds
        float m_removed_sounds_check_timer;
        // Mapping from server sound ids to our sound ids
-       std::map<s32, int> m_sounds_server_to_client;
+       UNORDERED_MAP<s32, int> m_sounds_server_to_client;
        // And the other way!
-       std::map<int, s32> m_sounds_client_to_server;
+       UNORDERED_MAP<int, s32> m_sounds_client_to_server;
        // And relations to objects
-       std::map<int, u16> m_sounds_to_objects;
+       UNORDERED_MAP<int, u16> m_sounds_to_objects;
 
        // Privileges
-       std::set<std::string> m_privileges;
+       UNORDERED_SET<std::string> m_privileges;
 
        // Detached inventories
        // key = name
-       std::map<std::string, Inventory*> m_detached_inventories;
+       UNORDERED_MAP<std::string, Inventory*> m_detached_inventories;
 
        // Storage for mesh data for creating multiple instances of the same mesh
        StringMap m_mesh_data;
@@ -674,6 +721,14 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
        // 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;
+
+       DISABLE_CLASS_COPY(Client);
 };
 
 #endif // !CLIENT_HEADER