Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

> Unreal Engine API Reference > Developer > DerivedDataCache > IBuildJob

Light Theme

Dark Theme

IBuildJob

A build job is responsible for the execution of one build.

Windows

MacOS

Linux

References

Module	DerivedDataCache
Header	/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildJob.h
Include	#include "DerivedDataBuildJob.h"

Syntax

class IBuildJob

Remarks

A build job is responsible for the execution of one build.

Jobs typically proceed through each one of a sequence of states, though a state may be skipped if the action was found in the cache or if the scheduler finds duplicate jobs for a definition or an action.

The job depends on the build scheduler to move it through its states. That relationship allows the scheduler more control over resources such as: memory, compute, storage, network.

Functions

	Name	Description
IBuild &	GetBuild()	Returns the build system associated with this job.
ICache &	GetCache()	Returns the cache associated with this job.
FStringView	GetFunction()	Returns the name of the function to build with, or "Unknown" if not resolved yet.
FStringView	GetName()	Returns the name by which to identify this job for logging and profiling.
void	SetOutput ( const FBuildOutput& Output )	Called by the scheduler if it has cached output compatible with the build policy.
void	SkipExecuteRemote()	Called by the scheduler to skip remote execution and fall back to local execution if permitted.
void	StepExecution()	Called by the scheduler to continue this job on the calling thread.