1. Epic GamesDeveloper
  3. FCookDependency

FCookDependency

TargetDomain dependencies that can be reported from the class instances in a package.

API > API/Runtime > API/Runtime/CoreUObject

TargetDomain dependencies that can be reported from the class instances in a package. These dependencies are stored in the cook oplog and are evaluated during incremental cook. If any of them changes, the package is invalidated and must be recooked (loaded/saved). These dependencies do not impact whether DDC keys built from the package need to be recalculated.

   
Name FCookDependency
Type class
Header File /Engine/Source/Runtime/CoreUObject/Public/Cooker/CookDependency.h
Include Path #include "Cooker/CookDependency.h"

Syntax

class FCookDependency

Constructors

Name Remarks Include Path Unreal Specifiers

FCookDependency ( ECookDependency InType
)

   Cooker/CookDependency.h  
Construct an empty dependency; it will never be invalidated. Cooker/CookDependency.h  

FCookDependency ( const FCookDependency& Other
)

   Cooker/CookDependency.h  
  Cooker/CookDependency.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FCookDependency()

   Cooker/CookDependency.h  

Structs

Name Remarks
FFunctionData  
FTransitiveBuildData  

Constants

Name Type Remarks Include Path
ValueSizeInBytes const uint8   Cooker/CookDependency.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ARFilter TUniquePtr< FARFilter >   Cooker/CookDependency.h  
ConfigAccessData TUniquePtr< UE::ConfigAccessTracking::FConfigAccessData >   Cooker/CookDependency.h  
ConsoleVariableData TUniquePtr< FConsoleVariableData >   Cooker/CookDependency.h  
FunctionData FFunctionData   Cooker/CookDependency.h  
HashedValue FBlake3Hash   Cooker/CookDependency.h  
NameData FName   Cooker/CookDependency.h  
ObjectPtr const UObject *   Cooker/CookDependency.h  
RawValue uint8   Cooker/CookDependency.h  
StringData FString   Cooker/CookDependency.h  
TransitiveBuildData FTransitiveBuildData   Cooker/CookDependency.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
FCookDependency union UE::Cook::FCookDependency   Cooker/CookDependency.h  
FCookDependency union UE::Cook::FCookDependency This is the value of the dependency stored as 32 bytes. Cooker/CookDependency.h  
Type ECookDependency   Cooker/CookDependency.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

const FARFilter * GetARFilter()

 Returns the FARFilter if GetType() == AssetRegistryQuery, else nullptr. Cooker/CookDependency.h  

FStringView GetClassPath ()

 Returns the classpath if GetType() == NativeClass, else empty string. Cooker/CookDependency.h  
Returns the ConfigAccess in its struct form (File,Section,Key) if GetType() == Config, else empty. Cooker/CookDependency.h  

FString GetConfigPath()

 Returns the full path of the config access (e.g. Platform.Filename.Section.ValueName) if GetType() == Config, else empty. Cooker/CookDependency.h  

FString GetDebugIdentifier()

 Return a string that describes which data is looked up by this CookDependency, within the context of its type. Cooker/CookDependency.h  

FStringView GetFileName()

 FileName if GetType() == File, else empty. StringView points to null or a null-terminated string. Cooker/CookDependency.h  

FCbFieldViewIterator GetFunctionArgs()

 FunctionArgs if GetType() == Function, else FCbFieldViewIterator(). Cooker/CookDependency.h  

FName GetFunctionName()

 FunctionName if GetType() == Function, else NAME_None. Cooker/CookDependency.h  

const FBlake3Hash & GetHashValue()

 Returns the value of the dependency, interpreted as a Blake3Hash. Cooker/CookDependency.h  

FName GetPackageName()

 PackageName if GetType() == TransitiveBuild or GetType() == Package, else NAME_None. Cooker/CookDependency.h  

const uint8 * GetRawValue()

 Returns the value of the dependency. It's an array of size FCookDependency::VALUE_MAX_BYTES_SIZE Cooker/CookDependency.h  
Returns the SettingsObject pointer if GetType() == SettingsObject, else nullptr. Cooker/CookDependency.h  

ECookDependency GetType ()

 FCookDependency is a vararg type. Cooker/CookDependency.h  

bool IsAlsoAddRuntimeDependency()

   Cooker/CookDependency.h  

