ITargetPlatform::CheckRequirements

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

Unreal Engine C++ API Reference > Developer > TargetPlatform > Interfaces > ITargetPlatform

  • ITargetPlatform::CheckRequirements()

References

   
Module TargetPlatform
Header /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h
Include #include "Interfaces/ITargetPlatform.h"
int32 CheckRequirements
(
    bool bProjectHasCode,
    EBuildConfiguration Configuration,
    bool bRequiresAssetNativization,
    [FString](API\Runtime\Core\Containers\FString) & OutTutorialPath,
    [FString](API\Runtime\Core\Containers\FString) & OutDocumentationPath,
    [FText](API\Runtime\Core\Internationalization\FText) & CustomizedLogMessage
) const

Remarks

Checks whether the platform's build requirements are met so that we can do things like package for the platform. A mask of ETargetPlatformReadyStatus flags to indicate missing requirements, or 0 if all requirements are met.

Parameters

Name 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library