Navigation
API > API/Runtime > API/Runtime/CoreUObject
Engine interface for information provided by UCookOnTheFlyServer in cook callbacks.
| Name | ICookInfo |
| Type | class |
| Header File | /Engine/Source/Runtime/CoreUObject/Public/UObject/ICookInfo.h |
| Include Path | #include "UObject/ICookInfo.h" |
Syntax
class ICookInfo
Derived Classes
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| The release version of the basegame the current DLC is based on, when cooking DLC or when making a patch. | UObject/ICookInfo.h | ||
UE::Cook::ECookingDLC GetCookingDLC () |
Whether DLC is being cooked (e.g. via "-dlcname= |
UObject/ICookInfo.h | |
FString GetCookOutputFolder
(
const ITargetPlatform* TargetPlatform |
Returns the output folder being used by the cooker for the given platform in the given session. | UObject/ICookInfo.h | |
UE::Cook::ECookType GetCookType () |
The type (e.g. CookByTheBook) of the running cook. | UObject/ICookInfo.h | |
UE::Cook::ECookValidationOptions GetCookValidationOptions() |
Get the validation options used by the running cook, if any. | UObject/ICookInfo.h | |
FString GetCreateReleaseVersion() |
The release version being created when making a patch. | UObject/ICookInfo.h | |
| Gets the current cultures that are being cooked. | UObject/ICookInfo.h | ||
| When DLC is being cooked ( | UObject/ICookInfo.h | ||
const TSet< IPlugin * > * GetEnabledPlugins
(
const ITargetPlatform* TargetPlatform |
Return the set of plugins that the cooker has determined are enabled on the current platform. | UObject/ICookInfo.h | |
FInstigator GetInstigator
(
FName PackageName |
Return the instigator that first caused the package to be requested by the cook. | UObject/ICookInfo.h | |
TArray< FInstigator > GetInstigatorChain
(
FName PackageName |
Return the chain of instigators that caused the package to be requested by the cook. | UObject/ICookInfo.h | |
UE::Cook::EProcessType GetProcessType() |
The role the current process plays in its MPCook session, or EProcessType::SingleProcess if it is running standalone. | UObject/ICookInfo.h | |
TArray< const ITargetPlatform * > GetSessionPlatforms () |
Returns the list of platforms that will be/are being/have been cooked for the current cook session. | UObject/ICookInfo.h | |
bool IsIncremental () |
Returns true if the cooker is cooking after a previous cook session and is cooking only the changed files. | UObject/ICookInfo.h | |
bool IsIterative() |
UObject/ICookInfo.h | ||
void RegisterArtifact
(
ICookArtifact* Artifact |
Call in SPCook or on the cookdirector to register an Artifact that saves non-package files in the cook's output directory for each TargetPlatform. | UObject/ICookInfo.h | |
void RegisterCollector
(
IMPCollector* Collector, |
MPCook: register in the current process a collector that replicates system-specific and package-specific information between CookWorkers and the CookDirector. | UObject/ICookInfo.h | |
void UnregisterArtifact
(
ICookArtifact* Artifact |
Unregister Artifact that was registered via RegisterArtifact. | UObject/ICookInfo.h | |
void UnregisterCollector
(
IMPCollector* Collector |
MPCook: Unregister in the current process a collector that was registered via RegisterCollector. | UObject/ICookInfo.h |