FEditorFileUtils::PromptToCheckoutPackages

Prompt the user with a check-box dialog allowing him/her to check out the provided packages from source control, if desired

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 PromptToCheckoutPackages
(
    bool bCheckDirty,
    const TArray< UPackage * > & PackagesToCheckOut,
    TArray< UPackage * > * OutPackagesCheckedOutOrMadeWritable,
    TArray< UPackage * > * OutPackagesNotNeedingCheckout,
    const bool bPromptingAfterModify
)

Remarks

Prompt the user with a check-box dialog allowing him/her to check out the provided packages from source control, if desired

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

PackagesToCheckOut

Reference to array of packages to prompt the user with for possible check out

OutPackagesCheckedOutOrMadeWritable

If not NULL, this array will be populated with packages that the user selected to check out or make writable.

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.

bPromptingAfterModify

If true, we are prompting the user after an object has been modified, which changes the cancel button to "Ask me later".
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss