WorkshopDownloads.hpp

Go to the documentation of this file.

#pragma once
 
#include "Host/EngineInterfaces.hpp"
#include "Host/Workshop/DownloadQueue.hpp"
 
#include <VoltMod/Core/Signals/Subscription.hpp>
#include <VoltMod/Engine/GameData/Bindings.hpp>
#include <VoltMod/Host/IPluginAddons.hpp>
#include <cstdint>
#include <vector>
 
namespace VoltMod
{
 
/**
 * The workshop addons connecting clients must download, for every plugin at once: one set of hooks
 * and one list, so an addon two plugins require downloads once. One addon per reconnect; see
 * @ref workshop_guide. Game thread only.
 */
class WorkshopDownloads final : public IPluginAddons
{
public:
    /** Unbound @p bindings or a listen server downloads nothing. @p bindings must outlive this. */
    WorkshopDownloads(const Bindings& bindings, const EngineInterfaces& engine);
 
    /** Require @p addonId of every client until a matching @ref Remove; false when nothing was added. */
    bool Add(uint64_t addonId) override;
    void Remove(uint64_t addonId) override;
 
    /** Whether @p slot has every required addon. */
    bool IsReady(int slot) override;
 
    /** A reconnect is the only sign a download finished. */
    void OnClientConnected(int64_t steamId);
 
    /** A player who really left, not one moved by a map change. */
    void OnClientDisconnected(int64_t steamId);
 
    /** Runs the kicks queued last frame: kicking inside the send hook crashes on Windows. */
    void OnFrame();
 
private:
    Status Install();
    void RemoveHooksIfUnused();
 
    void OnJoinMessage(const CNetMessage* message, void* client);
    /** Add @p client's addons to the server's list for its connection reply, then remove them. */
    void AddToReply(CNetworkGameServerBase& server, const EngineClient* client);
    void RestoreReply(CNetworkGameServerBase& server);
 
    struct Kick
    {
        int Slot = -1;
        int64_t SteamId = 0;
    };
 
    IVEngineServer2* _engine;
    const Bindings& _bindings;
    DownloadQueue _queue;
    std::vector<Kick> _kicks;
    std::vector<uint64_t> _addedToReply;
    Subscription _joinMessageHook;      ///< tells a client what to download
    Subscription _connectionReplyHook;  ///< tells a client what to mount
};
 
}  // namespace VoltMod