1. Epic GamesDeveloper
  3. ITargetPlatformControls

ITargetPlatformControls

API > API/Developer > API/Developer/TargetPlatform

   
Name ITargetPlatformControls
Type class
Header File /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatformControls.h
Include Path #include "Interfaces/ITargetPlatformControls.h"

Syntax

class ITargetPlatformControls

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

ITargetPlatformControls ( ITargetPlatformSettings* InTargetPlatformSettings
)

   Interfaces/ITargetPlatformControls.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ITargetPlatformControls()

 Virtual destructor. Interfaces/ITargetPlatformControls.h  

Classes

Name Remarks
FOnTargetDeviceDiscovered Gets an event delegate that is executed when a new target device has been discovered.
FOnTargetDeviceLost Gets an event delegate that is executed when a target device has been lost, i.e. disconnected or timed out.

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddDevice ( const FString& DeviceName,
bool bDefault
)

 Add a target device by name. Interfaces/ITargetPlatformControls.h  

bool AddDevice ( const FString& DeviceId,
const FString& DeviceUserFriendlyName,
const FString& Username,
const FString& Password,
bool bDefault
)

 Add a target device. Interfaces/ITargetPlatformControls.h  
Checks whether this platform will allow development objects to be cooked. Interfaces/ITargetPlatformControls.h  
Checks whether this platform will allow editor objects to be cooked, as opposed to editoronly properties. Interfaces/ITargetPlatformControls.h  

bool CanSupportRemoteShaderCompile()

 Checks whether this platform supports shader compilation over XGE interface. Interfaces/ITargetPlatformControls.h  

int32 CheckRequirements ( bool bProjectHasCode,
EBuildConfiguration Configuration,
bool bRequiresAssetNativization,
FString& OutTutorialPath,
FString& OutDocumentationPath,
FText& CustomizedLogMessage
) const

 Checks whether the platform's build requirements are met so that we can do things like package for the platform. Interfaces/ITargetPlatformControls.h  

FString CookingDeviceProfileName()

 Gets the name of the device profile to use when cooking this TargetPlatform Interfaces/ITargetPlatformControls.h  

bool CopyFileToTarget ( const FString& DeviceId,
const FString& HostFilename,
const FString& TargetFilename,
const TMap< FString, FString >& CustomPlatformData
)

 Copy a file to the target Interfaces/ITargetPlatformControls.h  
Gets the platform's display name. Interfaces/ITargetPlatformControls.h  

void EnableDeviceCheck ( bool OnOff
)

 Enables/Disable the device check Interfaces/ITargetPlatformControls.h  

bool GenerateStreamingInstallManifest ( const TMultiMap< FString, int32 >& PakchunkMap,
const TSet< int32 >& PakchunkIndicesInUse
) const

 Generates a platform specific asset manifest given an array of FAssetData. Interfaces/ITargetPlatformControls.h  

void GetAllDevices ( TArray< ITargetDevicePtr >& OutDevices
) const

 Returns all discoverable physical devices. Interfaces/ITargetPlatformControls.h  

void GetBuildProjectSettingKeys ( FString& OutSection,
TArray< FString >& InBoolKeys,
TArray< FString >& InIntKeys,
TArray< FString >& InStringKeys
) const

 Project settings to check to determine if a build should occur Interfaces/ITargetPlatformControls.h  
Returns custom DeviceManager widget creator for this platform Interfaces/ITargetPlatformControls.h  

ITargetDevicePtr GetDefaultDevice()

 Gets the default device.Note that not all platforms may have a notion of default devices. Interfaces/ITargetPlatformControls.h  

ITargetDevicePtr GetDevice ( const FTargetDeviceId& DeviceId
)

 Gets an interface to the specified device. Interfaces/ITargetPlatformControls.h  

void GetExtraPackagesToCook ( TArray< FName >& PackageNames
) const

 Gets a list of package names to cook when cooking this platform Interfaces/ITargetPlatformControls.h  

int64 GetMemoryMappingAlignment()

 Gets the alignment of memory mapping for this platform, typically the page size. Interfaces/ITargetPlatformControls.h  

const FDataDrivenPlatformInfo & GetPlatformInfo()

 Returns the information about the platform as a whole Interfaces/ITargetPlatformControls.h  
Get unique integer identifier for this platform. Interfaces/ITargetPlatformControls.h  

void GetPlatformSpecificProjectAnalytics ( TArray< struct FAnalyticsEventAttribute >& AnalyticsParamArray
) const

 Gather per-project cook/package analytics Interfaces/ITargetPlatformControls.h  
Return the TargetType this platform uses at runtime. Interfaces/ITargetPlatformControls.h  

void GetShaderCompilerDependencies ( TArray< FString >& OutDependencies
) const

 Provide platform specific file dependency patterns for SN-DBS shader compilation. Interfaces/ITargetPlatformControls.h  

const PlatformInfo::FTargetPlatformInfo & GetTargetPlatformInfo()

 Returns the information about this target platform Interfaces/ITargetPlatformControls.h  

ITargetPlatformSettings * GetTargetPlatformSettings()

   Interfaces/ITargetPlatformControls.h  

float GetVariantPriority()

 Gets the variant priority of this platform Interfaces/ITargetPlatformControls.h  

FName GetZlibReplacementFormat()

 Gets a new compression format to use in place of Zlib. This should be rarely implemented Interfaces/ITargetPlatformControls.h  

bool HasEditorOnlyData()

 Checks whether this platform has only editor data (typically desktop platforms). Interfaces/ITargetPlatformControls.h  

bool HasSecurePackageFormat()

 Checks whether this platform has a secure shippable package format, and therefore doesn't need any encryption or signing support Interfaces/ITargetPlatformControls.h  
Hook called when a TargetPlatform is selected for cooking. Interfaces/ITargetPlatformControls.h  

bool InitializeHostPlatform()

 Initializes the host platform to support target devices (may be called multiple times after an SDK is installed while running) Interfaces/ITargetPlatformControls.h  

bool IsClientOnly()

 Checks whether this platform is only a client (and must connect to a server to run). Interfaces/ITargetPlatformControls.h  

bool IsEnabledForPlugin ( const IPlugin& Plugin
) const

 Checks whether this platform is enabled for the given plugin in the currently active project. Interfaces/ITargetPlatformControls.h  

bool IsLittleEndian()

 Checks whether this platform is little endian. Interfaces/ITargetPlatformControls.h  
Checks whether this platform is the platform that's currently running. Interfaces/ITargetPlatformControls.h  

bool IsSdkInstalled ( bool bProjectHasCode,
FString& OutDocumentationPath
) const

 Checks whether the platform's SDK requirements are met so that we can do things like package for the platform Interfaces/ITargetPlatformControls.h  

bool IsServerOnly()

 Checks whether this platform is only a server. Interfaces/ITargetPlatformControls.h  

bool PackageBuild ( const FString& InPackgeDirectory
)

 Package a build for the given platform Interfaces/ITargetPlatformControls.h  

FString PlatformName ()

 Returns the name of this platform Interfaces/ITargetPlatformControls.h  

virtual void RefreshAllDevices()

 Manually refresh the devices Interfaces/ITargetPlatformControls.h  

bool RequiresCookedData()

 Checks whether this platform requires cooked data (typically console platforms). Interfaces/ITargetPlatformControls.h  

bool RequiresOriginalReleaseVersionForPatch()

 Checks whether this platform requires the originally released version (in addition to the previously released version) to create a patch Interfaces/ITargetPlatformControls.h  

bool RequiresTempTarget ( bool bProjectHasCode,
EBuildConfiguration Configuration,
bool bRequiresAssetNativization,
FText& OutReason
) const

 Checks whether the current project needs a temporary .target.cs file to be packaged as a code project. Interfaces/ITargetPlatformControls.h  

EPlatformAuthentication RequiresUserCredentials()

 Checks whether this platform requires user credentials (typically server platforms). Interfaces/ITargetPlatformControls.h  

bool SendLowerCaseFilePaths()

 Whether or not to send all lower-case filepaths when connecting over a fileserver connection. Interfaces/ITargetPlatformControls.h  

bool ShouldExpandTo32Bit ( const uint16* Indices,
const int32 NumIndices
) const

 Returns wheter or not this 16bit index buffer should be promoted to 32bit Interfaces/ITargetPlatformControls.h  

bool SupportsAutoSDK()

 Returns true if the platform supports the AutoSDK system Interfaces/ITargetPlatformControls.h  

bool SupportsBuildTarget ( EBuildTargetType TargetType
) const

 Checks whether this platform supports the specified build target, i.e. Game or Editor. Interfaces/ITargetPlatformControls.h  

bool SupportsVariants()

 Returns true if the platform is part of a family of variants Interfaces/ITargetPlatformControls.h  

Static

Name Remarks Include Path Unreal Specifiers

static int32 AssignPlatformOrdinal ( const ITargetPlatformControls& Platform
)

   Interfaces/ITargetPlatformControls.h  

static const ITargetPlatformControls * GetPlatformFromOrdinal ( int32 Ordinal
)

 Given a platform ordinal number, returns the corresponding ITargetPlatform instance Interfaces/ITargetPlatformControls.h  

static FOnTargetDeviceDiscovered & OnDeviceDiscovered()

   Interfaces/ITargetPlatformControls.h  

static FOnTargetDeviceLost & OnDeviceLost()

   Interfaces/ITargetPlatformControls.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page