1. Epic GamesDeveloper
  3. UPackageTools

UPackageTools

API > API/Editor > API/Editor/UnrealEd

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

Syntax

UCLASS (Abstract, MinimalAPI)  
class UPackageTools : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UPackageTools ( const FObjectInitializer& ObjectInitializer
)

   PackageTools.h  

Structs

Name Remarks
FUnloadPackageParams Struct containing list of packages to unload and other params.

Typedefs

Name Type Remarks Include Path
EReloadPackagesInteractionMode ::EReloadPackagesInteractionMode   PackageTools.h

Constants

Name Type Remarks Include Path
ObjectsThatHadFlagsCleared TSet< UObject * >   PackageTools.h
PackagesBeingUnloaded TSet< UPackage * > * State passed to RestoreStandaloneOnReachableObjects. PackageTools.h
ReachabilityCallbackHandle FDelegateHandle   PackageTools.h

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static void CheckOutRootPackages ( const TArray< UPackage* >& Packages
)

 Helper function that attempts to check out the specified top-level packages. PackageTools.h  

static FString DoBulkExport ( const TArray< UPackage* >& TopLevelPackages,
FString LastExportPath,
const TSet< UClass* >* FilteredClasses,
bool bUseProvidedExportPath
)

 Wrapper method for multiple objects at once. PackageTools.h  

static void ExportPackages ( const TArray< UPackage* >& PackagesToExport,
FString* ExportPath,
bool bUseProvidedExportPath
)

 Exports the given packages to files. PackageTools.h  

static FString FilenameToPackageName ( const FString& Filename
)

 Tries to convert a given relative or absolute filename to a long package name or path starting with a root like /Game This works on both package names and directories, and it does not validate that it actually exists on disk. PackageTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Package Tools"

static UPackage * FindOrCreatePackageForAssetType ( const FName LongPackageName,
UClass* AssetClass
)

 Find or create a package at the desired path If a package already exist but was made for another type of asset, this function will create another one with a modified unique name PackageTools.h  

static void FlushAsyncCompilation ( TArrayView< UPackage*const > Packages
)

 Utility function that gathers all async compilable objects from given packages and flush them to make sure there is no remaining async work trying to load data from said packages. PackageTools.h  

static void GetFilteredPackageList ( TSet< UPackage* >& OutFilteredPackageMap
)

 Filters the global set of packages. PackageTools.h  

static void GetObjectsInPackages ( const TArray< UPackage* >* InPackages,
TArray< UObject* >& OutObjects
)

 Fills the OutObjects list with all valid objects that are supported by the current browser settings and that reside withing the set of specified packages. PackageTools.h  

static bool HandleFullyLoadingPackages ( const TArray< UPackage* >& TopLevelPackages,
const FText& OperationText
)

 Handles fully loading passed in packages. PackageTools.h  

static void HandlePackageReloaded ( const EPackageReloadPhase InPackageReloadPhase,
FPackageReloadedEvent* InPackageReloadedEvent
)

   PackageTools.h  

static bool IsPackageExternal ( const UPackage& Package
)

 Checks if the passed in package's filename is in an external directory. PackageTools.h  

static bool IsPackagePathExternal ( const FString& PackagePath
)

 Checks if the passed in path is in an external directory. PackageTools.h  

static bool IsSingleAssetPackage ( const FString& Package
)

 Checks if the package has only one asset which shares its name PackageTools.h  

static UPackage * LoadPackage ( FString InFilename,
uint32 InLoadFlags
)

 Loads the specified package file (or returns an existing package if it's already loaded.) PackageTools.h  

static FString PackageNameToFilename ( const FString& PackageName,
const FString& Extension
)

 Converts a long package name to a file name. PackageTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Package Tools"
  • Meta=(AdvancedDisplay=1)

static bool ReloadPackages ( const TArray< UPackage* >& PackagesToReload
)

 Helper function that attempts to reload the specified top-level packages. PackageTools.h  

static bool ReloadPackages ( const TArray< UPackage* >& PackagesToReload,
FText& OutErrorMessage,
const bool bInteractive
)

 Helper function that attempts to reload the specified top-level packages. PackageTools.h  

static bool ReloadPackages ( const TArray< UPackage* >& PackagesToReload,
FText& OutErrorMessage,
const EReloadPackagesInteractionMode InteractionMode
)

 Helper function that attempts to reload the specified top-level packages. PackageTools.h  
Called during GC, after reachability analysis is performed but before garbage is purged. PackageTools.h  

static FString SanitizePackageName ( const FString& InPackageName
)

 Replaces all invalid package name characters with _ PackageTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Package Tools"

static bool SavePackagesForObjects ( const TArray< UObject* >& ObjectsToSave
)

 Saves all the dirty packages for the specified objects PackageTools.h  

static bool UnloadPackages ( const TArray< UPackage* >& PackagesToUnload
)

 Helper function that attempts to unload the specified top-level packages. PackageTools.h  

static bool UnloadPackages ( FUnloadPackageParams& Params
)

 Helper function that attemps to unload the specified top-level packages. PackageTools.h  

static bool UnloadPackages ( const TArray< UPackage* >& PackagesToUnload,
FText& OutErrorMessage,
bool bUnloadDirtyPackages
)

 Helper function that attempts to unload the specified top-level packages. PackageTools.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page