IBuildManifest | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/BuildPatchServices

Interface to a Build Manifest.


Name	IBuildManifest
Type	class
Header File	/Engine/Source/Runtime/Online/BuildPatchServices/Public/Interfaces/IBuildManifest.h
Include Path	#include "Interfaces/IBuildManifest.h"

Syntax

class IBuildManifest

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~IBuildManifest()	Virtual destructor.	Interfaces/IBuildManifest.h

Functions

Public

Name	Remarks	Include Path
void CopyCustomFields ( const IBuildManifestRef& Other, bool bClobber )	Copy the custom fields from another manifest into this one.	Interfaces/IBuildManifest.h
IBuildManifestRef Duplicate ()	Duplicated this manifest to create a copy.	Interfaces/IBuildManifest.h
uint32 GetAppID()	Get the App ID that this manifest belongs to	Interfaces/IBuildManifest.h
const FString & GetAppName()	Get the name of the App that this manifest belongs to	Interfaces/IBuildManifest.h
TArray< FString > GetBuildFileList ()	Get the list of files in this build. Filenames are all relative to an install directory	Interfaces/IBuildManifest.h
TArray< FString > GetBuildFileList ( const TSet< FString >& Tags ) const	Get the list of files in this build which match a tag from a given set.	Interfaces/IBuildManifest.h
TArray< FStringView > GetBuildFileListView ()	Get the list of files in this build.	Interfaces/IBuildManifest.h
TArray< FStringView > GetBuildFileListView ( const TSet< FString >& Tags ) const	Get the list of files in this build which match a tag from a given set.	Interfaces/IBuildManifest.h
int64 GetBuildSize ()	Get the size of this build	Interfaces/IBuildManifest.h
int64 GetBuildSize ( const TSet< FString >& Tags ) const	Get the size of the build of this set of tags	Interfaces/IBuildManifest.h
const IManifestFieldPtr GetCustomField ( const FString& FieldName ) const	Get a custom field from the manifest	Interfaces/IBuildManifest.h
int64 GetDeltaDownloadSize ( const TSet< FString >& Tags, const IBuildManifestRef& PreviousVersion, const TSet< FString >& PreviousTags ) const	Get the size of the download of this set of tags	Interfaces/IBuildManifest.h
int64 GetDeltaDownloadSize ( const TSet< FString >& Tags, const IBuildManifestRef& PreviousVersion ) const	Get the size of the download of this set of tags	Interfaces/IBuildManifest.h
int64 GetDownloadSize ( const TSet< FString >& Tags ) const	Get the size of the download of this set of tags	Interfaces/IBuildManifest.h
int64 GetDownloadSize ()	Get the size of this download, assuming fresh install	Interfaces/IBuildManifest.h
bool GetFileHash ( const FString& Filename, FSHAHash& OutHash ) const	Gets the file hash for a given file	Interfaces/IBuildManifest.h
int64 GetFileSize ( const TSet< FString >& Filenames ) const	Returns the total size of all files in the set	Interfaces/IBuildManifest.h
int64 GetFileSize ( const TArray< FString >& Filenames ) const	Returns the total size of all files in the array	Interfaces/IBuildManifest.h
int64 GetFileSize ( FStringView Filename ) const	Returns the size of a particular file in the build	Interfaces/IBuildManifest.h
void GetFileTagList ( TSet< FString >& Tags ) const	Get the list of install tags in this manifest	Interfaces/IBuildManifest.h
TSet< FString > GetFileTagList ()	Get the list of install tags in this manifest	Interfaces/IBuildManifest.h
const FString & GetLaunchCommand()	Get the command line arguments that the launch exe should be ran with	Interfaces/IBuildManifest.h
const FString & GetLaunchExe()	Get the local install path to the exe that launches the App	Interfaces/IBuildManifest.h
void GetOutdatedFiles ( const IBuildManifestRef& OldManifest, TSet< FString >& OutdatedFiles ) const	Gets a list of files that were installed with the Old Manifest, but no longer required by this Manifest.	Interfaces/IBuildManifest.h
const FString & GetPrereqArgs()	Get the command line arguments that should be passed to the prerequisites installer	Interfaces/IBuildManifest.h
const TSet< FString > & GetPrereqIds()	Get the list of prereq ids that the prereq installer of this manifest satisfies	Interfaces/IBuildManifest.h
const FString & GetPrereqName()	Get the name of the prerequisites installer for the app	Interfaces/IBuildManifest.h
const FString & GetPrereqPath()	Get the path to the prerequisites installer exe	Interfaces/IBuildManifest.h
void GetRemovableFiles ( const IBuildManifestRef& OldManifest, TArray< FString >& RemovableFiles ) const	Gets a list of files that were installed with the Old Manifest, but no longer required by this Manifest.	Interfaces/IBuildManifest.h
void GetRemovableFiles ( const TCHAR* InstallPath, TArray< FString >& RemovableFiles ) const	Gets a list of files that are installed in InstallPath, but no longer required by this Manifest.	Interfaces/IBuildManifest.h
const FString & GetVersionString()	Get the string App version that this manifest describes	Interfaces/IBuildManifest.h
bool NeedsResaving()	Checks the manifest format version to see if this manifest was loaded from latest data	Interfaces/IBuildManifest.h
void RemoveCustomField ( const FString& FieldName )	Remove a custom field from the manifest	Interfaces/IBuildManifest.h
const IManifestFieldPtr SetCustomField ( const FString& FieldName, const FString& Value )	Various functions for setting a custom field in the manifest	Interfaces/IBuildManifest.h
const IManifestFieldPtr SetCustomField ( const FString& FieldName, const double& Value )		Interfaces/IBuildManifest.h
const IManifestFieldPtr SetCustomField ( const FString& FieldName, const int64& Value )		Interfaces/IBuildManifest.h

Navigation

Syntax

Destructors

Functions

Public