IInstallBundleSource

Choose your operating system:

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

Public function Virtual

~IInstallBundleSource()

Functions

Name Description

Public function

void

 

AsyncInit

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.

Public function

void

 

AsyncInit_QueryBundleInfo

Currently only called after AsyncInit initialization.

Public function Virtual

void

 

AsyncInit_SetUpdateBundleInfoCallback

Sets callbacks to Install Bundle Manager for dynamically discovered bundles UpdateCallback - Call to add or update bundle info from this source.

Public function Virtual

void

 

CancelBundles

(
    TArrayView< const FName > BundleNam...
)

Cancel the install for the specified bundles.

Public function Virtual

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

Public function Virtual

void

 

CheckForContentPatch

Public function Const

TSet< FName ...

 

GetBundleDependencies

(
    FName InBundleName,
    TSet< FName >* SkippedUnknownB...
)

Finds all dependencies for InBundleName, including InBundleName SkippedUnknownBundles contains any unknown bundles that may have been found

Public function Virtual Const

TOptional< F...

 

GetBundleProgress

(
    FName BundleName
)

Derived classes should implement this if their content install will take a significant amount of time.

Public function Virtual Const

EInstallBund...

 

GetBundleSkipReason

(
    FName BundleName
)

Allows this bundle source to reject bundle requests early, rather than failing them.

Public function

void

 

GetContentState

(
    TArrayView< const FName > BundleNam...,
    EInstallBundleGetContentStateFlags ...,
    FInstallBundleGetContentStateDelega...
)

Gets the state of content on disk BundleNames contains all dependencies and has been deduped

Public function Const

FString

 

GetContentVersion()

Returns content version in a "-" format.

Public function Const

EInstallBund...

 

GetInitState()

Whether this source has been initialized or not.

Public function Virtual Const

EInstallBund...

 

GetModifyableContentRequestFlags()

UpdateContentRequestFlags - Allow some flags to be updated for in flight requests Currently only CheckForCellularDataUsage is supported

Public function Virtual Const

double

 

GetSourceCacheAgeScalar()

Returns a value in the [0.1, 1.0] range that allows bundles using this source to age out of the LRU cache more slowly.

Public function Const

EInstallBund...

 

GetSourceType()

Returns a unique id for this source.

Public function Virtual Const

float

 

GetSourceWeight()

Returns the how this source should be weighted when combined with other sources.

Public function

FInstallBund...

 

Init

Called once by bundle manager after constructing the bundle source Any non-fallback errors returned will cause bundle manager to fail to initialize

Public function Virtual

void

 

OnBundleInfoPruned

(
    FName InBundleName
)

Public function Virtual

void

 

RequestReleaseContent

Notify bundle source that a bundle has been released If EInstallBundleReleaseRequestFlags::RemoveFilesIfPossible is set, the source should remove content from disk if present The source should set bContentWasRemoved to indicate to bundle manager that the bundle content was uninstalled BundleContexts contains all dependencies and has been deduped Bundle manager will not schedule removes at the same time as updates for the same bundle

Public function Virtual

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

Public function

void

 

RequestUpdateContent

Updates content on disk if necessary BundleContexts contains all dependencies and has been deduped

Public function Virtual

void

 

SetErrorSimulationCommands

(
    const FString& CommandLine
)

Called by bundle manager to pass through command line options to simulate errors.

Public function Virtual

void

 

UpdateContentRequestFlags

(
    TArrayView< const FName > BundleNam...,
    EInstallBundleRequestFlags AddFlags,
    EInstallBundleRequestFlags RemoveFl...
)

Public function Virtual

void

 

UserPauseBundles

(
    TArrayView< const FName > BundleNam...
)

User Pause/Resume bundles.

Public function Virtual

void

 

UserResumeBundles

(
    TArrayView< const FName > BundleNam...
)

Classes