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 > API/Runtime/CoreUObject/Cooker

References

   
Module CoreUObject
Header /Engine/Source/Runtime/CoreUObject/Public/Cooker/CookDependency.h
Include #include "Cooker/CookDependency.h"

Syntax

class FCookDependency

Remarks

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.

Variables

  Type Name Description
Public variable TUniquePtr< FARFilter > ARFilter  
Public variable TUniquePtr< UE::ConfigAccessTracking::FConfigAccessData > ConfigAccessData  
Public variable FFunctionData FunctionData  
Public variable FName NameData  
Public variable const UObject * ObjectPtr  
Public variable FString StringData  
Public variable FTransitiveBuildData TransitiveBuildData  

Constructors

  Type Name Description
Public function   Construct an empty dependency; it will never be invalidated.
Public function  

FCookDependency ( const FCookDependency& Other
)

  
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Static FCookDependency Adds a dependency on the results reported by an AssetRegistry query.
Public function Static FCookDependency

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

  
Public function 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.
Public function Static FCookDependency Create a dependency on the value of a config variable.
Public function Static FCookDependency

ConsoleVariable ( FStringView VariableName
)

 Create a dependency on the value of a cvar.
Public function Static FCookDependency

File ( FStringView InFileName
)

 Create a dependency on the contents of the file.
Public function Static FCookDependency

Function ( FName InFunctionName,
FCbFieldIterator&& InArgs
)

 Create a dependency on a call to the specified function with the given arguments.
Public function Const const FARFilter * Returns the FARFilter if GetType() == AssetRegistryQuery, else nullptr.
Public function Const FStringView Returns the classpath if GetType() == NativeClass, else empty string.
Public function Const FString Returns the full path of the config access (e.g. Platform.Filename.Section.ValueName) if GetType() == Config, else empty.
Public function Const FStringView FileName if GetType() == File, else empty.
Public function Const FCbFieldViewIterator FunctionArgs if GetType() == Function, else FCbFieldViewIterator().
Public function Const FName FunctionName if GetType() == Function, else NAME_None.
Public function Const FName PackageName if GetType() == TransitiveBuild or GetType() == Package, else NAME_None.
Public function Const const UObject * Returns the SettingsObject pointer if GetType() == SettingsObject, else nullptr.
Public function Const ECookDependency

GetType ()

 FCookDependency is a vararg type.
Public function Const bool If GetType() == TransitiveBuild, whether AlsoAddRuntimeDependency was selected, otherwise false.
Public function Static FCookDependency

NativeClass ( FStringView ClassPath
)

  
Public function Static FCookDependency

NativeClass ( const UClass* InClass
)

 Adds a dependency on the class schema of a nativeclass.
Public function Static FCookDependency

Package ( FName PackageName
)

 Create a build dependency on the contents of a package.
Public function Static FCookDependency

SettingsObject ( const UObject* InObject
)

 Adds a dependency on the config values and class schema of a settings object.
Public function Static FCookDependency Create a transitive build dependency on another package.
Public function Const void Calculate the current hash of this CookDependency, and add it into Context.

Operators

  Type Name Description
Public function Const bool

operator!= ( const FCookDependency& Other
)

  
Public function Const bool

operator< ( const FCookDependency& Other
)

 Comparison operator for e.g. deterministic ordering of dependencies.
Public function FCookDependency &

operator= ( const FCookDependency& Other
)

  
Public function FCookDependency &  
Public function Const bool

operator== ( const FCookDependency& Other
)

 Equality operator for uniqueness testing

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page