void SetValue ( const FIoHash& Hash
)

   Cooker/CookDependency.h  

void SetValue ( const FBlake3Hash& Hash
)

   Cooker/CookDependency.h  

void SetValue ( const FUtf8String& String
)

   Cooker/CookDependency.h  

void UpdateHash ( FCookDependencyContext& Context,
FBlake3Hash* OutCurrentValue
) const

 Calculate the current hash of this CookDependency, add it into Context, and optionally return it. Cooker/CookDependency.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool ARFilterEqual ( const FARFilter& A,
const FARFilter& B
)

   Cooker/CookDependency.h  

static bool ARFilterLessThan ( const FARFilter& A,
const FARFilter& B
)

   Cooker/CookDependency.h  

static FCookDependency AssetRegistryQuery ( FARFilter Filter
)

 Adds a dependency on the results reported by an AssetRegistry query. Cooker/CookDependency.h  

static FCookDependency Config ( UE::ConfigAccessTracking::ELoadType LoadType,
FName Platform,
FName FileName,
FName SectionName,
FName ValueName
)

   Cooker/CookDependency.h  

static FCookDependency Config ( FName FileName,
FName SectionName,
FName ValueName
)

 Create a dependency on the value of a config variable, with LoadType=ConfigSystem and Platform=NAME_None. Cooker/CookDependency.h  
Create a dependency on the value of a config variable. Cooker/CookDependency.h  

static bool ConfigAccessDataEqual ( const UE::ConfigAccessTracking::FConfigAccessData& A,
const UE::ConfigAccessTracking::FConfigAccessData& B
)

   Cooker/CookDependency.h  

static bool ConfigAccessDataLessThan ( const UE::ConfigAccessTracking::FConfigAccessData& A,
const UE::ConfigAccessTracking::FConfigAccessData& B
)

   Cooker/CookDependency.h  

static FCookDependency ConsoleVariable ( const FStringView& VariableName,
const ITargetPlatform* TargetPlatform,
bool bFallbackToNonPlatform
)

   Cooker/CookDependency.h  

static FCookDependency ConsoleVariable ( const FStringView& VariableName
)

 Create a dependency on the value of a cvar. Cooker/CookDependency.h  

static bool ConsoleVariableDataEqual ( const FConsoleVariableData& A,
const FConsoleVariableData& B
)

   Cooker/CookDependency.h  

static bool ConsoleVariableDataLessThan ( const FConsoleVariableData& A,
const FConsoleVariableData& B
)

   Cooker/CookDependency.h  

static FBlake3Hash ConvertToHash ( const FUtf8String& String
)

   Cooker/CookDependency.h  

static FBlake3Hash ConvertToHash ( const FIoHash& Hash
)

   Cooker/CookDependency.h  

static FCookDependency File ( FStringView InFileName
)

 Create a dependency on the contents of the file. Cooker/CookDependency.h  

static FCookDependency Function ( FName InFunctionName,
FCbFieldIterator&& InArgs
)

 Create a dependency on a call to the specified function with the given arguments. Cooker/CookDependency.h  

static FCookDependency NativeClass ( const UClass* InClass
)

 Adds a dependency on the class schema of a nativeclass. Cooker/CookDependency.h  

static FCookDependency NativeClass ( FStringView ClassPath
)

   Cooker/CookDependency.h  

static FCookDependency Package ( FName PackageName
)

 Create a build dependency on the contents of a package. Cooker/CookDependency.h  

static FCookDependency RedirectionTarget ( FName PackageName
)

 Adds a dependency on the ObjectRedirectors and CoreRedirects that affect the given PackageName. Cooker/CookDependency.h  

static FCookDependency SettingsObject ( const UObject* InObject
)

 Adds a dependency on the config values and class schema of a settings object. Cooker/CookDependency.h  

static FCookDependency TransitiveBuild ( FName PackageName
)

 Create a transitive build dependency on another package. Cooker/CookDependency.h  

static FCookDependency TransitiveBuildAndRuntime ( FName PackageName
)

   Cooker/CookDependency.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator!= ( const FCookDependency& Other
) const

   Cooker/CookDependency.h  
  Cooker/CookDependency.h  
  Cooker/CookDependency.h  

bool operator== ( const FCookDependency& Other
) const

 Equality operator for uniqueness testing Cooker/CookDependency.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page