Navigation
API > API/Developer > API/Developer/DerivedDataCache
A build function is referenced by a build definition as the way to build its inputs.
Functions are expected to be pure and maintain no state. Inputs are provided through the build context, and outputs are saved through the build context.
Functions have a version which is used as a proxy for their code. Any code changes that affect the behavior of a function must have a corresponding change in the function version.
Functions must be registered by a build function factory to be available to the build system.
| Name | IBuildFunction |
| Type | class |
| Header File | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h |
| Include Path | #include "DerivedDataBuildFunction.h" |
Syntax
class IBuildFunction
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IBuildFunction() |
DerivedDataBuildFunction.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Build
(
FBuildContext& Context |
Build the output for the input in the build context. | DerivedDataBuildFunction.h | |
virtual void CancelAsyncBuild
(
FBuildContext& Context |
Cancel an asynchronous build. | DerivedDataBuildFunction.h | |
virtual void Configure
(
FBuildConfigContext& Context |
Configure the build based on its constants. | DerivedDataBuildFunction.h | |
const FUtf8SharedString & GetName() |
Returns the name of the build function, which identifies it in a build definition. | DerivedDataBuildFunction.h | |
FGuid GetVersion() |
Returns the version of the build function, which must change when the function changes. | DerivedDataBuildFunction.h |