Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > InstallBundleManager > IInstallBundleSource

Light Theme

Dark Theme

IInstallBundleSource

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

IInstallBundleSource

References

Module	InstallBundleManager
Header	/Engine/Source/Runtime/InstallBundleManager/Public/InstallBundleSourceInterface.h
Include	#include "InstallBundleSourceInterface.h"

Syntax

class IInstallBundleSource : public TSharedFromThis< IInstallBundleSource >

Destructors

	Name	Description
	~IInstallBundleSource()

Functions

	Name	Description
void	AsyncInit ( FInstallBundleSourceInitDelegate Ca... )	Bundle manager will not call AsyncInit again until the bundle source calls back that it is complete It will be retried indefinitely until init is successful.
void	CancelBundles ( TArrayView< const FName > BundleNam..., EInstallBundleCancelFlags Flags )	Cancel the install for the specified bundles.
bool	CancelRequestRemoveContentOnNextInit ( TArrayView< const FName > BundleNam... )	Call to cancel the removal of any content scheduled for removal the next time the source is initialized Returns true if all bundles were canceled
TOptional< F...	GetBundleProgress ( FName BundleName )	Derived classes should implement this if their content install will take a significant amount of time.
EInstallBund...	GetBundleSkipReason ( FName BundleName )	Allows this bundle source to reject bundle requests early, rather than failing them.
void	GetContentState ( TArrayView< const FName > BundleNam..., EInstallBundleGetContentStateFlags ..., FInstallBundleGetContentStateDelega... )	Gets the state of content on disk BundleNames contains all dependencies and has been deduped
FString	GetContentVersion()	Returns content version in a "-" format.
EInstallBund...	GetInitState()	Whether this source has been initialized or not.
EInstallBund...	GetModifyableContentRequestFlags()	UpdateContentRequestFlags - Allow some flags to be updated for in flight requests Currently only CheckForCellularDataUsage is supported
EInstallBund...	GetSourceType()	Returns a unique id for this source.
float	GetSourceWeight()	Returns the how this source should be weighted when combined with other sources.
FInstallBund...	Init ( TSharedRef< InstallBundleUtil::FCon..., TSharedPtr< IAnalyticsProviderET > ..., TSharedPtr< InstallBundleUtil::Pers... )	Called once by bundle manager after constructing the bundle source Any non-fallback errors returned will cause bundle manager to fail to initialize
bool	RequestRemoveContentOnNextInit ( TArrayView< const FName > RemoveNam... )	Returns true if content is scheduled to be removed the next time the source is initialized BundleNames contains all dependencies and has been deduped
void	RequestUpdateContent ( FRequestUpdateContentBundleContext ... )	Updates content on disk if necessary BundleContexts contains all dependencies and has been deduped
void	SetErrorSimulationCommands ( const FString& CommandLine )	Called by bundle manager to pass through command line options to simulate errors.
void	UpdateContentRequestFlags ( TArrayView< const FName > BundleNam..., EInstallBundleRequestFlags AddFlags, EInstallBundleRequestFlags RemoveFl... )
void	UserPauseBundles ( TArrayView< const FName > BundleNam... )	User Pause/Resume bundles.
void	UserResumeBundles ( TArrayView< const FName > BundleNam... )

Classes

	Name	Description
	FRequestUpdateContentBundleContext

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss