FAssetRegistryModule Class Reference

#include <AssetRegistryModule.h>

Inheritance diagram for FAssetRegistryModule:

Public Member Functions
virtual void	StartupModule () override
virtual IAssetRegistry &	Get () const
bool	IsValid () const
IAssetRegistry *	TryGet () const
virtual void	GetDependencies (FName InPackageName, TArray< FName > &OutDependencies, UE::AssetRegistry::EDependencyCategory Category=UE::AssetRegistry::EDependencyCategory::Package, const UE::AssetRegistry::FDependencyQuery &Flags=UE::AssetRegistry::FDependencyQuery()) override
virtual UE::AssetRegistry::EExists	TryGetAssetByObjectPath (const FSoftObjectPath &ObjectPath, FAssetData &OutAssetData) const override
virtual UE::AssetRegistry::EExists	TryGetAssetPackageData (FName PackageName, FAssetPackageData &OutAssetPackageData) const override
virtual UE::AssetRegistry::EExists	TryGetAssetPackageData (FName PackageName, FAssetPackageData &OutAssetPackageData, FName &OutCorrectCasePackageName) const override
virtual bool	EnumerateAssets (const FARFilter &Filter, TFunctionRef< bool(const FAssetData &)> Callback, UE::AssetRegistry::EEnumerateAssetsFlags InEnumerateFlags=UE::AssetRegistry::EEnumerateAssetsFlags::None) const override
virtual bool	RegisterOnAssetsAddedDelegate (const TFunction< void(TConstArrayView< FAssetData >)> &Function, FDelegateHandle &OutHandle) override
virtual bool	UnregisterOnAssetsAddedDelegate (const FDelegateHandle &Handle) override
virtual bool	RegisterOnAssetsRemovedDelegate (const TFunction< void(TConstArrayView< FAssetData >)> &Function, FDelegateHandle &OutHandle) override
virtual bool	UnregisterOnAssetsRemovedDelegate (const FDelegateHandle &Handle) override
Public Member Functions inherited from IModuleInterface
virtual	~IModuleInterface ()
virtual void	PreUnloadCallback ()
virtual void	PostLoadCallback ()
virtual void	ShutdownModule ()
virtual bool	SupportsDynamicReloading ()
virtual bool	SupportsAutomaticShutdown ()
virtual bool	IsGameModule () const

Static Public Member Functions
static IAssetRegistry &	GetRegistry ()
static void	TickAssetRegistry (float DeltaTime)
static void	AssetCreated (UObject *NewAsset)
static void	AssetDeleted (UObject *DeletedAsset)
static void	AssetRenamed (const UObject *RenamedAsset, const FString &OldObjectPath)
static void	AssetsSaved (TArray< FAssetData > &&SavedAssets)
static void	PackageDeleted (UPackage *DeletedPackage)
Static Public Member Functions inherited from IAssetRegistryInterface
static COREUOBJECT_API IAssetRegistryInterface *	GetPtr ()

Additional Inherited Members
Static Protected Attributes inherited from IAssetRegistryInterface
static COREUOBJECT_API IAssetRegistryInterface *	Default = nullptr

Detailed Description

Asset registry module

Member Function Documentation

AssetCreated()

static void FAssetRegistryModule::AssetCreated ( UObject *  NewAsset )

inlinestatic

AssetDeleted()

static void FAssetRegistryModule::AssetDeleted ( UObject *  DeletedAsset )

inlinestatic

AssetRenamed()

static void FAssetRegistryModule::AssetRenamed ( const UObject *  RenamedAsset, const FString &  OldObjectPath  )

inlinestatic

AssetsSaved()

static void FAssetRegistryModule::AssetsSaved ( TArray< FAssetData > &&  SavedAssets )

inlinestatic

EnumerateAssets()

virtual bool FAssetRegistryModule::EnumerateAssets ( const FARFilter &  Filter, TFunctionRef< bool(const FAssetData &)>  Callback, UE::AssetRegistry::EEnumerateAssetsFlags  InEnumerateFlags = UE::AssetRegistry::EEnumerateAssetsFlags::None  ) const

inlineoverridevirtual

Enumerate asset data for all assets that match the filter. Assets returned must satisfy every filter component if there is at least one element in the component's array. Assets will satisfy a component if they match any of the elements in it.

Parameters

Filter	filter to apply to the assets in the AssetRegistry
Callback	function to call for each asset data enumerated
InEnumerateFlags	flags to control enumeration and filtering.

See also

EEnumerateAssetsFlags.

Returns

False if the AssetRegistry is not available or the filter is invalid, otherwise true.

Implements IAssetRegistryInterface.

