Navigation
API > API/Developer > API/Developer/TargetPlatform
Template for target platforms.
| Name | TTargetPlatformBase |
| Type | class |
| Header File | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h |
| Include Path | #include "Common/TargetPlatformBase.h" |
Syntax
template<typename TPlatformProperties>
class TTargetPlatformBase : public FTargetPlatformBase
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Constructor that makes a TPI based solely on TPlatformProperties | Common/TargetPlatformBase.h | ||
TTargetPlatformBase
(
PlatformInfo::FTargetPlatformInfo* PremadePlatformInfo |
Constructor that already has a TPI (notably coming from TNonDesktopTargetPlatform) | Common/TargetPlatformBase.h |
Functions
Public
Overridden from ITargetPlatformSettings
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FString IniPlatformName () |
Gets the platform's INI name (so an offline tool can load the INI for the given target platform). | Common/TargetPlatformBase.h | |
virtual bool SupportsFeature
(
ETargetPlatformFeatures Feature |
Checks whether the target platform supports the specified feature. | Common/TargetPlatformBase.h | |
virtual bool UsesRayTracing() |
Gets whether the platform will use ray tracing. | Common/TargetPlatformBase.h |
Overridden from ITargetPlatformControls
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FString CookingDeviceProfileName() |
Gets the name of the device profile to use when cooking this TargetPlatform | Common/TargetPlatformBase.h | |
virtual int64 GetMemoryMappingAlignment() |
Gets the alignment of memory mapping for this platform, typically the page size. | Common/TargetPlatformBase.h | |
virtual EBuildTargetType GetRuntimePlatformType () |
Return the TargetType this platform uses at runtime. | Common/TargetPlatformBase.h | |
virtual FName GetZlibReplacementFormat() |
Gets a new compression format to use in place of Zlib. This should be rarely implemented | Common/TargetPlatformBase.h | |
virtual bool HasEditorOnlyData() |
Checks whether this platform has only editor data (typically desktop platforms). | Common/TargetPlatformBase.h | |
virtual bool HasSecurePackageFormat() |
Checks whether this platform has a secure shippable package format, and therefore doesn't need any encryption or signing support | Common/TargetPlatformBase.h | |
virtual bool IsClientOnly() |
Checks whether this platform is only a client (and must connect to a server to run). | Common/TargetPlatformBase.h | |
virtual bool IsLittleEndian() |
Checks whether this platform is little endian. | Common/TargetPlatformBase.h | |
virtual bool IsServerOnly() |
Checks whether this platform is only a server. | Common/TargetPlatformBase.h | |
virtual FString PlatformName () |
Returns the name of this platform | Common/TargetPlatformBase.h | |
virtual bool RequiresCookedData() |
Checks whether this platform requires cooked data (typically console platforms). | Common/TargetPlatformBase.h | |
virtual bool RequiresOriginalReleaseVersionForPatch() |
Checks whether this platform requires the originally released version (in addition to the previously released version) to create a patch | Common/TargetPlatformBase.h | |
virtual EPlatformAuthentication RequiresUserCredentials() |
Checks whether this platform requires user credentials (typically server platforms). | Common/TargetPlatformBase.h | |
virtual bool SupportsAutoSDK() |
Returns true if the platform supports the AutoSDK system | Common/TargetPlatformBase.h | |
virtual bool SupportsBuildTarget
(
EBuildTargetType TargetType |
Checks whether this platform supports the specified build target, i.e. Game or Editor. | Common/TargetPlatformBase.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool IsUsable () |
Returns true if the target platform will be able to be initialized with an FPlatformInfo. | Common/TargetPlatformBase.h |