1. Epic GamesDeveloper
  3. FDataDrivenPlatformInfoRegistry

FDataDrivenPlatformInfoRegistry

Unreal Engine C++ API Reference > Runtime > Core > Misc

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Misc/DataDrivenPlatformInfoRegistry.h
Include #include "Misc/DataDrivenPlatformInfoRegistry.h"

Syntax

struct FDataDrivenPlatformInfoRegistry

Functions

  Type Name Description
Public function Static void

ClearDeviceStatus ( FName PlatformName
)

 Wipes out cached device status for all devices in a platform (or all platforms if PlatformName is empty)
Public function Static FDataDrivenPlatformInfo &

DeviceIdToInfo ( FString DeviceId,
FString* OutDeviceName
)

  
Public function Static const TMap< FName, FDataDrivenPlatformInfo > & Get the global set of data driven platform information
Public function Static const TArray< struct FPreviewPlatformMenuItem > & Retrieve the full list of all known preview platforms from all DDPIs
Public function Static const TArray< FName > & 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)
Public function Static int32 Returns the number of discovered ini files that can be loaded with LoadDataDrivenIniFile
Public function Static const FDataDrivenPlatformInfo &

GetPlatformInfo ( const char* PlatformName
)

 Get the data driven platform info for a given platform.
Public function Static const FDataDrivenPlatformInfo &

GetPlatformInfo ( FName PlatformName
)

 Get the data driven platform info for a given platform.
Public function Static const FDataDrivenPlatformInfo &

GetPlatformInfo ( const FString& PlatformName
)

 Get the data driven platform info for a given platform.
Public function Static const TArray< const FDataDrivenPlatformInfo * > &

GetSortedPlatformInfos ( EPlatformInfoType PlatformType
)

  
Public function Static const TArray< FName >

GetSortedPlatformNames ( EPlatformInfoType PlatformType
)

 Get sorted platorm infos or names.
Public function Static const TArray< FString > & 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
Public function Static bool

HasCompiledSupportForPlatform ( FName PlatformName,
EPlatformNameType PlatformNameType
)

  
Public function Static bool

IsPlatformHiddenFromUI ( FName PlatformName
)

 Option to hide a platform from the user interface at runtime
Public function Static bool

LoadDataDrivenIniFile ( int32 Index,
FConfigFile& IniFile,
FString& PlatformName
)

 Load the given ini file, and
Public function Static void

SetPlatformHiddenFromUI ( FName PlatformName
)

  

Enums

  Type Name Description
Public enum EPlatformNameType Checks for the existence of compiled modules for a given (usually another, target, platform) Since there are different types of platform names, it is necessary pass in the type of name  

Deprecated Functions

  Type Name Description
Public function Static const TArray< const FDataDrivenPlatformInfo * > & Use GetSortedPlatformInfos that takes a PlatformType parameter
Public function Static const TArray< FName > Use GetSoprtedPlatformNames that takes a PlatformType parameter

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page