className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
0
76
code
stringlengths
0
11.4k
variables
listlengths
0
395
FTargetReceipt
/Engine/Source/Developer/DesktopPlatform/Public/TargetReceipt.h
Stores information about a compiled target. Mirror of the TargetReceipt class generated by UBT.
DesktopPlatform
struct FTargetReceipt
[ { "type": "TArray<FReceip...", "name": "AdditionalProperties", "description": "Additional build properties passed through from the module rules" }, { "type": "FString", "name": "Architecture", "description": "Which platform the target is compiled for" }, { "type": "TArray<FBuildP...", "name": "BuildProducts", "description": "The build products which are part of this target" }, { "type": "EBuildConfigura...", "name": "Configuration", "description": "Which configuration this target is compiled in" }, { "type": "FString", "name": "Launch", "description": "The exectuable to launch for this target" }, { "type": "FString", "name": "Platform", "description": "Which platform the target is compiled for" }, { "type": "TMap<FString, ...", "name": "PluginNameToEnabledState", "description": "All plugins that were either enabled or disabled via the target rules." }, { "type": "FString", "name": "ProjectDir", "description": "The project directory" }, { "type": "FString", "name": "ProjectFile", "description": "Path to the project file for this target" }, { "type": "TArray<FRuntim...", "name": "RuntimeDependencies", "description": "All the runtime dependencies that this target relies on" }, { "type": "FString", "name": "TargetName", "description": "The name of this target" }, { "type": "EBuildTargetTyp...", "name": "TargetType", "description": "The type of the target" }, { "type": "FBuildVersion", "name": "Version", "description": "The version information for this target" } ]
FTargetReceipt::Read
/Engine/Source/Developer/DesktopPlatform/Public/TargetReceipt.h
Read a target receipt from disk True if the file was read successfully
DesktopPlatform
bool Read ( const [FString](API\Runtime\Core\Containers\FString) & FileName, bool bExpandVariables )
[]
FWorkerPathMeta
/Engine/Source/Developer/DesktopPlatform/Public/TargetReceiptBuildWorker.h
DesktopPlatform
typedef [TTuple](API\Runtime\Core\Misc\TTuple)< [FIoHash](API\Runtime\Core\IO\FIoHash), uint64 > FWorkerPathMeta
[]
WorkerReceiptVersion
/Engine/Source/Developer/DesktopPlatform/Public/TargetReceiptBuildWorker.h
DesktopPlatform
static const [FGuid](API\Runtime\Core\Misc\FGuid) WorkerReceiptVersion;
[]
FTargetReceiptBuildWorker::FTargetReceiptBuildWorker
/Engine/Source/Developer/DesktopPlatform/Public/TargetReceiptBuildWorker.h
DesktopPlatform
FTargetReceiptBuildWorker ( const TCHAR * TargetReceiptFilePath )
[]
FTargetReceiptBuildWorker::~FTargetReceiptBuildWorker
/Engine/Source/Developer/DesktopPlatform/Public/TargetReceiptBuildWorker.h
DesktopPlatform
virtual ~FTargetReceiptBuildWorker()
[]
FTargetReceiptBuildWorker
/Engine/Source/Developer/DesktopPlatform/Public/TargetReceiptBuildWorker.h
Globally registers aUE::DerivedData::IBuildWorkerFactoryinstance that runs an executable built by UnrealBuildTool. UnrealBuildTool provides the executable information through a TargetReceipt file.
DesktopPlatform
class FTargetReceiptBuildWorker
[]
IDesktopPlatform::CleanGameProject
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Cleans a game project. Removes the intermediate folder and binary build products.
DesktopPlatform
bool CleanGameProject ( const [FString](API\Runtime\Core\Containers\FString) & ProjectDir, [FString](API\Runtime\Core\Containers\FString) & OutFailPath, [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) * Warn )
[]
IDesktopPlatform::CompileGameProject
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Compiles a game project. true if project files were generated successfully.
DesktopPlatform
bool CompileGameProject ( const [FString](API\Runtime\Core\Containers\FString) & RootDir, const [FString](API\Runtime\Core\Containers\FString) & ProjectFileName, [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) * Warn, [ECompilationResult::Type](API\Runtime\Core\Misc\ECompilationResult__Type) * OutResult )
[]
IDesktopPlatform::EnumerateEngineInstallations
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Enumerates all the registered engine installations.
DesktopPlatform
void EnumerateEngineInstallations ( [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & OutInstallations )
[]
IDesktopPlatform::EnumerateLauncherEngineInstallations
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Enumerates all the registered binary engine installations.
DesktopPlatform
void EnumerateLauncherEngineInstallations ( [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & OutInstallations )
[]
IDesktopPlatform::EnumerateLauncherSampleInstallations
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Enumerates all the samples installed by the launcher.
DesktopPlatform
void EnumerateLauncherSampleInstallations ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutInstallations )
[]
IDesktopPlatform::EnumerateLauncherSampleProjects
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Enumerates all the sample projects installed by the launcher.
DesktopPlatform
void EnumerateLauncherSampleProjects ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutFileNames )
[]
IDesktopPlatform::EnumerateProjectsKnownByEngine
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Finds all the projects which the engine (given by an identifier) has a record of. This includes all the recently opened projects, projects in the default project directory, and so on. Path to the folder
DesktopPlatform
bool EnumerateProjectsKnownByEngine ( const [FString](API\Runtime\Core\Containers\FString) & Identifier, bool bIncludeNativeProjects, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutProjectFileNames )
[]
IDesktopPlatform::GenerateProjectFiles
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Generates project files for the given project. true if project files were generated successfully.
DesktopPlatform
bool GenerateProjectFiles ( const [FString](API\Runtime\Core\Containers\FString) & RootDir, const [FString](API\Runtime\Core\Containers\FString) & ProjectFileName, [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) * Warn, [FString](API\Runtime\Core\Containers\FString) LogFilePath )
[]
IDesktopPlatform::GetCurrentEngineIdentifier
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Gets the identifier for the currently executing engine installation Identifier for the current engine installation. Empty string if it isn't registered.
DesktopPlatform
[FString](API\Runtime\Core\Containers\FString) GetCurrentEngineIdentifier()
[]
IDesktopPlatform::GetDefaultEngineIdentifier
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Gets the identifier for the default engine. This will be the newest installed engine. true if OutIdentifier is valid.
DesktopPlatform
bool GetDefaultEngineIdentifier ( [FString](API\Runtime\Core\Containers\FString) & OutIdentifier )
[]
IDesktopPlatform::GetDefaultEngineRootDir
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Gets the root directory for the default engine installation. true if OutRootDir is valid
DesktopPlatform
bool GetDefaultEngineRootDir ( [FString](API\Runtime\Core\Containers\FString) & OutRootDir )
[]
IDesktopPlatform::GetDefaultProjectCreationPath
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Gets the default folder for creating new projects. Path to the folder
DesktopPlatform
[FString](API\Runtime\Core\Containers\FString) GetDefaultProjectCreationPath()
[]
IDesktopPlatform::GetEngineDescription
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Returns a description for the engine with the given identifier. Description for the engine identifier. Empty string if it's unknown.
DesktopPlatform
[FString](API\Runtime\Core\Containers\FString) GetEngineDescription ( const [FString](API\Runtime\Core\Containers\FString) & Identifier )
[]
IDesktopPlatform::GetEngineIdentifierForProject
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Gets the engine association for a project. true if OutIdentifier is set to the project's engine association
DesktopPlatform
bool GetEngineIdentifierForProject ( const [FString](API\Runtime\Core\Containers\FString) & ProjectFileName, [FString](API\Runtime\Core\Containers\FString) & OutIdentifier )
[]
IDesktopPlatform::GetEngineIdentifierFromRootDir
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Returns the identifier for the engine with the given root directory.
DesktopPlatform
bool GetEngineIdentifierFromRootDir ( const [FString](API\Runtime\Core\Containers\FString) & RootDir, [FString](API\Runtime\Core\Containers\FString) & OutIdentifier )
[]
IDesktopPlatform::GetEngineRootDirFromIdentifier
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Returns the identifier for the engine with the given root directory.
DesktopPlatform
bool GetEngineRootDirFromIdentifier ( const [FString](API\Runtime\Core\Containers\FString) & Identifier, [FString](API\Runtime\Core\Containers\FString) & OutRootDir )
[]
IDesktopPlatform::GetEngineSavedConfigDirectory
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Gets the root directory for the engine's saved config files The absoluate path to the engines Saved/Config directory
DesktopPlatform
[FString](API\Runtime\Core\Containers\FString) GetEngineSavedConfigDirectory ( const [FString](API\Runtime\Core\Containers\FString) & Identifier )
[]
IDesktopPlatform::GetNativeFeedbackContext
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Gets a feedback context which can display progress information using the native platform GUI.FFeedbackContextfor the native GUI.
DesktopPlatform
[FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) * GetNativeFeedbackContext()
[]
IDesktopPlatform::GetOidcAccessToken
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Get a Access token for use by OIDC compliant Identity Providers true if the task completed successfully.
DesktopPlatform
bool GetOidcAccessToken ( const [FString](API\Runtime\Core\Containers\FString) & RootDir, const [FString](API\Runtime\Core\Containers\FString) & ProjectFileName, const [FString](API\Runtime\Core\Containers\FString) & ProviderIdentifier, bool bUnattended, [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) * Warn, [FString](API\Runtime\Core\Containers\FString) & OutToken, [FDateTime](API\Runtime\Core\Misc\FDateTime) & OutTokenExpiresAt, bool & bOutWasInteractiveLogin )
[]
IDesktopPlatform::GetOidcTokenStatus
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Get the status of a access token for use by OIDC compliant Identity Providers true if the task completed successfully.
DesktopPlatform
bool GetOidcTokenStatus ( const [FString](API\Runtime\Core\Containers\FString) & RootDir, const [FString](API\Runtime\Core\Containers\FString) & ProjectFileName, const [FString](API\Runtime\Core\Containers\FString) & ProviderIdentifier, [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) * Warn, int & OutStatus )
[]
IDesktopPlatform::GetTargetsForProject
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Gets information about the build targets supported by a particular project. Array of TargetInfo objects
DesktopPlatform
const [TArray](API\Runtime\Core\Containers\TArray)< [FTargetInfo](API\Developer\DesktopPlatform\FTargetInfo) > & GetTargetsForProject ( const [FString](API\Runtime\Core\Containers\FString) & ProjectFile ) const
[]
IDesktopPlatform::GetTargetsForCurrentProject
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Gets information about the build targets supported by the current project. Array of TargetInfo objects
DesktopPlatform
const [TArray](API\Runtime\Core\Containers\TArray)< [FTargetInfo](API\Developer\DesktopPlatform\FTargetInfo) > & GetTargetsForCurrentProject() const
[]
IDesktopPlatform::GetUserTempPath
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Gets the path to the user's temporary directory The path to the user's temporary directory
DesktopPlatform
[FString](API\Runtime\Core\Containers\FString) GetUserTempPath()
[]
IDesktopPlatform::InvokeUnrealBuildToolAsync
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Launches UnrealBuildTool with the specified command line parameters process handle to the new UBT process
DesktopPlatform
[FProcHandle](API\Runtime\Core\Unix\FProcHandle) InvokeUnrealBuildToolAsync ( const [FString](API\Runtime\Core\Containers\FString) & InCmdLineParams, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar, void *& OutReadPipe, void *& OutWritePipe, bool bSkipBuildUBT )
[]
IDesktopPlatform::InvokeUnrealBuildToolSync
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Invokes UnrealBuildTool with the given arguments true if tool was invoked properly
DesktopPlatform
bool InvokeUnrealBuildToolSync ( const [FString](API\Runtime\Core\Containers\FString) & InCmdLineParams, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar, bool bSkipBuildUBT, int32 & OutReturnCode, [FString](API\Runtime\Core\Containers\FString) & OutProcOutput )
[]
IDesktopPlatform::IsPerforceBuild
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Tests whether an engine installation is a perforce build. true if the engine is a perforce build.
DesktopPlatform
bool IsPerforceBuild ( const [FString](API\Runtime\Core\Containers\FString) & RootDir )
[]
IDesktopPlatform::IsPreferredEngineIdentifier
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Compares two identifiers and checks whether the first is preferred to the second. true if Identifier is preferred over OtherIdentifier
DesktopPlatform
bool IsPreferredEngineIdentifier ( const [FString](API\Runtime\Core\Containers\FString) & Identifier, const [FString](API\Runtime\Core\Containers\FString) & OtherIdentifier )
[]
IDesktopPlatform::IsStockEngineRelease
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Checks if the given engine identifier is for an stock engine release. true if the identifier is for a binary engine release
DesktopPlatform
bool IsStockEngineRelease ( const [FString](API\Runtime\Core\Containers\FString) & Identifier )
[]
IDesktopPlatform::IsSourceDistribution
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Tests whether an engine installation is a source distribution. true if the engine contains source.
DesktopPlatform
bool IsSourceDistribution ( const [FString](API\Runtime\Core\Containers\FString) & RootDir )
[]
IDesktopPlatform::IsUnrealBuildToolAvailable
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Determines whether UnrealBuildTool is available true if UnrealBuildTool is available
DesktopPlatform
bool IsUnrealBuildToolAvailable()
[]
IDesktopPlatform::IsUnrealBuildToolRunning
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Checks if an instance of UnrealBuildTool is running. true if an instance of UnrealBuildTool is running.
DesktopPlatform
bool IsUnrealBuildToolRunning()
[]
IDesktopPlatform::IsValidRootDirectory
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Tests whether a root directory is a valid Unreal Engine installation true if the engine is a valid installation
DesktopPlatform
bool IsValidRootDirectory ( const [FString](API\Runtime\Core\Containers\FString) & RootDir )
[]
IDesktopPlatform::OpenDirectoryDialog
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Opens the "choose folder" dialog for the platform true if folder choice was successfully selected
DesktopPlatform
bool OpenDirectoryDialog ( const void * ParentWindowHandle, const [FString](API\Runtime\Core\Containers\FString) & DialogTitle, const [FString](API\Runtime\Core\Containers\FString) & DefaultPath, [FString](API\Runtime\Core\Containers\FString) & OutFolderName )
[]
IDesktopPlatform::OpenFileDialog
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Opens the "open file" dialog for the platform true if files were successfully selected
DesktopPlatform
bool OpenFileDialog ( const void * ParentWindowHandle, const [FString](API\Runtime\Core\Containers\FString) & DialogTitle, const [FString](API\Runtime\Core\Containers\FString) & DefaultPath, const [FString](API\Runtime\Core\Containers\FString) & DefaultFile, const [FString](API\Runtime\Core\Containers\FString) & FileTypes, uint32 Flags, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutFilenames )
[]
IDesktopPlatform::OpenFileDialog
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Opens the "open file" dialog for the platform true if files were successfully selected
DesktopPlatform
bool OpenFileDialog ( const void * ParentWindowHandle, const [FString](API\Runtime\Core\Containers\FString) & DialogTitle, const [FString](API\Runtime\Core\Containers\FString) & DefaultPath, const [FString](API\Runtime\Core\Containers\FString) & DefaultFile, const [FString](API\Runtime\Core\Containers\FString) & FileTypes, uint32 Flags, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutFilenames, int32 & outFilterIndex )
[]
IDesktopPlatform::OpenFontDialog
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Opens the "choose font" dialog for the platform true if font choice was successfully selected
DesktopPlatform
bool OpenFontDialog ( const void * ParentWindowHandle, [FString](API\Runtime\Core\Containers\FString) & OutFontName, float & OutHeight, [EFontImportFlags](API\Developer\DesktopPlatform\EFontImportFlags) & OutFlags )
[]
IDesktopPlatform::OpenProject
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Opens the given project with the appropriate editor. Tries to use the shell association. true if the project was opened successfully.
DesktopPlatform
bool OpenProject ( const [FString](API\Runtime\Core\Containers\FString) & ProjectFileName )
[]
IDesktopPlatform::RegisterEngineInstallation
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Registers a directory as containing an engine installation true if the directory was added. OutIdentifier will be set to the assigned identifier.
DesktopPlatform
bool RegisterEngineInstallation ( const [FString](API\Runtime\Core\Containers\FString) & RootDir, [FString](API\Runtime\Core\Containers\FString) & OutIdentifier )
[]
IDesktopPlatform::RunUnrealBuildTool
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Runs UnrealBuildTool with the given arguments. true if the task completed successfully.
DesktopPlatform
bool RunUnrealBuildTool ( const [FText](API\Runtime\Core\Internationalization\FText) & Description, const [FString](API\Runtime\Core\Containers\FString) & RootDir, const [FString](API\Runtime\Core\Containers\FString) & Arguments, [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) * Warn )
[]
IDesktopPlatform::RunUnrealBuildTool
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Runs UnrealBuildTool with the given arguments. true if the task completed successfully.
DesktopPlatform
bool RunUnrealBuildTool ( const [FText](API\Runtime\Core\Internationalization\FText) & Description, const [FString](API\Runtime\Core\Containers\FString) & RootDir, const [FString](API\Runtime\Core\Containers\FString) & Arguments, [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) * Warn, int32 & OutExitCode )
[]
IDesktopPlatform::SaveFileDialog
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Opens the "save file" dialog for the platform true if files were successfully selected
DesktopPlatform
bool SaveFileDialog ( const void * ParentWindowHandle, const [FString](API\Runtime\Core\Containers\FString) & DialogTitle, const [FString](API\Runtime\Core\Containers\FString) & DefaultPath, const [FString](API\Runtime\Core\Containers\FString) & DefaultFile, const [FString](API\Runtime\Core\Containers\FString) & FileTypes, uint32 Flags, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutFilenames )
[]
IDesktopPlatform::SetEngineIdentifierForProject
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Sets the engine association for a project. true if the project was successfully updated
DesktopPlatform
bool SetEngineIdentifierForProject ( const [FString](API\Runtime\Core\Containers\FString) & ProjectFileName, const [FString](API\Runtime\Core\Containers\FString) & Identifier )
[]
IDesktopPlatform::TryGetEngineVersion
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Attempt to get the engine version from the supplied engine root directory. Tries to read the contents of Engine/Build/Build.version, but scrapes information from the Engine/Source/Launch/Resources/Version.h if it fails. true if the engine version was successfully obtained
DesktopPlatform
bool TryGetEngineVersion ( const [FString](API\Runtime\Core\Containers\FString) & RootDir, [FEngineVersion](API\Runtime\Core\Misc\FEngineVersion) & OutVersion )
[]
IDesktopPlatform::TryParseStockEngineVersion
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Attempt to get the engine version from the supplied identifier true if the engine version was successfully obtained
DesktopPlatform
bool TryParseStockEngineVersion ( const [FString](API\Runtime\Core\Containers\FString) & Identifier, [FEngineVersion](API\Runtime\Core\Misc\FEngineVersion) & OutVersion )
[]
IDesktopPlatform::UpdateFileAssociations
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Updates file associations. true if file associations were successfully updated.
DesktopPlatform
bool UpdateFileAssociations()
[]
IDesktopPlatform::VerifyFileAssociations
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Checks that the current file associations are correct. true if file associations are up to date.
DesktopPlatform
bool VerifyFileAssociations()
[]
IDesktopPlatform::~IDesktopPlatform
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Virtual destructor
DesktopPlatform
virtual ~IDesktopPlatform()
[]
IDesktopPlatform
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
Interface for functionality supported by desktop platforms
DesktopPlatform
class IDesktopPlatform
[]
operator&
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
DesktopPlatform
constexpr [EFontImportFlags](API\Developer\DesktopPlatform\EFontImportFlags) operator& ( [EFontImportFlags](API\Developer\DesktopPlatform\EFontImportFlags) Lhs, [EFontImportFlags](API\Developer\DesktopPlatform\EFontImportFlags) Rhs )
[]
operator~
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
DesktopPlatform
constexpr [EFontImportFlags](API\Developer\DesktopPlatform\EFontImportFlags) operator~ ( [EFontImportFlags](API\Developer\DesktopPlatform\EFontImportFlags) E )
[]
operator&=
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
DesktopPlatform
[EFontImportFlags](API\Developer\DesktopPlatform\EFontImportFlags) & operator&= ( [EFontImportFlags](API\Developer\DesktopPlatform\EFontImportFlags) & Lhs, [EFontImportFlags](API\Developer\DesktopPlatform\EFontImportFlags) Rhs )
[]
operator^
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
DesktopPlatform
constexpr [EFontImportFlags](API\Developer\DesktopPlatform\EFontImportFlags) operator^ ( [EFontImportFlags](API\Developer\DesktopPlatform\EFontImportFlags) Lhs, [EFontImportFlags](API\Developer\DesktopPlatform\EFontImportFlags) Rhs )
[]
operator^=
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
DesktopPlatform
[EFontImportFlags](API\Developer\DesktopPlatform\EFontImportFlags) & operator^= ( [EFontImportFlags](API\Developer\DesktopPlatform\EFontImportFlags) & Lhs, [EFontImportFlags](API\Developer\DesktopPlatform\EFontImportFlags) Rhs )
[]
operator!
/Engine/Source/Developer/DesktopPlatform/Public/IDesktopPlatform.h
DesktopPlatform
constexpr bool operator! ( [EFontImportFlags](API\Developer\DesktopPlatform\EFontImportFlags) E )
[]
PlatformInfo::EPlatformFlags::Flag
/Engine/Source/Developer/DesktopPlatform/Public/PlatformInfo.h
Flags describing platform variants
DesktopPlatform
namespace PlatformInfo { namespace EPlatformFlags { enum Flag { None = 0, BuildFlavor = 1 << 0, CookFlavor = 1 << 1, } } }
[]
PlatformInfo::EPlatformFilter
/Engine/Source/Developer/DesktopPlatform/Public/PlatformInfo.h
Flavor types used when filtering the platforms based upon their flags
DesktopPlatform
namespace PlatformInfo { enum EPlatformFilter { All, BuildFlavor, CookFlavor, } }
[]
TSteamDeckDevice::GetName
/Engine/Source/Developer/DesktopPlatform/Public/SteamDeck/SteamDeckDevice.h
DesktopPlatform
virtual [FString](API\Runtime\Core\Containers\FString) GetName() const
[]
TSteamDeckDevice::DiscoverDevices
/Engine/Source/Developer/DesktopPlatform/Public/SteamDeck/SteamDeckDevice.h
DesktopPlatform
static [TArray](API\Runtime\Core\Containers\TArray)< [ITargetDevicePtr](API\Developer\TargetPlatform\Interfaces\ITargetDevicePtr) > DiscoverDevices ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) & TargetPlatform, const TCHAR * RuntimeOSName )
[]
TSteamDeckDevice::GetId
/Engine/Source/Developer/DesktopPlatform/Public/SteamDeck/SteamDeckDevice.h
DesktopPlatform
virtual [FTargetDeviceId](API\Developer\TargetPlatform\Interfaces\FTargetDeviceId) GetId() const
[]
TSteamDeckDevice::GetOperatingSystemName
/Engine/Source/Developer/DesktopPlatform/Public/SteamDeck/SteamDeckDevice.h
DesktopPlatform
virtual [FString](API\Runtime\Core\Containers\FString) GetOperatingSystemName()
[]
TSteamDeckDevice::TSteamDeckDevice
/Engine/Source/Developer/DesktopPlatform/Public/SteamDeck/SteamDeckDevice.h
DesktopPlatform
TSteamDeckDevice ( [FString](API\Runtime\Core\Containers\FString) InIpAddr, [FString](API\Runtime\Core\Containers\FString) InDeviceName, [FString](API\Runtime\Core\Containers\FString) InUserName, const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) & InTargetPlatform, const TCHAR * InRuntimeOSName )
[]
TSteamDeckDevice::GetUserCredentials
/Engine/Source/Developer/DesktopPlatform/Public/SteamDeck/SteamDeckDevice.h
DesktopPlatform
virtual bool GetUserCredentials ( [FString](API\Runtime\Core\Containers\FString) & OutUserName, [FString](API\Runtime\Core\Containers\FString) & OutUserPassword )
[]
TSteamDeckDevice
/Engine/Source/Developer/DesktopPlatform/Public/SteamDeck/SteamDeckDevice.h
Extend from either WIndows or Linux device, since there will be a lot of shared functionality.
DesktopPlatform
template<class ParentDeviceClass> class TSteamDeckDevice : public ParentDeviceClass
[]
SDirectoryPicker::Construct
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SDirectoryPicker.h
DesktopWidgets
void Construct ( const [FArguments](API\Developer\DesktopWidgets\Widgets\Input\SDirectoryPicker\FArguments) & InArgs )
[]
FOnPathPicked
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SFilePathPicker.h
The first parameter will contain the path to the picked file.
DesktopWidgets
typedef TBaseDelegate_OneParam< void, const [FString](API\Runtime\Core\Containers\FString) & > FOnPathPicked
[]
SDirectoryPicker::FArguments::Directory
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SDirectoryPicker.h
DesktopWidgets
WidgetArgsType & Directory &40; FString InArg &41;
[]
SDirectoryPicker::FArguments::File
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SDirectoryPicker.h
DesktopWidgets
WidgetArgsType & File &40; FString InArg &41;
[]
SDirectoryPicker::FArguments::IsEnabled
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SDirectoryPicker.h
DesktopWidgets
WidgetArgsType & IsEnabled &40; const TAttribute< bool > & InAttribute &41;
[]
SDirectoryPicker::FArguments::Message
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SDirectoryPicker.h
DesktopWidgets
WidgetArgsType & Message &40; FText InArg &41;
[]
SDirectoryPicker::FArguments::OnDirectoryChanged
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SDirectoryPicker.h
Called when a path has been picked or modified.
DesktopWidgets
WidgetArgsType & OnDirectoryChanged &40; const FOnDirectoryChanged & InDelegate &41;
[]
WidgetArgsType
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SDirectoryPicker.h
DesktopWidgets
typedef FArguments WidgetArgsType
[]
SDirectoryPicker::FArguments::FArguments
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SDirectoryPicker.h
DesktopWidgets
FArguments&40;&41;
[]
FArguments
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SDirectoryPicker.h
DesktopWidgets
struct FArguments : public [TSlateBaseNamedArgs< SDirectoryPicker >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)
[]
FOnDirectoryChanged
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SDirectoryPicker.h
DesktopWidgets
typedef TBaseDelegate_OneParam< void, const [FString](API\Runtime\Core\Containers\FString) & > FOnDirectoryChanged
[]
FOnDirectoryPicked
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SDirectoryPicker.h
The first parameter will contain the path to the picked file.
DesktopWidgets
typedef TBaseDelegate_OneParam< void, const [FString](API\Runtime\Core\Containers\FString) & > FOnDirectoryPicked
[]
SDirectoryPicker::GetDirectory
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SDirectoryPicker.h
DesktopWidgets
[FString](API\Runtime\Core\Containers\FString) GetDirectory() const
[]
SDirectoryPicker::GetFilePath
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SDirectoryPicker.h
DesktopWidgets
[FString](API\Runtime\Core\Containers\FString) GetFilePath() const
[]
SDirectoryPicker
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SDirectoryPicker.h
A directory path box, with a button for picking a new path.
DesktopWidgets
class SDirectoryPicker : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)
[]
SFilePathPicker::Construct
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SFilePathPicker.h
Constructs a new widget.
DesktopWidgets
void Construct ( const [FArguments](API\Developer\DesktopWidgets\Widgets\Input\SFilePathPicker\FArguments) & InArgs )
[]
SFilePathPicker::FArguments::BrowseButtonImage
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SFilePathPicker.h
Browse button image resource.
DesktopWidgets
WidgetArgsType & BrowseButtonImage &40; const TAttribute< const FSlateBrush &42; > & InAttribute &41;
[]
SFilePathPicker::FArguments::BrowseButtonStyle
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SFilePathPicker.h
Browse button visual style.
DesktopWidgets
WidgetArgsType & BrowseButtonStyle &40; const FButtonStyle &42; InArg &41;
[]
SFilePathPicker::FArguments::BrowseButtonToolTip
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SFilePathPicker.h
Browse button tool tip text.
DesktopWidgets
WidgetArgsType & BrowseButtonToolTip &40; const TAttribute< FText > & InAttribute &41;
[]
SFilePathPicker::FArguments::BrowseDirectory
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SFilePathPicker.h
The directory to browse by default
DesktopWidgets
WidgetArgsType & BrowseDirectory &40; const TAttribute< FString > & InAttribute &41;
[]
SFilePathPicker::FArguments::BrowseTitle
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SFilePathPicker.h
Title for the browse dialog window.
DesktopWidgets
WidgetArgsType & BrowseTitle &40; const TAttribute< FText > & InAttribute &41;
[]
SFilePathPicker::FArguments::DialogReturnsFullPath
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SFilePathPicker.h
Whether the path returned by the dialog should be converted from relative to full
DesktopWidgets
WidgetArgsType & DialogReturnsFullPath &40; const TAttribute< bool > & InAttribute &41;
[]
SFilePathPicker::FArguments::FilePath
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SFilePathPicker.h
The currently selected file path.
DesktopWidgets
WidgetArgsType & FilePath &40; const TAttribute< FString > & InAttribute &41;
[]
SFilePathPicker::FArguments::FileTypeFilter
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SFilePathPicker.h
File type filter string.
DesktopWidgets
WidgetArgsType & FileTypeFilter &40; const TAttribute< FString > & InAttribute &41;
[]
SFilePathPicker::FArguments::Font
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SFilePathPicker.h
Font color and opacity of the path text box.
DesktopWidgets
WidgetArgsType & Font &40; const TAttribute< FSlateFontInfo > & InAttribute &41;
[]
SFilePathPicker::FArguments::IsReadOnly
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SFilePathPicker.h
Whether the path text box can be modified by the user.
DesktopWidgets
WidgetArgsType & IsReadOnly &40; const TAttribute< bool > & InAttribute &41;
[]
SFilePathPicker::FArguments::OnPathPicked
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SFilePathPicker.h
Called when a file path has been picked.
DesktopWidgets
WidgetArgsType & OnPathPicked &40; const FOnPathPicked & InDelegate &41;
[]
SFilePathPicker::FArguments::FArguments
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SFilePathPicker.h
DesktopWidgets
FArguments&40;&41;
[]
WidgetArgsType
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SFilePathPicker.h
DesktopWidgets
typedef FArguments WidgetArgsType
[]
FArguments
/Engine/Source/Developer/DesktopWidgets/Public/Widgets/Input/SFilePathPicker.h
DesktopWidgets
struct FArguments : public [TSlateBaseNamedArgs< SFilePathPicker >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)
[]