Navigation
API > API/Runtime > API/Runtime/Core
Information about a platform loaded from disk.
| Name | FDataDrivenPlatformInfo |
| Type | struct |
| Header File | /Engine/Source/Runtime/Core/Public/Misc/DataDrivenPlatformInfoRegistry.h |
| Include Path | #include "Misc/DataDrivenPlatformInfoRegistry.h" |
Syntax
struct FDataDrivenPlatformInfo
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AdditionalRestrictedFolders | TArray< FString > | List of additional restricted folders | Misc/DataDrivenPlatformInfoRegistry.h | |
| AutoSDKPath | FString | Path under CarefullyRedist for the SDK. | Misc/DataDrivenPlatformInfoRegistry.h | |
| bCanChangeGamepadType | bool | Misc/DataDrivenPlatformInfoRegistry.h | ||
| bCanUseCrashReporter | bool | Whether or not the platform can use Crash Reporter | Misc/DataDrivenPlatformInfoRegistry.h | |
| bDefaultInputStandardKeyboard | bool | True if this platform handles input via standard keyboard layout by default, translates to PC platform. | Misc/DataDrivenPlatformInfoRegistry.h | |
| bEnabledForUse | bool | Enabled for use | Misc/DataDrivenPlatformInfoRegistry.h | |
| bHasCompiledTargetSupport | bool | Whether or not this editor/program has compiled in support for this platform (by looking for TargetPlatform style DLLs, without loading them) | Misc/DataDrivenPlatformInfoRegistry.h | |
| bHasDedicatedGamepad | bool | True if this platform has a non-generic gamepad specifically associated with it. | Misc/DataDrivenPlatformInfoRegistry.h | |
| bInputSupportConfigurable | bool | Input-related settings. | Misc/DataDrivenPlatformInfoRegistry.h | |
| bIsConfidential | bool | Is this platform confidential | Misc/DataDrivenPlatformInfoRegistry.h | |
| bIsFakePlatform | bool | Some platforms are here just for IniParentChain needs and are not concrete platforms | Misc/DataDrivenPlatformInfoRegistry.h | |
| bSupportsGamepad | bool | Misc/DataDrivenPlatformInfoRegistry.h | ||
| bSupportsMouseAndKeyboard | bool | Misc/DataDrivenPlatformInfoRegistry.h | ||
| bSupportsTouch | bool | Misc/DataDrivenPlatformInfoRegistry.h | ||
| bUATClosesAfterLaunch | bool | Whether UAT closes immediately after launching on this platform, or if it sticks around to read output from the running process | Misc/DataDrivenPlatformInfoRegistry.h | |
| bUsesHostCompiler | bool | Whether code projects for this platform require the host platform compiler to be installed. | Misc/DataDrivenPlatformInfoRegistry.h | |
| DefaultInputType | FString | Misc/DataDrivenPlatformInfoRegistry.h | ||
| Freezing_b32Bit | bool | Misc/DataDrivenPlatformInfoRegistry.h | ||
| Freezing_bAlignBases | bool | Misc/DataDrivenPlatformInfoRegistry.h | ||
| Freezing_bForce64BitMemoryImagePointers | bool | Misc/DataDrivenPlatformInfoRegistry.h | ||
| Freezing_MaxFieldAlignment | uint32 | MemoryFreezing information, matches FPlatformTypeLayoutParameters - defaults are clang, noneditor. | Misc/DataDrivenPlatformInfoRegistry.h | |
| GlobalIdentifier | FGuid | GUID to represent this platform forever. | Misc/DataDrivenPlatformInfoRegistry.h | |
| HardwareCompressionFormat | FString | The compression format that this platform wants; overrides game unless bForceUseProjectCompressionFormat | Misc/DataDrivenPlatformInfoRegistry.h | |
| IconPaths | FPlatformIconPaths | Information about where to find the platform icons (for use by FAppStyle) | Misc/DataDrivenPlatformInfoRegistry.h | |
| IniParentChain | TArray< FString > | Cached list of ini parents | Misc/DataDrivenPlatformInfoRegistry.h | |
| IniPlatformName | FName | Copy of the platform name, same as the Key into GetAllPlatformInfos() | Misc/DataDrivenPlatformInfoRegistry.h | |
| OverrideCookPlatformName | FName | Platform name to be used for cooking (note: DOES NOT include the configuration name, eg "Server", "Client", only the platform name) | Misc/DataDrivenPlatformInfoRegistry.h | |
| PlatformGroupName | FName | An identifier to group similar platforms together, such as "Mobile" and "Console". | Misc/DataDrivenPlatformInfoRegistry.h | |
| PlatformSubMenu | FName | Submenu name to group similar platforms together in menus, such as "Linux" and "LinuxArm64". | Misc/DataDrivenPlatformInfoRegistry.h | |
| SDKTutorial | FString | Tutorial path for tutorial to install SDK | Misc/DataDrivenPlatformInfoRegistry.h | |
| TargetSettingsIniSectionName | FString | The name of the ini section to use to load target platform settings (used at runtime and cooktime) | Misc/DataDrivenPlatformInfoRegistry.h | |
| UBTPlatformName | FName | An identifier that corresponds to UBT's UnrealTargetPlatform enum (and by proxy, FGenericPlatformMisc::GetUBTPlatform()), as well as the directory Binaries are placed under | Misc/DataDrivenPlatformInfoRegistry.h | |
| UBTPlatformString | FString | Misc/DataDrivenPlatformInfoRegistry.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FName & GetCookPlatformName() |
Misc/DataDrivenPlatformInfoRegistry.h | ||
const FString & GetIconPath
(
const EPlatformIconSize InIconSize |
Get the path to the icon on disk (for FAppStyle) for the given icon type for this platform | Misc/DataDrivenPlatformInfoRegistry.h | |
FName GetIconStyleName
(
const EPlatformIconSize InIconSize |
Get the icon name (for FAppStyle) used by the given icon type for this platform | Misc/DataDrivenPlatformInfoRegistry.h |