UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IInstallBundleSource Class Referenceabstract

#include <InstallBundleSourceInterface.h>

+ Inheritance diagram for IInstallBundleSource:

Classes

struct  FRequestReleaseContentBundleContext
 
struct  FRequestUpdateContentBundleContext
 

Public Member Functions

virtual ~IInstallBundleSource ()
 
virtual FInstallBundleSourceType GetSourceType () const =0
 
virtual float GetSourceWeight () const
 
virtual double GetSourceCacheAgeScalar () const
 
virtual FInstallBundleSourceInitInfo Init (TSharedRef< InstallBundleUtil::FContentRequestStatsMap > InRequestStats, TSharedPtr< IAnalyticsProviderET > AnalyticsProvider, TSharedPtr< InstallBundleUtil::PersistentStats::FPersistentStatContainerBase > PersistentStatsContainer)=0
 
virtual void AsyncInit (FInstallBundleSourceInitDelegate Callback)=0
 
virtual void AsyncInit_QueryBundleInfo (FInstallBundleSourceQueryBundleInfoDelegate OnCompleteCallback)=0
 
virtual void AsyncInit_SetUpdateBundleInfoCallback (FInstallBundleSourceUpdateBundleInfoDelegate UpdateCallback, FInstallBundleLostRelevanceForSourceDelegate LostRelevanceCallback)
 
virtual void OnBundleInfoPruned (FName InBundleName)
 
virtual EInstallBundleManagerInitState GetInitState () const =0
 
virtual FString GetContentVersion () const =0
 
virtual TSet< FNameGetBundleDependencies (FName InBundleName, TSet< FName > *SkippedUnknownBundles=nullptr) const =0
 
virtual void GetContentState (TArrayView< const FName > BundleNames, EInstallBundleGetContentStateFlags Flags, FInstallBundleGetContentStateDelegate Callback)=0
 
virtual EInstallBundleSourceBundleSkipReason GetBundleSkipReason (FName BundleName) const
 
virtual void RequestUpdateContent (FRequestUpdateContentBundleContext BundleContext)=0
 
virtual void RequestReleaseContent (FRequestReleaseContentBundleContext BundleContext)
 
virtual bool RequestRemoveContentOnNextInit (TArrayView< const FName > RemoveNames)
 
virtual bool CancelRequestRemoveContentOnNextInit (TArrayView< const FName > BundleNames)
 
virtual TArray< FNameGetRequestedRemoveContentOnNextInit () const
 
virtual void CancelBundles (TArrayView< const FName > BundleNames)
 
virtual void CancelBundles (TArrayView< const FName > BundleNames, TArray< FName > &OutAdditionalBunldlesToCancel)
 
virtual void UserPauseBundles (TArrayView< const FName > BundleNames)
 
virtual void UserResumeBundles (TArrayView< const FName > BundleNames)
 
virtual EInstallBundleRequestFlags GetModifyableContentRequestFlags () const
 
virtual void UpdateContentRequestFlags (TArrayView< const FName > BundleNames, EInstallBundleRequestFlags AddFlags, EInstallBundleRequestFlags RemoveFlags)
 
virtual void SetCellularPreference (int32 Value)
 
virtual TOptional< FInstallBundleSourceProgressGetBundleProgress (FName BundleName) const
 
virtual TArray< FBuildInstallerStat > & GetBundleUpdateStats (FName BundleName)
 
virtual void CheckForContentPatch (FInstallBundleSourceContentPatchResultDelegate Callback)
 
virtual void SetErrorSimulationCommands (const FString &CommandLine)
 
virtual void GetDebugText (TArray< FString > &Output)
 
virtual bool SupportsReportingDelegate () const
 
virtual void SetReportingDelegate (FInstallBundleReportingDelegate Delegate)
 
virtual bool SupportsBundleRequestEventDelegates () const
 
virtual void SetBundleRequestStartedDelegate (FInstallBundleRequestStartedDelegate Delegate)
 
virtual void SetBundleRequestCompletedDelegate (FInstallBundleRequestCompletedDelegate Delegate)
 
- Public Member Functions inherited from TSharedFromThis< IInstallBundleSource >
TSharedRef< IInstallBundleSource, Mode > AsShared ()
 
TSharedRef< IInstallBundleSource const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< IInstallBundleSource, Mode > AsWeak ()
 
TWeakPtr< IInstallBundleSource const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Additional Inherited Members

- Protected Member Functions inherited from TSharedFromThis< IInstallBundleSource >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Static Protected Member Functions inherited from TSharedFromThis< IInstallBundleSource >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Constructor & Destructor Documentation

◆ ~IInstallBundleSource()

virtual IInstallBundleSource::~IInstallBundleSource ( )
inlinevirtual

Member Function Documentation

◆ AsyncInit()

virtual void IInstallBundleSource::AsyncInit ( FInstallBundleSourceInitDelegate  Callback)
pure virtual

◆ AsyncInit_QueryBundleInfo()

virtual void IInstallBundleSource::AsyncInit_QueryBundleInfo ( FInstallBundleSourceQueryBundleInfoDelegate  OnCompleteCallback)
pure virtual

◆ AsyncInit_SetUpdateBundleInfoCallback()

virtual void IInstallBundleSource::AsyncInit_SetUpdateBundleInfoCallback ( FInstallBundleSourceUpdateBundleInfoDelegate  UpdateCallback,
FInstallBundleLostRelevanceForSourceDelegate  LostRelevanceCallback 
)
inlinevirtual

◆ CancelBundles() [1/2]

virtual void IInstallBundleSource::CancelBundles ( TArrayView< const FName BundleNames)
inlinevirtual

◆ CancelBundles() [2/2]

