1. Epic GamesDeveloper
  3. IPackageResourceManager

IPackageResourceManager

Provides directory queries and Archive payloads for PackagePaths and their PackageSegments from a repository that might be the local content directories, a database running on the current machine, or a remote database.

API > API/Runtime > API/Runtime/CoreUObject

Provides directory queries and Archive payloads for PackagePaths and their PackageSegments from a repository that might be the local content directories, a database running on the current machine, or a remote database.

   
Name IPackageResourceManager
Type class
Header File /Engine/Source/Runtime/CoreUObject/Public/UObject/PackageResourceManager.h
Include Path #include "UObject/PackageResourceManager.h"

Syntax

class IPackageResourceManager

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IPackageResourceManager()

   UObject/PackageResourceManager.h  

Typedefs

Name Type Remarks Include Path
FPackagePathStatVisitor TFunctionRef< bool(const FPackagePath &PackagePath, const FFileStatData &StatData)> Return value specifies whether iteration should continue UObject/PackageResourceManager.h
FPackagePathVisitor TFunctionRef< bool(const FPackagePath &PackagePath)> Return value specifies whether iteration should continue UObject/PackageResourceManager.h
FPackageSegmentStatVisitor TFunctionRef< bool(const FPackagePath &PackagePath, EPackageSegment PackageSegment, const FFileStatData &StatData)> Return value specifies whether iteration should continue UObject/PackageResourceManager.h
FPackageSegmentVisitor TFunctionRef< bool(const FPackagePath &PackagePath, EPackageSegment PackageSegment)> Return value specifies whether iteration should continue UObject/PackageResourceManager.h

Constants

Name Type Remarks Include Path
PreloadedPaths TMap< FName, TPair< TSharedPtr< FPreloadableArchive >, FOpenPackageResult > >   UObject/PackageResourceManager.h
PreloadedPathsLock FCriticalSection   UObject/PackageResourceManager.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool DoesExternalResourceExist ( EPackageExternalResource ResourceType,
FStringView Identifier
)

 Report whether a given ExternalResource exists. UObject/PackageResourceManager.h  

bool DoesPackageExist ( const FPackagePath& PackagePath,
FBulkDataCookedIndex CookedIndex,
EPackageSegment PackageSegment,
FPackagePath* OutUpdatedPath
)

 DoesPackageExist that takes a PackageSegment UObject/PackageResourceManager.h  

bool DoesPackageExist ( const FPackagePath& PackagePath,
EPackageSegment PackageSegment,
FPackagePath* OutUpdatedPath
)

 Internal API used by low-level PackageResourceManager users UObject/PackageResourceManager.h  

bool DoesPackageExist ( const FPackagePath& PackagePath,
FPackagePath* OutUpdatedPath
)

 Report whether the package exists UObject/PackageResourceManager.h  

int64 FileSize ( const FPackagePath& PackagePath,
FBulkDataCookedIndex CookedIndex,
EPackageSegment PackageSegment,
FPackagePath* OutUpdatedPath
)

 FileSize that takes a PackageSegment UObject/PackageResourceManager.h  

int64 FileSize ( const FPackagePath& PackagePath,
FPackagePath* OutUpdatedPath
)

 Report the payload size of the package UObject/PackageResourceManager.h  

int64 FileSize ( const FPackagePath& PackagePath,
EPackageSegment PackageSegment,
FPackagePath* OutUpdatedPath
)

   UObject/PackageResourceManager.h  

void FindPackagesRecursive ( TArray< TPair< FPackagePath, EPackageSegment > >& OutPackages,
FStringView PackageMount,
FStringView FileMount,
FStringView RootRelPath,
FStringView BasenameWildcard
)

 FindPackagesRecursive that returns PackageSegments UObject/PackageResourceManager.h  

void FindPackagesRecursive ( TArray< FPackagePath >& OutPackages,
FStringView PackageMount,
FStringView FileMount,
FStringView RootRelPath,
FStringView BasenameWildcard
)

 Search the given subdirectory of a package mount for all packages with the given package basename in the package repository UObject/PackageResourceManager.h  

void IteratePackagesInLocalOnlyDirectory ( FStringView RootDir,
FPackageSegmentVisitor Callback
)

 IteratePackagesInLocalOnlyDirectory that takes a FPackageSegmentStatVisitor UObject/PackageResourceManager.h  

void IteratePackagesInLocalOnlyDirectory ( FStringView RootDir,
FPackagePathVisitor Callback
)

 Call the callback on all packages in the given local path UObject/PackageResourceManager.h  

void IteratePackagesInPath ( FStringView PackageMount,
FStringView FileMount,
FStringView RootRelPath,
FPackagePathVisitor Callback
)

 Call the callback on all packages in the package repository that are in the given subdirectory of a package mount UObject/PackageResourceManager.h  

void IteratePackagesInPath ( FStringView PackageMount,
FStringView FileMount,
FStringView RootRelPath,
FPackageSegmentVisitor Callback
)

 IteratePackagesInPath that takes a FPackageSegmentVisitor UObject/PackageResourceManager.h  

