UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
IPackageStoreBackend Class Referenceabstract

#include <PackageStore.h>

+ Inheritance diagram for IPackageStoreBackend:

Public Member Functions

virtual ~IPackageStoreBackend ()
 
virtual EPackageLoader GetSupportedLoaders ()
 
virtual void OnMounted (TSharedRef< const FPackageStoreBackendContext > Context)=0
 
virtual void BeginRead ()=0
 
virtual void EndRead ()=0
 
virtual EPackageStoreEntryStatus GetPackageStoreEntry (FPackageId PackageId, FName PackageName, FPackageStoreEntry &OutPackageStoreEntry)=0
 
virtual bool GetPackageRedirectInfo (FPackageId PackageId, FName &OutSourcePackageName, FPackageId &OutRedirectedToPackageId)=0
 
virtual TConstArrayView< uint32 > GetSoftReferences (FPackageId PackageId, TConstArrayView< FPackageId > &OutPackageIds)
 

Detailed Description

Package store backend interface.

Constructor & Destructor Documentation

◆ ~IPackageStoreBackend()

virtual IPackageStoreBackend::~IPackageStoreBackend ( )
inlinevirtual

Member Function Documentation

◆ BeginRead()

virtual void IPackageStoreBackend::BeginRead ( )
pure virtual

Called when the loader enters a package store read scope.

Implemented in FLinkerLoadPackageStoreBackend, FHybridPackageStoreBackend, UE::IoStore::FOnDemandPackageStoreBackend, FFilePackageStoreBackend, and FStorageServerPackageStoreBackend.

◆ EndRead()

virtual void IPackageStoreBackend::EndRead ( )
pure virtual

Called when the loader exits a package store read scope.

Implemented in FLinkerLoadPackageStoreBackend, FHybridPackageStoreBackend, UE::IoStore::FOnDemandPackageStoreBackend, FFilePackageStoreBackend, and FStorageServerPackageStoreBackend.

◆ GetPackageRedirectInfo()

virtual bool IPackageStoreBackend::GetPackageRedirectInfo ( FPackageId  PackageId,
FName &  OutSourcePackageName,
FPackageId &  OutRedirectedToPackageId 
)
pure virtual

Implemented in FLinkerLoadPackageStoreBackend, FHybridPackageStoreBackend, UE::IoStore::FOnDemandPackageStoreBackend, FFilePackageStoreBackend, and FStorageServerPackageStoreBackend.

◆ GetPackageStoreEntry()

virtual EPackageStoreEntryStatus IPackageStoreBackend::GetPackageStoreEntry ( FPackageId  PackageId,
FName  PackageName,
FPackageStoreEntry &  OutPackageStoreEntry 
)
pure virtual

Implemented in FLinkerLoadPackageStoreBackend, FHybridPackageStoreBackend, UE::IoStore::FOnDemandPackageStoreBackend, FFilePackageStoreBackend, and FStorageServerPackageStoreBackend.

◆ GetSoftReferences()

virtual TConstArrayView< uint32 > IPackageStoreBackend::GetSoftReferences ( FPackageId  PackageId,
TConstArrayView< FPackageId > &  OutPackageIds 
)
inlinevirtual

Reimplemented in UE::IoStore::FOnDemandPackageStoreBackend, and FFilePackageStoreBackend.

◆ GetSupportedLoaders()

virtual EPackageLoader IPackageStoreBackend::GetSupportedLoaders ( )
inlinevirtual

Returns what possible loader types are supported by this PackageStore backend

Reimplemented in FLinkerLoadPackageStoreBackend, and FHybridPackageStoreBackend.

◆ OnMounted()

virtual void IPackageStoreBackend::OnMounted ( TSharedRef< const FPackageStoreBackendContext >  Context)
pure virtual

Called when the backend is mounted

Implemented in UE::IoStore::FOnDemandPackageStoreBackend, FStorageServerPackageStoreBackend, FLinkerLoadPackageStoreBackend, FHybridPackageStoreBackend, and FFilePackageStoreBackend.

The documentation for this class was generated from the following file: