1. Epic GamesDeveloper
  3. FLaunchExtensionInstance

FLaunchExtensionInstance

Base class for a launch extension instance.

API > API/Plugins > API/Plugins/ProjectLauncher

Base class for a launch extension instance. Used while editing a specific profile, and when finalizing the command line arguments during profile launch.

Created by a specialization of FLaunchExtension as follows:

TSharedPtr FMyLaunchExtension::CreateInstanceForProfile( ProjectLauncher::FLaunchExtensionInstance::FArgs& InArgs ) { return MakeShared(InArgs); }

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

Syntax

class FLaunchExtensionInstance : public TSharedFromThis< FLaunchExtensionInstance >

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FLaunchExtensionInstance ( FArgs& InArgs
)

   Extension/LaunchExtension.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FLaunchExtensionInstance()

   Extension/LaunchExtension.h  

Structs

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

Enums

Protected

Name Remarks
EConfig Enumeration to choose where a value should be stored

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Extension TSharedRef< FLaunchExtension >   Extension/LaunchExtension.h  
Model TSharedRef< FModel >   Extension/LaunchExtension.h  
Profile ILauncherProfileRef   Extension/LaunchExtension.h  
PropertyChangedDelegate FPropertyChangedDelegate   Extension/LaunchExtension.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Create the default heading for this extension Extension/LaunchExtension.h  
Create the default heading for this extension, with a bespoke display name Extension/LaunchExtension.h  

virtual void CustomizeAutomatedTestCommandLine ( const ILauncherProfileAutomatedTestRef& InAutomatedTest,
FString& InOutCommandLine
)

 Advanced hook to allow any advanced modification of the command line when an automated test is launched Extension/LaunchExtension.h  

virtual void CustomizeLaunchCommandLine ( FString& InOutCommandLine
)

 Advanced hook to allow any advanced modification of the command line when our profile is launched Extension/LaunchExtension.h  

virtual void CustomizeParametersSubmenu ( FMenuBuilder& MenuBuilder
)

 Hook to allow the extension to extend the extension parameters menu Extension/LaunchExtension.h  

virtual void CustomizeTree ( FLaunchProfileTreeData& ProfileTreeData
)

 Hook to allow the extension to add extra fields to the property editing tree, if the tree builder allows it Property tree items should be hidden until the user has selected something to make it relevent, to avoid cluttering the UI. Extension/LaunchExtension.h  

TSharedRef< FLaunchExtension > GetExtension()

 Get the extension that instantiated us Extension/LaunchExtension.h  

virtual FText GetExtensionParameterDisplayName ( const FString& InParameter
) const

 Returns the user-facing name for the given parameter. It will default to the parameter itself. Extension/LaunchExtension.h  

virtual bool GetExtensionParameters ( TArray< FString >& OutParameters
) const

 Returns the parameters that this extension provides. They will be added to the submenu. Extension/LaunchExtension.h  

virtual void GetExtensionsMenuEntry ( FExtensionsMenuEntry& MenuEntry
) const

   Extension/LaunchExtension.h  

virtual bool GetExtensionVariables ( TArray< FString >& OutVariables
) const

 Returns the user facing variables that this extension provides, in "$(name)" format Extension/LaunchExtension.h  

virtual bool GetExtensionVariableValue ( const FString& InParameter,
FString& OutValue
) const

 Returns the current value for the given variable Extension/LaunchExtension.h  

FPropertyChangedDelegate & GetPropertyChangedDelegate()

 Get the property changed delegate that will be called when an extension changes the profile Extension/LaunchExtension.h  

virtual void MakeCustomExtensionSubmenu ( FMenuBuilder& MenuBuilder
)

 Populate the custom extension menu for this extension. Extension/LaunchExtension.h  

virtual void OnPropertyChanged()

 Notification callback when a property has been changed in our profile Extension/LaunchExtension.h  

virtual void OnValidateProfile()

 Notification callback when the profile is validated Extension/LaunchExtension.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AddParameter ( const FString& InParameter
)

 Add the given parameter to the command line Extension/LaunchExtension.h  

void BroadcastPropertyChanged()

 Signal to any listeners that a property in the profile has changed Extension/LaunchExtension.h  

FString GetCommandLine()

 Get the current command line Extensions should generally go through this function instead of querying the Profile directlry Extension/LaunchExtension.h  

bool GetConfigBool ( EConfig Config,
const TCHAR* Name,
bool DefaultValue
) const

 Read a configuration bool value Extension/LaunchExtension.h  

float GetConfigFloat ( EConfig Config,
const TCHAR* Name,
float DefaultValue
) const

 Read a configuration float value Extension/LaunchExtension.h  

int32 GetConfigInteger ( EConfig Config,
const TCHAR* Name,
int32 DefaultValue
) const

 Read a configuration int value Extension/LaunchExtension.h  

FString GetConfigKeyName ( EConfig Config,
const TCHAR* Name
) const

 Get the final key name to use for reading & writing a configuration value Extension/LaunchExtension.h  

FString GetConfigString ( EConfig Config,
const TCHAR* Name,
const TCHAR* DefaultValue
) const

 Read a configuration string value Extension/LaunchExtension.h  

FString GetFinalParameter ( const FString& InParameter
) const

 Get the current state of the given command line parameter, allowing for user-changed values Extension/LaunchExtension.h  

FName GetLaunchPlatformName()

 Get the name of the platform to launch on Extension/LaunchExtension.h  

TSharedRef< FModel > GetModel()

 Get the model, for general purpose helper functions Extension/LaunchExtension.h  

FString GetParameterValue ( const FString& InParameter
) const

 Retrieve the current value for the given command line parameter Extension/LaunchExtension.h  

ILauncherProfileRef GetProfile()

 Get the profile we were instantiated for Extension/LaunchExtension.h  

bool IsParameterUsed ( const FString& InParameter
) const

 Determine if the given parameter is on the command line Extension/LaunchExtension.h  

void RemoveParameter ( const FString& InParameter
)

 Remove the given parameter from the command line Extension/LaunchExtension.h  

void SetCommandLine ( const FString& CommandLine
)

 Update the current command line Extensions should generally go through this function instead of modifying the Profile directlry Extension/LaunchExtension.h  

void SetConfigBool ( EConfig Config,
const TCHAR* Name,
const bool& Value
) const

 Write a configuration bool value Extension/LaunchExtension.h  

void SetConfigFloat ( EConfig Config,
const TCHAR* Name,
const float& Value
) const

 Write a configuration float value Extension/LaunchExtension.h  

void SetConfigInteger ( EConfig Config,
const TCHAR* Name,
const int32& Value
) const

 Write a configuration int value Extension/LaunchExtension.h  

void SetConfigString ( EConfig Config,
const TCHAR* Name,
const FString& Value
) const

 Write a configuration string value Extension/LaunchExtension.h  

void SetParameterUsed ( const FString& InParameter,
bool bUsed
)

 Add or remove the given parameter on the command line Extension/LaunchExtension.h  

bool UpdateParameterValue ( const FString& InParameter,
const FString& InNewValue
)

 Update the value of the given command line parameter Extension/LaunchExtension.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page