Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Developer > TargetPlatform > Interfaces > ITargetPlatform > ITargetPlatform::CheckRequirements

Light Theme

Dark Theme

ITargetPlatform::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/Interfaces/ITargetPlatform.h
Include	#include "Interfaces/ITargetPlatform.h"

Syntax

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.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss