UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FDataDrivenPlatformInfoRegistry Struct Reference

#include <DataDrivenPlatformInfoRegistry.h>

Static Public Member Functions

static CORE_API const TMap< FName, FDataDrivenPlatformInfo > & GetAllPlatformInfos ()
 
static CORE_API const TArray< FString > & GetPlatformDirectoryNames (bool bCheckValid)
 
static const TArray< FString > & GetValidPlatformDirectoryNames ()
 
static CORE_API const FDataDrivenPlatformInfoGetPlatformInfo (const FString &PlatformName)
 
static CORE_API const FDataDrivenPlatformInfoGetPlatformInfo (FName PlatformName)
 
static CORE_API const FDataDrivenPlatformInfoGetPlatformInfo (const char *PlatformName)
 
static CORE_API const TArray< FNameGetSortedPlatformNames (EPlatformInfoType PlatformType)
 
static CORE_API const TArray< const FDataDrivenPlatformInfo * > & GetSortedPlatformInfos (EPlatformInfoType PlatformType)
 
static const TArray< FNameGetSortedPlatformNames ()
 
static const TArray< const FDataDrivenPlatformInfo * > & GetSortedPlatformInfos ()
 
static CORE_API const TArray< FName > & GetConfidentialPlatforms ()
 
static CORE_API int32 GetNumDataDrivenIniFiles ()
 
static CORE_API bool LoadDataDrivenIniFile (int32 Index, FConfigFile &IniFile, FString &PlatformName)
 

Member Function Documentation

◆ GetAllPlatformInfos()

const TMap< FName, FDataDrivenPlatformInfo > & FDataDrivenPlatformInfoRegistry::GetAllPlatformInfos ( )
static

Get the global set of data driven platform information

◆ GetConfidentialPlatforms()

const TArray< FName > & FDataDrivenPlatformInfoRegistry::GetConfidentialPlatforms ( )
static

Gets a list of all known confidential platforms (note these are just the platforms you have access to, so, for example PS4 won't be returned if you are not a PS4 licensee)

◆ GetNumDataDrivenIniFiles()

int32 FDataDrivenPlatformInfoRegistry::GetNumDataDrivenIniFiles ( )
static

Returns the number of discovered ini files that can be loaded with LoadDataDrivenIniFile

◆ GetPlatformDirectoryNames()

const TArray< FString > & FDataDrivenPlatformInfoRegistry::GetPlatformDirectoryNames ( bool  bCheckValid)
static

Gets a set of platform names based on GetAllPlatformInfos, their AdditionalRestrictedFolders This is not necessarily the same as IniParents, although there is overlap - IniParents come from chaining DDPIs, so those will be in GetAllPlatformInfos already to be checked

Parameters
bCheckValidIf true, the result is filtered based on what editor has support compiled for

◆ GetPlatformInfo() [1/3]

const FDataDrivenPlatformInfo & FDataDrivenPlatformInfoRegistry::GetPlatformInfo ( const char PlatformName)
static

◆ GetPlatformInfo() [2/3]

const FDataDrivenPlatformInfo & FDataDrivenPlatformInfoRegistry::GetPlatformInfo ( const FString &  PlatformName)
static

Get the data driven platform info for a given platform. If the platform doesn't have any on disk, this will return a default constructed FConfigDataDrivenPlatformInfo

◆ GetPlatformInfo() [3/3]

const FDataDrivenPlatformInfo & FDataDrivenPlatformInfoRegistry::GetPlatformInfo ( FName  PlatformName)
static

◆ GetSortedPlatformInfos() [1/2]

static const TArray< const FDataDrivenPlatformInfo * > & FDataDrivenPlatformInfoRegistry::GetSortedPlatformInfos ( )
inlinestatic

◆ GetSortedPlatformInfos() [2/2]

const TArray< const FDataDrivenPlatformInfo * > & FDataDrivenPlatformInfoRegistry::GetSortedPlatformInfos ( EPlatformInfoType  PlatformType)
static

◆ GetSortedPlatformNames() [1/2]

static const TArray< FName > FDataDrivenPlatformInfoRegistry::GetSortedPlatformNames ( )
inlinestatic

◆ GetSortedPlatformNames() [2/2]

const TArray< FName > FDataDrivenPlatformInfoRegistry::GetSortedPlatformNames ( EPlatformInfoType  PlatformType)
static

Get sorted platorm infos or names. PlatformType is used to choose between true platforms and platform groups (or other fake platforms)

◆ GetValidPlatformDirectoryNames()

static const TArray< FString > & FDataDrivenPlatformInfoRegistry::GetValidPlatformDirectoryNames ( )
inlinestatic

Gets a set of platform names based on GetAllPlatformInfos, their AdditionalRestrictedFolders, and possibly filtered based on what editor has support compiled for This is not necessarily the same as IniParents, although there is overlap - IniParents come from chaining DDPIs, so those will be in GetAllPlatformInfos already to be checked

◆ LoadDataDrivenIniFile()

bool FDataDrivenPlatformInfoRegistry::LoadDataDrivenIniFile ( int32  Index,
FConfigFile IniFile,
FString &  PlatformName 
)
static

Load the given ini file, and


The documentation for this struct was generated from the following files: