FInstalledPlatformInfo

Singleton class for accessing information about installed platform configurations

Windows
MacOS
Linux

References

Module

TargetPlatform

Header

/Engine/Source/Developer/TargetPlatform/Public/InstalledPlatformInfo.h

Include

#include "InstalledPlatformInfo.h"

Syntax

class FInstalledPlatformInfo

Remarks

Singleton class for accessing information about installed platform configurations

Constructors

No constructors are accessible with public or protected access.

Functions

Name Description

Public function Const

bool

 

CanDisplayPlatform

(
    const FString& PlatformName,
    EProjectType ProjectType
)

Queries whether a platform can be displayed as an option, even if it's not supported for the specified project type

Public function Static

FInstalledPl...

 

Get()

Accessor for singleton

Public function Const

bool

 

IsPlatformMissingRequiredFile

(
    const FString& PlatformName
)

Queries whether a platform has any missing required files

Public function Const

bool

 

IsValid

(
    TOptional< EBuildTargetType > Targe...,
    TOptional< FString > Platform,
    TOptional< EBuildConfiguration > Co...,
    EProjectType ProjectType,
    EInstalledPlatformState State
)

Determines whether the given target type is supported

Public function Const

bool

 

IsValidConfiguration

(
    const EBuildConfiguration Configura...,
    EProjectType ProjectType
)

Queries whether a configuration is valid for any available platform

Public function Const

bool

 

IsValidPlatform

(
    const FString& PlatformName,
    EProjectType ProjectType
)

Queries whether a platform has any valid configurations

Public function Const

bool

 

IsValidPlatformAndConfiguration

(
    const EBuildConfiguration Configura...,
    const FString& PlatformName,
    EProjectType ProjectType
)

Queries whether a platform and configuration combination is valid

Public function Const

bool

 

IsValidPlatformArchitecture

(
    const FString& PlatformName,
    const FString& Architecture
)

Queries whether a platform architecture is valid for any configuration

Public function Const

bool

 

IsValidTargetType

(
    EBuildTargetType TargetType
)

Queries whether a target type is valid for any configuration

Public function Static

bool

 

OpenInstallerOptions()

Attempts to open the Launcher to the Installer options so that additional platforms can be downloaded

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