1. Epic GamesDeveloper
  3. IDesktopPlatform

IDesktopPlatform

Interface for functionality supported by desktop platforms

API > API/Developer > API/Developer/DesktopPlatform

Interface for functionality supported by desktop platforms

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

Syntax

class IDesktopPlatform

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IDesktopPlatform()

 Virtual destructor IDesktopPlatform.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CleanGameProject ( const FString& ProjectDir,
FString& OutFailPath,
FFeedbackContext* Warn
)

 Cleans a game project. Removes the intermediate folder and binary build products. IDesktopPlatform.h  

bool CompileGameProject ( const FString& RootDir,
const FString& ProjectFileName,
FFeedbackContext* Warn,
ECompilationResult::Type* OutResult
)

 Compiles a game project. IDesktopPlatform.h  

void EnumerateEngineInstallations ( TMap< FString, FString >& OutInstallations
)

 Enumerates all the registered engine installations. IDesktopPlatform.h  

void EnumerateLauncherEngineInstallations ( TMap< FString, FString >& OutInstallations
)

 Enumerates all the registered binary engine installations. IDesktopPlatform.h  

void EnumerateLauncherSampleInstallations ( TArray< FString >& OutInstallations
)

 Enumerates all the samples installed by the launcher. IDesktopPlatform.h  

void EnumerateLauncherSampleProjects ( TArray< FString >& OutFileNames
)

 Enumerates all the sample projects installed by the launcher. IDesktopPlatform.h  

bool EnumerateProjectsKnownByEngine ( const FString& Identifier,
bool bIncludeNativeProjects,
TArray< FString >& OutProjectFileNames
)

 Finds all the projects which the engine (given by an identifier) has a record of. IDesktopPlatform.h  

bool GenerateProjectFiles ( const FString& RootDir,
const FString& ProjectFileName,
FFeedbackContext* Warn,
FString LogFilePath
)

 Generates project files for the given project. IDesktopPlatform.h  

FString GetCurrentEngineIdentifier()

 Gets the identifier for the currently executing engine installation IDesktopPlatform.h  

bool GetDefaultEngineIdentifier ( FString& OutIdentifier
)

 Gets the identifier for the default engine. This will be the newest installed engine. IDesktopPlatform.h  

bool GetDefaultEngineRootDir ( FString& OutRootDir
)

 Gets the root directory for the default engine installation. IDesktopPlatform.h  

FString GetDefaultProjectCreationPath()

 Gets the default folder for creating new projects. IDesktopPlatform.h  

FString GetEngineDescription ( const FString& Identifier
)

 Returns a description for the engine with the given identifier. IDesktopPlatform.h  

bool GetEngineIdentifierForProject ( const FString& ProjectFileName,
FString& OutIdentifier
)

 Gets the engine association for a project. IDesktopPlatform.h  

bool GetEngineIdentifierFromRootDir ( const FString& RootDir,
FString& OutIdentifier
)

 Returns the identifier for the engine with the given root directory. IDesktopPlatform.h  

bool GetEngineRootDirFromIdentifier ( const FString& Identifier,
FString& OutRootDir
)

 Returns the identifier for the engine with the given root directory. IDesktopPlatform.h  

FString GetEngineSavedConfigDirectory ( const FString& Identifier
)

 Gets the root directory for the engine's saved config files IDesktopPlatform.h  

bool GetHordeAccessToken ( const FString& HordeUrl,
bool bUnattended,
FFeedbackContext* Warn,
FString& OutToken,
FDateTime& OutTokenExpiresAt,
bool& bOutWasInteractiveLogin
)

 Gets an access token for the given Horde Server. IDesktopPlatform.h  

bool GetHordeUrl ( FString& OutHordeUrl,
FString* OutHordeUrlConfigSource
)

 Get the URL of the configured Horde server for the current user account. IDesktopPlatform.h  

FFeedbackContext * GetNativeFeedbackContext()

 Gets a feedback context which can display progress information using the native platform GUI. IDesktopPlatform.h  

bool GetOidcAccessToken ( const FString& RootDir,
const FString& ProjectFileName,
const FString& ProviderIdentifier,
bool bUnattended,
FFeedbackContext* Warn,
FString& OutToken,
FDateTime& OutTokenExpiresAt,
bool& bOutWasInteractiveLogin
)

 Get a Access token for use by OIDC compliant Identity Providers IDesktopPlatform.h  

bool GetOidcTokenStatus ( const FString& RootDir,
const FString& ProjectFileName,
const FString& ProviderIdentifier,
FFeedbackContext* Warn,
int& OutStatus
)

 Get the status of a access token for use by OIDC compliant Identity Providers IDesktopPlatform.h  

const TArray< FTargetInfo > & GetTargetsForCurrentProject()

 Gets information about the build targets supported by the current project. IDesktopPlatform.h  

const TArray< FTargetInfo > & GetTargetsForProject ( const FString& ProjectFile
) const

 Gets information about the build targets supported by a particular project. IDesktopPlatform.h  

