1. Epic GamesDeveloper
  3. FTargetPlatformControlsBase

FTargetPlatformControlsBase

API > API/Developer > API/Developer/TargetPlatform

   
Name FTargetPlatformControlsBase
Type class
Header File /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformControlsBase.h
Include Path #include "Common/TargetPlatformControlsBase.h"

Syntax

class FTargetPlatformControlsBase : public ITargetPlatformControls

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

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

   Common/TargetPlatformControlsBase.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AudioFormatSettings TPimplPtr< Audio::FAudioFormatSettings >   Common/TargetPlatformControlsBase.h  

Functions

Public

Overridden from ITargetPlatformControls

Name Remarks Include Path Unreal Specifiers

virtual bool AddDevice ( const FString& DeviceName,
bool bDefault
)

 Add a target device by name. Common/TargetPlatformControlsBase.h  

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

 Add a target device. Common/TargetPlatformControlsBase.h  

virtual bool AllowsDevelopmentObjects ()

 Checks whether this platform will allow development objects to be cooked. Common/TargetPlatformControlsBase.h  

virtual bool AllowsEditorObjects ()

 Checks whether this platform will allow editor objects to be cooked, as opposed to editoronly properties. Common/TargetPlatformControlsBase.h  

virtual bool CanSupportRemoteShaderCompile()

 Checks whether this platform supports shader compilation over XGE interface. Common/TargetPlatformControlsBase.h  

virtual 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. Common/TargetPlatformControlsBase.h  

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

 Copy a file to the target Common/TargetPlatformControlsBase.h  

virtual FText DisplayName ()

 Gets the platform's display name. Common/TargetPlatformControlsBase.h  

virtual 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 Common/TargetPlatformControlsBase.h  

virtual TSharedPtr< IDeviceManagerCustomPlatformWidgetCreator > GetCustomWidgetCreator()

 Returns custom DeviceManager widget creator for this platform Common/TargetPlatformControlsBase.h  

virtual void GetExtraPackagesToCook ( TArray< FName >& PackageNames
) const

 Gets a list of package names to cook when cooking this platform Common/TargetPlatformControlsBase.h  

virtual const FDataDrivenPlatformInfo & GetPlatformInfo()

 Returns the information about the platform as a whole Common/TargetPlatformControlsBase.h  

virtual int32 GetPlatformOrdinal ()

 Get unique integer identifier for this platform. Common/TargetPlatformControlsBase.h  

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

 Gather per-project cook/package analytics Common/TargetPlatformControlsBase.h  

virtual void GetShaderCompilerDependencies ( TArray< FString >& OutDependencies
) const

 Provide platform specific file dependency patterns for SN-DBS shader compilation. Common/TargetPlatformControlsBase.h  

virtual const PlatformInfo::FTargetPlatformInfo & GetTargetPlatformInfo()

 Returns the information about this target platform Common/TargetPlatformControlsBase.h  

virtual float GetVariantPriority()

 Gets the variant priority of this platform Common/TargetPlatformControlsBase.h  

virtual void InitializeForCook ()

 Hook called when a TargetPlatform is selected for cooking. Common/TargetPlatformControlsBase.h  

virtual bool InitializeHostPlatform()

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

virtual bool IsEnabledForPlugin ( const IPlugin& Plugin
) const

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

virtual 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 Common/TargetPlatformControlsBase.h  

virtual bool PackageBuild ( const FString& InPackgeDirectory
)

 Package a build for the given platform Common/TargetPlatformControlsBase.h  

virtual 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. Common/TargetPlatformControlsBase.h  

virtual bool SendLowerCaseFilePaths()

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

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

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

virtual bool SupportsVariants()

 Returns true if the platform is part of a family of variants Common/TargetPlatformControlsBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

const Audio::FAudioFormatSettings & GetAudioFormatSettings()

   Common/TargetPlatformControlsBase.h  

Static

Name Remarks Include Path Unreal Specifiers

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. Common/TargetPlatformControlsBase.h  

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

   Common/TargetPlatformControlsBase.h  

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

 Analytics helper functions Common/TargetPlatformControlsBase.h  

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

   Common/TargetPlatformControlsBase.h  

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

   Common/TargetPlatformControlsBase.h  

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

   Common/TargetPlatformControlsBase.h  

static bool DoProjectSettingsMatchDefault ( const FString& InPlatformName,
const FString& InSection,
const TArray< FString >* InBoolKeys,
const TArray< FString >* InIntKeys,
const TArray< FString >* InStringKeys
)

   Common/TargetPlatformControlsBase.h  

static bool IsPluginEnabledForTarget ( const IPlugin& Plugin,
const FProjectDescriptor* Project,
const FString& Platform,
EBuildConfiguration Configuration,
EBuildTargetType TargetType
)

   Common/TargetPlatformControlsBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page