LauncherServices

Windows
MacOS
Linux

Classes

Name

Description

Public class

FGameProjectHelper

Implements a helper class for finding project specific information.

Public class

ILauncher

Interface for game launchers.

Public class

ILauncherDeviceGroup

Interface for Launcher device groups.

Public class

ILauncherProfile

Interface for launcher profile.

Public class

ILauncherProfileLaunchRole

Interface for launch roles.

Public class

ILauncherProfileManager

Interface for launcher profile managers.

Public class

ILauncherProfileWizard

Interface for a factory to create pre-defined launcher profiles.

Public class

ILauncherServicesModule

Interface for launcher tools modules.

Public class

ILauncherSimpleProfile

Interface for simple launcher profile.

Public class

ILauncherTask

Interface for launcher worker tasks.

Public class

ILauncherWorker

Interface for launcher worker threads.

Typedefs

Name

Description

FCookCanceledDelegate

Delegate type used to callback if the cook has been canceled only used for cook by the book in editor

FIsCookFinishedDelegate

Delegate type for detecting if cook is finished Used when cooking from the editor.

FOnLaunchCanceledDelegate

Delegate used to notify when the launch was canceled

FOnLaunchCompletedDelegate

Delegate used to notify when the launch is complete

FOnLauncherDeviceGroupDeviceAdded

Delegate type for adding devices.

FOnLauncherDeviceGroupDeviceRemoved

Delegate type for removing devices.

FOnLauncherProfileDeployedDeviceGroupChanged

Delegate type for changing the device group to deploy to.

FOnLauncherProfileManagerDeviceGroupAdded

Declares a delegate to be invoked when a device group was added to a profile manager.

FOnLauncherProfileManagerDeviceGroupRemoved

Declares a delegate to be invoked when a device group was removed from a profile manager.

FOnLauncherProfileManagerInitialized

Declares a delegate to be invoked when a launcher profile manager has been initialized.

FOnLauncherProfileManagerProfileAdded

Declares a delegate to be invoked when a launcher profile was added to a profile manager.

FOnLauncherProfileManagerProfileRemoved

Declares a delegate to be invoked when a launcher profile was removed from a profile manager.

FOnProfileProjectChanged

Delegate type for a change in project

FOnStageCompletedDelegate

Delegate used to notify when a stage ends

FOnStageStartedDelegate

Delegate used to notify when a stage starts

FOnTaskCompletedDelegate

Delegate used to notify when a stage ends

FOnTaskStartedDelegate

FOutputMessageReceivedDelegate

Delegate used to notify of an output message

ILauncherDeviceGroupPtr

Type definition for shared pointers to instances of ILauncherDeviceGroup.

ILauncherDeviceGroupRef

Type definition for shared references to instances of ILauncherDeviceGroup.

ILauncherProfileLaunchRolePtr

Type definition for shared pointers to instances of ILauncherProfileLaunchRole.

ILauncherProfileLaunchRoleRef

Type definition for shared references to instances of ILauncherProfileLaunchRole.

ILauncherProfileManagerPtr

Type definition for shared pointers to instances of ILauncherProfileManager.

ILauncherProfileManagerRef

Type definition for shared references to instances of ILauncherProfileManager.

ILauncherProfilePtr

Type definition for shared pointers to instances of ILauncherProfile.

ILauncherProfileRef

Type definition for shared references to instances of ILauncherProfile.

ILauncherProfileWizardPtr

Type definition for shared references to instances of ILauncherProfile.

ILauncherProfileWizardRef

Type definition for shared references to instances of ILauncherProfile.

ILauncherPtr

Type definition for shared pointers to instances of ILauncher.

ILauncherRef

Type definition for shared references to instances of ILauncher.

ILauncherSimpleProfilePtr

Type definition for shared pointers to instances of ILauncherProfile.

ILauncherSimpleProfileRef

Type definition for shared references to instances of ILauncherProfile.

ILauncherTaskPtr

Type definition for shared pointers to instances of ILauncherTask.

ILauncherTaskRef

Type definition for shared references to instances of ILauncherTask.

ILauncherWorkerPtr

Type definition for shared pointers to instances of ILauncherWorker.

ILauncherWorkerRef

Type definition for shared references to instances of ILauncherWorker.

Enums

Name

Description

Public enum

ELauncherProfileCookedMaps::Type

Enumerates selections for maps to cook.

Public enum

ELauncherProfileCookModes::Type

Enumerates modes in which the launcher cooks builds.

Public enum

ELauncherProfileDeploymentModes::Type

Enumerates deployment modes.

Public enum

ELauncherProfileLaunchModes::Type

Enumerates launch modes.

Public enum

ELauncherProfilePackagingModes::Type

Enumerates packaging modes.

Public enum

ELauncherProfileRoleInstanceTypes::Type

Enumerates launch role instance types.

Public enum

ELauncherProfileValidationErrors::Type

Enumerates profile validation messages.

Public enum

ELauncherTaskStatus::Type

Enumerates launcher task status types.

Public enum

ELauncherWorkerStatus::Type

Functions

Name Description

Public function

FString

 

ELauncherProfileRoleInstanceTypes::ToString

Returns the string representation of the specified ELauncherProfileRoleInstanceTypes value.

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback