Navigation
API > API/Runtime > API/Runtime/CoreUObject
Interface used during cooking for systems that create an artifact collected from cooked packages. Provides hooks to save global settings that invalidate the artifact when changed. Provides hooks to clean the artifact when invalidated.
| Name | ICookArtifact |
| Type | class |
| Header File | /Engine/Source/Runtime/CoreUObject/Public/Cooker/CookArtifact.h |
| Include Path | #include "Cooker/CookArtifact.h" |
Syntax
class ICookArtifact : public FRefCountBase
Inheritance Hierarchy
- TTransactionalAtomicRefCount → FRefCountBase → ICookArtifact
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ICookArtifact() |
Cooker/CookArtifact.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FConfigFile CalculateCurrentSettings
(
ICookInfo& CookInfo, |
Construct a container of config settings from the current executable, config, and global assets. | Cooker/CookArtifact.h | |
virtual void CompareSettings
(
UE::Cook::Artifact::FCompareSettingsContext& Context |
Compare the results of the previous cook's CalculateCurrentSettings with the current results, and report to the cooker if needs to invalidate the artifact constructed by the previous cook. | Cooker/CookArtifact.h | |
FString GetArtifactName() |
The name of the artifact in log messages and its Metadata/CookSettings_ |
Cooker/CookArtifact.h | |
virtual void OnFullRecook
(
const ITargetPlatform* TargetPlatform |
Called from the cooker when a full recook was required by the cooker or by CompareSettings from any artifact. | Cooker/CookArtifact.h | |
virtual void OnInvalidate
(
const ITargetPlatform* TargetPlatform |
Called from the cooker when a full recook was not required and CompareSettings requested invalidate. | Cooker/CookArtifact.h |