FAssetRegistryInterface Class Reference

Inheritance diagram for FAssetRegistryInterface:

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()) override
virtual UE::AssetRegistry::EExists	TryGetAssetByObjectPath (const FSoftObjectPath &ObjectPath, FAssetData &OutAssetData) const override
virtual UE::AssetRegistry::EExists	TryGetAssetPackageData (FName PackageName, class FAssetPackageData &OutPackageData) const override
virtual UE::AssetRegistry::EExists	TryGetAssetPackageData (FName PackageName, class FAssetPackageData &OutPackageData, FName &OutCorrectCasePackageName) const override
virtual bool	EnumerateAssets (const FARFilter &Filter, TFunctionRef< bool(const FAssetData &)> Callback, UE::AssetRegistry::EEnumerateAssetsFlags InEnumerateFlags) 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

Additional Inherited Members
Static Public Member Functions inherited from IAssetRegistryInterface
static COREUOBJECT_API IAssetRegistryInterface *	GetPtr ()
Static Protected Attributes inherited from IAssetRegistryInterface
static COREUOBJECT_API IAssetRegistryInterface *	Default = nullptr

Detailed Description

Implementation of IAssetRegistryInterface; forwards calls from the CoreUObject-accessible IAssetRegistryInterface into the AssetRegistry-accessible IAssetRegistry

Member Function Documentation

EnumerateAssets()

virtual bool FAssetRegistryInterface::EnumerateAssets ( const FARFilter &  Filter, TFunctionRef< bool(const FAssetData &)>  Callback, UE::AssetRegistry::EEnumerateAssetsFlags  InEnumerateFlags  ) 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.

GetDependencies()

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

inlineoverridevirtual

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

Implements IAssetRegistryInterface.

RegisterOnAssetsAddedDelegate()

virtual bool FAssetRegistryInterface::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 FAssetRegistryInterface::RegisterOnAssetsRemovedDelegate ( const TFunction< void(TConstArrayView< FAssetData >)> &  Function, FDelegateHandle &  OutHandle  )

inlineoverridevirtual

Register delegate for when assets are removed from the registry

Implements IAssetRegistryInterface.

TryGetAssetByObjectPath()

virtual UE::AssetRegistry::EExists FAssetRegistryInterface::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 FAssetRegistryInterface::TryGetAssetPackageData ( FName  PackageName, class 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 FAssetRegistryInterface::TryGetAssetPackageData ( FName  PackageName, class 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 FAssetRegistryInterface::UnregisterOnAssetsAddedDelegate ( const FDelegateHandle &  Handle )

inlineoverridevirtual

Removes registered delegate for when assets are added to the registry

Implements IAssetRegistryInterface.

UnregisterOnAssetsRemovedDelegate()

virtual bool FAssetRegistryInterface::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 file:

• Engine/Source/Runtime/AssetRegistry/Private/AssetRegistry.cpp