Get()

virtual IAssetRegistry & FAssetRegistryModule::Get ( ) const

inlinevirtual

GetDependencies()

virtual void FAssetRegistryModule::GetDependencies ( FName  InPackageName, TArray< FName > &  OutDependencies, UE::AssetRegistry::EDependencyCategory  Category = UE::AssetRegistry::EDependencyCategory::Package, const UE::AssetRegistry::FDependencyQuery &  Flags = UE::AssetRegistry::FDependencyQuery()  )

inlineoverridevirtual

Access the dependent package names for a given source package

Implements IAssetRegistryInterface.

GetRegistry()

static IAssetRegistry & FAssetRegistryModule::GetRegistry ( )

inlinestatic

IsValid()

bool FAssetRegistryModule::IsValid ( ) const

inline

Reports whether Get is valid to call. Will be true except during engine shutdown.

PackageDeleted()

static void FAssetRegistryModule::PackageDeleted ( UPackage *  DeletedPackage )

inlinestatic

RegisterOnAssetsAddedDelegate()

virtual bool FAssetRegistryModule::RegisterOnAssetsAddedDelegate ( const TFunction< void(TConstArrayView< FAssetData >)> &  Function, FDelegateHandle &  OutHandle  )

inlineoverridevirtual

Register delegate for when assets are added to the registry

Implements IAssetRegistryInterface.

RegisterOnAssetsRemovedDelegate()

virtual bool FAssetRegistryModule::RegisterOnAssetsRemovedDelegate ( const TFunction< void(TConstArrayView< FAssetData >)> &  Function, FDelegateHandle &  OutHandle  )

inlineoverridevirtual

Register delegate for when assets are removed from the registry

Implements IAssetRegistryInterface.

StartupModule()

void FAssetRegistryModule::StartupModule ( )

overridevirtual

Called right after the module DLL has been loaded and the module object has been created

Reimplemented from IModuleInterface.

TickAssetRegistry()

static void FAssetRegistryModule::TickAssetRegistry ( float  DeltaTime )

inlinestatic

TryGet()

IAssetRegistry * FAssetRegistryModule::TryGet ( ) const

inline

Returns AssetRegistry pointer if valid, or nullptr. Will be non-null except during engine shutdown.

TryGetAssetByObjectPath()

virtual UE::AssetRegistry::EExists FAssetRegistryModule::TryGetAssetByObjectPath ( const FSoftObjectPath &  ObjectPath, FAssetData &  OutAssetData  ) const

inlineoverridevirtual

Tries to get the asset data for the specified object path

Parameters

ObjectPath	the path of the object to be looked up
OutAssetData	out FAssetData

Returns

Return code enum

Implements IAssetRegistryInterface.

TryGetAssetPackageData() [1/2]

virtual UE::AssetRegistry::EExists FAssetRegistryModule::TryGetAssetPackageData ( FName  PackageName, FAssetPackageData &  OutPackageData  ) const

inlineoverridevirtual

Tries to get the package data for the specified package name

Parameters

PackageName	name of the package
OutAssetPackageData	out FAssetPackageData

Returns

Return code enum

Implements IAssetRegistryInterface.

TryGetAssetPackageData() [2/2]

virtual UE::AssetRegistry::EExists FAssetRegistryModule::TryGetAssetPackageData ( FName  PackageName, FAssetPackageData &  OutPackageData, FName &  OutCorrectCasePackageName  ) const

inlineoverridevirtual

Tries to get the package data for the specified package name. If found, OutCorrectCasePackageName will be populated with the PackageName that matches the casing used by the filesystem

Parameters

PackageName	name of the package
OutAssetPackageData	out FAssetPackageData
OutCorrectCasePackageName	out FName matching filesystem casing

Returns

Return code enum

Implements IAssetRegistryInterface.

UnregisterOnAssetsAddedDelegate()

virtual bool FAssetRegistryModule::UnregisterOnAssetsAddedDelegate ( const FDelegateHandle &  Handle )

inlineoverridevirtual

Removes registered delegate for when assets are added to the registry

Implements IAssetRegistryInterface.

UnregisterOnAssetsRemovedDelegate()

virtual bool FAssetRegistryModule::UnregisterOnAssetsRemovedDelegate ( const FDelegateHandle &  Handle )

inlineoverridevirtual

Removes registered delegate for when assets are removed from the registry

Implements IAssetRegistryInterface.

---

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

• Engine/Source/Runtime/AssetRegistry/Public/AssetRegistry/AssetRegistryModule.h
• Engine/Source/Runtime/AssetRegistry/Private/AssetRegistryModule.cpp