1. Epic GamesDeveloper
  3. UCookOnTheFlyServer

UCookOnTheFlyServer

API > API/Editor > API/Editor/UnrealEd > API/Editor/UnrealEd/CookOnTheSide

Inheritance Hierarchy

References

   
Module UnrealEd
Header /Engine/Source/Editor/UnrealEd/Classes/CookOnTheSide/CookOnTheFlyServer.h
Include #include "CookOnTheSide/CookOnTheFlyServer.h"

Syntax

class UCookOnTheFlyServer :  
    public UObject,  
    public FTickableEditorObject,  
    public FExec,  
    public UE::Cook::ICookInfo

Constructors

No constructors are accessible with public or protected access.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function bool

BroadcastFileserverPresence ( const FGuid& InstanceId
)

 Broadcast the fileserver's presence on the network
Public function void Demote PackageDatas in any queue back to Idle, and eliminate pending requests.
Public function void Cancel the currently running cook by the book (needs to be called from the game thread)
Public function void Clear all the previously cooked data all cook requests from now on will be considered recook requests
Public function void Clear any cached cooked platform data for a platform and call ClearCachedCookedPlatformData on all UObjects.
Public function void  
Public function void

ClearPlatformCookedData ( const ITargetPlatform* TargetPlatform
)

 Clear all the previously cooked data for the platform passed in
Public function void  
Public function void Dumps cooking stats to the log. Run from the exec command "Cook stats".
Public function void

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

  
Public function Const ECookInitializationFlags  
Public function Const ECookMode::Type  
Public function Const double Returns the configured amount of idle time before forcing a GC
Public function Const uint32 Returns the configured number of packages to process before GC
Public function Const uint32 Returns the configured number of packages to process before partial GC
Public function void

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

 Calculate the ShaderLibrary codedir and metadatadir
Public function Const bool Return whether the tick needs to take any action for the current session.
Public function void

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

 Initialize *this so that either CookOnTheFly or CookByTheBook can be started and ticked
Public function Const bool Is the local CookOnTheFlyServer initialized to run CookByTheBook (find all required packages and cook them)?
Public function Const bool Is the local CookOnTheFlyServer in a cook session in CookByTheBook Mode?
Public function Const bool Is the local CookOnTheFlyServer cooking a DLC plugin rather than a Project+Engine+EmbeddedPlugins?
Public function Const bool Is the local CookOnTheFlyServer running in the editor?
Public function Const bool Is the local CookOnTheFlyServer initialized to run CookOnTheFly (accept connections from game executables, cook what they ask for)?
Public function Const bool 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)?
Public function Const bool Is the CookDirector (local CookOnTheFlyServer for SPCook or MPDirector, or the remote MPDirector for a CookWorker) initialized to run CookByTheBook?
Public function Const bool Is the CookDirector (local CookOnTheFlyServer for SPCook or MPDirector, or the remote MPDirector for a CookWorker) initialized to run CookOnTheFly?
Public function Const bool Is the local CookOnTheFlyServer in a cook session in any CookMode? Used to restrict operations when cooking and reduce cputime when not cooking.
Public function Const bool Is the local CookOnTheFlyServer initialized to run in real time mode (respects the timeslice), (e.g. in Editor)?
Public function Const bool Is the local CookOnTheFlyServer in a mode that uses ShaderCodeLibraries rather than storing shaders in the Packages that use them?
Public function Const bool Is the local CookOnTheFlyServer using ZenStore (cooked packages are stored in Zen's Cache storage rather than as loose files on disk)?
Public function void Log stats for the CookWorker; this is called before the connection to the director is terminated.
Public function 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)
Public function void Helper function for MarkPackageDirtyForCooker.
Public function void 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
Public function Const uint32  
Public function Static FOnCookByTheBookFinished &  
Public function Static FOnCookByTheBookStarted &  
Public function void

OnObjectModified ( UObject* ObjectMoving
)

 Callbacks from editor
Public function void

OnObjectPropertyChanged ( UObject* ObjectBeingModified,
FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function void

OnObjectSaved ( UObject* ObjectSaved,
FObjectPreSaveContext SaveContext
)

  
Public function void

OnObjectUpdated ( UObject* Object
)

  
Public function void  
Public function void

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

 Execute class-specific special case cook postloads and reference discovery on a given package.
Public function void Callbacks from UObject globals.
Public function void Print detailed stats from the cook.
Public function void Queue a cook by the book cancel (can be called from any thread)
Public function 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
Public function bool

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

 RequestPackage to be cooked
Public function 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
Public function void

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

 Clear platforms' explored flags for all PackageDatas and optionally clear the cookresult flags.
Public function void

RunCookList ( ECookListOptions CookListOptions
)

 Log a list of all of the transitively requested packages.
Public function void

SetGarbageCollectType ( uint32 ResultFlagsFromTick
)

  
Public function Const bool Return whether EDLCookInfo verification has NOT been rendered useless by settings such as CookFilter.
Public function void Terminate the CookWorker session
Public function void Shutdown *this from running in CookOnTheFly mode
Public function 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
Public function bool Initialize cook on the fly server
Public function void 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
Public function uint32

TickCookByTheBook ( const float TimeSlice,
ECookTickFlags TickFlags
)

 Tick CBTB until it finishes or needs to yield. Should only be called when in CookByTheBook Mode.
Public function uint32

TickCookOnTheFly ( const float TimeSlice,
ECookTickFlags TickFlags
)

 Tick COTF until it finishes or needs to yield. Should only be called when in CookOnTheFly Mode.
Public function uint32 Tick CookWorker until it finishes or needs to yield. Should only be called when in CookWorker Mode.
Public function void  
Public function bool Connect to the CookDirector host, Initialize this UCOTFS, and start the CookWorker session
Public function void

WaitForRequests ( int TimeoutMs
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.

Overridden from FTickableObjectBase

  Type Name Description
Public function Virtual Const TStatId FTickableEditorObject interface used by cook on the side.
Public function Virtual Const bool Virtual that can be overloaded by the inheriting class.
Public function Virtual void

Tick ( float DeltaTime
)

 Pure virtual that must be overloaded by the inheriting class.

Overridden from FExec

  Type Name Description
Protected function Virtual bool

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

 FExec interface used in the editor.

Overridden from ICookInfo

  Type Name Description
Public function Virtual UE::Cook::FInstigator

GetInstigator ( FName PackageName
)

 Return the instigator that first caused the package to be requested by the cook.
Public function Virtual TArray< UE::Cook::FInstigator >

GetInstigatorChain ( FName PackageName
)

 Return the chain of instigators that caused the package to be requested by the cook.

Classes

  Type Name Description
Public struct FCookByTheBookStartupOptions    
Public class FCookOnTheFlyServerInterface    
Public struct FCookOnTheFlyStartupOptions    

Enums

  Type Name Description
Private enum ECookAction    
Public enum ECookOnTheSideResult    
Private enum EIdleStatus    

Typedefs

Name Description
FOnCookByTheBookFinished  
FOnCookByTheBookStarted  
FPollFunction  

Constants

Name Description
ActiveCOTFS Cook on the fly server.
CookByTheBookFinishedEvent  
CookByTheBookStartedEvent Cook events that can be listenned to.

Deprecated Functions

  Type Name Description
Public function bool UCookOnTheFlyServer now uses a more complicated private GC scheme; HasExceededMaxMemory is no longer used and returns false

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page