UPackageTools

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Public/PackageTools.h

Include

#include "PackageTools.h"

Syntax

class UPackageTools : public UObject

Constructors

Name Description

Public function

UPackageTools

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static

void

 

CheckOutRootPackages

(
    const TArray< UPackage* >& Pa...
)

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

Public function Static

FString

 

DoBulkExport

(
    const TArray< UPackage* >& To...,
    FString LastExportPath,
    const TSet< UClass* >* Fi...,
    bool bUseProvidedExportPath
)

Wrapper method for multiple objects at once.

Public function Static

void

 

ExportPackages

(
    const TArray< UPackage* >& Pa...,
    FString* ExportPath,
    bool bUseProvidedExportPath
)

Exports the given packages to files.

Public function 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

Public function Static

void

 

GetFilteredPackageList

(
    TSet< UPackage* >& OutFiltere...
)

Filters the global set of packages.

Public function Static

void

 

GetObjectsInPackages

(
    const TArray< UPackage* >*...,
    TArray< UObject* >& OutObject...
)

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.

Public function Static

bool

 

HandleFullyLoadingPackages

(
    const TArray< UPackage* >& To...,
    const FText& OperationText
)

Handles fully loading passed in packages.

Public function Static

bool

 

IsPackageExternal

(
    const UPackage& Package
)

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

Public function Static

bool

 

IsPackagePathExternal

(
    const FString& PackagePath
)

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

Public function Static

bool

 

IsSingleAssetPackage

(
    const FString& Package
)

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

Public function Static

UPackage ...

 

LoadPackage

(
    FString InFilename
)

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

Public function Static

bool

 

ReloadPackages

(
    const TArray< UPackage* >& Pa...
)

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

Public function Static

bool

 

ReloadPackages

(
    const TArray< UPackage* >& Pa...,
    FText& OutErrorMessage,
    const EReloadPackagesInteractionMod...
)

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

Public function Static

FString

 

SanitizePackageName

(
    const FString& InPackageName
)

Replaces all invalid package name characters with _

Public function Static

bool

 

SavePackagesForObjects

(
    const TArray< UObject* >& Obj...
)

Saves all the dirty packages for the specified objects

Public function Static

bool

 

UnloadPackages

(
    const TArray< UPackage* >& Pa...
)

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

Public function Static

bool

 

UnloadPackages

(
    const TArray< UPackage* >& Pa...,
    FText& OutErrorMessage,
    bool bUnloadDirtyPackages
)

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

Typedefs

Constants

Name

Description

ObjectsThatHadFlagsCleared

PackagesBeingUnloaded

State passed to RestoreStandaloneOnReachableObjects.

ReachabilityCallbackHandle

Deprecated Functions

Name Description

Public function Static

bool

 

ReloadPackages

(
    const TArray< UPackage* >& Pa...,
    FText& OutErrorMessage,
    const bool bInteractive
)

ReloadPackages taking bInteractive is deprecated. Use the version taking EReloadPackagesInteractionMode instead.