BuildPatchServices

Choose your operating system:

Windows

macOS

Linux

Filters

Classes

Name

Description

Public struct

FBuildInstallerConfiguration

Defines a list of all the options of an installation task.

Public class

FBuildPatchServices

Copyright Epic Games, Inc. All Rights Reserved.

Public struct

FBuildPatchServicesInitSettings

Defines a list of all build patch services initialization settings, can be used to override default init behaviors.

Public struct

FChunkBuildConfiguration

Defines a list of all options for the build chunking task.

Public struct

FChunkDeltaOptimiserConfiguration

Defines a list of all options for the chunk delta optimisation task.

Public struct

FChunkSourceEvent

A message describing an event that occurred for a chunk source.

Public struct

FChunkUriRequest

A Request for a chunk

Public struct

FChunkUriResponse

A Response containing the actual location of the chunk

Public struct

FCompactifyConfiguration

Defines a list of all options for the cloud directory compactifier task.

Public class

FDefaultMessageHandler

Public struct

FDiffManifestsConfiguration

Defines a list of all options for the diff manifests task.

Public struct

FInstallationFileAction

A message describing an action taken to an installation file.

Public struct

FInstallerAction

Public struct

FInstallerConfiguration

DEPRECATED STRUCT.

Public class

FMessageHandler

Base class of a message handler, this should be inherited from and passed to an installer to receive messages that you want to handle.

Public struct

FPackageChunksConfiguration

Defines a list of all options for the chunk packaging task.

Public struct

FPatchDataEnumerationConfiguration

Defines a list of all options for the patch data enumeration task.

Typedefs

Name

Description

FGenerationConfiguration

Temporary for use with deprecated module function.

Enums

Name

Description

Public enum

BuildPatchServices::EBuildPatchState

Namespace to declares the progress type enum

Public enum

BuildPatchServices::EDeltaPolicy

An enum defining the desired policy for requesting an optimised delta.

Public enum

BuildPatchServices::EFeatureLevel

An enum type to describe supported features of a certain manifest.

Public enum

BuildPatchServices::EInstallMode

An enum defining the installation mode that should be used.

Public enum

BuildPatchServices::EVerifyError

An enum defining the possible causes for a verification failure.

Public enum

BuildPatchServices::EVerifyMode

An enum defining the verification mode that should be used.

Functions

Name Description

Public function

uint64

 

BuildPatchServices::CalculateRequiredDiskSpace

(
    const IBuildManifestPtr& CurrentMa...,
    const IBuildManifestRef& BuildMani...,
    const EInstallMode& InstallMode,
    const TSet< FString >& InstallTags
)

Public function

const FStrin...

 

BuildPatchServices::EnumToString

(
    const EDeltaPolicy& DeltaPolicy
)

Returns the string representation of the EDeltaPolicy value. Used for analytics and logging only.

Public function

const FStrin...

 

BuildPatchServices::EnumToString

(
    const EInstallMode& InstallMode
)

Returns the string representation of the EInstallMode value. Used for analytics and logging only.

Public function

const FStrin...

 

BuildPatchServices::EnumToString

(
    const EVerifyMode& VerifyMode
)

Returns the string representation of the EVerifyMode value. Used for analytics and logging only.

Public function

bool

 

BuildPatchServices::FeatureLevelFromString

(
    const TCHAR* FeatureLevelStrin...,
    EFeatureLevel& FeatureLevel
)

Parses the provided string into the relevant EFeatureLevel value, if it matches.

Public function

const TCHAR ...

 

BuildPatchServices::FeatureLevelToString

(
    const EFeatureLevel& FeatureLevel
)

Returns the string representation of the EFeatureLevel value. Used for analytics and logging only.

Public function

FString

 

BuildPatchServices::GetChunkDeltaFilename

(
    const IBuildManifestRef& SourceMan...,
    const IBuildManifestRef& Destinati...
)

Based on the source and destination manifests, get the filename for the delta that optimises patching from source to destination.

Public function

IBuildManife...

 

BuildPatchServices::MergeDeltaManifest

(
    const IBuildManifestRef& Manifest,
    const IBuildManifestRef& Delta
)

Public function

const FStrin...

 

BuildPatchServices::StateToString

(
    const EBuildPatchState& State
)

Returns the string representation of the EBuildPatchState value.

Public function

const FText ...

 

BuildPatchServices::StateToText

(
    const EBuildPatchState& State
)

BuildPatchServices::StateToText(const EBuildPatchState& State) has been deprecated. It will no longer be supported by BuildPatchServices in the future.