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  

Enums

Public

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

Variables

Protected

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

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BroadcastPropertyChanged()

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

void CustomizeTree ()

 Internal property tree customization function - don't call directly 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  

ILauncherProfileRef GetDefaultProfile()

 Get the reference default profile Extension/LaunchExtension.h  

TSharedRef< FLaunchExtension > GetExtension()

 Get the extension that instantiated us Extension/LaunchExtension.h  
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  

ILauncherProfileRef GetProfile()

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

FPropertyChangedDelegate & GetPropertyChangedDelegate()

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

void RequestFullTreeRebuild()

 Request that the enture property tree is rebuilt - such as when adding or removing top-level sections Extension/LaunchExtension.h  

void RequestTreeRefresh()

 Request that the property tree should be refreshed - such as when a widget has changed size 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  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual FLaunchProfileTreeNode & AddDefaultHeading ( ProjectLauncher::FLaunchProfileTreeData& ProfileTreeData
) const

 Create the default heading for this extension Extension/LaunchExtension.h  

virtual IBuildCookRunExtensionFactory * AsBuildCookRunFactory()

 Attempt to cast this launch extension instance to a build cook run factory Extension/LaunchExtension.h  

virtual ICmdLineParametersExtensionFactory * AsCmdLineParametersFactory()

 Attempt to cast this launch extension instance to a launch command line factory Extension/LaunchExtension.h  

virtual void BroadcastEvent ( const FString& EventName,
void* EventData
)

 Broadcast an event to all other extension instances associated to the same profile. Extension/LaunchExtension.h  

virtual bool CanBeRemoved()

 Whether the given extension can be removed or not 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 CustomizeTargetLaunchCommandLine ( FString& InOutCommandLine,
EBuildTargetType InBuildTargetType
)

 Advanced hook to allow any advanced modification of the command line when our profile is launched for the given build target type 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  

virtual bool CustomizeUATCommandLine ( const ILauncherProfileUATCommandRef& InUATCommand,
FString& InOutCommandLine
)

 Advanced hook to allow any advanced modification of the command line when a UAT command test is launched 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 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  

virtual ILauncherProfileUATCommandPtr GetUATCommand()

 Get the associated UAT command, if any Extension/LaunchExtension.h  

virtual void HandleEventCallback ( const FString& EventName,
void* EventData
)

 The listener checks the incoming event name and chooses to handle the event accordingly. Extension/LaunchExtension.h  

virtual void InternalInitialize()

 Internal intitialization function, called immediately after construction - don't call directly Extension/LaunchExtension.h  

virtual void MakeCustomExtensionSubmenu ( FMenuBuilder& MenuBuilder
)

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

virtual bool ManagesUATCommand ( const ILauncherProfileUATCommandRef& UATCommand
) const

 Determine if this launch extension instance manages the given UAT command Extension/LaunchExtension.h  

virtual void OnAdded()

   Extension/LaunchExtension.h  

virtual void OnProjectChanged()

 Notification callback when the project has been changed in our profile Extension/LaunchExtension.h  

virtual void OnPropertyChanged()

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

virtual void OnRemoved()

   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
)

   Extension/LaunchExtension.h  

FString GetCommandLine()

 Get the current command line Extension/LaunchExtension.h  

FString GetFinalParameter ( const FString& InParameter
) const

   Extension/LaunchExtension.h  

FLaunchProfileTreeData & GetOwnerTreeData()

 Get the owner tree data Extension/LaunchExtension.h  

FString GetParameterValue ( const FString& InParameter
) const

   Extension/LaunchExtension.h  

bool IsParameterUsed ( const FString& InParameter
) const

   Extension/LaunchExtension.h  

void RemoveParameter ( const FString& InParameter
)

   Extension/LaunchExtension.h  

void SetCommandLine ( const FString& CommandLine
)

 Update the current command line Extension/LaunchExtension.h  

void SetParameterUsed ( const FString& InParameter,
bool bUsed
)

   Extension/LaunchExtension.h  

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

   Extension/LaunchExtension.h  

Static

Name Remarks Include Path Unreal Specifiers

static TArray< TSharedPtr< FLaunchExtensionInstance > > GetProfileExtensionInstancesByName ( const FString& ExtensionName,
ILauncherProfileRef InProfile
)

 Search for the extension instances associated with the given profile by name 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