1. Epic GamesDeveloper
  3. UCookOnTheFlyServer

UCookOnTheFlyServer

API > API/Editor > API/Editor/UnrealEd

   
Name UCookOnTheFlyServer
Type class
Header File /Engine/Source/Editor/UnrealEd/Classes/CookOnTheSide/CookOnTheFlyServer.h
Include Path #include "CookOnTheSide/CookOnTheFlyServer.h"

Syntax

UCLASS (MinimalAPI)  
class UCookOnTheFlyServer :  
    public UObject ,  
    public FTickableEditorObject ,  
    public FExec ,  
    public UE::Cook::ICookInfo ,  
    public UE::PackageWriter::Private::ICookerInterface

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UCookOnTheFlyServer ( const FObjectInitializer& ObjectInitializer
)

   CookOnTheSide/CookOnTheFlyServer.h  
  CookOnTheSide/CookOnTheFlyServer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UCookOnTheFlyServer()

   CookOnTheSide/CookOnTheFlyServer.h  

Classes

Name Remarks
FCookOnTheFlyServerInterface  

Structs

Name Remarks
FActivePackageData  
FCookByTheBookStartupOptions  
FCookOnTheFlyStartupOptions  
FPollable Wrapper around a function for cooker tasks that need to be ticked on a schedule.
FPollableQueueKey A key/value pair for storing Pollables in a priority queue, keyed by next call time.
FScopedActivePackage Scoped type to call Set/ClearActivePackage.

Enums

Public

Name Remarks
ECookOnTheSideResult  

Typedefs

Name Type Remarks Include Path
FOnCookByTheBookFinished TMulticastDelegate_NoParams< void >   CookOnTheSide/CookOnTheFlyServer.h
FOnCookByTheBookStarted TMulticastDelegate_NoParams< void >   CookOnTheSide/CookOnTheFlyServer.h
FPollFunction TUniqueFunction< void(UE::Cook::FTickStackData &)>   CookOnTheSide/CookOnTheFlyServer.h

Constants

