ILauncherProfileManager

Interface for launcher profile managers.

Windows
MacOS
Linux

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

Name Description

Public function Virtual

~ILauncherProfileManager()

Virtual destructor.

Functions

Name Description

Public function

void

 

AddDeviceGroup

(
    const ILauncherDeviceGroupRef& Dev...
)

Adds the given device group.

Public function

ILauncherDev...

 

AddNewDeviceGroup()

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

Public function

ILauncherPro...

 

AddNewProfile()

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

ILauncherDev...

 

CreateUnmanagedDeviceGroup()

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

Public function

ILauncherPro...

 

CreateUnsavedProfile

(
    FString ProfileName
)

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

Public function

ILauncherSim...

 

FindOrAddSimpleProfile

(
    const FString& DeviceName
)

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

Public function

ILauncherPro...

 

FindProfile

(
    const FString& ProfileName
)

Gets the profile with the specified name.

Public function

ILauncherSim...

 

FindSimpleProfile

(
    const FString& DeviceName
)

Gets the simple profile for the specified device.

Public function Const

const TArray...

 

GetAllDeviceGroups()

Gets the collection of device groups.

Public function Const

const TArray...

 

GetAllProfiles()

Gets the collection of profiles.

Public function Const

ILauncherDev...

 

GetDeviceGroup

(
    const FGuid& GroupId
)

Gets the device group with the specified identifier.

Public function Const

ILauncherPro...

 

GetProfile

(
    const FGuid& ProfileId
)

Gets the profile with the specified identifier.

Public function Const

const TArray...

 

GetProfileWizards()

Return list of all registered profile wizards

Public function Const

FString

 

GetProjectBasePath()

Gets the base project path for the project

Public function Const

FString

 

GetProjectName()

Gets the name of the Unreal project to use.

Public function Const

FString

 

GetProjectPath()

Gets the full path to the Unreal project to use.

Public function

ILauncherPro...

 

LoadJSONProfile

(
    FString ProfileFile
)

Attempts to load a profile from the specified file.

Public function

ILauncherPro...

 

LoadProfile

(
    FArchive& Archive
)

Attempts to load a profile from the specified archive.

Public function

void

 

LoadSettings()

Loads all device groups and launcher profiles from disk.

Public function

FOnLauncherP...

 

OnDeviceGroupAdded()

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

Public function

FOnLauncherP...

 

OnDeviceGroupRemoved()

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

Public function

FOnLauncherP...

 

OnProfileAdded()

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

Public function

FOnLauncherP...

 

OnProfileRemoved()

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

Public function

void

 

RegisterProfileWizard

(
    const ILauncherProfileWizardPtr& P...
)

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

Public function

void

 

RemoveDeviceGroup

(
    const ILauncherDeviceGroupRef& Dev...
)

Deletes the specified device group.

Public function

void

 

RemoveProfile

(
    const ILauncherProfileRef& Profile
)

Deletes the given profile.

Public function

void

 

RemoveSimpleProfile

(
    const ILauncherSimpleProfileRef& S...
)

Deletes the given simple profile.

Public function

void

 

SaveDeviceGroups()

Saves all the device groups to a config file

Public function

bool

 

SaveJSONProfile

(
    const ILauncherProfileRef& Profile
)

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

 

SaveSettings()

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

Public function

void

 

SetProjectPath

(
    const FString& InProjectPath
)

Sets the path to the Unreal project to use.

Public function

void

 

UnregisterProfileWizard

(
    const ILauncherProfileWizardPtr& P...
)

Unregister launcher profile wizard

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss