1. Epic GamesDeveloper
  3. FEditorFileUtils

FEditorFileUtils

For saving map files through the main editor frame.

API > API/Editor > API/Editor/UnrealEd

References

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

Syntax

class FEditorFileUtils

Remarks

For saving map files through the main editor frame.

Functions

  Type Name Description
Public function Static bool

AttemptUnloadInactiveWorldPackage ( UPackage* PackageToUnload,
FText& OutErrorMessage
)

 Unloads the specified package potentially containing an inactive world.
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function 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
Public function 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
Public function Static void

Export ( bool bExportSelectedActorsOnly
)

  
Public function Static FString

ExtractPackageName ( const FString& ObjectPath
)

 Helper function used to extract the package name from the object path
Public function Static void

FindAllConfigFiles ( TArray< FString >& OutConfigFiles
)

 Looks for config files for the current project.
Public function Static void

FindAllPackageFiles ( TArray< FString >& OutPackages
)

 Looks for package files in the known content paths on disk.
Public function Static void Looks for source control submittable non-package config files for the current project.
Public function Static void

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

 Looks for source control submittable files in the known content paths on disk.
Public function Static void Looks for source control submittable non-package project files for the current project.
Public function Static FString

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

 Get the autosave filename for the given package.
Public function Static void

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

 Appends array with all currently dirty content packages.
Public function Static void

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

 Appends array with all currently dirty packages
Public function Static void

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

 Appends array with all currently dirty world packages.
Public function Static FString

GetFilename ( const FName& PackageName
)

  
Public function Static FString

GetFilename ( UObject* LevelObject
)

  
Public function Static FString Returns a file filter string appropriate for a specific file interaction.
Public function Static FOnLoadMapEnd &  
Public function Static FOnLoadMapStart &  
Public function Static void

Import ( const FString& InFilename
)

  
Public function Static void

Import ()

 Presents the user with a file dialog for importing.
Public function Static bool Whether or not we're in the middle of loading the simple startup map
Public function Static bool

IsMapPackageAsset ( const FString& ObjectPath,
FString& MapFilePath
)

 Helper function used to decide whether a package name is a map package or not.
Public function Static bool

IsMapPackageAsset ( const FString& ObjectPath
)

 Helper function used to decide whether a package name is a map package or not.
Public function Static bool

IsValidMapFilename ( const FString& MapFilename,
FText& OutErrorMessage
)

 Returns true if the specified map filename is valid for loading or saving.
Public function Static void Loads a simple example map
Public function Static bool

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

 Loads the specified map.
Public function 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.
Public function Static void

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

 Opens a non-modal dialog to allow the user to choose a level
Public function Static void

PrepareWorldsForExplicitSave ( TArray< UWorld* > Worlds
)

 Broadcasts the OnPrepareWorldsForExplicitSave event to allow validation and changes to worlds before they're saved.
Public function Static EPromptReturnCode

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

  
Public function Static EPromptReturnCode

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

  
Public function Static EPromptReturnCode

PromptForCheckoutAndSave ( const TArray< UPackage* >& PackagesToSave,
FPromptForCheckoutAndSaveParams& InOutParams
)

 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.
Public function 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
Public function 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
Public function 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
Public function 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
Public function Static void Clears current level filename so that the user must SaveAs on next Save.
Public function Static void

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

 Does a SaveAs for the specified assets.
Public function Static bool Saves the active level, prompting the use for checkout if necessary.
Public function 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)
Public function 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)
Public function Static bool

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

 Saves the specified level.
Public function Static bool

SaveLevelAs ( ULevel* Level,
FString* OutSavedFilename
)

 Does a saveAs for the specified level.Does a saveAs for the specified level.
Public function Static bool

SaveMap ( UWorld* World,
const FString& Filename
)

 Saves the specified map package, returning true on success.
Public function Static bool

SaveMapDataPackages ( UWorld* World,
bool bCheckDirty
)

 Saves packages which contain map data but are not map packages themselves.
Public function 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.
Public function Static bool Whether or not saving the map package should save the external objects packages

Classes

  Type Name Description
Public struct FPromptForCheckoutAndSaveParams    
Public struct FShouldIgnorePackage    

Enums

  Type Name Description
Public enum EGarbageCollectionOption Used to decide how to handle garbage collection.  
Public enum EPromptReturnCode Enum used for prompt returns  

Typedefs

Name Description
FOnLevelPickingCancelled  
FOnLevelsChosen  
FOnLoadMapEnd  
FOnLoadMapStart  
FOnPrepareWorldsForExplicitSave  
FShouldIgnorePackageFunctionRef Dirty Package Ignore

Constants

Name Description
bIsLoadingDefaultStartupMap  
bIsPromptingForCheckoutAndSave Flag used to determine if the checkout and save prompt is already open to prevent re-entrance
bSkipExternalObjectSave Flag used in SaveMap to skip saving external objects and only save the map
OnLoadMapEnd  
OnLoadMapStart  
OnPrepareWorldsForExplicitSave  
PackagesNotSavedDuringSaveAll Set of packages to ignore for save/checkout when using SaveAll.
PackagesNotToPromptAnyMore Set of packages which should no longer prompt for checkouts / to be made writable.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page