FString GetUserTempPath()

 Gets the path to the user's temporary directory IDesktopPlatform.h  

FProcHandle InvokeUnrealBuildToolAsync ( const FString& InCmdLineParams,
FOutputDevice& Ar,
void*& OutReadPipe,
void*& OutWritePipe,
bool bSkipBuildUBT
)

 Launches UnrealBuildTool with the specified command line parameters IDesktopPlatform.h  

bool InvokeUnrealBuildToolSync ( const FString& InCmdLineParams,
FOutputDevice& Ar,
bool bSkipBuildUBT,
int32& OutReturnCode,
FString& OutProcOutput
)

 Invokes UnrealBuildTool with the given arguments IDesktopPlatform.h  

bool IsPerforceBuild ( const FString& RootDir
)

 Tests whether an engine installation is a perforce build. IDesktopPlatform.h  

bool IsPreferredEngineIdentifier ( const FString& Identifier,
const FString& OtherIdentifier
)

 Compares two identifiers and checks whether the first is preferred to the second. IDesktopPlatform.h  

bool IsSourceDistribution ( const FString& RootDir
)

 Tests whether an engine installation is a source distribution. IDesktopPlatform.h  

bool IsStockEngineRelease ( const FString& Identifier
)

 Checks if the given engine identifier is for an stock engine release. IDesktopPlatform.h  

bool IsUnrealBuildToolAvailable()

 Determines whether UnrealBuildTool is available IDesktopPlatform.h  

bool IsUnrealBuildToolRunning()

 Checks if an instance of UnrealBuildTool is running. IDesktopPlatform.h  

bool IsValidRootDirectory ( const FString& RootDir
)

 Tests whether a root directory is a valid Unreal Engine installation IDesktopPlatform.h  

bool OpenDirectoryDialog ( const void* ParentWindowHandle,
const FString& DialogTitle,
const FString& DefaultPath,
FString& OutFolderName
)

 Opens the "choose folder" dialog for the platform IDesktopPlatform.h  

bool OpenFileDialog ( const void* ParentWindowHandle,
const FString& DialogTitle,
const FString& DefaultPath,
const FString& DefaultFile,
const FString& FileTypes,
uint32 Flags,
TArray< FString >& OutFilenames,
int32& outFilterIndex
)

 Opens the "open file" dialog for the platform IDesktopPlatform.h  

bool OpenFileDialog ( const void* ParentWindowHandle,
const FString& DialogTitle,
const FString& DefaultPath,
const FString& DefaultFile,
const FString& FileTypes,
uint32 Flags,
TArray< FString >& OutFilenames
)

 Opens the "open file" dialog for the platform IDesktopPlatform.h  

bool OpenFontDialog ( const void* ParentWindowHandle,
FString& OutFontName,
float& OutHeight,
EFontImportFlags& OutFlags
)

 Opens the "choose font" dialog for the platform IDesktopPlatform.h  

bool OpenProject ( const FString& ProjectFileName
)

 Opens the given project with the appropriate editor. Tries to use the shell association. IDesktopPlatform.h  

bool RegisterEngineInstallation ( const FString& RootDir,
FString& OutIdentifier
)

 Registers a directory as containing an engine installation IDesktopPlatform.h  

bool RunUnrealBuildTool ( const FText& Description,
const FString& RootDir,
const FString& Arguments,
FFeedbackContext* Warn
)

 Runs UnrealBuildTool with the given arguments. IDesktopPlatform.h  

bool RunUnrealBuildTool ( const FText& Description,
const FString& RootDir,
const FString& Arguments,
FFeedbackContext* Warn,
int32& OutExitCode
)

 Runs UnrealBuildTool with the given arguments. IDesktopPlatform.h  

bool SaveFileDialog ( const void* ParentWindowHandle,
const FString& DialogTitle,
const FString& DefaultPath,
const FString& DefaultFile,
const FString& FileTypes,
uint32 Flags,
TArray< FString >& OutFilenames
)

 Opens the "save file" dialog for the platform IDesktopPlatform.h  

bool SetEngineIdentifierForProject ( const FString& ProjectFileName,
const FString& Identifier
)

 Sets the engine association for a project. IDesktopPlatform.h  

void SetHordeUrl ( const FString& HordeUrl
)

 Set the URL of the configured Horde server for the current user account. IDesktopPlatform.h  

bool TryGetEngineVersion ( const FString& RootDir,
FEngineVersion& OutVersion
)

 Attempt to get the engine version from the supplied engine root directory. IDesktopPlatform.h  

bool TryParseStockEngineVersion ( const FString& Identifier,
FEngineVersion& OutVersion
)

 Attempt to get the engine version from the supplied identifier IDesktopPlatform.h  

bool UpdateFileAssociations()

 Updates file associations. IDesktopPlatform.h  

bool VerifyFileAssociations()

 Checks that the current file associations are correct. IDesktopPlatform.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page