1. Epic GamesDeveloper
  3. FTargetPlatformControlsBase

FTargetPlatformControlsBase

API > API/Developer > API/Developer/TargetPlatform > API/Developer/TargetPlatform/Common

Inheritance Hierarchy

References

   
Module TargetPlatform
Header /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformControlsBase.h
Include #include "Common/TargetPlatformControlsBase.h"

Syntax

class FTargetPlatformControlsBase : public ITargetPlatformControls

Variables

  Type Name Description
Protected variable const PlatformInfo::FTargetPlatformInfo * PlatformInfo Information about this platform
Protected variable int32 PlatformOrdinal  

Constructors

  Type Name Description
Protected function  

FTargetPlatformControlsBase ( const PlatformInfo::FTargetPlatformInfo*const InPlatformInfo,
ITargetPlatformSettings* TargetPlatformSettings
)

  

Functions

  Type Name Description
Public function Static void

AddDependencySCArrayHelper ( TArray< FString >& OutDependencies,
const FString& DependencyRelativePath
)

 Helper method to fill a dependencies array for the shader compiler with absolute paths, passing a relative path to the Engine as the parameter.
Protected function Static void

AppendAnalyticsEventConfigArray ( TArray< struct FAnalyticsEventAttribute >& AnalyticsParamArray,
const TCHAR* ConfigSection,
const TCHAR* ConfigKey,
const FString& IniFileName,
const TCHAR* AnalyticsKeyNameOverride
)

  
Protected function Static void

AppendAnalyticsEventConfigBool ( TArray< struct FAnalyticsEventAttribute >& AnalyticsParamArray,
const TCHAR* ConfigSection,
const TCHAR* ConfigKey,
const FString& IniFileName,
const TCHAR* AnalyticsKeyNameOverride
)

 Analytics helper functions
Protected function Static void

AppendAnalyticsEventConfigFloat ( TArray< struct FAnalyticsEventAttribute >& AnalyticsParamArray,
const TCHAR* ConfigSection,
const TCHAR* ConfigKey,
const FString& IniFileName,
const TCHAR* AnalyticsKeyNameOverride
)

  
Protected function Static void

AppendAnalyticsEventConfigInt ( TArray< struct FAnalyticsEventAttribute >& AnalyticsParamArray,
const TCHAR* ConfigSection,
const TCHAR* ConfigKey,
const FString& IniFileName,
const TCHAR* AnalyticsKeyNameOverride
)

  
Protected function Static void

AppendAnalyticsEventConfigString ( TArray< struct FAnalyticsEventAttribute >& AnalyticsParamArray,
const TCHAR* ConfigSection,
const TCHAR* ConfigKey,
const FString& IniFileName,
const TCHAR* AnalyticsKeyNameOverride
)

  
Protected function Const const Audio::FAudioFormatSettings &  

Overridden from ITargetPlatformControls

  Type Name Description
Public function Virtual bool

AddDevice ( const FString& DeviceName,
bool bDefault
)

 Add a target device by name.
Public function Virtual bool

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

 Add a target device.
Public function Virtual Const bool Checks whether this platform will allow development objects to be cooked.
Public function Virtual Const bool Checks whether this platform will allow editor objects to be cooked, as opposed to editoronly properties.
Public function Virtual Const bool Checks whether this platform supports shader compilation over XGE interface.
Public function Virtual Const int32

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

 Checks whether the platform's build requirements are met so that we can do things like package for the platform.
Public function Virtual bool

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

 Copy a file to the target
Public function Virtual Const FText Gets the platform's display name.
Public function Virtual Const void

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

 Project settings to check to determine if a build should occur
Public function Virtual Const TSharedPtr< IDeviceManagerCustomPlatformWidgetCreator > Returns custom DeviceManager widget creator for this platform
Public function Virtual Const void

GetExtraPackagesToCook ( TArray< FName >& PackageNames
)

 Gets a list of package names to cook when cooking this platform
Public function Virtual Const const FDataDrivenPlatformInfo & Returns the information about the platform as a whole
Public function Virtual Const int32 Get unique integer identifier for this platform.
Public function Virtual Const void

GetPlatformSpecificProjectAnalytics ( TArray< struct FAnalyticsEventAttribute >& AnalyticsParamArray
)

 Gather per-project cook/package analytics
Public function Virtual Const void

GetShaderCompilerDependencies ( TArray< FString >& OutDependencies
)

 Provide platform specific file dependency patterns for SN-DBS shader compilation.
Public function Virtual Const const PlatformInfo::FTargetPlatformInfo & Returns the information about this target platform
Public function Virtual Const float Gets the variant priority of this platform
Public function Virtual void Hook called when a TargetPlatform is selected for cooking.
Public function Virtual bool Initializes the host platform to support target devices (may be called multiple times after an SDK is installed while running)
Public function Virtual Const bool

IsEnabledForPlugin ( const IPlugin& Plugin
)

 Checks whether this platform is enabled for the given plugin in the currently active project.
Public function Virtual Const bool

IsSdkInstalled ( bool bProjectHasCode,
FString& OutDocumentationPath
)

 Checks whether the platform's SDK requirements are met so that we can do things like package for the platform
Public function Virtual bool

PackageBuild ( const FString& InPackgeDirectory
)

 Package a build for the given platform
Public function Virtual Const bool

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

 Checks whether the current project needs a temporary .target.cs file to be packaged as a code project.
Public function Virtual Const bool Whether or not to send all lower-case filepaths when connecting over a fileserver connection.
Public function Virtual Const bool

ShouldExpandTo32Bit ( const uint16* Indices,
const int32 NumIndices
)

 Returns wheter or not this 16bit index buffer should be promoted to 32bit
Public function Virtual Const bool Returns true if the platform is part of a family of variants

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page