IAssetRegistryInterface Class Reference

#include <AssetRegistryInterface.h>

Inheritance diagram for IAssetRegistryInterface:

Public Member Functions
virtual void	GetDependencies (FName InPackageName, TArray< FName > &OutDependencies, UE::AssetRegistry::EDependencyCategory Category=UE::AssetRegistry::EDependencyCategory::Package, const UE::AssetRegistry::FDependencyQuery &Flags=UE::AssetRegistry::FDependencyQuery())=0
virtual UE::AssetRegistry::EExists	TryGetAssetByObjectPath (const FSoftObjectPath &ObjectPath, struct FAssetData &OutAssetData) const =0
virtual UE::AssetRegistry::EExists	TryGetAssetPackageData (FName PackageName, class FAssetPackageData &OutPackageData) const =0
virtual UE::AssetRegistry::EExists	TryGetAssetPackageData (FName PackageName, class FAssetPackageData &OutPackageData, FName &OutCorrectCasePackageName) const =0
virtual bool	EnumerateAssets (const FARFilter &Filter, TFunctionRef< bool(const FAssetData &)> Callback, UE::AssetRegistry::EEnumerateAssetsFlags InEnumerateFlags=UE::AssetRegistry::EEnumerateAssetsFlags::None) const =0
virtual bool	RegisterOnAssetsAddedDelegate (const TFunction< void(TConstArrayView< FAssetData >)> &Function, FDelegateHandle &OutHandle)=0
virtual bool	UnregisterOnAssetsAddedDelegate (const FDelegateHandle &Handle)=0
virtual bool	RegisterOnAssetsRemovedDelegate (const TFunction< void(TConstArrayView< FAssetData >)> &Function, FDelegateHandle &OutHandle)=0
virtual bool	UnregisterOnAssetsRemovedDelegate (const FDelegateHandle &Handle)=0

Static Public Member Functions
static COREUOBJECT_API IAssetRegistryInterface *	GetPtr ()

Static Protected Attributes
static COREUOBJECT_API IAssetRegistryInterface *	Default = nullptr

Friends
class	UAssetRegistryImpl

Detailed Description

Asset Registry module interface

Member Function Documentation

EnumerateAssets()

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

pure virtual

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.

Implemented in FAssetRegistryInterface, and FAssetRegistryModule.

GetDependencies()

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

pure virtual

Lookup dependencies for the given package name and fill OutDependencies with direct dependencies

Implemented in FAssetRegistryInterface, and FAssetRegistryModule.

GetPtr()

IAssetRegistryInterface * IAssetRegistryInterface::GetPtr ( )

static

Tries to get a pointer to the active AssetRegistryInterface implementation.

RegisterOnAssetsAddedDelegate()

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

pure virtual

Register delegate for when assets are added to the registry

Implemented in FAssetRegistryInterface, and FAssetRegistryModule.

RegisterOnAssetsRemovedDelegate()

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

pure virtual

Register delegate for when assets are removed from the registry

Implemented in FAssetRegistryInterface, and FAssetRegistryModule.

TryGetAssetByObjectPath()

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

pure virtual

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

Implemented in FAssetRegistryInterface, and FAssetRegistryModule.

TryGetAssetPackageData() [1/2]

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

pure virtual

Tries to get the package data for the specified package name

Parameters

PackageName	name of the package
OutAssetPackageData	out FAssetPackageData

Returns

Return code enum

Implemented in FAssetRegistryInterface, and FAssetRegistryModule.

TryGetAssetPackageData() [2/2]

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

pure virtual

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

Implemented in FAssetRegistryInterface, and FAssetRegistryModule.

UnregisterOnAssetsAddedDelegate()

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

pure virtual

Removes registered delegate for when assets are added to the registry

Implemented in FAssetRegistryInterface, and FAssetRegistryModule.

UnregisterOnAssetsRemovedDelegate()

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

pure virtual

Removes registered delegate for when assets are removed from the registry

Implemented in FAssetRegistryInterface, and FAssetRegistryModule.

Friends And Related Symbol Documentation

UAssetRegistryImpl

friend class UAssetRegistryImpl

friend

Member Data Documentation

Default

IAssetRegistryInterface * IAssetRegistryInterface::Default = nullptr

staticprotected

---

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

• Engine/Source/Runtime/CoreUObject/Public/Misc/AssetRegistryInterface.h
• Engine/Source/Runtime/CoreUObject/Private/Misc/AssetRegistryInterface.cpp