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 > BuildPatchServices > Interfaces > IBuildPatchServicesModule

Light Theme

Dark Theme

IBuildPatchServicesModule

Interface for the services manager.

Windows

MacOS

Linux

Inheritance Hierarchy

IModuleInterface

IBuildPatchServicesModule

References

Module	BuildPatchServices
Header	/Engine/Source/Runtime/Online/BuildPatchServices/Public/Interfaces/IBuildPatchServicesModule.h
Include	#include "Interfaces/IBuildPatchServicesModule.h"

Syntax

class IBuildPatchServicesModule : public IModuleInterface

Remarks

Interface for the services manager.

Destructors

	Name	Description
	~IBuildPatchServicesModule()	Virtual destructor.

Functions

	Name	Description
void	CancelAllInstallers ( bool WaitForThreads )	Call to force the exit out of all current installers, optionally blocks until threads have exited and complete delegates are called.
bool	ChunkBuildDirectory ( const BuildPatchServices::FChunkBui... )	Processes a Build directory to create chunks for new data and produce a manifest, saved to the provided cloud directory.
bool	CompactifyCloudDirectory ( const BuildPatchServices::FCompacti... )	Processes a Cloud Directory to identify and delete any orphaned chunks or files.
IBuildInstal...	CreateBuildInstaller ( BuildPatchServices::FBuildInstaller..., FBuildPatchInstallerDelegate OnComp... )	Factory providing construction of a build installer class.
BuildPatchSe...	CreateBuildStatistics ( const IBuildInstallerRef& Installe... )	Factory providing construction of a build statistics class.
BuildPatchSe...	CreatePatchDataEnumeration ( BuildPatchServices::FPatchDataEnume... )	Factory providing construction of a patch data enumeration class.
bool	DiffManifests ( const BuildPatchServices::FDiffMani... )	Takes two manifests as input and outputs the details of the patch.
bool	EnumeratePatchData ( const BuildPatchServices::FPatchDat... )	Saves info for an enumeration of patch data referenced from an input file of known format, to a specified output file.
TSet< FStrin...	GetInstalledPrereqIds()	Gets an array of prerequisite identifiers that are registered as installed on this system.
const TArray...	GetInstallers()	Gets a list of currently active installers
IBuildManife...	LoadManifestFromFile ( const FString& Filename )	Loads a Build Manifest from file and returns the interface
IBuildManife...	MakeManifestFromData ( const TArray< uint8 >& ManifestDat... )	Constructs a Build Manifest from a data
bool	MergeManifests ( const FString& ManifestFilePathA, const FString& ManifestFilePathB, const FString& ManifestFilePathC, const FString& NewVersionString, const FString& SelectionDetailFile... )	Takes two manifests as input, in order to merge together producing a new manifest containing all files.
IBuildPatchS...	OnStartBuildInstall()
bool	OptimiseChunkDelta ( const BuildPatchServices::FChunkDel... )	Process a pair of manifests to produce additional delta data which reduces the patch directly between them.
bool	PackageChunkData ( const BuildPatchServices::FPackageC... )	Packages data referenced by a manifest file into chunkdb files, supporting a maximum filesize per chunkdb.
void	RegisterAppInstallation ( IBuildManifestRef AppManifest, const FString AppInstallDirectory )	Registers an installation on this machine.
bool	SaveManifestToFile ( const FString& Filename, IBuildManifestRef Manifest )	Saves a Build Manifest to file
void	SetAnalyticsProvider ( TSharedPtr< IAnalyticsProvider > An... )	Sets the Analytics provider that will be used to register errors with patch/build installs
void	SetBackupDirectory ( const FString& BackupDir )	Sets the backup directory where files that are being clobbered by repair/patch will be placed.
void	SetCloudDirectories ( TArray< FString > CloudDirs )	Sets the cloud directory list where chunks and manifests will be pulled from and saved to.
void	SetCloudDirectory ( FString CloudDir )	Sets the cloud directory where chunks and manifests will be pulled from and saved to.
void	SetStagingDirectory ( const FString& StagingDir )	Sets the directory used for staging intermediate files.
bool	UnregisterAppInstallation ( const FString AppInstallDirectory )	Unregisters an installation on this machine
bool	VerifyChunkData ( const FString& SearchPath, const FString& OutputFile )	Searches a given directory for chunk and chunkdb files, and verifies their integrity uses the hashes in the files.

Classes

	Name	Description
	FSimpleEvent	Returns an event which fires when we start a new build install.

Deprecated Functions

	Name	Description
bool	EnumerateManifestData ( const FString& ManifestFilePath, const FString& OutputFile, bool bIncludeSizes )	Please use EnumeratePatchData instead.
bool	GenerateChunksManifestFromDirectory ( const BuildPatchServices::FGenerati... )	Please use ChunkBuildDirectory instead.
IBuildManife...	MakeManifestFromJSON ( const FString& ManifestJSON )	MakeManifestFromJSON(const FString& ManifestJSON) has been deprecated. Please use MakeManifestFromData(const TArray& ManifestData) instead.
IBuildInstal...	StartBuildInstall ( BuildPatchServices::FInstallerConfi..., FBuildPatchBoolManifestDelegate OnC... )	StartBuildInstall(BuildPatchServices::FInstallerConfiguration, FBuildPatchBoolManifestDelegate) has been deprecated. Please use CreateBuildInstaller(BuildPatchServices::FBuildInstallerConfiguration, FBuildPatchInstallerDelegate) instead, followed by IBuildInstaller::StartInstallation.
IBuildInstal...	StartBuildInstall ( IBuildManifestPtr CurrentManifest, IBuildManifestPtr InstallManifest, const FString& InstallDirectory, FBuildPatchBoolManifestDelegate OnC..., bool bIsRepair, TSet< FString > InstallTags )	StartBuildInstall(IBuildManifestPtr, IBuildManifestPtr, const FString&, FBuildPatchBoolManifestDelegate, bool, TSet) has been deprecated. Please use CreateBuildInstaller(BuildPatchServices::FBuildInstallerConfiguration, FBuildPatchInstallerDelegate) instead, followed by IBuildInstaller::StartInstallation.
IBuildInstal...	StartBuildInstallStageOnly ( IBuildManifestPtr CurrentManifest, IBuildManifestPtr InstallManifest, const FString& InstallDirectory, FBuildPatchBoolManifestDelegate OnC..., bool bIsRepair, TSet< FString > InstallTags )	StartBuildInstallStageOnly(IBuildManifestPtr, IBuildManifestPtr, const FString&, FBuildPatchBoolManifestDelegate, bool, TSet) has been deprecated. Please use CreateBuildInstaller(BuildPatchServices::FBuildInstallerConfiguration, FBuildPatchInstallerDelegate) instead, followed by IBuildInstaller::StartInstallation.

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

Take our survey

Dismiss