FLaunchExtension | Unreal Engine 5.8 Documentation

Base class for a launch extension.

Singleton instance is registered with this plugin during initialization as follows:

TSharedPtr MyExtension = MakeShared(); IProjectLauncherModule::Get().RegisterExtension( MyExtension.ToSharedRef() );


Name	FLaunchExtension
Type	class
Header File	/Engine/Plugins/Developer/ProjectLauncher/Source/ProjectLauncher/Public/Extension/LaunchExtension.h
Include Path	#include "Extension/LaunchExtension.h"

Syntax

class FLaunchExtension : public TSharedFromThis< FLaunchExtension >

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FLaunchExtension()		Extension/LaunchExtension.h

Name	Remarks
FExtensionsMenuEntry	Describes how this extension is represented in the extensions menu

Name	Remarks	Include Path	Unreal Specifiers
FText GetDisplayName()	Returns the user-facing name for this extension	Extension/LaunchExtension.h
const TCHAR * GetInternalName()	Returns the debug name for this extension	Extension/LaunchExtension.h

Name	Remarks	Include Path
virtual FBuildCookRunLaunchExtension * AsBuildCookRunLaunchExtension()	Attempt to cast this launch extension to an BuildCookRun launch extension (this is an extension for a build cook run UAT command)	Extension/LaunchExtension.h
virtual IUATCommandExtensionFactory * AsUATCommandFactory()	Attempt to cast this launch extension instance to a UAT command factory	Extension/LaunchExtension.h
virtual bool CanBeCreated ( ILauncherProfileRef InProfile, TSharedRef< FModel > InModel ) const	Whether this extension can be created at this time	Extension/LaunchExtension.h
virtual void GetExtensionsMenuEntry ( FExtensionsMenuEntry& MenuEntry ) const		Extension/LaunchExtension.h
virtual FSlateIcon GetIcon()	Returns the icon to use for this extension in menus etc	Extension/LaunchExtension.h
virtual bool IsAlwaysCreated ( ILauncherProfileRef InProfile, TSharedRef< FModel > InModel ) const	Whether this extension is always created. the user cannot remove it	Extension/LaunchExtension.h
virtual bool IsCreatedByDefault ( ILauncherProfileRef InProfile, TSharedRef< FModel > InModel ) const	Whether this extension will be created by default. the user can still remove it	Extension/LaunchExtension.h
virtual bool IsUATCommandManager()	Whether this extension manages a UAT command	Extension/LaunchExtension.h
virtual void MakeCustomExtensionSubmenu ( FMenuBuilder& MenuBuilder, ILauncherProfileRef InProfile, TSharedRef< FModel > InModel )		Extension/LaunchExtension.h

Name	Remarks	Include Path
static TSharedPtr< FLaunchExtensionInstance > CreateExtensionInstance ( TSharedRef< FLaunchExtension > InExtension, ILauncherProfileRef InProfile, TSharedRef< FModel > InModel, FLaunchProfileTreeData& InOwnerTreeData, ILauncherProfileUATCommandPtr InUATCommand )		Extension/LaunchExtension.h
static TArray< TSharedPtr< FLaunchExtensionInstance > > CreateExtensionInstancesForProfile ( ILauncherProfileRef InProfile, TSharedRef< FModel > InModel, FLaunchProfileTreeData& InOwnerTreeData )	Instantiate all compatible extensions	Extension/LaunchExtension.h
static void DestroyExtensionInstance ( TSharedRef< FLaunchExtensionInstance > InExtensionInstance, ILauncherProfileRef InProfile, TSharedRef< FModel > InModel )		Extension/LaunchExtension.h
static void DestroyExtensionInstancesForProfile ( ILauncherProfilePtr InProfile )	Destroy all extension instances for the given profile	Extension/LaunchExtension.h
static TSharedPtr< FLaunchExtensionInstance > GetExtensionInstance ( TSharedRef< FLaunchExtension > InExtension, ILauncherProfileRef InProfile )		Extension/LaunchExtension.h
static TArray< TSharedRef< FLaunchExtensionInstance > > GetExtensionInstances ( TSharedRef< FLaunchExtension > InExtension, ILauncherProfileRef InProfile )		Extension/LaunchExtension.h
static TArray< TSharedRef< FLaunchExtension > > GetExtensions()		Extension/LaunchExtension.h