FBuildCookRunExtension

Base for a launch extension for an [ILauncherProfileBuildCookRun](API\Developer\LauncherServices\ILauncherProfileBuildCookRun)

API > API/Plugins > API/Plugins/ProjectLauncher

Base for a launch extension for an ILauncherProfileBuildCookRun

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

Syntax

class FBuildCookRunExtension : public TSharedFromThis< FBuildCookRunExtension >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FBuildCookRunExtension ( const FArgs& InArgs
)

   Extension/BuildCookRunCommandExtension.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FBuildCookRunExtension()

   Extension/BuildCookRunCommandExtension.h  

Structs

Name Remarks
FArgs  

Typedefs

Name Type Remarks Include Path
EConfig FLaunchExtensionInstance::EConfig   Extension/BuildCookRunCommandExtension.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
BuildCookRun ILauncherProfileBuildCookRunRef   Extension/BuildCookRunCommandExtension.h  
DefaultBuildCookRun ILauncherProfileBuildCookRunRef   Extension/BuildCookRunCommandExtension.h  
Extension TSharedRef< FLaunchExtension >   Extension/BuildCookRunCommandExtension.h  
ExtensionInstance TSharedRef< FLaunchExtensionInstance >   Extension/BuildCookRunCommandExtension.h  
Model TSharedRef< FModel >   Extension/BuildCookRunCommandExtension.h  
OwnerTreeData FLaunchProfileTreeData &   Extension/BuildCookRunCommandExtension.h  
Profile ILauncherProfileRef   Extension/BuildCookRunCommandExtension.h  
PropertyChangedDelegate FPropertyChangedDelegate   Extension/BuildCookRunCommandExtension.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FLaunchProfileTreeNode & AddDefaultHeading ( FLaunchProfileTreeNode& ProfileTreeNode
) const

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

TSharedRef< FLaunchExtension > GetExtension()

 Get the extension we belong to Extension/BuildCookRunCommandExtension.h  

TSharedRef< FLaunchExtensionInstance > GetExtensionInstance()

 Get the extension instance that instantiated us Extension/BuildCookRunCommandExtension.h  

void OnPropertyChanged()

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

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void CustomizeTree ( FLaunchProfileTreeNode& ProfileTreeNode
)

 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/BuildCookRunCommandExtension.h  

virtual void CustomizeUATCommandLine ( FString& InOutCommandLine
)

 Advanced hook to allow any advanced modification of the command line when a UAT command test is launched Extension/BuildCookRunCommandExtension.h  

virtual void OnProjectChanged()

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

virtual void OnValidate()

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

Protected

Name Remarks Include Path Unreal Specifiers

ILauncherProfileBuildCookRunRef GetBuildCookRun()

 Get the BuildCookRun we were instantiated for Extension/BuildCookRunCommandExtension.h  

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

 Read a configuration bool value Extension/BuildCookRunCommandExtension.h  

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

 Read a configuration float value Extension/BuildCookRunCommandExtension.h  

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

 Read a configuration int value Extension/BuildCookRunCommandExtension.h  

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

 Read a configuration string value Extension/BuildCookRunCommandExtension.h  

ILauncherProfileBuildCookRunRef GetDefaultBuildCookRun()

 Get the reference default BuildCookRun Extension/BuildCookRunCommandExtension.h  

TSharedRef< FModel > GetModel()

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

ILauncherProfileRef GetProfile()

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

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

 Write a configuration bool value Extension/BuildCookRunCommandExtension.h  

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

 Write a configuration float value Extension/BuildCookRunCommandExtension.h  

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

 Write a configuration int value Extension/BuildCookRunCommandExtension.h  

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

 Write a configuration string value Extension/BuildCookRunCommandExtension.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page