Navigation
API > API/Plugins > API/Plugins/ProjectLauncher
| Name | FBuildCookRunCommandExtensionInstance |
| Type | class |
| Header File | /Engine/Plugins/Developer/ProjectLauncher/Source/ProjectLauncher/Public/Extension/BuildCookRunCommandExtension.h |
| Include Path | #include "Extension/BuildCookRunCommandExtension.h" |
Syntax
class FBuildCookRunCommandExtensionInstance :
public ProjectLauncher::FLaunchExtensionInstance ,
public ProjectLauncher::IBuildCookRunExtensionFactory
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FLaunchExtensionInstance → FBuildCookRunCommandExtensionInstance
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FBuildCookRunCommandExtensionInstance
(
FArgs& InArgs |
Extension/BuildCookRunCommandExtension.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FBuildCookRunCommandExtensionInstance() |
Extension/BuildCookRunCommandExtension.h |
Functions
Public
Overridden from IBuildCookRunExtensionFactory
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedRef< FBuildCookRunExtension > CreateBuildCookRunExtension
(
const FBuildCookRunExtension::FArgs& InArgs |
A launch extension must override this to create a new build cook run extension | Extension/BuildCookRunCommandExtension.h |
Public Virtual
Overridden from FLaunchExtensionInstance
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual IBuildCookRunExtensionFactory * AsBuildCookRunFactory() |
Attempt to cast this launch extension instance to a build cook run factory | Extension/BuildCookRunCommandExtension.h | |
virtual bool CanBeRemoved() |
Fixme: ideally enumerate FLaunchExtension to find those that are BCR | Extension/BuildCookRunCommandExtension.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/BuildCookRunCommandExtension.h | |
virtual void InternalInitialize() |
Internal intitialization function, called immediately after construction - don't call directly | Extension/BuildCookRunCommandExtension.h | |
virtual void OnPropertyChanged() |
Notification callback when a property has been changed in our profile | Extension/BuildCookRunCommandExtension.h |
Overridden from IBuildCookRunExtensionFactory
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CustomizeBuildCookRunExtensionMenu
(
FMenuBuilder& InMenuBuilder, |
Customizes the build cook run extensions menu to allow extenions to be enabled & disabled | Extension/BuildCookRunCommandExtension.h | |
virtual bool HasActiveBuildCookRunExtension() |
Returns whether there are any active build cook run extensions from this launch extension | Extension/BuildCookRunCommandExtension.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedRef< FBuildCookRunExtension > CreateBuildCookRunExtensionInternal
(
const ILauncherProfileBuildCookRunRef& InBuildCookRun |
Extension/BuildCookRunCommandExtension.h | ||
FString GetConfigKeyName
(
const TCHAR* Name, |
Get the key name to use for reading & writing a configuration value for the given BuildCookRun, expected to be passed as Name to the GetConfigXXX/SetConfigXXX functions | Extension/BuildCookRunCommandExtension.h | |
void OnUATCommandAdded
(
const ILauncherProfileUATCommandRef& UATCommand |
Extension/BuildCookRunCommandExtension.h | ||
void OnUATCommandRemoved
(
const ILauncherProfileUATCommandRef& UATCommand |
Extension/BuildCookRunCommandExtension.h |
Protected Virtual
Overridden from FLaunchExtensionInstance
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CustomizeUATCommandLine
(
const ILauncherProfileUATCommandRef& InUATCommand, |
Advanced hook to allow any advanced modification of the command line when a UAT command test is launched | Extension/BuildCookRunCommandExtension.h |
Overridden from IBuildCookRunExtensionFactory
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanToggleBuildCookRunExtension
(
const ILauncherProfileBuildCookRunRef& InBuildCookRun, |
Returns whether our build cook run extensions can be toggled on or off. Typically true | Extension/BuildCookRunCommandExtension.h | |
virtual bool IsBuildCookRunExtensionEnabledByDefault
(
const ILauncherProfileBuildCookRunRef& InBuildCookRun |
Returns whether build cook run extensions should be enabled by default. Typically false | Extension/BuildCookRunCommandExtension.h |