virtual void IInstallBundleSource::CancelBundles ( TArrayView< const FName BundleNames,
TArray< FName > &  OutAdditionalBunldlesToCancel 
)
inlinevirtual

◆ CancelRequestRemoveContentOnNextInit()

virtual bool IInstallBundleSource::CancelRequestRemoveContentOnNextInit ( TArrayView< const FName BundleNames)
inlinevirtual

◆ CheckForContentPatch()

virtual void IInstallBundleSource::CheckForContentPatch ( FInstallBundleSourceContentPatchResultDelegate  Callback)
inlinevirtual

◆ GetBundleDependencies()

virtual TSet< FName > IInstallBundleSource::GetBundleDependencies ( FName  InBundleName,
TSet< FName > *  SkippedUnknownBundles = nullptr 
) const
pure virtual

◆ GetBundleProgress()

virtual TOptional< FInstallBundleSourceProgress > IInstallBundleSource::GetBundleProgress ( FName  BundleName) const
inlinevirtual

◆ GetBundleSkipReason()

virtual EInstallBundleSourceBundleSkipReason IInstallBundleSource::GetBundleSkipReason ( FName  BundleName) const
inlinevirtual

◆ GetBundleUpdateStats()

virtual TArray< FBuildInstallerStat > & IInstallBundleSource::GetBundleUpdateStats ( FName  BundleName)
inlinevirtual

◆ GetContentState()

virtual void IInstallBundleSource::GetContentState ( TArrayView< const FName BundleNames,
EInstallBundleGetContentStateFlags  Flags,
FInstallBundleGetContentStateDelegate  Callback 
)
pure virtual

◆ GetContentVersion()

virtual FString IInstallBundleSource::GetContentVersion ( ) const
pure virtual

◆ GetDebugText()

virtual void IInstallBundleSource::GetDebugText ( TArray< FString > &  Output)
inlinevirtual

◆ GetInitState()

virtual EInstallBundleManagerInitState IInstallBundleSource::GetInitState ( ) const
pure virtual

◆ GetModifyableContentRequestFlags()

virtual EInstallBundleRequestFlags IInstallBundleSource::GetModifyableContentRequestFlags ( ) const
inlinevirtual

◆ GetRequestedRemoveContentOnNextInit()

virtual TArray< FName > IInstallBundleSource::GetRequestedRemoveContentOnNextInit ( ) const
inlinevirtual

◆ GetSourceCacheAgeScalar()

virtual double IInstallBundleSource::GetSourceCacheAgeScalar ( ) const
inlinevirtual

◆ GetSourceType()

virtual FInstallBundleSourceType IInstallBundleSource::GetSourceType ( ) const
pure virtual

◆ GetSourceWeight()

virtual float IInstallBundleSource::GetSourceWeight ( ) const
inlinevirtual

◆ Init()

virtual FInstallBundleSourceInitInfo IInstallBundleSource::Init ( TSharedRef< InstallBundleUtil::FContentRequestStatsMap InRequestStats,
TSharedPtr< IAnalyticsProviderET >  AnalyticsProvider,
TSharedPtr< InstallBundleUtil::PersistentStats::FPersistentStatContainerBase PersistentStatsContainer 
)
pure virtual

◆ OnBundleInfoPruned()

virtual void IInstallBundleSource::OnBundleInfoPruned ( FName  InBundleName)
inlinevirtual

◆ RequestReleaseContent()

virtual void IInstallBundleSource::RequestReleaseContent ( FRequestReleaseContentBundleContext  BundleContext)
inlinevirtual

◆ RequestRemoveContentOnNextInit()

virtual bool IInstallBundleSource::RequestRemoveContentOnNextInit ( TArrayView< const FName RemoveNames)
inlinevirtual

◆ RequestUpdateContent()

virtual void IInstallBundleSource::RequestUpdateContent ( FRequestUpdateContentBundleContext  BundleContext)
pure virtual

◆ SetBundleRequestCompletedDelegate()

virtual void IInstallBundleSource::SetBundleRequestCompletedDelegate ( FInstallBundleRequestCompletedDelegate  Delegate)
inlinevirtual

◆ SetBundleRequestStartedDelegate()

virtual void IInstallBundleSource::SetBundleRequestStartedDelegate ( FInstallBundleRequestStartedDelegate  Delegate)
inlinevirtual

◆ SetCellularPreference()

virtual void IInstallBundleSource::SetCellularPreference ( int32  Value)
inlinevirtual

◆ SetErrorSimulationCommands()

virtual void IInstallBundleSource::SetErrorSimulationCommands ( const FString &  CommandLine)
inlinevirtual

◆ SetReportingDelegate()

virtual void IInstallBundleSource::SetReportingDelegate ( FInstallBundleReportingDelegate  Delegate)
inlinevirtual

◆ SupportsBundleRequestEventDelegates()

virtual bool IInstallBundleSource::SupportsBundleRequestEventDelegates ( ) const
inlinevirtual

◆ SupportsReportingDelegate()

virtual bool IInstallBundleSource::SupportsReportingDelegate ( ) const
inlinevirtual

◆ UpdateContentRequestFlags()

virtual void IInstallBundleSource::UpdateContentRequestFlags ( TArrayView< const FName BundleNames,
EInstallBundleRequestFlags  AddFlags,
EInstallBundleRequestFlags  RemoveFlags 
)
inlinevirtual

◆ UserPauseBundles()

virtual void IInstallBundleSource::UserPauseBundles ( TArrayView< const FName BundleNames)
inlinevirtual

◆ UserResumeBundles()

virtual void IInstallBundleSource::UserResumeBundles ( TArrayView< const FName BundleNames)
inlinevirtual

The documentation for this class was generated from the following file: