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

Public Member Functions

virtual void StartupModule () override
 
virtual void ShutdownModule () override
 
virtual bool SupportsDynamicReloading () override
 
virtual TSharedPtr< IPortalServiceGetService (const FString &ServiceName, const TSharedRef< FTypeContainer > &Dependencies) override
 
- Public Member Functions inherited from IModuleInterface
virtual ~IModuleInterface ()
 
virtual void PreUnloadCallback ()
 
virtual void PostLoadCallback ()
 
virtual bool SupportsAutomaticShutdown ()
 
virtual bool IsGameModule () const
 

Detailed Description

Implements the PortalProxies module.

Member Function Documentation

◆ GetService()

virtual TSharedPtr< IPortalService > FPortalProxiesModule::GetService ( const FString &  ServiceName,
const TSharedRef< FTypeContainer > &  Dependencies 
)
inlineoverridevirtual

Get a service instance of the specified type.

Parameters
ServiceNameThe name of the service type to get.
DependenciesOptional service dependencies.
Returns
The service instance, or nullptr if unavailable.

Implements IPortalServiceProvider.

◆ ShutdownModule()

virtual void FPortalProxiesModule::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 FPortalProxiesModule::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 FPortalProxiesModule::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: