FTargetPlatformBase::CheckRequirements

Checks whether the platform's build requirements are met so that we can do things like package for the platform.

Windows
MacOS
Linux

Override Hierarchy

ITargetPlatform::CheckRequirements()

FTargetPlatformBase::CheckRequirements()

References

Module

TargetPlatform

Header

/Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h

Include

#include "Common/TargetPlatformBase.h"

Syntax

virtual int32 CheckRequirements
(
    bool bProjectHasCode,
    EBuildConfiguration Configuration,
    bool bRequiresAssetNativization,
    FString & OutTutorialPath,
    FString & OutDocumentationPath,
    FText & CustomizedLogMessage
) const

Remarks

Checks whether the platform's build requirements are met so that we can do things like package for the platform.

Returns

A mask of ETargetPlatformReadyStatus flags to indicate missing requirements, or 0 if all requirements are met.

Parameters

Parameter

Description

bProjectHasCode

true if the project has code, and therefore any compilation based SDK requirements should be checked.

Configuration

The configuration being built

bRequiresAssetNativization

Whether asset nativization is required

OutTutorialPath

Let's the platform tell the editor a path to show some information about how to fix any problem.

OutDocumentationPath

Let's the platform tell the editor a documentation path.

CustomizedLogMessage

Let's the platform return a customized log message instead of the default for the returned status.