1. Epic GamesDeveloper
  3. ILauncherProfileManager

ILauncherProfileManager

Interface for launcher profile managers.

API > API/Developer > API/Developer/LauncherServices

Interface for launcher profile managers.

   
Name ILauncherProfileManager
Type class
Header File /Engine/Source/Developer/LauncherServices/Public/ILauncherProfileManager.h
Include Path #include "ILauncherProfileManager.h"

Syntax

class ILauncherProfileManager

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ILauncherProfileManager()

 Virtual destructor. ILauncherProfileManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddDeviceGroup ( const ILauncherDeviceGroupRef& DeviceGroup
)

 Adds the given device group. ILauncherProfileManager.h  

ILauncherDeviceGroupRef AddNewDeviceGroup()

 Create a new device group and maintains a reference for its future usage. ILauncherProfileManager.h  

ILauncherProfileRef AddNewProfile()

 Creates a new profile. ILauncherProfileManager.h  

void AddProfile ( const ILauncherProfileRef& Profile
)

 Adds the given profile to the list of managed profiles. ILauncherProfileManager.h  

void ChangeProfileName ( const ILauncherProfileRef& Profile,
FString Name
)

 Modifies profile name. ILauncherProfileManager.h  

ILauncherDeviceGroupRef CreateUnmanagedDeviceGroup()

 Creates a new device group but does not add it to the internal tracking. ILauncherProfileManager.h  

ILauncherProfileRef CreateUnsavedProfile ( FString ProfileName
)

 Creates a new profile but does not add it to the internal tracking. ILauncherProfileManager.h  

ILauncherSimpleProfilePtr FindOrAddSimpleProfile ( const FString& DeviceName
)

 Finds or Adds then returns a simple profile for the specified Device ILauncherProfileManager.h  

ILauncherProfilePtr FindProfile ( const FString& ProfileName
)

 Gets the profile with the specified name. ILauncherProfileManager.h  

ILauncherSimpleProfilePtr FindSimpleProfile ( const FString& DeviceName
)

 Gets the simple profile for the specified device. ILauncherProfileManager.h  

const TArray< ILauncherDeviceGroupPtr > & GetAllDeviceGroups()

 Gets the collection of device groups. ILauncherProfileManager.h  

const TArray< FString > & GetAllExplicitBuildTargetNames()

 Return a list of all build build targets for the current project that need to be specified explicitly via -target= If a build target isn't in the list, it does not need to be specified (and BuildTarget can be an empty string) ILauncherProfileManager.h  

const TArray< ILauncherProfilePtr > & GetAllProfiles ()

 Gets the collection of profiles. ILauncherProfileManager.h  

FString GetBuildTarget()

 Gets the default build target to use. ILauncherProfileManager.h  

ILauncherDeviceGroupPtr GetDeviceGroup ( const FGuid& GroupId
) const

 Gets the device group with the specified identifier. ILauncherProfileManager.h  

ILauncherProfilePtr GetProfile ( const FGuid& ProfileId
) const

 Gets the profile with the specified identifier. ILauncherProfileManager.h  

const TArray< ILauncherProfileWizardPtr > & GetProfileWizards()

 Return list of all registered profile wizards ILauncherProfileManager.h  

FString GetProjectBasePath()

 Gets the base project path for the project ILauncherProfileManager.h  

FString GetProjectName()

 Gets the name of the Unreal project to use. ILauncherProfileManager.h  
Gets the full path to the Unreal project to use. ILauncherProfileManager.h  

ILauncherProfilePtr LoadJSONProfile ( FString ProfileFile
)

 Attempts to load a profile from the specified file. ILauncherProfileManager.h  

ILauncherProfilePtr LoadProfile ( FArchive& Archive
)

 Attempts to load a profile from the specified archive. ILauncherProfileManager.h  

void LoadSettings ()

 Loads all device groups and launcher profiles from disk. ILauncherProfileManager.h  

FString MakeBuildCookRunParamsForProjectCustomBuild ( const ILauncherProfileRef& InProfile,
const TArray< FString >& InPlatforms
) const

 Returns best-guess BuildCookRun parameters for the given profile in the format expected by FProjectBuidSettings::BuildCookRunParams Used by the Project custom Build's "import from Project Launcher" menu ILauncherProfileManager.h  

FOnLauncherProfileManagerDeviceGroupAdded & OnDeviceGroupAdded()

 Returns a delegate that is invoked when a device group was added. ILauncherProfileManager.h  

FOnLauncherProfileManagerDeviceGroupRemoved & OnDeviceGroupRemoved()

 Returns a delegate that is invoked when a device group was removed. ILauncherProfileManager.h  

FOnLauncherProfilePostProcessAutomatedTestCommandLine & OnPostProcessAutomatedTestCommandLine()

 Returns a delegate that is invoked to post-process the command line before an automated test is launched ILauncherProfileManager.h  

FOnLauncherProfilePostProcessCommandLine & OnPostProcessLaunchCommandLine()

 Returns a delegate that is invoked to post-process the command line before a profile launched ILauncherProfileManager.h  

FOnLauncherProfileManagerProfileAdded & OnProfileAdded()

 Returns a delegate that is invoked when a profile was added. ILauncherProfileManager.h  

FOnLauncherProfileManagerProfileRemoved & OnProfileRemoved()

 Returns a delegate that is invoked when a profile was removed. ILauncherProfileManager.h  

FOnLauncherProfileManagerProjectChanged & OnProjectChanged()

 Returns a delegate that is invoked when the project is changed. ILauncherProfileManager.h  

void RegisterProfileWizard ( const ILauncherProfileWizardPtr& ProfileWizard
)

 Register wizard that can be used to create pre-defined launcher profiles ILauncherProfileManager.h  

void RemoveDeviceGroup ( const ILauncherDeviceGroupRef& DeviceGroup
)

 Deletes the specified device group. ILauncherProfileManager.h  

void RemoveProfile ( const ILauncherProfileRef& Profile
)

 Deletes the given profile. ILauncherProfileManager.h  

void RemoveSimpleProfile ( const ILauncherSimpleProfileRef& SimpleProfile
)

 Deletes the given simple profile. ILauncherProfileManager.h  

void SaveDeviceGroups()

 Saves all the device groups to a config file ILauncherProfileManager.h  

bool SaveJSONProfile ( const ILauncherProfileRef& Profile
)

 Saves the given profile to the specified file. ILauncherProfileManager.h  

bool SaveProfile ( const ILauncherProfileRef& Profile
)

 Saves the given profile to the specified archive. ILauncherProfileManager.h  

void SaveSettings ()

 Persists all device groups, launcher profiles and other settings to disk.\ ILauncherProfileManager.h  

void SetBuildTarget ( const FString& InBuildTarget
)

 Sets the default buid target to use. ILauncherProfileManager.h  

void SetProjectPath ( const FString& InProjectPath
)

 Sets the path to the Unreal project to use. ILauncherProfileManager.h  

void UnregisterProfileWizard ( const ILauncherProfileWizardPtr& ProfileWizard
)

 Unregister launcher profile wizard ILauncherProfileManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page