TTargetPlatformBase

Template for target platforms.

Windows
MacOS
Linux

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

Remarks

Template for target platforms.

Constructors

Name Description

Public function

TTargetPlatformBase()

Constructor that makes a TPI based solely on TPlatformProperties

Public function

TTargetPlatformBase

Constructor that already has a TPI (notably coming from TNonDesktopTargetPlatform)

Functions

Name Description

Public function Static

bool

 

IsUsable()

Returns true if the target platform will be able to be initialized with an FPlatformInfo.

Overridden from ITargetPlatform

Name Description

Public function Virtual Const

FString

 

CookingDeviceProfileName()

Gets the name of the device profile to use when cooking this TargetPlatform

Public function Virtual Const

int32

 

GetMemoryMappingAlignment()

Gets the alignment of memory mapping for this platform, typically the page size.

Public function Virtual Const

EBuildTarget...

 

GetRuntimePlatformType()

Return the TargetType this platform uses at runtime.

Public function Virtual Const

FName

 

GetZlibReplacementFormat()

Gets a new compression format to use in place of Zlib. This should be rarely implemented

Public function Virtual Const

bool

 

HasEditorOnlyData()

Checks whether this platform has only editor data (typically desktop platforms).

Public function Virtual Const

bool

 

HasSecurePackageFormat()

Checks whether this platform has a secure shippable package format, and therefore doesn't need any encryption or signing support

Public function Virtual Const

FString

 

IniPlatformName()

Gets the platform's INI name (so an offline tool can load the INI for the given target platform).

Public function Virtual Const

bool

 

IsClientOnly()

Checks whether this platform is only a client (and must connect to a server to run).

Public function Virtual Const

bool

 

IsLittleEndian()

Checks whether this platform is little endian.

Public function Virtual Const

bool

 

IsServerOnly()

Checks whether this platform is only a server.

Public function Virtual Const

FString

 

PlatformName()

Returns the name of this platform

Public function Virtual Const

bool

 

RequiresCookedData()

Checks whether this platform requires cooked data (typically console platforms).

Public function Virtual Const

EPlatformAut...

 

RequiresUserCredentials()

Checks whether this platform requires user credentials (typically server platforms).

Public function Virtual Const

bool

 

SupportsAutoSDK()

Returns true if the platform supports the AutoSDK system

Public function Virtual Const

bool

 

SupportsBuildTarget

(
    EBuildTargetType TargetType
)

Checks whether this platform supports the specified build target, i.e. Game or Editor.

Public function Virtual Const

bool

 

SupportsFeature

(
    ETargetPlatformFeatures Feature
)

Checks whether the target platform supports the specified feature.