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 > Editor > UnrealEd > FEditorFileUtils > PromptToCheckoutLevels > FEditorFileUtils::PromptToCheckoutLevels

Light Theme

Dark Theme

FEditorFileUtils::PromptToCheckoutLevels

Prompt the user with a check-box dialog allowing him/her to check out relevant level packages from source control

Windows

MacOS

Linux

References

Module	UnrealEd
Header	/Engine/Source/Editor/UnrealEd/Public/FileHelpers.h
Include	#include "FileHelpers.h"
Source	/Engine/Source/Editor/UnrealEd/Private/FileHelpers.cpp

Syntax

static bool PromptToCheckoutLevels
(
    bool bCheckDirty,
    const TArray< ULevel * > & SpecificLevelsToCheckOut,
    TArray< UPackage * > * OutPackagesNotNeedingCheckout
)

Remarks

Prompt the user with a check-box dialog allowing him/her to check out relevant level packages from source control

Returns

true if the user did not cancel out of the dialog and has potentially checked out some files (or if there is no source control integration); false if the user cancelled the dialog

Parameters

Parameter	Description
bCheckDirty	If true, non-dirty packages won't be added to the dialog
SpecificLevelsToCheckOut	If specified, only the provided levels' packages will display in the dialog if they are under source control; If nothing is specified, all levels referenced by GWorld whose packages are under source control will be displayed
OutPackagesNotNeedingCheckout	If not null, this array will be populated with packages that the user was not prompted about and do not need to be checked out to save. Useful for saving packages even if the user canceled the checkout dialog.

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

Take our survey

Dismiss