IBuild

Interface to the build system.

Unreal Engine C++ API Reference > Developer > DerivedDataCache

References

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

Syntax

class IBuild  

Remarks

Interface to the build system.

Executing a build typically requires a definition, input resolver, session, and function.

Use IBuild::CreateDefinition() to make a new build definition, or use IBuild::LoadDefinition() to load a build definition that was previously saved. This references the function to execute, and the inputs needed by the function.

Use IBuild::CreateSession() to make a new build session with a build input resolver to resolve input references into the referenced data. Use FBuildSession::Build() to schedule a definition to build, along with any of its transitive build dependencies.

Implement a IBuildFunction, with a unique name and version, to add values to the build context based on constants and inputs in the context. Use TBuildFunctionFactory to add the function to the registry at IBuild::GetFunctionRegistry() to allow the build job to find it.

Destructors

Type Name Description
  ~IBuild ()  

Functions

Type Name Description
FBuildAction... CreateAction ( const FSharedString& Name, const FUtf8SharedString& Function ) Create a build action builder.
FBuildDefini... CreateDefinition ( const FSharedString& Name, const FUtf8SharedString& Function ) Create a build definition builder.
FBuildInputs... CreateInputs ( const FSharedString& Name ) Create a build inputs builder.
FBuildOutput... CreateOutput ( const FSharedString& Name, const FUtf8SharedString& Function ) Create a build output builder.
FBuildSessio... CreateSession ( const FSharedString& Name, IBuildInputResolver* InputReso..., IBuildScheduler* Scheduler ) Create a build session.
IBuildFuncti... GetFunctionRegistry () Returns the build function registry used by the build system.
const FGuid ... GetVersion () Returns the version of the build system.
IBuildWorker... GetWorkerRegistry () Returns the build worker registry used by the build system.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library