UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
BuildPatchServices::FPrerequisites Class Reference
+ Inheritance diagram for BuildPatchServices::FPrerequisites:

Public Member Functions

 FPrerequisites (IMachineConfig *MachineConfig, IInstallerAnalytics *InstallerAnalytics, IInstallerError *InstallerError, IFileSystem *FileSystem, IPlatform *Platform)
 
bool RunPrereqs (const IBuildManifestSet *ManifestSet, const FBuildInstallerConfiguration &Configuration, const FString &InstallStagingDir, FBuildPatchProgress &BuildProgress) override
 
- Public Member Functions inherited from BuildPatchServices::IPrerequisites
virtual ~IPrerequisites ()
 

Constructor & Destructor Documentation

◆ FPrerequisites()

BuildPatchServices::FPrerequisites::FPrerequisites ( IMachineConfig *  MachineConfig,
IInstallerAnalytics *  InstallerAnalytics,
IInstallerError *  InstallerError,
IFileSystem *  FileSystem,
IPlatform *  Platform 
)

Constructor with configuration values.

Parameters
MachineConfigA class responsible for loading and saving per machine configuration data.
InstallerAnalyticsA pointer to the analytics object used to record analytics events about the installation.
InstallerErrorA pointer to the class used to record errors during installation.
FileSystemA pointer to a filesystem abstraction used to interact with the filesystem.
PlatformA pointer to a platform abstraction used to perform platform operations.

Member Function Documentation

◆ RunPrereqs()

bool BuildPatchServices::FPrerequisites::RunPrereqs ( const IBuildManifestSet *  ManifestSet,
const FBuildInstallerConfiguration &  Configuration,
const FString &  InstallStagingDir,
FBuildPatchProgress &  BuildProgress 
)
overridevirtual

Runs any prerequisites associated with the installation.

Parameters
BuildManifestThe manifest containing details of the prerequisite installer.
ConfigurationThe installer configuration structure.
InstallStagingDirThe directory within staging to construct install files to.
BuildProgressUsed to keep track of install progress.
Returns
Returns true if the prerequisites installer succeeded, false otherwise.

Implements BuildPatchServices::IPrerequisites.

The documentation for this class was generated from the following file: