UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FCookOnTheFlyModule Class Referencefinal
+ Inheritance diagram for FCookOnTheFlyModule:

Public Member Functions

virtual void StartupModule () override
 
virtual void ShutdownModule () override
 
virtual bool SupportsDynamicReloading () override
 
virtual TSharedPtr< UE::Cook::ICookOnTheFlyServerConnectionGetDefaultServerConnection () override
 
virtual TUniquePtr< UE::Cook::ICookOnTheFlyServerConnectionConnectToServer (const UE::Cook::FCookOnTheFlyHostOptions &HostOptions) override
 
- Public Member Functions inherited from UE::Cook::ICookOnTheFlyModule
virtual ~ICookOnTheFlyModule ()
 
- Public Member Functions inherited from IModuleInterface
virtual ~IModuleInterface ()
 
virtual void PreUnloadCallback ()
 
virtual void PostLoadCallback ()
 
virtual bool SupportsAutomaticShutdown ()
 
virtual bool IsGameModule () const
 

Member Function Documentation

◆ ConnectToServer()

virtual TUniquePtr< UE::Cook::ICookOnTheFlyServerConnection > FCookOnTheFlyModule::ConnectToServer ( const UE::Cook::FCookOnTheFlyHostOptions HostOptions)
inlineoverridevirtual

Connect to the cook-on-the-fly server.

Parameters
HostOptionsCook-on-the-fly host options.

Implements UE::Cook::ICookOnTheFlyModule.

◆ GetDefaultServerConnection()

virtual TSharedPtr< UE::Cook::ICookOnTheFlyServerConnection > FCookOnTheFlyModule::GetDefaultServerConnection ( )
inlineoverridevirtual

◆ ShutdownModule()

virtual void FCookOnTheFlyModule::ShutdownModule ( )
inlineoverridevirtual

Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finish StartupModule(). This means that, as long as a module references dependent modules in it's StartupModule(), it can safely reference those dependencies in ShutdownModule() as well.

Reimplemented from IModuleInterface.

◆ StartupModule()

virtual void FCookOnTheFlyModule::StartupModule ( )
inlineoverridevirtual

Called right after the module DLL has been loaded and the module object has been created Load dependent modules here, and they will be guaranteed to be available during ShutdownModule. ie:

FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

Reimplemented from IModuleInterface.

◆ SupportsDynamicReloading()

virtual bool FCookOnTheFlyModule::SupportsDynamicReloading ( )
inlineoverridevirtual

Override this to set whether your module is allowed to be unloaded on the fly

Returns
Whether the module supports shutdown separate from the rest of the engine.

Reimplemented from IModuleInterface.


The documentation for this class was generated from the following file: