1. Epic GamesDeveloper
  3. FEditorFileUtils

FEditorFileUtils

For saving map files through the main editor frame.

API > API/Editor > API/Editor/UnrealEd

For saving map files through the main editor frame.

   
Name FEditorFileUtils
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/FileHelpers.h
Include Path #include "FileHelpers.h"

Syntax

class FEditorFileUtils

Structs

Name Remarks
FPromptForCheckoutAndSaveParams  
FShouldIgnorePackage  

Enums

Public

Name Remarks
EGarbageCollectionOption Used to decide how to handle garbage collection.
EPromptReturnCode Enum used for prompt returns

Typedefs

Name Type Remarks Include Path
FOnLevelPickingCancelled TBaseDelegate_NoParams< void >   FileHelpers.h
FOnLevelsChosen TBaseDelegate_OneParam< void, const TArray< FAssetData > & >   FileHelpers.h
FOnLoadMapEnd TMulticastDelegate_OneParam< void, const FString &Filename >   FileHelpers.h
FOnLoadMapStart TMulticastDelegate_NoParams< void >   FileHelpers.h
FOnPrepareWorldsForExplicitSave TMulticastDelegate_OneParam< void, TArray< UWorld * > Worlds >   FileHelpers.h
FShouldIgnorePackageFunctionRef TFunctionRef< bool(UPackage *)> Dirty Package Ignore FileHelpers.h

Constants

Name Type Remarks Include Path
bIsLoadingDefaultStartupMap bool   FileHelpers.h
bIsPromptingForCheckoutAndSave bool Flag used to determine if the checkout and save prompt is already open to prevent re-entrance FileHelpers.h
bSkipExternalObjectSave bool Flag used in SaveMap to skip saving external objects and only save the map FileHelpers.h
OnLoadMapEnd FOnLoadMapEnd   FileHelpers.h
OnLoadMapStart FOnLoadMapStart   FileHelpers.h
OnPrepareWorldsForExplicitSave FOnPrepareWorldsForExplicitSave   FileHelpers.h
PackagesNotSavedDuringSaveAll TSet< FString > Set of packages to ignore for save/checkout when using SaveAll. FileHelpers.h
PackagesNotToPromptAnyMore TSet< FString > Set of packages which should no longer prompt for checkouts / to be made writable. FileHelpers.h

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool AddCheckoutPackageItems ( bool bCheckDirty,
const TArray< UPackage* >& PackagesToCheckOut,
const TSet< FName >& ReadOnlyPackages,
TArray< UPackage* >* OutPackagesNotNeedingCheckout,
bool* bOutHavePackageToCheckOut
)

 Private method used to build a list of items requiring checkout FileHelpers.h  

static bool AttemptUnloadInactiveWorldPackage ( UPackage* PackageToUnload,
FText& OutErrorMessage
)

 Unloads the specified package potentially containing an inactive world. FileHelpers.h  

static bool AutomaticCheckoutOrPromptToRevertPackages ( const TArray< UPackage* >& PackagesToCheckOut,
TArray< UPackage* >* OutPackagesCheckedOutOrMadeWritable,
TArray< UPackage* >* OutPackagesNotNeedingCheckout,
TArray< UPackage* >* OutPackagesToRevert
)

 Tries to checkout packages without prompting and only prompts (for revert) if that fails FileHelpers.h  

static bool AutosaveContentPackages ( const FString& AbsoluteAutosaveDir,
const int32 AutosaveIndex,
const bool bForceIfNotInList,
const TSet< TWeakObjectPtr< UPackage >, TWeakObjectPtrSetKeyFuncs< TWeakObjectPtr< UPackage > > >& ...
)

 Saves all asset packages to the specified directory. FileHelpers.h  

static EAutosaveContentPackagesResult::Type AutosaveContentPackagesEx ( const FString& AbsoluteAutosaveDir,
const int32 AutosaveIndex,
const bool bForceIfNotInList,
const TSet< TWeakObjectPtr< UPackage >, TWeakObjectPtrSetKeyFuncs< TWeakObjectPtr< UPackage > > >& ...
)

 Saves all asset packages to the specified directory. FileHelpers.h  

static bool AutosaveMap ( const FString& AbsoluteAutosaveDir,
const int32 AutosaveIndex,
const bool bForceIfNotInList,
const TSet< TWeakObjectPtr< UPackage >, TWeakObjectPtrSetKeyFuncs< TWeakObjectPtr< UPackage > > >& ...
)

 Saves all levels to the specified directory. FileHelpers.h  

static EAutosaveContentPackagesResult::Type AutosaveMapEx ( const FString& AbsoluteAutosaveDir,
const int32 AutosaveIndex,
const bool bForceIfNotInList,
const TSet< TWeakObjectPtr< UPackage >, TWeakObjectPtrSetKeyFuncs< TWeakObjectPtr< UPackage > > >& ...
)

 Saves all levels to the specified directory. FileHelpers.h  

static ECommandResult::Type CheckoutPackages ( const TArray< UPackage* >& PkgsToCheckOut,
TArray< UPackage* >* OutPackagesCheckedOut,
const bool bErrorIfAlreadyCheckedOut,
const bool bConfirmPackageBranchCheckOutStatus
)

 Check out the specified packages from source control and report any errors while checking out FileHelpers.h  

static ECommandResult::Type CheckoutPackages ( const TArray< FString >& PkgsToCheckOut,
TArray< FString >* OutPackagesCheckedOut,
const bool bErrorIfAlreadyCheckedOut
)

 Check out the specified packages from source control and report any errors while checking out FileHelpers.h  

static void Export ( bool bExportSelectedActorsOnly
)

   FileHelpers.h  

static FString ExtractPackageName ( const FString& ObjectPath
)

 Helper function used to extract the package name from the object path FileHelpers.h  

static void FindAllConfigFiles ( TArray< FString >& OutConfigFiles
)

 Looks for config files for the current project. FileHelpers.h  

static void FindAllPackageFiles ( TArray< FString >& OutPackages
)

 Looks for package files in the known content paths on disk. FileHelpers.h  

static void FindAllSubmittableConfigFiles ( TMap< FString, FSourceControlStatePtr >& OutConfigFiles
)

 Looks for source control submittable non-package config files for the current project. FileHelpers.h  

static void FindAllSubmittablePackageFiles ( TMap< FString, FSourceControlStatePtr >& OutPackages,
const bool bIncludeMaps
)

 Looks for source control submittable files in the known content paths on disk. FileHelpers.h  

static void FindAllSubmittableProjectFiles ( TMap< FString, FSourceControlStatePtr >& OutProjectFiles
)

 Looks for source control submittable non-package project files for the current project. FileHelpers.h  

static FString GetAutoSaveFilename ( UPackage*const Package,
const FString& AbsoluteAutosaveDir,
const int32 AutoSaveIndex,
const FString& PackageExt
)

 Get the autosave filename for the given package. FileHelpers.h  

static void GetDirtyContentPackages ( TArray< UPackage* >& OutDirtyPackages,
const FShouldIgnorePackageFunctionRef& ShouldIgnorePackageFunction
)

 Appends array with all currently dirty content packages. FileHelpers.h  

static void GetDirtyPackages ( TArray< UPackage* >& OutDirtyPackages,
const FShouldIgnorePackageFunctionRef& ShouldIgnorePackageFunction
)

 Appends array with all currently dirty packages FileHelpers.h  

static void GetDirtyWorldPackages ( TArray< UPackage* >& OutDirtyPackages,
const FShouldIgnorePackageFunctionRef& ShouldIgnorePackageFunction
)

 Appends array with all currently dirty world packages. FileHelpers.h  

static FString GetFilename ( const FName& PackageName
)

   FileHelpers.h  

static FString GetFilename ( UObject* LevelObject
)

   FileHelpers.h  

static FString GetFilterString ( EFileInteraction Interaction
)

 Returns a file filter string appropriate for a specific file interaction. FileHelpers.h  

static FOnLoadMapEnd & GetOnLoadMapEndDelegate()

   FileHelpers.h  

static FOnLoadMapStart & GetOnLoadMapStartDelegate()

   FileHelpers.h  

static void Import ( const FString& InFilename
)

   FileHelpers.h  

static void Import ()

 Presents the user with a file dialog for importing. FileHelpers.h  

static bool IsLoadingStartupMap()

 Whether or not we're in the middle of loading the simple startup map FileHelpers.h  

static bool IsMapPackageAsset ( const FString& ObjectPath,
FString& MapFilePath
)

 Helper function used to decide whether a package name is a map package or not. FileHelpers.h  

static bool IsMapPackageAsset ( const FString& ObjectPath
)

 Helper function used to decide whether a package name is a map package or not. FileHelpers.h  

static bool IsValidMapFilename ( const FString& MapFilename,
FText& OutErrorMessage
)

 Returns true if the specified map filename is valid for loading or saving. FileHelpers.h  

static void LoadDefaultMapAtStartup()

 Loads a simple example map FileHelpers.h  

static bool LoadMap ( const FString& Filename,
bool LoadAsTemplate,
const bool bShowProgress
)

 Loads the specified map. FileHelpers.h  

static bool LoadMap ()

 Prompts the user to save the current map if necessary, the presents a load dialog and loads a new map if selected by the user. FileHelpers.h  

static void MakePackagesWritable ( const TArray< UPackage* >& PackagesToMakeWritable,
TArray< UPackage* >* OutPackagesMadeWritable,
TArray< UPackage* >* OutPackagesMadeWritableFailed
)

 Tries to make the given packages writable FileHelpers.h  

static void OpenLevelPickingDialog ( const FOnLevelsChosen& OnLevelsChosen,
const FOnLevelPickingCancelled& OnLevelPickingCancelled,
bool bAllowMultipleSelection
)

 Opens a non-modal dialog to allow the user to choose a level FileHelpers.h  

static void PrepareWorldsForExplicitSave ( TArray< UWorld* > Worlds
)

 Broadcasts the OnPrepareWorldsForExplicitSave event to allow validation and changes to worlds before they're saved. FileHelpers.h  

static EPromptReturnCode PromptForCheckoutAndSave ( const TArray< UPackage* >& PackagesToSave,
bool bCheckDirty,
bool bPromptToSave,
const FText& Title,
const FText& Message,
TArray< UPackage* >* OutFailedPackages,
bool bAlreadyCheckedOut,
bool bCanBeDeclined
)

   FileHelpers.h  

static EPromptReturnCode PromptForCheckoutAndSave ( const TArray< UPackage* >& PackagesToSave,
bool bCheckDirty,
bool bPromptToSave,
TArray< UPackage* >* OutFailedPackages,
bool bAlreadyCheckedOut,
bool bCanBeDeclined
)

   FileHelpers.h  
Optionally prompts the user for which of the provided packages should be saved, and then additionally prompts the user to check-out any of the provided packages which are under source control. FileHelpers.h  

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

 Prompt the user with a check-box dialog allowing them to check out relevant level packages from source control FileHelpers.h  

static bool PromptToCheckoutLevels ( bool bCheckDirty,
ULevel* SpecificLevelToCheckOut
)

 Overloaded version of PromptToCheckOutLevels which prompts the user with a check-box dialog allowing them to check out the relevant level package if necessary FileHelpers.h  

static bool PromptToCheckoutPackages ( bool bCheckDirty,
const TArray< UPackage* >& PackagesToCheckOut,
TArray< UPackage* >* OutPackagesCheckedOutOrMadeWritable,
TArray< UPackage* >* OutPackagesNotNeedingCheckout,
const bool bPromptingAfterModify,
const bool bAllowSkip
)

 Prompt the user with a check-box dialog allowing them to check out the provided packages from source control, if desired FileHelpers.h  

static bool PromptToCheckoutPackagesInternal ( bool bCheckDirty,
const TArray< UPackage* >& PackagesToCheckOut,
TArray< UPackage* >* OutPackagesCheckedOutOrMadeWritable,
TArray< UPackage* >* OutPackagesNotNeedingCheckout,
const bool bPromptingAfterModify,
const bool bAllowSkip
)

 Prompts for package checkout without reentrance check FileHelpers.h  

static void RegisterLevelFilename ( UObject* Object,
const FString& NewLevelFilename
)

 Sets the active level filename so that "Save" operates on this file and "SaveAs" must be used on others FileHelpers.h  

static void ResetLevelFilenames ()

 Clears current level filename so that the user must SaveAs on next Save. FileHelpers.h  

static void SaveAssetsAs ( const TArray< UObject* >& Assets,
TArray< UObject* >& OutSavedAssets
)

 Does a SaveAs for the specified assets. FileHelpers.h  

static bool SaveCurrentLevel()

 Saves the active level, prompting the use for checkout if necessary. FileHelpers.h  

static bool SaveDirtyContentPackages ( TArray< UClass* >& SaveContentClasses,
const bool bPromptUserToSave,
const bool bFastSave,
const bool bNotifyNoPackagesSaved,
const bool bCanBeDeclined
)

 Looks at all currently loaded packages and saves them if their "bDirty" flag is set and they include specified clasees, optionally prompting the user to select which packages to save) FileHelpers.h  

static bool SaveDirtyPackages ( const bool bPromptUserToSave,
const bool bSaveMapPackages,
const bool bSaveContentPackages,
const bool bFastSave,
const bool bNotifyNoPackagesSaved,
const bool bCanBeDeclined,
bool* bOutPackagesNeededSaving,
const FShouldIgnorePackageFunctionRef& ShouldIgnorePackageFunction,
bool bSkipExternalObjectSave
)

 Looks at all currently loaded packages and saves them if their "bDirty" flag is set, optionally prompting the user to select which packages to save) FileHelpers.h  

static bool SaveLevel ( ULevel* Level,
const FString& DefaultFilename,
FString* OutSavedFilename
)

 Saves the specified level. FileHelpers.h  

static bool SaveLevelAs ( ULevel* Level,
FString* OutSavedFilename
)

 Does a saveAs for the specified level.Does a saveAs for the specified level. FileHelpers.h  

static bool SaveMap ( UWorld* World,
const FString& Filename
)

 Saves the specified map package, returning true on success. FileHelpers.h  

static bool SaveMapDataPackages ( UWorld* World,
bool bCheckDirty
)

 Saves packages which contain map data but are not map packages themselves. FileHelpers.h  

static bool SaveWorlds ( UWorld* InWorld,
const FString& RootPath,
const TCHAR* Prefix,
TArray< FString >& OutFilenames
)

 Save all packages corresponding to the specified world, with the option to override their path and also apply a prefix. FileHelpers.h  

static bool ShouldSkipExternalObjectSave()

 Whether or not saving the map package should save the external objects packages FileHelpers.h  

static void UpdateCheckoutPackageItems ( bool bCheckDirty,
TArray< UPackage* > PackagesToCheckOut,
TSet< FName > ReadOnlyPackages,
TArray< UPackage* >* OutPackagesNotNeedingCheckout
)

 Callback from PackagesDialog used to update the list of items when the source control state changes FileHelpers.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page