Name Type Remarks Include Path
ActiveCOTFS UCookOnTheFlyServer * Cook on the fly server. CookOnTheSide/CookOnTheFlyServer.h
CookByTheBookFinishedEvent FOnCookByTheBookFinished   CookOnTheSide/CookOnTheFlyServer.h
CookByTheBookStartedEvent FOnCookByTheBookStarted Cook events that can be listenned to. CookOnTheSide/CookOnTheFlyServer.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActivePackageData FActivePackageData Data tracking the package currently having calls made (Load/Save/Other) from COTFS. CookOnTheSide/CookOnTheFlyServer.h  
AllContextArtifactReader TUniquePtr< FLayeredCookArtifactReader >   CookOnTheSide/CookOnTheFlyServer.h  
AssetRegistry IAssetRegistry * Cached copy of asset registry CookOnTheSide/CookOnTheFlyServer.h  
AsyncIODelete TUniquePtr< FAsyncIODelete >   CookOnTheSide/CookOnTheFlyServer.h  
bCallIsCachedOnSaveCreatedObjects bool Experimental feature to correctly invoke the BeginCacheForCookedPlatformData contracts for objects created by PreSave CookOnTheSide/CookOnTheFlyServer.h  
bCookFastStartup bool True if experimental optimizations for fast startup should be used. CookOnTheSide/CookOnTheFlyServer.h  
bCookFilter bool True if commandline arguments specified that we suppress the cook of packages based on filter criteria. CookOnTheSide/CookOnTheFlyServer.h  
bCookIncrementalAllowAllClasses bool   CookOnTheSide/CookOnTheFlyServer.h  
bCookingDLCBaseGamePlugin bool True (on CookWorkers and CookDirector) if and only if commandline requested CookingDLCBaseGamePlugin. CookOnTheSide/CookOnTheFlyServer.h  
bCookListMode bool True if we're running cooklist; tweak output CookOnTheSide/CookOnTheFlyServer.h  
bCookOnTheFlyExternalRequests bool Set to true during CookOnTheFly if a plugin is calling RequestPackage and we should therefore not make assumptions about when platforms are done cooking CookOnTheSide/CookOnTheFlyServer.h  
bDeterminismDebug bool Whether cooked packages should store extra data to debug indeterminism. CookOnTheSide/CookOnTheFlyServer.h  
bFirstCookInThisProcess bool   CookOnTheSide/CookOnTheFlyServer.h  
bFirstCookInThisProcessInitialized bool   CookOnTheSide/CookOnTheFlyServer.h  
bGarbageCollectTypeSoft bool   CookOnTheSide/CookOnTheFlyServer.h  
bHiddenDependenciesClassPathFilterListIsAllowList bool   CookOnTheSide/CookOnTheFlyServer.h  
bHiddenDependenciesDebug bool   CookOnTheSide/CookOnTheFlyServer.h  
bImportBehaviorCallbackInstalled bool   CookOnTheSide/CookOnTheFlyServer.h  
bIncrementallyModifiedDiagnostics bool   CookOnTheSide/CookOnTheFlyServer.h  
bIsSavingPackage bool   CookOnTheSide/CookOnTheFlyServer.h  
bKickedBuildDependencies bool After cooking all requested packages in CookByTheBook we need to search for any build dependencies and request them for commit as build dependencies. CookOnTheSide/CookOnTheFlyServer.h  
bLegacyBuildDependencies bool By default (aka CookIncremental system), we load/save TargetDomainKey hashes and tweak behavior throughout the cooker to support that. CookOnTheSide/CookOnTheFlyServer.h  
bLegacyIterativeCalculateExe bool Whether we should calculate the exe's hash for LegacyIiterative; might be true even if bLegacyIterativeIgnoreExe is true. CookOnTheSide/CookOnTheFlyServer.h  
bLegacyIterativeIgnoreExe bool Command-line parameter; if true then legacyiterative cooks will not be invalidated by exe changes. CookOnTheSide/CookOnTheFlyServer.h  
bLegacyIterativeIgnoreIni bool Command-line parameter; if true then legacyiterative cooks will not be invalidated by ini changes. CookOnTheSide/CookOnTheFlyServer.h  
bLoadBusy bool True when PumpLoads has detected it is blocked on async work and CookOnTheFlyServer should do work elsewhere. CookOnTheSide/CookOnTheFlyServer.h  
bOnlyEditorOnlyDebug bool   CookOnTheSide/CookOnTheFlyServer.h  
bPollablesInTick bool Multithreaded synchronization of Pollables, accessible only inside PollablesLock. CookOnTheSide/CookOnTheFlyServer.h  
bPreloadingEnabled bool If preloading is enabled, we call TryPreload until it returns true before sending the package to LoadReady, otherwise we skip TryPreload and it goes immediately. CookOnTheSide/CookOnTheFlyServer.h  
bRandomizeCookOrder bool True if we want to randomize cook order, for robustness validation or to avoid encountering the same DDC build jobs when multiple machines are cooking at the same time. CookOnTheSide/CookOnTheFlyServer.h  
bRunningAsShaderServer bool When running as a shader server (-odsc) we avoid cooking packages; the cooker does not queue them and the game does not request them. CookOnTheSide/CookOnTheFlyServer.h  
bSaveBusy bool True when PumpSaves has detected it is blocked on async work and CookOnTheFlyServer should do work elsewhere. CookOnTheSide/CookOnTheFlyServer.h  
bSessionRunning bool True if a session is started for any mode. CookOnTheSide/CookOnTheFlyServer.h  
bShaderCompilerWasActiveOnPreviousBusyReport bool We need to track whether the compiler has been inactive for a long time before issuing a warning about it. CookOnTheSide/CookOnTheFlyServer.h  
bSkipOnlyEditorOnly bool Config value that specifies whether the Skip-Only-Editor-Only feature is enabled. CookOnTheSide/CookOnTheFlyServer.h  
bSkipSave bool Whether to skip saving packages that are cooked. CookOnTheSide/CookOnTheFlyServer.h  
BuildDefinitions TUniquePtr< UE::Cook::FBuildDefinitions >   CookOnTheSide/CookOnTheFlyServer.h  
bUseSoftGC bool   CookOnTheSide/CookOnTheFlyServer.h  
bWarnedExceededMaxMemoryWithinGCCooldown bool   CookOnTheSide/CookOnTheFlyServer.h  
bWriteIncrementallyModifiedDiagnosticsToLogs bool   CookOnTheSide/CookOnTheFlyServer.h  
bZenStore bool Whether we're using ZenStore for storage of cook results. CookOnTheSide/CookOnTheFlyServer.h  
CachedMaterialsToCacheArray TArray< FWeakObjectPtr > Precaching system CookOnTheSide/CookOnTheFlyServer.h  
CachedTexturesToCacheArray TArray< FWeakObjectPtr >   CookOnTheSide/CookOnTheFlyServer.h  
ConfigCollector TRefCountPtr< UE::Cook::IMPCollector >   CookOnTheSide/CookOnTheFlyServer.h  
ConfigSettingDenyList TArray< FString >   CookOnTheSide/CookOnTheFlyServer.h  
CookArtifacts TArray< TRefCountPtr< UE::Cook::ICookArtifact > >   CookOnTheSide/CookOnTheFlyServer.h  
CookByTheBookOptions TUniquePtr< UE::Cook::FCookByTheBookOptions >   CookOnTheSide/CookOnTheFlyServer.h  
CookDirector TUniquePtr< UE::Cook::FCookDirector >   CookOnTheSide/CookOnTheFlyServer.h  
CookedPackageCountSinceLastGC uint32   CookOnTheSide/CookOnTheFlyServer.h  
CookerIdleWarningSeverity ELogVerbosity::Type   CookOnTheSide/CookOnTheFlyServer.h  
CookFilterIncludedAssetClasses TSet< FName > Classes (and all subclasses) that were listed as the only asset classes that should be cooked in the filter settings. CookOnTheSide/CookOnTheFlyServer.h  
CookFilterIncludedClasses TSet< FName > Classes (and all subclasses) that were listed as the only classes that should be cooked in the filter settings. CookOnTheSide/CookOnTheFlyServer.h  
CookFlags ECookInitializationFlags   CookOnTheSide/CookOnTheFlyServer.h  
CookOnTheFlyNetworkServer TSharedPtr< UE::Cook::ICookOnTheFlyNetworkServer >   CookOnTheSide/CookOnTheFlyServer.h  
CookOnTheFlyOptions TUniquePtr< UE::Cook::FCookOnTheFlyOptions >   CookOnTheSide/CookOnTheFlyServer.h  
CookOnTheFlyRequestManager TUniquePtr< UE::Cook::ICookOnTheFlyRequestManager >   CookOnTheSide/CookOnTheFlyServer.h  
CookOnTheFlyServerInterface TUniquePtr< FCookOnTheFlyServerInterface >   CookOnTheSide/CookOnTheFlyServer.h  
CookProgressRetryBusyPeriodSeconds float Amount of time to wait when save and load are busy waiting on async operations before trying them again. CookOnTheSide/CookOnTheFlyServer.h  
CookWorkerClient TUniquePtr< UE::Cook::FCookWorkerClient >   CookOnTheSide/CookOnTheFlyServer.h  
CurrentAsyncCacheForType TMap< FName, int32 > Max number of objects of a specific type which are allowed to async cache at once CookOnTheSide/CookOnTheFlyServer.h  
CurrentCookMode ECookMode::Type Current cook mode the cook on the fly server is running in CookOnTheSide/CookOnTheFlyServer.h  
DesiredLoadQueueLength uint32 A knob to tune performance - How many packages should be present in the LoadPrepare+LoadReady queues before we start processing the LoadQueue. CookOnTheSide/CookOnTheFlyServer.h  
DesiredSaveQueueLength uint32 A knob to tune performance - How many packages should be present in the SaveQueue before we start processing the SaveQueue. CookOnTheSide/CookOnTheFlyServer.h  
DiffModeHelper TUniquePtr< FDiffModeCookServerUtils > Helper struct for running cooking in diagnostic modes CookOnTheSide/CookOnTheFlyServer.h  
DirectorCookMode ECookMode::Type CookMode of the Cook Director, equal to CurrentCookMode if not a CookWorker, otherwise equal to Director's CurrentCookMode CookOnTheSide/CookOnTheFlyServer.h  
DirectorPollable TRefCountPtr< FPollable >   CookOnTheSide/CookOnTheFlyServer.h  
DisplayUpdatePeriodSeconds float   CookOnTheSide/CookOnTheFlyServer.h  
ExpectedFreedPackageNames TSet< FName > Packages that were expected to be freed by the last Soft GC and we expect not to load again. CookOnTheSide/CookOnTheFlyServer.h  
FAssetRegistryGenerator friend   CookOnTheSide/CookOnTheFlyServer.h  
FileModifiedDelegate FOnFileModifiedDelegate   CookOnTheSide/CookOnTheFlyServer.h  
FIncrementalValidatePackageWriter friend   CookOnTheSide/CookOnTheFlyServer.h  
GCDiagnosticContext TUniquePtr< UE::Cook::FCookGCDiagnosticContext >   CookOnTheSide/CookOnTheFlyServer.h  
GCKeepObjects TArray< TObjectPtr< UObject > > Objects that were collected during the single-threaded PreGarbageCollect callback and that should be reported as referenced in CookerAddReferencedObjects. CookOnTheSide/CookOnTheFlyServer.h  
GlobalArtifact UE::Cook::FGlobalCookArtifact *   CookOnTheSide/CookOnTheFlyServer.h  
HiddenDependenciesClassPathFilterList TSet< FName > AllowList or BlockList for reporting hidden dependencies, parsed from ini and commandline, only used if bHiddenDependenciesDebug. CookOnTheSide/CookOnTheFlyServer.h  
HiddenDependenciesLock FCriticalSection   CookOnTheSide/CookOnTheFlyServer.h  
IdleStatus EIdleStatus   CookOnTheSide/CookOnTheFlyServer.h  
IdleStatusLastReportTime double   CookOnTheSide/CookOnTheFlyServer.h  
IdleStatusStartTime double   CookOnTheSide/CookOnTheFlyServer.h  
IdleTimeToGC double Amount of time that is allowed to be idle before forcing a garbage collect. CookOnTheSide/CookOnTheFlyServer.h  
IncrementallyModifiedDiagnostics TUniquePtr< UE::Cook::FIncrementallyModifiedDiagnostics > These structs are TUniquePtr both for implementation hiding and because they are only sometimes needed. CookOnTheSide/CookOnTheFlyServer.h  
InitialRequestCount int32 Number of packages requested in CookByTheBook, set to 0 in other modes. CookOnTheSide/CookOnTheFlyServer.h  
LastCookableObjectTickTime double Tracking for the ticking of tickable cook objects CookOnTheSide/CookOnTheFlyServer.h  
LastCookedPackagesCount int32   CookOnTheSide/CookOnTheFlyServer.h  
LastCookPendingCount int32   CookOnTheSide/CookOnTheFlyServer.h  
LastDiagnosticsDisplayTime double   CookOnTheSide/CookOnTheFlyServer.h  
LastFullGCTime double   CookOnTheSide/CookOnTheFlyServer.h  
LastGCTime double   CookOnTheSide/CookOnTheFlyServer.h  
LastProgressDisplayTime double   CookOnTheSide/CookOnTheFlyServer.h  
LastSoftGCTime double   CookOnTheSide/CookOnTheFlyServer.h  
LastUpdateTick int32   CookOnTheSide/CookOnTheFlyServer.h  
LoadBatchSize int32 A knob to tune performance - how many packages to load in each call to PumpLoads. CookOnTheSide/CookOnTheFlyServer.h  
LoadBusyRetryTimeSeconds double   CookOnTheSide/CookOnTheFlyServer.h  
LoadBusyStartTimeSeconds double   CookOnTheSide/CookOnTheFlyServer.h  
LoadBusyWarnTimeSeconds double   CookOnTheSide/CookOnTheFlyServer.h  
LogHandler TUniquePtr< UE::Cook::ILogHandler >   CookOnTheSide/CookOnTheFlyServer.h  
MaxAsyncCacheForType TMap< FName, int32 > Max number of objects of a specific type which are allowed to async cache at once CookOnTheSide/CookOnTheFlyServer.h  
MaxConcurrentShaderJobs int32 Max number of concurrent shader jobs reducing this too low will increase cook time CookOnTheSide/CookOnTheFlyServer.h  
MaxNumPackagesBeforePartialGC int32 Max number of packages to save before we partial gc CookOnTheSide/CookOnTheFlyServer.h  
MaxPrecacheShaderJobs int32   CookOnTheSide/CookOnTheFlyServer.h  
MaxPreloadAllocated uint32 The maximum number of packages that should be preloaded at once. CookOnTheSide/CookOnTheFlyServer.h  
MemoryExpectedFreedToSpreadRatio float   CookOnTheSide/CookOnTheFlyServer.h  
MemoryMaxUsedPhysical uint64   CookOnTheSide/CookOnTheFlyServer.h  
MemoryMaxUsedVirtual uint64 Memory Limits for when to Collect Garbage CookOnTheSide/CookOnTheFlyServer.h  
MemoryMinFreePhysical uint64   CookOnTheSide/CookOnTheFlyServer.h  
MemoryMinFreeVirtual uint64   CookOnTheSide/CookOnTheFlyServer.h  
MemoryTriggerGCAtPressureLevel FGenericPlatformMemoryStats::EMemoryPressureStatus   CookOnTheSide/CookOnTheFlyServer.h  
MinFreeUObjectIndicesBeforeGC int32 Min number of free UObject indices before the cooker should partial gc CookOnTheSide/CookOnTheFlyServer.h  
ModifiedAssetFilenames TSet< FName > List of filenames that may be out of date in the asset registry CookOnTheSide/CookOnTheFlyServer.h  
MPCookGeneratorSplit UE::Cook::EMPCookGeneratorSplit   CookOnTheSide/CookOnTheFlyServer.h  
NetworkFileServers TArray< class INetworkFileServer * > Cook on the fly server uses the NetworkFileServer CookOnTheSide/CookOnTheFlyServer.h  
NumObjectsHistory UE::Cook::FStatHistoryInt   CookOnTheSide/CookOnTheFlyServer.h  
ObjectHandleReadHandle UE::CoreUObject::FObjectHandleTrackingCallbackId Registration handle for TObjectPtr's OnRead delegate. CookOnTheSide/CookOnTheFlyServer.h  
ODSCClientData TUniquePtr< UE::Cook::FODSCClientData >   CookOnTheSide/CookOnTheFlyServer.h  
OutputDirectoryOverride FString Directory to output to instead of the default should be empty in the case of DLC cooking CookOnTheSide/CookOnTheFlyServer.h  
OutSCLCSVPaths TMap< FName, TArray< FString > > Map of platform name to scl.csv files we saved out. CookOnTheSide/CookOnTheFlyServer.h  
OverrideCookCVarControl int32 Override for Cook.CVarControl, parsed from the commandline (-CookCVarControl=) CookOnTheSide/CookOnTheFlyServer.h  
OverrideDeviceProfileName FName Override for the platform-dependent base device profile used for cooking, parsed from the commandline (-DeviceProfile=) CookOnTheSide/CookOnTheFlyServer.h  
PackageDataFromBaseGameNum int32   CookOnTheSide/CookOnTheFlyServer.h  
PackageDatas TUniquePtr< UE::Cook::FPackageDatas >   CookOnTheSide/CookOnTheFlyServer.h  
PackagesPerGC uint32 Number of packages to load before performing a garbage collect. CookOnTheSide/CookOnTheFlyServer.h  
PackageTracker TUniquePtr< UE::Cook::FPackageTracker > These structs are TUniquePtr rather than inline members so we can keep their headers private. CookOnTheSide/CookOnTheFlyServer.h  
PhaseTransitionFence int32   CookOnTheSide/CookOnTheFlyServer.h  
PlatformManager TUniquePtr< UE::Cook::FPlatformManager >   CookOnTheSide/CookOnTheFlyServer.h  
PluginsToRemap TArray< TSharedRef< IPlugin > > List of additional plugin directories to remap into the sandbox as needed CookOnTheSide/CookOnTheFlyServer.h  
Pollables TArray< FPollableQueueKey > Heap of Pollables to tick, ordered by NextTimeSeconds. CookOnTheSide/CookOnTheFlyServer.h  
PollablesDeferredTriggers TArray< FPollableQueueKey > List of pollables that were triggered during PumpPollables and need to be updated when the Pump is done. CookOnTheSide/CookOnTheFlyServer.h  
PollablesLock FCriticalSection Together with bPollablesInTick, provides a lock around Pollables. CookOnTheSide/CookOnTheFlyServer.h  
PollNextTimeIdleSeconds double   CookOnTheSide/CookOnTheFlyServer.h  
PollNextTimeSeconds double   CookOnTheSide/CookOnTheFlyServer.h  
QueuedCancelPollable TRefCountPtr< FPollable >   CookOnTheSide/CookOnTheFlyServer.h  
RecompileRequestsPollable TRefCountPtr< FPollable >   CookOnTheSide/CookOnTheFlyServer.h  
RegisteredSplitDataClasses TMultiMap< UClass *, UE::Cook::Private::FRegisteredCookPackageSplitter * >   CookOnTheSide/CookOnTheFlyServer.h  
RequestBatchSize uint32 A knob to tune performance - how many packages to pull off in each call to PumpRequests. CookOnTheSide/CookOnTheFlyServer.h  
SandboxFile TUniquePtr< UE::Cook::FCookSandbox >   CookOnTheSide/CookOnTheFlyServer.h  
SandboxFileOutputDirectory FString   CookOnTheSide/CookOnTheFlyServer.h  
SaveBusyRetryTimeSeconds double   CookOnTheSide/CookOnTheFlyServer.h  
SaveBusyStartTimeSeconds double Timers for tracking how long we have been busy, to manage retries and warnings of deadlock CookOnTheSide/CookOnTheFlyServer.h  
SaveBusyWarnTimeSeconds double   CookOnTheSide/CookOnTheFlyServer.h  
SavePackageContexts TArray< UE::Cook::FCookSavePackageContext * >   CookOnTheSide/CookOnTheFlyServer.h  
SavingPackageData UE::Cook::FPackageData *   CookOnTheSide/CookOnTheFlyServer.h  
SharedLooseFilesCookArtifactReader TSharedPtr< FLooseFilesCookArtifactReader >   CookOnTheSide/CookOnTheFlyServer.h  
SoftGCDenominator int32   CookOnTheSide/CookOnTheFlyServer.h  
SoftGCHistory TUniquePtr< UE::Cook::FSoftGCHistory >   CookOnTheSide/CookOnTheFlyServer.h  
SoftGCMinimumPeriodSeconds float   CookOnTheSide/CookOnTheFlyServer.h  
SoftGCNextAvailablePhysicalTarget int64   CookOnTheSide/CookOnTheFlyServer.h  
SoftGCPackageToObjectListBuffer TArray< UObject * > Used during garbagecolletion: a flat array of all the elements in UPackage::SoftGCPackageToObjectList arrayviews. CookOnTheSide/CookOnTheFlyServer.h  
SoftGCStartNumerator int32   CookOnTheSide/CookOnTheFlyServer.h  
SoftGCTimeFractionBudget float   CookOnTheSide/CookOnTheFlyServer.h  
StallDetector TUniquePtr< UE::Cook::FStallDetector >   CookOnTheSide/CookOnTheFlyServer.h  
StatLoadedPackageCount uint32   CookOnTheSide/CookOnTheFlyServer.h  
StatSavedPackageCount uint32   CookOnTheSide/CookOnTheFlyServer.h  
UnexpectedLoadWarningSeverity ELogVerbosity::Type   CookOnTheSide/CookOnTheFlyServer.h  
VirtualMemoryHistory UE::Cook::FStatHistoryInt   CookOnTheSide/CookOnTheFlyServer.h  
WaitForAsyncSleepSeconds float   CookOnTheSide/CookOnTheFlyServer.h  
WorkerRequests TUniquePtr< UE::Cook::IWorkerRequests >   CookOnTheSide/CookOnTheFlyServer.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool BroadcastFileserverPresence ( const FGuid& InstanceId
)

 Broadcast the fileserver's presence on the network CookOnTheSide/CookOnTheFlyServer.h  

void CancelAllQueues ()

 Demote PackageDatas in any queue back to Idle, and eliminate pending requests. CookOnTheSide/CookOnTheFlyServer.h  

void CancelCookByTheBook()

 Cancel the currently running cook by the book (needs to be called from the game thread) CookOnTheSide/CookOnTheFlyServer.h  

void ClearAllCookedData()

 Clear all the previously cooked data all cook requests from now on will be considered recook requests CookOnTheSide/CookOnTheFlyServer.h  

void ClearCachedCookedPlatformDataForPlatform ( const ITargetPlatform* TargetPlatform
)

 Clear any cached cooked platform data for a platform and call ClearCachedCookedPlatformData on all UObjects. CookOnTheSide/CookOnTheFlyServer.h  

void ClearGarbageCollectType()

   CookOnTheSide/CookOnTheFlyServer.h  

void ClearPlatformCookedData ( const ITargetPlatform* TargetPlatform
)

 Clear all the previously cooked data for the platform passed in CookOnTheSide/CookOnTheFlyServer.h  

void CookerAddReferencedObjects ( FReferenceCollector& Ar
)

   CookOnTheSide/CookOnTheFlyServer.h  

void DumpStats()

 Dumps cooking stats to the log. Run from the exec command "Cook stats". CookOnTheSide/CookOnTheFlyServer.h  

void EvaluateGarbageCollectionResults ( bool bWasDueToOOM,
bool bWasPartialGC,
uint32 ResultFlags,
int32 NumObjectsBeforeGC,
const FPlatformMemoryStats& MemStatsBeforeGC,
const FGenericMemoryStats& AllocatorStatsBeforeGC,
int32 NumObjectsAfterGC,
const FPlatformMemoryStats& MemStatsAfterGC,
const FGenericMemoryStats& AllocatorStatsAfterGC,
float GCDurationSeconds
)

   CookOnTheSide/CookOnTheFlyServer.h  

ECookInitializationFlags GetCookFlags()

   CookOnTheSide/CookOnTheFlyServer.h  

ECookMode::Type GetCookMode()

   CookOnTheSide/CookOnTheFlyServer.h  

double GetIdleTimeToGC()

 Returns the configured amount of idle time before forcing a GC CookOnTheSide/CookOnTheFlyServer.h  

uint32 GetPackagesPerGC()

 Returns the configured number of packages to process before GC CookOnTheSide/CookOnTheFlyServer.h  

uint32 GetPackagesPerPartialGC()

 Returns the configured number of packages to process before partial GC CookOnTheSide/CookOnTheFlyServer.h  

void GetShaderLibraryPaths ( const ITargetPlatform* TargetPlatform,
FString& OutShaderCodeDir,
FString& OutMetaDataPath,
bool bUseProjectDirForDLC
)

 Calculate the ShaderLibrary codedir and metadatadir CookOnTheSide/CookOnTheFlyServer.h  

bool HasExceededMaxMemory()

   CookOnTheSide/CookOnTheFlyServer.h  
Return whether the tick needs to take any action for the current session. CookOnTheSide/CookOnTheFlyServer.h  

void Initialize ( ECookMode::Type DesiredCookMode,
ECookInitializationFlags InCookInitializationFlags,
const FString& OutputDirectoryOverride
)

 Initialize *this so that either CookOnTheFly or CookByTheBook can be started and ticked CookOnTheSide/CookOnTheFlyServer.h  

bool IsCookByTheBookMode()

 Is the local CookOnTheFlyServer initialized to run CookByTheBook (find all required packages and cook them)? CookOnTheSide/CookOnTheFlyServer.h  

bool IsCookByTheBookRunning()

 Is the local CookOnTheFlyServer in a cook session in CookByTheBook Mode? CookOnTheSide/CookOnTheFlyServer.h  

bool IsCookingDLC()

 Is the local CookOnTheFlyServer cooking a DLC plugin rather than a Project+Engine+EmbeddedPlugins? CookOnTheSide/CookOnTheFlyServer.h  

bool IsCookingInEditor()

 Is the local CookOnTheFlyServer running in the editor? CookOnTheSide/CookOnTheFlyServer.h  

bool IsCookOnTheFlyMode()

 Is the local CookOnTheFlyServer initialized to run CookOnTheFly (accept connections from game executables, cook what they ask for)? CookOnTheSide/CookOnTheFlyServer.h  

bool IsCookWorkerMode()

 Is the local CookOnTheFlyServer initialized to run as a CookWorker (connect to a Director cooker cooking CBTB or COTF, cook what it assigns to us)? CookOnTheSide/CookOnTheFlyServer.h  

bool IsDirectorCookByTheBook()

 Is the CookDirector (local CookOnTheFlyServer for SPCook or MPDirector, or the remote MPDirector for a CookWorker) initialized to run CookByTheBook? CookOnTheSide/CookOnTheFlyServer.h  

bool IsDirectorCookOnTheFly()

 Is the CookDirector (local CookOnTheFlyServer for SPCook or MPDirector, or the remote MPDirector for a CookWorker) initialized to run CookOnTheFly? CookOnTheSide/CookOnTheFlyServer.h  

bool IsInSession()

 Is the local CookOnTheFlyServer in a cook session in any CookMode? Used to restrict operations when cooking and reduce cputime when not cooking. CookOnTheSide/CookOnTheFlyServer.h  

bool IsRealtimeMode()

 Is the local CookOnTheFlyServer initialized to run in real time mode (respects the timeslice), (e.g. in Editor)? CookOnTheSide/CookOnTheFlyServer.h  

bool IsStalled()

   CookOnTheSide/CookOnTheFlyServer.h  

bool IsUsingShaderCodeLibrary()

 Is the local CookOnTheFlyServer in a mode that uses ShaderCodeLibraries rather than storing shaders in the Packages that use them? CookOnTheSide/CookOnTheFlyServer.h  

bool IsUsingZenStore()

 Is the local CookOnTheFlyServer using ZenStore (cooked packages are stored in Zen's Cache storage rather than as loose files on disk)? CookOnTheSide/CookOnTheFlyServer.h  

void LogCookWorkerStats()

 Log stats for the CookWorker; this is called before the connection to the director is terminated. CookOnTheSide/CookOnTheFlyServer.h  

void MarkPackageDirtyForCooker ( UPackage* Package,
bool bAllowInSession
)

 Marks a package as dirty for cook causes package to be recooked on next request (and all dependent packages which are currently cooked) CookOnTheSide/CookOnTheFlyServer.h  
Helper function for MarkPackageDirtyForCooker. CookOnTheSide/CookOnTheFlyServer.h  

void MaybeMarkPackageAsAlreadyLoaded ( UPackage* Package
)

 MaybeMarkPackageAsAlreadyLoaded Mark the package as already loaded if we have already cooked the package for all requested target platforms this hints to the objects on load that we don't need to load all our bulk data CookOnTheSide/CookOnTheFlyServer.h  

bool NeedsDiagnosticSecondGC()

   CookOnTheSide/CookOnTheFlyServer.h  

uint32 NumConnections()

   CookOnTheSide/CookOnTheFlyServer.h  

void OnCookerEndCollectGarbage ( uint32& ResultFlagsFromTick
)

   CookOnTheSide/CookOnTheFlyServer.h  

void OnCookerStartCollectGarbage ( uint32& ResultFlagsFromTick
)

   CookOnTheSide/CookOnTheFlyServer.h  

void OnObjectModified ( UObject* ObjectMoving
)

 Callbacks from editor CookOnTheSide/CookOnTheFlyServer.h  

void OnObjectPropertyChanged ( UObject* ObjectBeingModified,
FPropertyChangedEvent& PropertyChangedEvent
)

   CookOnTheSide/CookOnTheFlyServer.h  

void OnObjectSaved ( UObject* ObjectSaved,
FObjectPreSaveContext SaveContext
)

   CookOnTheSide/CookOnTheFlyServer.h  

void OnObjectUpdated ( UObject* Object
)

   CookOnTheSide/CookOnTheFlyServer.h  

void PostGarbageCollect()

   CookOnTheSide/CookOnTheFlyServer.h  

void PostLoadPackageFixup ( UE::Cook::FPackageData& PackageData,
UPackage* Package
)

 Execute class-specific special case cook postloads and reference discovery on a given package. CookOnTheSide/CookOnTheFlyServer.h  

void PreGarbageCollect()

 Callbacks from UObject globals. CookOnTheSide/CookOnTheFlyServer.h  

void PrintDetailedCookStats()

 Print detailed stats from the cook. CookOnTheSide/CookOnTheFlyServer.h  

void QueueCancelCookByTheBook()

 Queue a cook by the book cancel (can be called from any thread) CookOnTheSide/CookOnTheFlyServer.h  

bool RecompileChangedShaders ( const TArray< const ITargetPlatform* >& TargetPlatforms
)

 Recompile any global shader changes if any are detected then clear the cooked platform data so that they can be rebuilt CookOnTheSide/CookOnTheFlyServer.h  

bool RequestPackage ( const FName& StandardFileName,
const TArrayView< const ITargetPlatform*const >& TargetPlatforms,
const bool bForceFrontOfQueue
)

 RequestPackage to be cooked CookOnTheSide/CookOnTheFlyServer.h  

bool RequestPackage ( const FName& StandardPackageFName,
const bool bForceFrontOfQueue
)

 RequestPackage to be cooked This function can only be called while the cooker is in cook by the book mode CookOnTheSide/CookOnTheFlyServer.h  

void ResetCook ( TConstArrayView< TPair< const ITargetPlatform*, bool > > TargetPlatforms
)

 Clear platforms' explored flags for all PackageDatas and optionally clear the cookresult flags. CookOnTheSide/CookOnTheFlyServer.h  

void RunCookList ( ECookListOptions CookListOptions
)

 Log a list of all of the transitively requested packages. CookOnTheSide/CookOnTheFlyServer.h  

void SetGarbageCollectType ( uint32 ResultFlagsFromTick
)

   CookOnTheSide/CookOnTheFlyServer.h  

bool ShouldVerifyEDLCookInfo()

 Return whether EDLCookInfo verification has NOT been rendered useless by settings such as CookFilter. CookOnTheSide/CookOnTheFlyServer.h  

void ShutdownCookAsCookWorker()

 Terminate the CookWorker session CookOnTheSide/CookOnTheFlyServer.h  

void ShutdownCookOnTheFly()

 Shutdown *this from running in CookOnTheFly mode CookOnTheSide/CookOnTheFlyServer.h  

void StartCookByTheBook ( const FCookByTheBookStartupOptions& CookByTheBookStartupOptions
)

 Start a cook by the book session Cook on the fly can't run at the same time as cook by the book CookOnTheSide/CookOnTheFlyServer.h  

bool StartCookOnTheFly ( FCookOnTheFlyStartupOptions InCookOnTheFlyOptions
)

 Initialize cook on the fly server CookOnTheSide/CookOnTheFlyServer.h  

void StopAndClearCookedData()

 Force stop whatever pending cook requests are going on and clear all the cooked data Note CookOnTheFly clients may not be able to recover from this if they are waiting on a cook request to complete CookOnTheSide/CookOnTheFlyServer.h  

uint32 TickCookByTheBook ( const float TimeSlice,
ECookTickFlags TickFlags
)

 Tick CBTB until it finishes or needs to yield. Should only be called when in CookByTheBook Mode. CookOnTheSide/CookOnTheFlyServer.h  

uint32 TickCookOnTheFly ( const float TimeSlice,
ECookTickFlags TickFlags
)

 Tick COTF until it finishes or needs to yield. Should only be called when in CookOnTheFly Mode. CookOnTheSide/CookOnTheFlyServer.h  

uint32 TickCookWorker()

 Tick CookWorker until it finishes or needs to yield. Should only be called when in CookWorker Mode. CookOnTheSide/CookOnTheFlyServer.h  

void TickRequestManager()

   CookOnTheSide/CookOnTheFlyServer.h  

bool TryInitializeCookWorker()

 Connect to the CookDirector host, Initialize this UCOTFS, and start the CookWorker session CookOnTheSide/CookOnTheFlyServer.h  

EDataValidationResult ValidateSourcePackage ( UE::Cook::FPackageData& PackageData,
UPackage* Package
)

 Execute validation on a loaded source package. CookOnTheSide/CookOnTheFlyServer.h  

void WaitForRequests ( int TimeoutMs
)

   CookOnTheSide/CookOnTheFlyServer.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   CookOnTheSide/CookOnTheFlyServer.h  

Overridden from FTickableObjectBase

Name Remarks Include Path Unreal Specifiers

virtual TStatId GetStatId()

 FTickableEditorObject interface used by cook on the side. CookOnTheSide/CookOnTheFlyServer.h  

virtual bool IsTickable()

   CookOnTheSide/CookOnTheFlyServer.h  

virtual void Tick ( float DeltaTime
)

   CookOnTheSide/CookOnTheFlyServer.h  

Overridden from ICookInfo

Name Remarks Include Path Unreal Specifiers

virtual FString GetBasedOnReleaseVersion()

   CookOnTheSide/CookOnTheFlyServer.h  

virtual UE::Cook::ECookingDLC GetCookingDLC()

   CookOnTheSide/CookOnTheFlyServer.h  

virtual FString GetCookOutputFolder ( const ITargetPlatform* TargetPlatform
)

   CookOnTheSide/CookOnTheFlyServer.h  

virtual UE::Cook::ECookType GetCookType()

   CookOnTheSide/CookOnTheFlyServer.h  

virtual UE::Cook::ECookValidationOptions GetCookValidationOptions()

   CookOnTheSide/CookOnTheFlyServer.h  

virtual FString GetCreateReleaseVersion()

   CookOnTheSide/CookOnTheFlyServer.h  

virtual void GetCulturesToCook ( TArray< FString >& OutCulturesToCook
) const

   CookOnTheSide/CookOnTheFlyServer.h  

virtual FString GetDLCName()

   CookOnTheSide/CookOnTheFlyServer.h  

virtual const TSet< IPlugin * > * GetEnabledPlugins ( const ITargetPlatform* TargetPlatform
)

   CookOnTheSide/CookOnTheFlyServer.h  

virtual UE::Cook::FInstigator GetInstigator ( FName PackageName
)

   CookOnTheSide/CookOnTheFlyServer.h  

virtual TArray< UE::Cook::FInstigator > GetInstigatorChain ( FName PackageName
)

   CookOnTheSide/CookOnTheFlyServer.h  

virtual UE::Cook::EProcessType GetProcessType()

   CookOnTheSide/CookOnTheFlyServer.h  

virtual TArray< const ITargetPlatform * > GetSessionPlatforms()

   CookOnTheSide/CookOnTheFlyServer.h  

virtual bool IsIncremental()

   CookOnTheSide/CookOnTheFlyServer.h  

virtual void RegisterArtifact ( UE::Cook::ICookArtifact* Artifact
)

   CookOnTheSide/CookOnTheFlyServer.h  

virtual void RegisterCollector ( UE::Cook::IMPCollector* Collector,
UE::Cook::EProcessType ProcessType
)

   CookOnTheSide/CookOnTheFlyServer.h  

virtual void UnregisterArtifact ( UE::Cook::ICookArtifact* Artifact
)

   CookOnTheSide/CookOnTheFlyServer.h  

virtual void UnregisterCollector ( UE::Cook::IMPCollector* Collector
)

   CookOnTheSide/CookOnTheFlyServer.h  

Overridden from ICookerInterface

Name Remarks Include Path Unreal Specifiers

virtual EPackageWriterResult CookerBeginCacheForCookedPlatformData ( UE::PackageWriter::Private::FBeginCacheForCookedPlatformDataInfo& Info
)

   CookOnTheSide/CookOnTheFlyServer.h  

virtual bool IsDeterminismDebug()

   CookOnTheSide/CookOnTheFlyServer.h  

virtual void RegisterDeterminismHelper ( ICookedPackageWriter* PackageWriter,
UObject* SourceObject,
const TRefCountPtr< UE::Cook::IDeterminismHelper >& DeterminismHelper
)

   CookOnTheSide/CookOnTheFlyServer.h  

virtual void WriteFileOnCookDirector ( const UE::PackageWriter::Private::FWriteFileData& FileData,
FMD5& AccumulatedHash,
const TRefCountPtr< FPackageHashes >& PackageHashes,
IPackageWriter::EWriteOptions WriteOptions
)

   CookOnTheSide/CookOnTheFlyServer.h  

Protected

Overridden from FExec

Name Remarks Include Path Unreal Specifiers

virtual bool Exec_Editor ( UWorld* InWorld,
const TCHAR* Cmd,
FOutputDevice& Ar
)

 FExec interface used in the editor. CookOnTheSide/CookOnTheFlyServer.h  

Static

Name Remarks Include Path Unreal Specifiers

static void GetGameDefaultObjects ( const TArray< ITargetPlatform* >& TargetPlatforms,
TMap< FName, TArray< FName > >& GameDefaultObjectsOut
)

 Gets all game default objects for all platforms. CookOnTheSide/CookOnTheFlyServer.h  

static FString GetMountedAssetPathForPlugin ( const FString& InPluginName
)

   CookOnTheSide/CookOnTheFlyServer.h  

static FOnCookByTheBookFinished & OnCookByTheBookFinished()

   CookOnTheSide/CookOnTheFlyServer.h  

static FOnCookByTheBookStarted & OnCookByTheBookStarted()

   CookOnTheSide/CookOnTheFlyServer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page