UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ILauncherCheckModule Class Referenceabstract

#include <ILauncherCheckModule.h>

+ Inheritance diagram for ILauncherCheckModule:

Public Member Functions

virtual bool WasRanFromLauncher () const =0
 
virtual bool RunLauncher (ELauncherAction Action, FString Payload=FString()) const =0
 
virtual ~ILauncherCheckModule ()
 
- Public Member Functions inherited from IModuleInterface
virtual ~IModuleInterface ()
 
virtual void StartupModule ()
 
virtual void PreUnloadCallback ()
 
virtual void PostLoadCallback ()
 
virtual void ShutdownModule ()
 
virtual bool SupportsDynamicReloading ()
 
virtual bool SupportsAutomaticShutdown ()
 
virtual bool IsGameModule () const
 

Static Public Member Functions

static ILauncherCheckModuleGet ()
 

Detailed Description

Interface for the Launcher checking system

Constructor & Destructor Documentation

◆ ~ILauncherCheckModule()

virtual ILauncherCheckModule::~ILauncherCheckModule ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

◆ Get()

static ILauncherCheckModule & ILauncherCheckModule::Get ( )
inlinestatic

Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.

Returns
Returns singleton instance, loading the module on demand if needed

◆ RunLauncher()

virtual bool ILauncherCheckModule::RunLauncher ( ELauncherAction  Action,
FString  Payload = FString() 
) const
pure virtual

Opens the launcher, appending our identifier to the cmdline

Parameters
Action- The Action we want the launcher to take
Payload- (Optional) additional information we want to supply to the action uri
Returns
true, if it was successful

Implemented in FLauncherCheckModule.

◆ WasRanFromLauncher()

virtual bool ILauncherCheckModule::WasRanFromLauncher ( ) const
pure virtual

Checks to see if the current app was ran from the Launcher

Returns
true, if it was

Implemented in FLauncherCheckModule.


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