1. Epic GamesDeveloper
  3. IBuildManifest

IBuildManifest

Interface to a Build Manifest.

Unreal Engine C++ API Reference > Runtime > BuildPatchServices > Interfaces

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

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Public function void

CopyCustomFields ( const IBuildManifestRef& Other,
bool bClobber
)

 Copy the custom fields from another manifest into this one.
Public function Const IBuildManifestRef Duplicated this manifest to create a copy.
Public function Const uint32 Get the App ID that this manifest belongs to
Public function Const const FString & Get the name of the App that this manifest belongs to
Public function Const TArray< FString >

GetBuildFileList ( const TSet< FString >& Tags
)

 Get the list of files in this build which match a tag from a given set.
Public function Const TArray< FString > Get the list of files in this build. Filenames are all relative to an install directory
Public function Const TArray< FStringView > Get the list of files in this build.
Public function Const int64 Get the size of this build
Public function Const int64

GetBuildSize ( const TSet< FString >& Tags
)

 Get the size of the build of this set of tags
Public function Const const IManifestFieldPtr

GetCustomField ( const FString& FieldName
)

 Get a custom field from the manifest
Public function Const int64

GetDeltaDownloadSize ( const TSet< FString >& Tags,
const IBuildManifestRef& PreviousVersion,
const TSet< FString >& PreviousTags
)

 Get the size of the download of this set of tags
Public function Const int64

GetDeltaDownloadSize ( const TSet< FString >& Tags,
const IBuildManifestRef& PreviousVersion
)

 Get the size of the download of this set of tags
Public function Const int64

GetDownloadSize ( const TSet< FString >& Tags
)

 Get the size of the download of this set of tags
Public function Const int64 Get the size of this download, assuming fresh install
Public function Const bool

GetFileHash ( const FString& Filename,
FSHAHash& OutHash
)

 Gets the file hash for a given file
Public function Const int64

GetFileSize ( const TSet< FString >& Filenames
)

 Returns the total size of all files in the set
Public function Const int64

GetFileSize ( const TArray< FString >& Filenames
)

 Returns the total size of all files in the array
Public function Const int64

GetFileSize ( const FString& Filename
)

 Returns the size of a particular file in the build
Public function Const void

GetFileTagList ( TSet< FString >& Tags
)

 Get the list of install tags in this manifest
Public function Const TSet< FString > Get the list of install tags in this manifest
Public function Const const FString & Get the command line arguments that the launch exe should be ran with
Public function Const const FString & Get the local install path to the exe that launches the App
Public function Const void

GetOutdatedFiles ( const IBuildManifestRef& OldManifest,
TSet< FString >& OutdatedFiles
)

 Gets a list of files that were installed with the Old Manifest, but no longer required by this Manifest.
Public function Const const FString & Get the command line arguments that should be passed to the prerequisites installer
Public function Const const TSet< FString > & Get the list of prereq ids that the prereq installer of this manifest satisfies
Public function Const const FString & Get the name of the prerequisites installer for the app
Public function Const const FString & Get the path to the prerequisites installer exe
Public function Const void

GetRemovableFiles ( const IBuildManifestRef& OldManifest,
TArray< FString >& RemovableFiles
)

 Gets a list of files that were installed with the Old Manifest, but no longer required by this Manifest.
Public function Const 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.
Public function Const const FString & Get the string App version that this manifest describes
Public function Const bool Checks the manifest format version to see if this manifest was loaded from latest data
Public function void

RemoveCustomField ( const FString& FieldName
)

 Remove a custom field from the manifest
Public function const IManifestFieldPtr

SetCustomField ( const FString& FieldName,
const FString& Value
)

 Various functions for setting a custom field in the manifest
Public function const IManifestFieldPtr

SetCustomField ( const FString& FieldName,
const double& Value
)

  
Public function const IManifestFieldPtr

SetCustomField ( const FString& FieldName,
const int64& Value
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page