TTargetPlatformBase

Template for target platforms.

Unreal Engine C++ API Reference > Developer > TargetPlatform > Common

Inheritance Hierarchy

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](API\Developer\TargetPlatform\Common\FTargetPlatformBase)  

Remarks

Template for target platforms.

Constructors

Type Name Description
  TTargetPlatformBase () Constructor that makes a TPI based solely on TPlatformProperties
  TTargetPlatformBase ( PlatformInfo::FTargetPlatformInfo&... ) 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 CookingDeviceProfileName () Gets the name of the device profile to use when cooking this TargetPlatform
int64 GetMemoryMappingAlignment () Gets the alignment of memory mapping for this platform, typically the page size.
EBuildTarget... GetRuntimePlatformType () Return the TargetType this platform uses at runtime.
FName GetZlibReplacementFormat () Gets a new compression format to use in place of Zlib. This should be rarely implemented
bool HasEditorOnlyData () Checks whether this platform has only editor data (typically desktop platforms).
bool HasSecurePackageFormat () Checks whether this platform has a secure shippable package format, and therefore doesn't need any encryption or signing support
FString IniPlatformName () 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 IsLittleEndian () 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 RequiresCookedData () Checks whether this platform requires cooked data (typically console platforms).
bool RequiresOriginalReleaseVersionForPatch () Checks whether this platform requires the originally released version (in addition to the previously released version) to create a patch
EPlatformAut... RequiresUserCredentials () Checks whether this platform requires user credentials (typically server platforms).
bool SupportsAutoSDK () 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 UsesRayTracing () Gets whether the platform will use ray tracing.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library