BuildPatchServices::CustomChunkReferencesHelpers Namespace Reference

Functions
FORCEINLINE TArray< FGuid >	OrderedUniqueReferences (const FBuildPatchAppManifestRef &InstallManifest)
FORCEINLINE TArray< FGuid >	OrderedUniquePatchReferences (const FBuildPatchAppManifestRef &InstallManifest, const FBuildPatchAppManifestRef &CurrentManifest)
FORCEINLINE TArray< FGuid >	OrderedUniqueReferencesTagged (const FBuildPatchAppManifestRef &InstallManifest, const TSet< FString > &InstallTagSet)
FORCEINLINE TArray< FGuid >	OrderedUniquePatchReferencesTagged (const FBuildPatchAppManifestRef &InstallManifest, const TSet< FString > &InstallTagSet, const FBuildPatchAppManifestRef &CurrentManifest, const TSet< FString > &CurrentTagSet)

Detailed Description

Helpers for creating a CustomChunkReferences array for use with the equivalent FChunkReferenceTrackerFactory.

Function Documentation

OrderedUniquePatchReferences()

FORCEINLINE TArray< FGuid > BuildPatchServices::CustomChunkReferencesHelpers::OrderedUniquePatchReferences	(	const FBuildPatchAppManifestRef &	InstallManifest,
		const FBuildPatchAppManifestRef &	CurrentManifest
	)

This implementation takes a new install manifest and a current manifest. It generates the CustomChunkReferences needed for a chunk reference tracker based on caching data for a patch only, and so using the chunks in InstallManifest, which are not in CurrentManifest, once each in the order that they would be required to patch the build.

Parameters

InstallManifest	The install manifest to enumerate chunk references from.
CurrentManifest	The current manifest to exclude chunk references from.

Returns

the chunk use references for FChunkReferenceTrackerFactory::Create.

OrderedUniquePatchReferencesTagged()

FORCEINLINE TArray< FGuid > BuildPatchServices::CustomChunkReferencesHelpers::OrderedUniquePatchReferencesTagged	(	const FBuildPatchAppManifestRef &	InstallManifest,
		const TSet< FString > &	InstallTagSet,
		const FBuildPatchAppManifestRef &	CurrentManifest,
		const TSet< FString > &	CurrentTagSet
	)

This implementation takes a new install manifest, a current manifest, and a tagset for each. It generates the CustomChunkReferences needed for a chunk reference tracker based on caching data for a patch only, and so using the chunks in InstallManifest, which are not in CurrentManifest, once each in the order that would be required to patch the build when using the tagsets provided.

Parameters

InstallManifest	The install manifest to enumerate chunk references from.
InstallTagSet	The tagset that would be used with install manifest, this will filter down required file list and thus required chunk list.
CurrentManifest	The current manifest if considering an update, which reduces the number of chunks required.
CurrentTagSet	The tagset filtering files from CurrentManifest, so that chunks would not be ignored for files not present on disk. This would often be the same as InstallTagSet unless InstallManifest changed the file tag names, or you are calling for purpose of adding/removing tags.

Returns

the chunk use references for FChunkReferenceTrackerFactory::Create.

OrderedUniqueReferences()

FORCEINLINE TArray< FGuid > BuildPatchServices::CustomChunkReferencesHelpers::OrderedUniqueReferences

(

const FBuildPatchAppManifestRef &

InstallManifest

)

This implementation takes the install manifest and generates the CustomChunkReferences needed for a chunk reference tracker based on caching data and so using each chunk once in the order that would be required to install the build.

Parameters

InstallManifest

The install manifest to enumerate references from.

Returns

the chunk use references for FChunkReferenceTrackerFactory::Create.

OrderedUniqueReferencesTagged()

FORCEINLINE TArray< FGuid > BuildPatchServices::CustomChunkReferencesHelpers::OrderedUniqueReferencesTagged	(	const FBuildPatchAppManifestRef &	InstallManifest,
		const TSet< FString > &	InstallTagSet
	)

This implementation takes the install manifest and a tagset. It generates the CustomChunkReferences needed for a chunk reference tracker based on caching data and so using each chunk once in the order that would be required to install the build when using the same tagset provided.

Parameters

InstallManifest	The install manifest to enumerate references from.
InstallTagSet	The tagset that would be used with install manifest, this will filter down required file list and thus required chunk list.

Returns

the chunk use references for FChunkReferenceTrackerFactory::Create.