FModel

This class contains a selection of helper functions and the current profile state

API > API/Plugins > API/Plugins/ProjectLauncher

This class contains a selection of helper functions and the current profile state

   
Name FModel
Type class
Header File /Engine/Plugins/Developer/ProjectLauncher/Source/ProjectLauncher/Public/Model/ProjectLauncherModel.h
Include Path #include "Model/ProjectLauncherModel.h"

Syntax

class FModel : public TSharedFromThis< FModel >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FModel ( const TSharedRef< ITargetDeviceProxyManager >& InDeviceProxyManager,
const TSharedRef< ILauncher >& InLauncher,
const TSharedRef< ILauncherProfileManager >& InProfileManager
)

 Constructor/destructor/one-time init Model/ProjectLauncherModel.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FModel()

   Model/ProjectLauncherModel.h  

Structs

Name Remarks
FUATCommandsDetail Get the current UAT command information for the given profile

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AllProfiles TArray< ILauncherProfilePtr >   Model/ProjectLauncherModel.h  
BasicLaunchProfile ILauncherProfilePtr   Model/ProjectLauncherModel.h  
bHasSetBasicLaunchProfilePlatform bool   Model/ProjectLauncherModel.h  
CachedMapPaths TMap< FString, TArray< FString > >   Model/ProjectLauncherModel.h  
CachedProjectSettings TMap< FString, FProjectSettings >   Model/ProjectLauncherModel.h  
CachedProjectSettingsCS FCriticalSection   Model/ProjectLauncherModel.h  
ConfigFileName FString   Model/ProjectLauncherModel.h  
DefaultBasicLaunchProfile ILauncherProfilePtr   Model/ProjectLauncherModel.h  
DefaultCustomLaunchProfile ILauncherProfilePtr   Model/ProjectLauncherModel.h  
DeviceProxyManager TSharedRef< ITargetDeviceProxyManager >   Model/ProjectLauncherModel.h  
Launcher TSharedRef< ILauncher >   Model/ProjectLauncherModel.h  
LaunchLogMessages TArray< TSharedPtr< FLaunchLogMessage > >   Model/ProjectLauncherModel.h  
PlatformChangedDelegate FOnSelectedPlatformChanged   Model/ProjectLauncherModel.h  
ProfileManager TSharedRef< ILauncherProfileManager >   Model/ProjectLauncherModel.h  
ProfileSelectedDelegate FOnSelectedProfileChanged   Model/ProjectLauncherModel.h  
ProjectSettingsReady FOnProjectSettingsReady   Model/ProjectLauncherModel.h  
SelectedProfile ILauncherProfilePtr   Model/ProjectLauncherModel.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSharedPtr< FLaunchLogMessage > AddLogMessage ( const FString& InMessage,
ELogVerbosity::Type InVerbosity
)

 Record a new log message from launching Model/ProjectLauncherModel.h  

bool AreExtensionsEnabled()

 Returns true if extensions are enabled for project launcher Model/ProjectLauncherModel.h  

bool AreProjectSettingsReady ( const ILauncherProfileRef& Profile
)

   Model/ProjectLauncherModel.h  

bool AreProjectSettingsReady ( const FString& ProjectPath
)

   Model/ProjectLauncherModel.h  

bool CanUseSimplifiedLayout ( const ILauncherProfileRef& Profile
)

 Returns true if we can use a simplified layout for this profile Model/ProjectLauncherModel.h  

void ClearLogMessages()

 Clear all log messages Model/ProjectLauncherModel.h  

ILauncherProfilePtr CloneCustomProfile ( const ILauncherProfileRef& Profile
)

 Clone an existing custom profile Model/ProjectLauncherModel.h  

ILauncherProfileRef CreateBasicLaunchProfile()

 Create a new basic launch profile Model/ProjectLauncherModel.h  

ILauncherProfileRef CreateCustomProfile ( const TCHAR* Name
)

 Create a new custom profile with the given name Model/ProjectLauncherModel.h  

EContentScheme DetermineProfileContentScheme ( const ILauncherProfileBuildCookRunRef& BuildCookRun
) const

 Determine the content scheme for a profile Model/ProjectLauncherModel.h  

void EnsureValidBuildTarget ( const ILauncherProfileRef& Profile,
const ILauncherProfileBuildCookRunRef& BuildCookRun
)

 Attempts to set a valid build target if one has not been specified Model/ProjectLauncherModel.h  

