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 > IBuildManifest

Light Theme

Dark Theme

IBuildManifest

Interface to a Build Manifest.

Windows

MacOS

Linux

References

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

Syntax

class IBuildManifest

Remarks

Interface to a Build Manifest.

Destructors

	Name	Description
	~IBuildManifest()	Virtual destructor.

Functions

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

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

Take our survey

Dismiss