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