FBuildWorker | Unreal Engine 5.8 Documentation

API > API/Developer > API/Developer/DerivedDataCache

A build worker is a reference to an immutable build worker program and its dependencies.

The purpose of a build worker is to capture which build functions a program contains and refer to everything required to execute the program, including files and environment.

The key for the worker uniquely identifies the worker using a hash of the serialized compact binary representation of the worker.

A build worker resolver is used to resolve file hashes to the referenced file data.


Name	FBuildWorker
Type	class
Header File	/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h
Include Path	#include "DerivedDataBuildWorker.h"

Syntax

class FBuildWorker

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FBuildWorker ( FIntrusiveUnsetOptionalState )		DerivedDataBuildWorker.h
FBuildWorker ()		DerivedDataBuildWorker.h

Typedefs

Name	Type	Remarks	Include Path
IntrusiveUnsetOptionalStateType	FBuildWorker		DerivedDataBuildWorker.h

Constants

Name	Type	Remarks	Include Path
bHasIntrusiveUnsetOptionalState	bool		DerivedDataBuildWorker.h

Variables

Protected

Name	Type	Include Path
Key	FBuildWorkerKey	DerivedDataBuildWorker.h
Object	FCbObject	DerivedDataBuildWorker.h
Resolver	TUniquePtr< IBuildWorkerResolver >	DerivedDataBuildWorker.h

Functions

Public

Name	Remarks	Include Path
bool Extract ( FStringView OutputPath ) const	Extracts the build worker into a directory, which must be empty.	DerivedDataBuildWorker.h
FGuid GetBuildSystemVersion()		DerivedDataBuildWorker.h
FUtf8StringView GetHostPlatform()		DerivedDataBuildWorker.h
FBuildWorkerKey GetKey()		DerivedDataBuildWorker.h
FUtf8StringView GetName()		DerivedDataBuildWorker.h
FStringView GetPackagePath()	Path to the package that this worker was loaded from. Empty when not loaded from a package.	DerivedDataBuildWorker.h
FUtf8StringView GetPath()		DerivedDataBuildWorker.h
void IterateDirectories ( TFunctionRef< void(FUtf8StringView Path)> Visitor ) const		DerivedDataBuildWorker.h
void IterateEnvironment ( TFunctionRef< void(FUtf8StringView Name, FUtf8StringView Value)> Visitor ) const		DerivedDataBuildWorker.h
void IterateExecutables ( TFunctionRef< void(FUtf8StringView Path, const FIoHash&RawHash, uint64 RawSize)> Visitor ) const		DerivedDataBuildWorker.h
void IterateFiles ( TFunctionRef< void(FUtf8StringView Path, const FIoHash&RawHash, uint64 RawSize)> Visitor ) const		DerivedDataBuildWorker.h
void IterateFunctions ( TFunctionRef< void(FUtf8StringView Name, const FGuid&Version)> Visitor ) const		DerivedDataBuildWorker.h
void Resolve ( TConstArrayView< FIoHash > RawHashes, IRequestOwner& Owner, FOnBuildWorkerResolved&& OnResolved ) const	Resolves files and executables referenced by this build worker, by raw hash.	DerivedDataBuildWorker.h
const FCbObject & Save()	Saves the build worker to a compact binary object, excluding file data.	DerivedDataBuildWorker.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static TOptional< FBuildWorker > Load ( FStringView PackagePath )	Loads a build worker from a package created by FBuildWorkerBuilder::Build.	DerivedDataBuildWorker.h
static FBuildWorker Load ( FCbObject Object, TNotNull< TUniquePtr< IBuildWorkerResolver > > Resolver )	Loads a build worker from a compact binary object.	DerivedDataBuildWorker.h

Operators

Name	Remarks	Include Path	Unreal Specifiers
bool operator== ( FIntrusiveUnsetOptionalState ) const		DerivedDataBuildWorker.h

Navigation