You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
0e5d779438
- will eventually be replaced with a better system #jira UE-146398 #rb Justin.Marcus #rnx #ROBOMERGE-AUTHOR: david.harvey #ROBOMERGE-SOURCE: CL 20258363 via CL 20258366 via CL 20258372 #ROBOMERGE-BOT: UE5 (Release-Engine-Staging -> Main) (v943-19904690) [CL 20262878 by david harvey in ue5-main branch]
163 lines
8.9 KiB
C++
163 lines
8.9 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "InstallBundleTypes.h"
|
|
#include "Misc/EnumClassFlags.h"
|
|
#include "Misc/ConfigCacheIni.h"
|
|
#include "Logging/LogMacros.h"
|
|
#include "Internationalization/Text.h"
|
|
#include "Templates/ValueOrError.h"
|
|
#include "Containers/Union.h"
|
|
|
|
class IAnalyticsProviderET;
|
|
|
|
struct FInstallBundleProgress
|
|
{
|
|
FName BundleName;
|
|
|
|
EInstallBundleStatus Status = EInstallBundleStatus::Requested;
|
|
|
|
EInstallBundlePauseFlags PauseFlags = EInstallBundlePauseFlags::None;
|
|
|
|
float Install_Percent = 0;
|
|
|
|
float Finishing_Percent = 0;
|
|
};
|
|
|
|
struct FInstallBundleRequestResultInfo
|
|
{
|
|
FName BundleName;
|
|
EInstallBundleResult Result = EInstallBundleResult::OK;
|
|
bool bIsStartup = false;
|
|
bool bContentWasInstalled = false;
|
|
|
|
// Currently, these just forward BPT Error info
|
|
FText OptionalErrorText;
|
|
FString OptionalErrorCode;
|
|
};
|
|
|
|
struct FInstallBundlePauseInfo
|
|
{
|
|
FName BundleName;
|
|
EInstallBundlePauseFlags PauseFlags = EInstallBundlePauseFlags::None;
|
|
};
|
|
|
|
struct FInstallBundleReleaseRequestResultInfo
|
|
{
|
|
FName BundleName;
|
|
EInstallBundleReleaseResult Result = EInstallBundleReleaseResult::OK;
|
|
};
|
|
|
|
enum class EInstallBundleManagerInitErrorHandlerResult
|
|
{
|
|
NotHandled, // Defer to the next handler
|
|
Retry, // Try to initialize again
|
|
StopInitialization, // Stop trying to initialize
|
|
};
|
|
|
|
using FInstallBundleSourceOrCache = TUnion<EInstallBundleSourceType, FName>;
|
|
|
|
DECLARE_DELEGATE_RetVal_OneParam(EInstallBundleManagerInitErrorHandlerResult, FInstallBundleManagerInitErrorHandler, EInstallBundleManagerInitResult);
|
|
DECLARE_MULTICAST_DELEGATE_OneParam(FInstallBundleManagerInitCompleteMultiDelegate, EInstallBundleManagerInitResult);
|
|
|
|
DECLARE_MULTICAST_DELEGATE_OneParam(FInstallBundleCompleteMultiDelegate, FInstallBundleRequestResultInfo);
|
|
DECLARE_MULTICAST_DELEGATE_OneParam(FInstallBundlePausedMultiDelegate, FInstallBundlePauseInfo);
|
|
DECLARE_MULTICAST_DELEGATE_OneParam(FInstallBundleReleasedMultiDelegate, FInstallBundleReleaseRequestResultInfo);
|
|
|
|
DECLARE_MULTICAST_DELEGATE_OneParam(FInstallBundleManagerOnPatchCheckComplete, EInstallBundleManagerPatchCheckResult);
|
|
|
|
DECLARE_DELEGATE_RetVal(bool, FInstallBundleManagerEnvironmentWantsPatchCheck);
|
|
|
|
DECLARE_DELEGATE_OneParam(FInstallBundleGetInstallStateDelegate, FInstallBundleCombinedInstallState);
|
|
|
|
DECLARE_DELEGATE(FInstallBundleManagerFlushCacheCompleteDelegate);
|
|
|
|
class INSTALLBUNDLEMANAGER_API IInstallBundleManager : public TSharedFromThis<IInstallBundleManager>
|
|
{
|
|
public:
|
|
static FInstallBundleManagerInitCompleteMultiDelegate InitCompleteDelegate;
|
|
|
|
static FInstallBundleCompleteMultiDelegate InstallBundleCompleteDelegate; // Called when a content request is complete
|
|
static FInstallBundlePausedMultiDelegate PausedBundleDelegate;
|
|
static FInstallBundleReleasedMultiDelegate ReleasedDelegate; // Called when content release request is complete
|
|
static FInstallBundleManagerOnPatchCheckComplete PatchCheckCompleteDelegate;
|
|
|
|
static TSharedPtr<IInstallBundleManager> GetPlatformInstallBundleManager();
|
|
|
|
virtual ~IInstallBundleManager() {}
|
|
|
|
virtual bool HasBundleSource(EInstallBundleSourceType SourceType) const = 0;
|
|
|
|
virtual FDelegateHandle PushInitErrorCallback(FInstallBundleManagerInitErrorHandler Callback) = 0;
|
|
virtual void PopInitErrorCallback() = 0;
|
|
virtual void PopInitErrorCallback(FDelegateHandle Handle) = 0;
|
|
virtual void PopInitErrorCallback(const void* InUserObject) = 0;
|
|
|
|
virtual EInstallBundleManagerInitState GetInitState() const = 0;
|
|
|
|
TValueOrError<FInstallBundleRequestInfo, EInstallBundleResult> RequestUpdateContent(FName BundleName, EInstallBundleRequestFlags Flags, ELogVerbosity::Type LogVerbosityOverride = ELogVerbosity::NoLogging);
|
|
virtual TValueOrError<FInstallBundleRequestInfo, EInstallBundleResult> RequestUpdateContent(TArrayView<const FName> BundleNames, EInstallBundleRequestFlags Flags, ELogVerbosity::Type LogVerbosityOverride = ELogVerbosity::NoLogging) = 0;
|
|
|
|
FDelegateHandle GetContentState(FName BundleName, EInstallBundleGetContentStateFlags Flags, bool bAddDependencies, FInstallBundleGetContentStateDelegate Callback, FName RequestTag = NAME_None);
|
|
virtual FDelegateHandle GetContentState(TArrayView<const FName> BundleNames, EInstallBundleGetContentStateFlags Flags, bool bAddDependencies, FInstallBundleGetContentStateDelegate Callback, FName RequestTag = NAME_None) = 0;
|
|
virtual void CancelAllGetContentStateRequestsForTag(FName RequestTag) = 0;
|
|
virtual void CancelAllGetContentStateRequests(FDelegateHandle Handle) = 0;
|
|
|
|
// Less expensive version of GetContentState() that only returns install state
|
|
// Synchronous versions return null if bundle manager is not yet initialized
|
|
FDelegateHandle GetInstallState(FName BundleName, bool bAddDependencies, FInstallBundleGetInstallStateDelegate Callback, FName RequestTag = NAME_None);
|
|
virtual FDelegateHandle GetInstallState(TArrayView<const FName> BundleNames, bool bAddDependencies, FInstallBundleGetInstallStateDelegate Callback, FName RequestTag = NAME_None) = 0;
|
|
TValueOrError<FInstallBundleCombinedInstallState, EInstallBundleResult> GetInstallStateSynchronous(FName BundleName, bool bAddDependencies) const;
|
|
virtual TValueOrError<FInstallBundleCombinedInstallState, EInstallBundleResult> GetInstallStateSynchronous(TArrayView<const FName> BundleNames, bool bAddDependencies) const = 0;
|
|
virtual void CancelAllGetInstallStateRequestsForTag(FName RequestTag) = 0;
|
|
virtual void CancelAllGetInstallStateRequests(FDelegateHandle Handle) = 0;
|
|
|
|
TValueOrError<FInstallBundleRequestInfo, EInstallBundleResult> RequestReleaseContent(FName ReleaseName, EInstallBundleReleaseRequestFlags Flags, TArrayView<const FName> KeepNames = TArrayView<const FName>(), ELogVerbosity::Type LogVerbosityOverride = ELogVerbosity::NoLogging);
|
|
virtual TValueOrError<FInstallBundleRequestInfo, EInstallBundleResult> RequestReleaseContent(TArrayView<const FName> ReleaseNames, EInstallBundleReleaseRequestFlags Flags, TArrayView<const FName> KeepNames = TArrayView<const FName>(), ELogVerbosity::Type LogVerbosityOverride = ELogVerbosity::NoLogging) = 0;
|
|
|
|
EInstallBundleResult FlushCache(FInstallBundleManagerFlushCacheCompleteDelegate Callback, ELogVerbosity::Type LogVerbosityOverride = ELogVerbosity::NoLogging);
|
|
virtual EInstallBundleResult FlushCache(FInstallBundleSourceOrCache SourceOrCache, FInstallBundleManagerFlushCacheCompleteDelegate Callback, ELogVerbosity::Type LogVerbosityOverride = ELogVerbosity::NoLogging) = 0;
|
|
|
|
virtual TArray<FInstallBundleCacheStats> GetCacheStats(EInstallBundleCacheDumpToLog DumpToLog = EInstallBundleCacheDumpToLog::None, ELogVerbosity::Type LogVerbosityOverride = ELogVerbosity::NoLogging) = 0;
|
|
virtual TOptional<FInstallBundleCacheStats> GetCacheStats(FInstallBundleSourceOrCache SourceOrCache, EInstallBundleCacheDumpToLog DumpToLog = EInstallBundleCacheDumpToLog::None, ELogVerbosity::Type LogVerbosityOverride = ELogVerbosity::NoLogging) = 0;
|
|
|
|
void RequestRemoveContentOnNextInit(FName RemoveName, TArrayView<const FName> KeepNames = TArrayView<const FName>());
|
|
virtual void RequestRemoveContentOnNextInit(TArrayView<const FName> RemoveNames, TArrayView<const FName> KeepNames = TArrayView<const FName>()) = 0;
|
|
|
|
void CancelRequestRemoveContentOnNextInit(FName BundleName);
|
|
virtual void CancelRequestRemoveContentOnNextInit(TArrayView<const FName> BundleNames) = 0;
|
|
|
|
void CancelUpdateContent(FName BundleName);
|
|
virtual void CancelUpdateContent(TArrayView<const FName> BundleNames) = 0;
|
|
|
|
void PauseUpdateContent(FName BundleName);
|
|
virtual void PauseUpdateContent(TArrayView<const FName> BundleNames) = 0;
|
|
|
|
void ResumeUpdateContent(FName BundleName);
|
|
virtual void ResumeUpdateContent(TArrayView<const FName> BundleNames) = 0;
|
|
|
|
virtual void RequestPausedBundleCallback() = 0;
|
|
|
|
virtual TOptional<FInstallBundleProgress> GetBundleProgress(FName BundleName) const = 0;
|
|
|
|
virtual EInstallBundleRequestFlags GetModifyableContentRequestFlags() const = 0;
|
|
void UpdateContentRequestFlags(FName BundleName, EInstallBundleRequestFlags AddFlags, EInstallBundleRequestFlags RemoveFlags);
|
|
virtual void UpdateContentRequestFlags(TArrayView<const FName> BundleNames, EInstallBundleRequestFlags AddFlags, EInstallBundleRequestFlags RemoveFlags) = 0;
|
|
|
|
virtual void StartPatchCheck();
|
|
virtual void AddEnvironmentWantsPatchCheckBackCompatDelegate(FName Tag, FInstallBundleManagerEnvironmentWantsPatchCheck Delegate) {}
|
|
virtual void RemoveEnvironmentWantsPatchCheckBackCompatDelegate(FName Tag) {}
|
|
virtual bool SupportsEarlyStartupPatching() const = 0;
|
|
|
|
virtual bool IsNullInterface() const = 0;
|
|
|
|
virtual void SetErrorSimulationCommands(const FString& CommandLine) {}
|
|
|
|
virtual TSharedPtr<IAnalyticsProviderET> GetAnalyticsProvider() const { return TSharedPtr<IAnalyticsProviderET>(); }
|
|
|
|
virtual void StartSessionPersistentStatTracking(const FString& SessionName, const TArray<FName>& RequiredBundles = TArray<FName>(), const FString& ExpectedAnalyticsID = FString(), bool bForceResetStatData = false, const FInstallBundleCombinedContentState* State = nullptr) {}
|
|
virtual void StopSessionPersistentStatTracking(const FString& SessionName) {}
|
|
};
|
|
|