TNonDesktopTargetPlatformBase

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 TNonDesktopTargetPlatformBase : public TTargetPlatformBase< TPlatformProperties >

Variables

Name Description

Protected variable

bool

 

bIsClientOnly

True if this target platform is client-only, ie strips out server stuff

Constructors

Name Description

Public function

TNonDesktopTargetPlatformBase

(
    bool bInIsClientOnly,
    const TCHAR* CookFlavor,
    const TCHAR* OverrideIniPlatfo...
)

A simplified version for TPs that never will have Editor or ServerOnly versions, potentially multiple CookFlavors, as well as IN VERY RARE CASES, a different runtime IniPlatformName than what is passed in here (an example being TVOS and IOS, where passing in TVOS properties is very complicated)

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

bool

 

HasEditorOnlyData()

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

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

 

IsRunningPlatform()

Checks whether this platform is the platform that's currently running.

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