const TArray< ILauncherProfilePtr > & GetAllProfiles()

 Get all known launcher profiles Model/ProjectLauncherModel.h  

TArray< FString > GetAvailableEngineMapNames()

   Model/ProjectLauncherModel.h  

TArray< FString > GetAvailableEngineMapPaths()

   Model/ProjectLauncherModel.h  

TArray< FString > GetAvailablePluginMapNames ( const FString& PluginContentDir
)

   Model/ProjectLauncherModel.h  

TArray< FString > GetAvailablePluginMapPaths ( const FString& PluginContentDir
)

   Model/ProjectLauncherModel.h  

TArray< FString > GetAvailableProjectMapNames ( const FString& InProjectPath,
bool bIncludeNonContentDirMaps
)

 Get available maps for a project, engine, or plugin Model/ProjectLauncherModel.h  

TArray< FString > GetAvailableProjectMapPaths ( const FString& InProjectPath,
bool bIncludeNonContentDirMaps
)

   Model/ProjectLauncherModel.h  

const ILauncherProfileBuildCookRunRef GetBasicDefaultBuildCookRun()

 Get the default build cook run for the basic profile - used for "reset to default" Model/ProjectLauncherModel.h  

ILauncherProfilePtr GetBasicLaunchProfile()

 Get the basic launch profile Model/ProjectLauncherModel.h  

FTargetInfo GetBuildTargetInfo ( const ILauncherProfileRef& Profile
)

   Model/ProjectLauncherModel.h  

FTargetInfo GetBuildTargetInfo ( FString BuildTargetName,
const FString& ProjectPath
)

 Get build target info for a project path or profile Model/ProjectLauncherModel.h  

TArray< FTargetInfo > GetBuildTargetInfos ( const ILauncherProfileRef& Profile,
const ILauncherProfileBuildCookRunRef& BuildCookRun
)

   Model/ProjectLauncherModel.h  

const FString & GetConfigIni()

   Model/ProjectLauncherModel.h  

const TCHAR * GetConfigSection()

 Get config section and ini file used for storing project launcher state Model/ProjectLauncherModel.h  

const ILauncherProfileBuildCookRunRef GetCustomDefaultBuildCookRun()

 Get the default build cook run for the custom profile - used for "reset to default" Model/ProjectLauncherModel.h  

const ILauncherProfileRef GetDefaultBasicLaunchProfile()

 Get the default basic launch profile - used for "reset to default" Model/ProjectLauncherModel.h  

const ILauncherProfileRef GetDefaultCustomLaunchProfile()

 Get the default custom launch profile - used for "reset to default" Model/ProjectLauncherModel.h  

const TSharedRef< ITargetDeviceProxyManager > & GetDeviceProxyManager()

 Get the target device proxy manager Model/ProjectLauncherModel.h  

const TSharedRef< ILauncher > & GetLauncher()

 Get the launcher instance Model/ProjectLauncherModel.h  

int32 GetNumLogMessages()

 Get number of log messages Model/ProjectLauncherModel.h  

const TSharedRef< ILauncherProfileManager > & GetProfileManager()

 Get the launcher profile manager Model/ProjectLauncherModel.h  

EProfileType GetProfileType ( const ILauncherProfileRef& Profile
) const

 Get the type of a profile (basic, custom, advanced) Model/ProjectLauncherModel.h  

FString GetProjectPath ( const ILauncherProfileRef& Profile
) const

   Model/ProjectLauncherModel.h  

const FProjectSettings GetProjectSettings ( const ILauncherProfileRef& Profile,
bool bWait
)

   Model/ProjectLauncherModel.h  

const FProjectSettings GetProjectSettings ( const FString& ProjectPath,
bool bWait
)

 Retrieve project settings from a project path or profile Model/ProjectLauncherModel.h  

const ILauncherProfilePtr & GetSelectedProfile()

 Get the currently selected profile Model/ProjectLauncherModel.h  

void GetUATCommandsDetail ( const ILauncherProfileRef& Profile,
FUATCommandsDetail& OutUATCommandsDetail
)

   Model/ProjectLauncherModel.h  

void Init()

   Model/ProjectLauncherModel.h  

