FBuildContext

A build context provides the inputs for a build function and saves its outputs.

Unreal Engine C++ API Reference > Developer > DerivedDataCache

References

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

Syntax

class FBuildContext  

Remarks

A build context provides the inputs for a build function and saves its outputs.

Destructors

Type Name Description
  ~FBuildContext ()  

Functions

Type Name Description
void AddError ( FStringView Message ) Adds the error to the build output. Must be deterministic and based only on inputs.
void AddMessage ( FStringView Message ) Adds the message to the build output. Must be deterministic and based only on inputs.
void AddValue ( const FValueId& Id, const FValue& Value ) Adds a value to the build output. Must have a non-null buffer and a unique ID.
void AddValue ( const FValueId& Id, const FCompressedBuffer& Buffer )  
void AddValue ( const FValueId& Id, const FCbObject& Object )  
void AddValue ( const FValueId& Id, const FCompositeBuffer& Buffer, uint64 BlockSize )  
void AddValue ( const FValueId& Id, const FSharedBuffer& Buffer, uint64 BlockSize )  
void AddWarning ( FStringView Message ) Adds the warning to the build output. Must be deterministic and based only on inputs.
void BeginAsyncBuild () Make this an asynchronous build by making the caller responsible for completing the build.
void EndAsyncBuild () Mark the end of an asynchronous build.
FCbObject FindConstant ( FUtf8StringView Key ) Returns the constant with the matching key, or an object with no fields if not found.
FSharedBuffe... FindInput ( FUtf8StringView Key ) Returns the input with the matching key, or a null buffer if not found.
const FShare... GetName () Returns the name by which to identify this build for logging and profiling.
void SetCachePolicyMask ( ECachePolicy Policy ) Overrides the cache policy mask used when writing this build in the cache.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library