FPlatformInfo

Information about a given platform

Windows
MacOS
Linux

References

Module

DesktopPlatform

Header

/Engine/Source/Developer/DesktopPlatform/Public/PlatformInfo.h

Include

#include "PlatformInfo.h"

Syntax

struct FPlatformInfo

Remarks

Information about a given platform

Variables

Name Description

Public variable

FString

 

AutoSDKPath

Path under CarefullyRedist for the SDK.

Public variable

bool

 

bEnabledForUse

Enabled for use

Public variable

FString

 

BinaryFolderName

Name of sub-folder where binaries will be placed

Public variable

bool

 

bIsConfidential

Whether or not the platform is confidential in nature

Public variable

bool

 

bTargetPlatformCanUseCrashReporter

Whether or not the platform can use Crash Reporter

Public variable

bool

 

bUATClosesAfterLaunch

Whether UAT closes immediately after launching on this platform, or if it sticks around to read output from the running process

Public variable

bool

 

bUsesHostCompiler

Whether code projects for this platform require the host platform compiler to be installed.

Public variable

FText

 

DisplayName

The friendly (and localized) display name of this platform

Public variable

FPlatformIconPa...

 

IconPaths

Information about where to find the platform icons (for use by FEditorStyle)

Public variable

FString

 

IniPlatformName

Name of this platform when loading INI files

Public variable

EPlatformFlags:...

 

PlatformFlags

Flags for this platform

Public variable

FName

 

PlatformFlavor

Platform flavor, eg "ETC2" for "Android_ETC2"

Public variable

FName

 

PlatformGroupName

An identifier to group similar platforms together, such as "Mobile" and "Console".

Public variable

FName

 

PlatformInfoName

Name used to identify this platform, eg "Android_ETC2"

Public variable

FName

 

PlatformSubMenu

Submenu name to group similar platforms together in menus, such as "Linux" and "LinuxAArch64".

Public variable

EBuildTargetTyp...

 

PlatformType

Type of this platform

Public variable

EPlatformSDKSta...

 

SDKStatus

Whether or not this platform SDK has been properly installed

Public variable

FString

 

SDKTutorial

Tutorial path for tutorial to install SDK

Public variable

FName

 

TargetPlatformName

Name used to find the corresponding ITargetPlatform for this platform (also used by UAT)

Public variable

FString

 

UATCommandLine

Additional argument string data to append to UAT commands relating to this platform

Public variable

FName

 

UBTTargetId

An identifier that corresponds to UBT's UnrealTargetPlatform enum (and by proxy, FGenericPlatformMisc::GetUBTPlatform())

Public variable

FName

 

VanillaPlatformName

Vanilla name for this platform, eg "Android" for "Android_ETC2"

Functions

Name Description

Public function Const

const FStrin...

 

GetIconPath

(
    const EPlatformIconSize InIconSize
)

Get the path to the icon on disk (for FEditorStyle) for the given icon type for this platform

Public function Const

FName

 

GetIconStyleName

(
    const EPlatformIconSize InIconSize
)

Get the icon name (for FEditorStyle) used by the given icon type for this platform

Public function Const

bool

 

IsFlavor()

Returns true if this platform is a flavor

Public function Const

bool

 

IsVanilla()

Returns true if this platform is vanilla

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss