FBuildAction

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

Windows
MacOS
Linux

Inheritance Hierarchy

FBuildAction

FOptionalBuildAction

References

Module

DerivedDataCache

Header

/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildAction.h

Include

#include "DerivedDataBuildAction.h"

Syntax

class FBuildAction

Remarks

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.

Constructors

No constructors are accessible with public or protected access.

Functions

Name Description

Public function Const

const FGuid ...

 

GetBuildSystemVersion()

Returns the version of the build system required to build this action.

Public function Const

FStringView

 

GetFunction()

Returns the name of the build function with which to build this action.

Public function Const

const FGuid ...

 

GetFunctionVersion()

Returns the version of the build function with which to build this action.

Public function Const

const FBuild...

 

GetKey()

Returns the key that uniquely identifies this build action.

Public function Const

FStringView

 

GetName()

Returns the name by which to identify this action for logging and profiling.

Public function Const

bool

 

HasConstants()

Returns whether the action has any constants.

Public function Const

bool

 

HasInputs()

Returns whether the action has any inputs.

Public function Const

void

 

IterateConstants

(
    TFunctionRef< void Key,...
)

Visits every constant in order by key.

Public function Const

void

 

IterateInputs

(
    TFunctionRef< void Key,...
)

Visits every input in order by key.

Public function Static

FOptionalBui...

 

Load

(
    FStringView Name,
    FCbObject&& Action
)

Load a build action from compact binary.

Public function Const

void

 

Save

(
    FCbWriter& Writer
)

Saves the build action to a compact binary object. Calls BeginObject and EndObject.

See Also