bool IsAdvancedProfile ( const ILauncherProfileRef& Profile
) const

 Returns true if the given profile is advanced (multiple platforms/cultures, DLC, patches, etc) Model/ProjectLauncherModel.h  

bool IsBasicLaunchProfile ( const ILauncherProfilePtr& Profile
) const

 Returns true if the given profile is the basic launch profile Model/ProjectLauncherModel.h  

FOnSelectedProfileChanged & OnProfileSelected()

 Delegate fired when a profile is selected Model/ProjectLauncherModel.h  

FOnProjectSettingsReady & OnProjectSettingsReady()

 Delegate fired when a project's settings have been loaded Model/ProjectLauncherModel.h  

void SelectProfile ( const ILauncherProfilePtr& Profile
)

 Change the selected profile Model/ProjectLauncherModel.h  

void SetDefaults ( const ILauncherProfileRef& Profile,
const ILauncherProfileBuildCookRunRef& BuildCookRun
)

 Set the defaults for this BuildCookRun Model/ProjectLauncherModel.h  

void SetProfileContentScheme ( EContentScheme ContentScheme,
const FProjectSettings& ProjectSettings,
const ILauncherProfileBuildCookRunRef& BuildCookRun,
bool bWantToCook,
ELauncherProfileDeploymentModes::Type DefaultDeploymentMode
)

 Apply a content scheme to a profile, setting cook/deploy/packaging options etc Model/ProjectLauncherModel.h  

void SortProfiles()

 Sort all profiles alphabetically, keeping the basic profile first in the list Model/ProjectLauncherModel.h  

void UpdateCookedPlatformsFromBuildTarget ( const ILauncherProfileRef& Profile,
const ILauncherProfileBuildCookRunRef& BuildCookRun
)

 Update cooked platforms based on build target Model/ProjectLauncherModel.h  

void UpdatedCookedPlatformsFromDeployDeviceProxy ( const ILauncherProfileRef& Profile,
const ILauncherProfileBuildCookRunRef& BuildCookRun,
TSharedPtr< ITargetDeviceProxy > DeviceProxy
)

 Update cooked platforms based on selected device proxy Model/ProjectLauncherModel.h  

void UpdateDeployDeviceProxyFromCookedPlatforms ( const ILauncherProfileRef& Profile
)

 Update device proxies based on the current cook platforms Model/ProjectLauncherModel.h  

Static

Name Remarks Include Path Unreal Specifiers

static FString GetBuildTargetPlatformName ( const FString& PlatformName,
const FTargetInfo& BuildTargetInfo
)

   Model/ProjectLauncherModel.h  

static TSharedPtr< ITargetDeviceProxy > GetDeviceProxy ( const ILauncherProfileBuildCookRunRef& BuildCookRun
)

 Get a device proxy for a profile Model/ProjectLauncherModel.h  

static const PlatformInfo::FTargetPlatformInfo * GetPlatformInfo ( FName PlatformName,
const FTargetInfo& BuildTargetInfo
)

   Model/ProjectLauncherModel.h  

static const PlatformInfo::FTargetPlatformInfo * GetPlatformInfo ( const ILauncherProfilePtr& Profile
)

 Get platform info for a profile or platform name Model/ProjectLauncherModel.h  

static TArray< const PlatformInfo::FTargetPlatformInfo * > GetPlatformInfos ( const ILauncherProfileBuildCookRunRef& BuildCookRun
)

   Model/ProjectLauncherModel.h  

static TArray< const PlatformInfo::FTargetPlatformInfo * > GetPlatformInfosForAllCommands ( const ILauncherProfilePtr& Profile
)

   Model/ProjectLauncherModel.h  

static FString GetPlatformNameWithFlavor ( const FString& PlatformName
)

   Model/ProjectLauncherModel.h  

static FString GetVanillaPlatformName ( const FString& PlatformName
)

 Utility functions for resolving platform names Model/ProjectLauncherModel.h  

static bool IsHostPlatform ( const ILauncherProfilePtr& Profile
)

 Returns true if profile or platform name refers to host platform Model/ProjectLauncherModel.h  

static bool IsHostPlatform ( FName PlatformName
)

   Model/ProjectLauncherModel.h  

static bool IsUsingRemotePlatform ( const ILauncherProfileBuildCookRunRef& BuildCookRun
)

   Model/ProjectLauncherModel.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page