void IteratePackagesStatInLocalOnlyDirectory ( FStringView RootDir,
FPackageSegmentStatVisitor Callback
)

 IteratePackagesStatInLocalOnlyDirectory that takes a FPackageSegmentStatVisitor UObject/PackageResourceManager.h  

void IteratePackagesStatInLocalOnlyDirectory ( FStringView RootDir,
FPackagePathStatVisitor Callback
)

 Call the callback - with stat data - on all packages in the given local path UObject/PackageResourceManager.h  

void IteratePackagesStatInPath ( FStringView PackageMount,
FStringView FileMount,
FStringView RootRelPath,
FPackageSegmentStatVisitor Callback
)

 IteratePackagesStatInPath that takes a FPackageSegmentVisitor UObject/PackageResourceManager.h  

void IteratePackagesStatInPath ( FStringView PackageMount,
FStringView FileMount,
FStringView RootRelPath,
FPackagePathStatVisitor Callback
)

 Call the callback - with stat data - on all packages in the package repository that are in the given subdirectory of a package mount UObject/PackageResourceManager.h  
Open an IAsyncReadFileHandle to asynchronously read the bytes of the given ExternalResource. UObject/PackageResourceManager.h  
Open an IAsyncReadFileHandle to asynchronously read the bytes of the package UObject/PackageResourceManager.h  
  UObject/PackageResourceManager.h  
OpenAsyncReadPackage that takes a PackageSegment UObject/PackageResourceManager.h  

IMappedFileHandle * OpenMappedHandleToPackage ( const FPackagePath& PackagePath,
FPackagePath* OutUpdatedPath
)

 Open an IMappedFileHandle to the package, if the PackageResourceManager supports it UObject/PackageResourceManager.h  

IMappedFileHandle * OpenMappedHandleToPackage ( const FPackagePath& PackagePath,
EPackageSegment PackageSegment,
FPackagePath* OutUpdatedPath
)

 OpenMappedHandleToPackage that takes a PackageSegment UObject/PackageResourceManager.h  

TUniquePtr< FArchive > OpenReadExternalResource ( EPackageExternalResource ResourceType,
FStringView Identifier
)

 Open a seekable binary FArchive to read the bytes of the given External Resource. UObject/PackageResourceManager.h  

FOpenPackageResult OpenReadPackage ( const FPackagePath& PackagePath,
FPackagePath* OutUpdatedPath
)

 Open an FArchive to read the bytes of the package UObject/PackageResourceManager.h  

FOpenPackageResult OpenReadPackage ( const FPackagePath& PackagePath,
FBulkDataCookedIndex CookedIndex,
EPackageSegment PackageSegment,
FPackagePath* OutUpdatedPath
)

 OpenReadPackage that takes a PackageSegment UObject/PackageResourceManager.h  

FOpenPackageResult OpenReadPackage ( const FPackagePath& PackagePath,
EPackageSegment PackageSegment,
FPackagePath* OutUpdatedPath
)

   UObject/PackageResourceManager.h  
Report whether the PackageResourceManager supports PackagePaths that are unmounted LocalPaths UObject/PackageResourceManager.h  
Report whether the PackageResourceManager supports PackagePaths that are unmounted PackageNames UObject/PackageResourceManager.h  

bool TryMatchCaseOnDisk ( const FPackagePath& PackagePath,
FPackagePath* OutNormalizedPath
)

 Find the package in the package repository and set OutNormalizedPath equal to PackagePath, but with capitalization of the PackageName and LocalPath matching the capitalization present in the package repository's internal path string (e.g. the path on disk) UObject/PackageResourceManager.h  

Static

Name Remarks Include Path Unreal Specifiers

static IPackageResourceManager & Get()

 Returns the package resource manager. It is illegal to call Get before calling initialize. UObject/PackageResourceManager.h  

static FOnClearPackageResourceManager & GetOnClearPackageResourceManagerDelegate()

   UObject/PackageResourceManager.h  

static FSetPackageResourceManager & GetSetPackageResourceManagerDelegate()

   UObject/PackageResourceManager.h  

static void Initialize()

 Call during engine startup to choose the appropriate PackageResourceManager for the current configuration and construct it and bind it to be returned from Get UObject/PackageResourceManager.h  

static void Shutdown()

 Call during engine shutdown to free the PackageResourceManager that was created by Initialize; Get will and return nullptr from this point on UObject/PackageResourceManager.h  

static bool TryRegisterPreloadableArchive ( const FPackagePath& PackagePath,
const TSharedPtr< FPreloadableArchive >& PreloadableArchive,
const FOpenPackageResult& PackageFormat
)

 Preloading Package Archives. UObject/PackageResourceManager.h  

static bool TryTakePreloadableArchive ( const FPackagePath& PackagePath,
FOpenPackageResult& OutResult
)

 Look up an FPreloadableFile instance registered for the given PackagePath, and return an FOpenPackageResult from it UObject/PackageResourceManager.h  

static bool UnRegisterPreloadableArchive ( const FPackagePath& PackagePath
)

 Remove any FPreloadableArchive instance that is registered for the given PackagePath. UObject/PackageResourceManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page