1. Epic GamesDeveloper
  3. ILauncherProfileManager

ILauncherProfileManager

Interface for launcher profile managers.

API > API/Developer > API/Developer/LauncherServices

References

   
Module LauncherServices
Header /Engine/Source/Developer/LauncherServices/Public/ILauncherProfileManager.h
Include #include "ILauncherProfileManager.h"

Syntax

class ILauncherProfileManager

Remarks

Interface for launcher profile managers.

Destructors

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Public function void

AddDeviceGroup ( const ILauncherDeviceGroupRef& DeviceGroup
)

 Adds the given device group.
Public function ILauncherDeviceGroupRef Create a new device group and maintains a reference for its future usage.
Public function ILauncherProfileRef Creates a new profile.
Public function void

AddProfile ( const ILauncherProfileRef& Profile
)

 Adds the given profile to the list of managed profiles.
Public function void

ChangeProfileName ( const ILauncherProfileRef& Profile,
FString Name
)

 Modifies profile name.
Public function ILauncherDeviceGroupRef Creates a new device group but does not add it to the internal tracking.
Public function ILauncherProfileRef

CreateUnsavedProfile ( FString ProfileName
)

 Creates a new profile but does not add it to the internal tracking.
Public function ILauncherSimpleProfilePtr

FindOrAddSimpleProfile ( const FString& DeviceName
)

 Finds or Adds then returns a simple profile for the specified Device
Public function ILauncherProfilePtr

FindProfile ( const FString& ProfileName
)

 Gets the profile with the specified name.
Public function ILauncherSimpleProfilePtr

FindSimpleProfile ( const FString& DeviceName
)

 Gets the simple profile for the specified device.
Public function Const const TArray< ILauncherDeviceGroupPtr > & Gets the collection of device groups.
Public function Const const TArray< FString > & 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)
Public function Const const TArray< ILauncherProfilePtr > & Gets the collection of profiles.
Public function Const FString Gets the default build target to use.
Public function Const ILauncherDeviceGroupPtr

GetDeviceGroup ( const FGuid& GroupId
)

 Gets the device group with the specified identifier.
Public function Const ILauncherProfilePtr

GetProfile ( const FGuid& ProfileId
)

 Gets the profile with the specified identifier.
Public function Const const TArray< ILauncherProfileWizardPtr > & Return list of all registered profile wizards
Public function Const FString Gets the base project path for the project
Public function Const FString Gets the name of the Unreal project to use.
Public function Const FString Gets the full path to the Unreal project to use.
Public function ILauncherProfilePtr

LoadJSONProfile ( FString ProfileFile
)

 Attempts to load a profile from the specified file.
Public function ILauncherProfilePtr

LoadProfile ( FArchive& Archive
)

 Attempts to load a profile from the specified archive.
Public function void Loads all device groups and launcher profiles from disk.
Public function FOnLauncherProfileManagerDeviceGroupAdded & Returns a delegate that is invoked when a device group was added.
Public function FOnLauncherProfileManagerDeviceGroupRemoved & Returns a delegate that is invoked when a device group was removed.
Public function FOnLauncherProfileManagerProfileAdded & Returns a delegate that is invoked when a profile was added.
Public function FOnLauncherProfileManagerProfileRemoved & Returns a delegate that is invoked when a profile was removed.
Public function FOnLauncherProfileManagerProjectChanged & Returns a delegate that is invoked when the project is changed.
Public function void Register wizard that can be used to create pre-defined launcher profiles
Public function void Deletes the specified device group.
Public function void

RemoveProfile ( const ILauncherProfileRef& Profile
)

 Deletes the given profile.
Public function void Deletes the given simple profile.
Public function void Saves all the device groups to a config file
Public function bool Saves the given profile to the specified file.
Public function bool

SaveProfile ( const ILauncherProfileRef& Profile
)

 Saves the given profile to the specified archive.
Public function void Persists all device groups, launcher profiles and other settings to disk.\
Public function void

SetBuildTarget ( const FString& InBuildTarget
)

 Sets the default buid target to use.
Public function void

SetProjectPath ( const FString& InProjectPath
)

 Sets the path to the Unreal project to use.
Public function void Unregister launcher profile wizard

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page