FBuildAction

API > API/Developer > API/Developer/DerivedDataCache

A build action is an immutable reference to a build function and its inputs.

The purpose of an action is to capture everything required to execute a derived data build for a fixed version of the build function and its constants and inputs.

The key for the action uniquely identifies the action and is derived by hashing the serialized compact binary representation of the action.

The keys for constants and inputs are names that are unique within the build action.


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

Syntax

class FBuildAction

Derived Classes

FOptionalBuildAction

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FBuildAction ( Private::IBuildActionInternal* InAction )	Construct a build action.	DerivedDataBuildAction.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
Action	TRefCountPtr< Private::IBuildActionInternal >		DerivedDataBuildAction.h

Functions

Public

Name	Remarks	Include Path
const FGuid & GetBuildSystemVersion()	Returns the version of the build system required to build this action.	DerivedDataBuildAction.h
const FUtf8SharedString & GetFunction()	Returns the name of the build function with which to build this action.	DerivedDataBuildAction.h
const FGuid & GetFunctionVersion()	Returns the version of the build function with which to build this action.	DerivedDataBuildAction.h
const FBuildActionKey & GetKey()	Returns the key that uniquely identifies this build action.	DerivedDataBuildAction.h
const FSharedString & GetName()	Returns the name by which to identify this action for logging and profiling.	DerivedDataBuildAction.h
bool HasConstants()	Returns whether the action has any constants.	DerivedDataBuildAction.h
bool HasInputs()	Returns whether the action has any inputs.	DerivedDataBuildAction.h
void IterateConstants ( TFunctionRef< void(FUtf8StringView Key, FCbObject&&Value)> Visitor ) const	Visits every constant in order by key. The key view is valid for the lifetime of the action.	DerivedDataBuildAction.h
void IterateInputs ( TFunctionRef< void(FUtf8StringView Key, const FIoHash&RawHash, uint64 RawSize)> Visitor ) const	Visits every input in order by key. The key view is valid for the lifetime of the action.	DerivedDataBuildAction.h
void Save ( FCbWriter& Writer ) const	Saves the build action to a compact binary object. Calls BeginObject and EndObject.	DerivedDataBuildAction.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static FOptionalBuildAction Load ( const FSharedString& Name, FCbObject&& Action )	Load a build action from compact binary.	DerivedDataBuildAction.h

Navigation