1. Epic GamesDeveloper
  3. IAssetRegistry

IAssetRegistry

Unreal Engine C++ API Reference > Runtime > AssetRegistry > AssetRegistry

References

   
Module AssetRegistry
Header /Engine/Source/Runtime/AssetRegistry/Public/AssetRegistry/IAssetRegistry.h
Include #include "AssetRegistry/IAssetRegistry.h"

Syntax

class IAssetRegistry

Functions

  Type Name Description
Public function bool

AddPath ( const FString& PathToAdd
)

 Adds the specified path to the set of cached paths.
Public function void

AppendState ( const FAssetRegistryState& InState
)

 Append the assets from the incoming state into our own
Public function void

AssetCreated ( UObject* NewAsset
)

 Informs the asset registry that an in-memory asset has been created
Public function void

AssetDeleted ( UObject* DeletedAsset
)

 Informs the asset registry that an in-memory asset has been deleted
Public function void Called on demand from systems that need to fully update an AssetData's tags.
Public function void

AssetRenamed ( const UObject* RenamedAsset,
const FString& OldObjectPath
)

 Informs the asset registry that an in-memory asset has been renamed
Public function void

AssetsSaved ( TArray< FAssetData >&& Assets
)

 Called during SavePackage to update the AssetRegistry's copy of the AssetDatas in the package to match the newly saved values.
Public function void

AssetTagsFinalized ( const UObject& FinalizedAsset
)

 Informs the asset registry that an Asset has finalized its tags after loading.
Public function void Empty the global gatherer's cache and disable further caching of scans from disk.
Public function Const void

CompileFilter ( const FARFilter& InFilter,
FARCompiledFilter& OutCompiledFilter
)

 Modifies passed in filter optimize it for query and expand any recursive paths and classes
Public function Const bool

ContainsTag ( FName TagName
)

 Return whether the given TagName occurs in the tags of any asset in the AssetRegistry
Public function  

DECLARE_TS_MULTICAST_DELEGATE ( FFilesLoadedEvent
)

 Event for when the asset registry is done loading files
Public function  

DECLARE_TS_MULTICAST_DELEGATE_OneParam ( FPathAddedEvent,
const FString&
)

 Event for when paths are added to the registry
Public function  

DECLARE_TS_MULTICAST_DELEGATE_OneParam ( FAssetsEvent,
TConstArrayView< FAssetData >
)

  
Public function  

DECLARE_TS_MULTICAST_DELEGATE_OneParam ( FAssetAddedEvent,
const FAssetData&
)

 Event for when assets are added to the registry
Public function  

DECLARE_TS_MULTICAST_DELEGATE_OneParam ( FAssetRemovedEvent,
const FAssetData&
)

 Event for when assets are removed from the registry
Public function  

DECLARE_TS_MULTICAST_DELEGATE_OneParam ( FFileLoadProgressUpdatedEvent,
const FFileLoadProgressUpdateData&
)

 Event to update the progress of the background file load
Public function  

DECLARE_TS_MULTICAST_DELEGATE_OneParam ( FVerseRemovedEvent,
const FName
)

 Event for when Verse files are removed from the registry
Public function  

DECLARE_TS_MULTICAST_DELEGATE_OneParam ( FVerseAddedEvent,
const FName
)

 Event for when Verse files are added to the registry
Public function  

DECLARE_TS_MULTICAST_DELEGATE_OneParam ( FInMemoryAssetDeletedEvent,
UObject*
)

 Event for when assets are deleted
Public function  

DECLARE_TS_MULTICAST_DELEGATE_OneParam ( FInMemoryAssetCreatedEvent,
UObject*
)

 Event for when in-memory assets are created
Public function  

DECLARE_TS_MULTICAST_DELEGATE_OneParam ( FAssetUpdatedEvent,
const FAssetData&
)

 Event for when assets are updated in the registry
Public function  

DECLARE_TS_MULTICAST_DELEGATE_TwoParams ( FAssetRenamedEvent,
const FAssetData&,
const FString&
)

 Event for when assets are renamed in the registry
Public function Const bool

DoesPackageExistOnDisk ( FName PackageName,
FString* OutCorrectCasePackageName,
FString* OutExtension
)

  
Public function Const void

DumpState ( const TArray< FString >& Arguments,
TArray< FString >& OutPages,
int32 LinesPerPage
)

 Writes out the state in textual form. Use arguments to control which segments to emit.
Public function Const bool

EnumerateAllAssets ( TFunctionRef< bool(const FAssetData&)> Callback,
bool bIncludeOnlyOnDiskAssets
)

 Enumerate asset data for all assets in the registry.
Public function Const void Enumerate all the paths that are currently cached
Public function Const void Enumerate all the paths that are currently cached
Public function Const void

EnumerateAllPackages ( TFunctionRef< void(FName PackageName, const FAssetPackageData&PackageData)> Callback
)

 Enumerate all PackageDatas in the AssetRegistry.
Public function Const bool

EnumerateAssets ( const FARCompiledFilter& Filter,
TFunctionRef< bool(const FAssetData&)> Callback,
bool bSkipARFilteredAssets
)

  
Public function Const bool

EnumerateAssets ( const FARFilter& Filter,
TFunctionRef< bool(const FAssetData&)> Callback,
bool bSkipARFilteredAssets
)

 Enumerate asset data for all assets that match the filter.
Public function Const void

EnumerateSubPaths ( const FName InBasePath,
TFunctionRef< bool(FName)> Callback,
bool bInRecurse
)

 Enumerate the all paths that are currently cached below the passed-in base path
Public function Const void

EnumerateSubPaths ( const FString& InBasePath,
TFunctionRef< bool(FString)> Callback,
bool bInRecurse
)

 Enumerate the all paths that are currently cached below the passed-in base path
Public function Static IAssetRegistry *

Get ()

  
Public function Const bool

GetAllAssets ( TArray< FAssetData >& OutAssetData,
bool bIncludeOnlyOnDiskAssets
)

 Gets asset data for all assets in the registry.
Public function Const void

GetAllCachedPaths ( TArray< FString >& OutPathList
)

 Gets a list of all paths that are currently cached
Public function Const SIZE_T

GetAllocatedSize ( bool bLogDetailed
)

 Returns memory size of entire registry, optionally logging sizes
Public function Const bool

GetAncestorClassNames ( FTopLevelAssetPath ClassPathName,
TArray< FTopLevelAssetPath >& OutAncestorClassNames
)

 Returns true if the specified ClassName's ancestors could be found.
Public function Const EAssetAvailability::Type

GetAssetAvailability ( const FAssetData& AssetData
)

 Gets the current availability of an asset, primarily for streaming install purposes.
Public function Const float Gets an ETA or percentage complete for an asset that is still in the process of being installed.
Public function Const bool  
Public function Const FAssetData

GetAssetByObjectPath ( const FSoftObjectPath& ObjectPath,
bool bIncludeOnlyOnDiskAssets,
bool bSkipARFilteredAssets
)

 Gets the asset data for the specified object path
Public function Const TOptional< FAssetPackageData >

GetAssetPackageDataCopy ( FName PackageName
)

 Finds Package data for a package name.
Public function Const bool

GetAssets ( const FARFilter& Filter,
TArray< FAssetData >& OutAssetData,
bool bSkipARFilteredAssets
)

 Gets asset data for all assets that match the filter.
Public function Const bool

GetAssetsByClass ( FTopLevelAssetPath ClassPathName,
TArray< FAssetData >& OutAssetData,
bool bSearchSubClasses
)

 Gets asset data for all assets with the supplied class
Public function Const bool

GetAssetsByPackageName ( FName PackageName,
TArray< FAssetData >& OutAssetData,
bool bIncludeOnlyOnDiskAssets,
bool bSkipARFilteredAssets
)

 Gets asset data for the assets in the package with the specified package name
Public function Const bool

GetAssetsByPath ( FName PackagePath,
TArray< FAssetData >& OutAssetData,
bool bRecursive,
bool bIncludeOnlyOnDiskAssets
)

 Gets asset data for all assets in the supplied folder path
Public function Const bool

GetAssetsByPaths ( TArray< FName > PackagePaths,
TArray< FAssetData >& OutAssetData,
bool bRecursive,
bool bIncludeOnlyOnDiskAssets
)

 Gets asset data for all assets in any of the supplied folder paths
Public function Const bool

GetAssetsByTags ( const TArray< FName >& AssetTags,
TArray< FAssetData >& OutAssetData
)

 Gets asset data for all assets with the supplied tags, regardless of their value
Public function Const bool

GetAssetsByTagValues ( const TMultiMap< FName, FString >& AssetTagsAndValues,
TArray< FAssetData >& OutAssetData
)

 Gets asset data for all assets with the supplied tags and values
Public function Const TSet< FName > Returns the set of empty package names fast iteration
Public function Static IAssetRegistry &  
Public function Const bool Gets a list of AssetIdentifiers or FAssetDependencies that are referenced by the supplied AssetIdentifier.
Public function Const bool  
Public function Const bool Gets a list of PackageNames that are referenced by the supplied package. (On disk references ONLY)
Public function Const void

GetDerivedClassNames ( const TArray< FTopLevelAssetPath >& ClassNames,
const TSet< FTopLevelAssetPath >& ExcludedClassNames,
TSet< FTopLevelAssetPath >& OutDerivedClassNames
)

 Returns the names of all classes derived by the supplied class names, excluding any classes matching the excluded class names.
Public function Const FName

GetFirstPackageByName ( FStringView PackageName
)

 Returns the first LongPackageName found for the given PackageName.
Public function Const void

GetPackagesByName ( FStringView PackageName,
TArray< FName >& OutPackageNames
)

 Gets the LongPackageName for all packages with the given PackageName.
Public function Const FSoftObjectPath Uses the asset registry to look for ObjectRedirectors.
Public function Const bool Gets a list of PackageNames that reference the supplied package. (On disk references ONLY)
Public function Const bool Gets a list of AssetIdentifiers or FAssetDependencies that reference the supplied AssetIdentifier.
Public function Const bool  
Public function Const void

GetSubPaths ( const FName& InBasePath,
TArray< FName >& OutPathList,
bool bInRecurse
)

 Gets a list of all paths by name that are currently cached below the passed-in base path
Public function Const void

GetSubPaths ( const FString& InBasePath,
TArray< FString >& OutPathList,
bool bInRecurse
)

 Gets a list of all paths that are currently cached below the passed-in base path
Public function Const bool Returns true if temporary caching mode enabled
Public function Const bool

GetVerseFilesByPath ( FName PackagePath,
TArray< FName >& OutFilePaths,
bool bRecursive
)

 Gets paths for all Verse files in the supplied folder
Public function Const bool

HasAssets ( const FName PackagePath,
const bool bRecursive
)

 Does the given path contain assets, optionally also testing sub-paths?
Public function Const bool

HasVerseFiles ( FName PackagePath,
bool bRecursive
)

 Returns whether the supplied folder contains any verse file
Public function Const void Fills in FAssetRegistrySerializationOptions from ini, optionally using a target platform ini name
Public function Const void

InitializeTemporaryAssetRegistryState ( FAssetRegistryState& OutState,
const FAssetRegistrySerializationOptions& Options,
bool bRefreshExisting,
const TSet< FName >& RequiredPackages,
const TSet< FName >& RemovePackages
)

 Fills in a AssetRegistryState with a copy of the data in the internal cache, overriding some
Public function Const bool

IsAssetExcludedByFilter ( const FAssetData& AssetData,
const FARCompiledFilter& Filter
)

 Tests to see whether the given asset would be excluded (fails) the given filter
Public function Const bool

IsAssetIncludedByFilter ( const FAssetData& AssetData,
const FARCompiledFilter& Filter
)

 Tests to see whether the given asset would be included (passes) the given filter
Public function Const bool Returns true if the asset registry is currently loading files and does not yet know about all assets
Public function Const bool

IsPathBeautificationNeeded ( const FString& InAssetPath
)

 Indicates if path should be beautified before presented to the user.
Public function Const bool Whether SearchAllAssets has been called, or was auto-called at startup.
Public function Const bool Whether searching is done async (and was started at startup), or synchronously and on-demand, requiring ScanPathsSynchronous or SearchAllAssets.
Public function Virtual Const FAssetData

K2_GetAssetByObjectPath ( const FSoftObjectPath& ObjectPath,
bool bIncludeOnlyOnDiskAssets,
bool bSkipARFilteredAssets
)

 Gets the asset data for the specified object path
Public function Virtual Const bool

K2_GetDependencies ( FName PackageName,
const FAssetRegistryDependencyOptions& DependencyOptions,
TArray< FName >& OutDependencies
)

 Gets a list of paths to objects that are referenced by the supplied package.
Public function Virtual Const bool

K2_GetReferencers ( FName PackageName,
const FAssetRegistryDependencyOptions& ReferenceOptions,
TArray< FName >& OutReferencers
)

 Gets a list of packages that reference the supplied package. (On disk references ONLY)
Public function Const void

LoadPackageRegistryData ( const FString& PackageFilename,
FLoadPackageRegistryData& InOutData
)

 Load FAssetData from the specified package filename
Public function Const void Load FPackageRegistry data from the supplied package
Public function FAssetAddedEvent &  
Public function FAssetRemovedEvent &  
Public function FAssetRenamedEvent &  
Public function FAssetsEvent & Event for when assets are added to the registry to handle batches more efficiently
Public function FAssetsEvent & Event for when assets are removed from the registry
Public function FAssetsEvent & Event for when assets are updated in the registry
Public function FAssetsEvent & Event for when assets are updated on disk and have been refreshed in the assetregistry
Public function FAssetUpdatedEvent &  
Public function FAssetUpdatedEvent & Event for when assets are updated on disk and have been refreshed in the assetregistry
Public function FFileLoadProgressUpdatedEvent &  
Public function FFilesBlockedEvent &  
Public function FFilesLoadedEvent &  
Public function FInMemoryAssetCreatedEvent &  
Public function FInMemoryAssetDeletedEvent &  
Public function FPathAddedEvent &  
Public function FPathRemovedEvent &  
Public function FVerseAddedEvent &  
Public function FVerseRemovedEvent &  
Public function void

PackageDeleted ( UPackage* DeletedPackage
)

 Informs the asset registry that an in-memory package has been deleted, and all associated assets should be removed
Public function Const bool

PathExists ( const FName PathToTest
)

  
Public function Const bool

PathExists ( const FString& PathToTest
)

 Queries whether the given path exists in the set of cached paths
Public function Const void

PrioritizeAssetInstall ( const FAssetData& AssetData
)

 Hint the streaming installers to prioritize a specific asset for install.
Public function void

PrioritizeSearchPath ( const FString& PathToPrioritize
)

 If assets are currently being asynchronously scanned in the specified path, this will cause them to be scanned before other assets.
Public function Const void

ReadLockEnumerateTagToAssetDatas ( TFunctionRef< void(FName TagName, const TArray< const FAssetData* >&Assets)> Callback
)

 Enumerate all pairs in State->TagToAssetDataMapAssetRegistry and call a callback on each pair.
Public function bool

RemovePath ( const FString& PathToRemove
)

 Attempts to remove the specified path to the set of cached paths.
Public function Const void

RunAssetsThroughFilter ( TArray< FAssetData >& AssetDataList,
const FARFilter& Filter
)

 Trims items out of the asset data list that do not pass the supplied filter
Public function void

ScanFilesSynchronous ( const TArray< FString >& InFilePaths,
bool bForceRescan
)

 Scan the specified individual files right now and populate the asset registry.
Public function void

ScanModifiedAssetFiles ( const TArray< FString >& InFilePaths
)

 Forces a rescan of specific filenames, call this when you need to refresh from disk
Public function void

ScanPathsSynchronous ( const TArray< FString >& InPaths,
bool bForceRescan,
bool bIgnoreDenyListScanFilters
)

 Scan the supplied paths recursively right now and populate the asset registry.
Public function void

ScanSynchronous ( const TArray< FString >& InPaths,
const TArray< FString >& InFilePaths,
UE::AssetRegistry::EScanFlags InScanFlags
)

 Scan the supplied paths and files recursively right now and populate the asset registry.
Public function void

SearchAllAssets ( bool bSynchronousSearch
)

 Look for all assets on disk (can be async or synchronous)
Public function void Serialize the registry to/from a file, skipping editor only data
Public function void  
Protected function void

SetManageReferences ( const TMultiMap< FAssetIdentifier, FAssetIdentifier >& ManagerMap,
bool bClearExisting,
UE::AssetRegistry::EDependencyCategory RecurseType,
TSet< FDependsNode* >& ExistingManagedNodes,
ShouldSetManagerPredicate ShouldSetManager
)

 Specifies a list of manager mappings, optionally recursing to dependencies.
Protected function bool

SetPrimaryAssetIdForObjectPath ( const FSoftObjectPath& ObjectPath,
FPrimaryAssetId PrimaryAssetId
)

  
Public function void

SetTemporaryCachingMode ( bool bEnable
)

 Enables or disable temporary search caching, when this is enabled scanning/searching is faster because we assume no objects are loaded between scans.
Public function void Mark that the temporary cached needs to be updated before being used again, because e.g. a new class was loaded.
Public function void

Tick ( float DeltaTime
)

 Tick the asset registry
Public function Const UE::AssetRegistry::EExists

TryGetAssetByObjectPath ( const FSoftObjectPath& ObjectPath,
FAssetData& OutAssetData
)

 Tries to get the asset data for the specified object path
Public function Const UE::AssetRegistry::EExists

TryGetAssetPackageData ( FName PackageName,
FAssetPackageData& OutAssetPackageData
)

 Tries to get the pacakge data for a specified path
Public function Const void

UseFilterToExcludeAssets ( TArray< FAssetData >& AssetDataList,
const FARCompiledFilter& CompiledFilter
)

 Trims items out of the asset data list that pass the supplied filter
Public function Const void

UseFilterToExcludeAssets ( TArray< FAssetData >& AssetDataList,
const FARFilter& Filter
)

 Trims items out of the asset data list that pass the supplied filter
Public function void Wait for scan to be complete.
Public function void

WaitForPackage ( const FString& PackageName
)

 Wait for the scan of a specific package to be complete

Classes

  Type Name Description
Public struct FFileLoadProgressUpdateData Payload data for a file progress update  
Public class FFilesBlockedEvent Event for when one or more files have been blocked from the registry  
Public struct FLoadPackageRegistryData    
Public class FPathRemovedEvent Event for when paths are removed from the registry  

Typedefs

Name Description
ShouldSetManagerPredicate Predicate called to decide whether to recurse into a reference when setting manager references

Deprecated Functions

  Type Name Description
Public function void

AssetSaved ( const UObject& SavedAsset
)

 Use the new AssetsSaved function that takes FAssetData.
Public function Const bool

GetAncestorClassNames ( FName ClassName,
TArray< FName >& OutAncestorClassNames
)

 Class names are now represented by path names. Please use a version of this function that uses FTopLevelAssetPath.
Public function Const FAssetData

GetAssetByObjectPath ( const FName ObjectPath,
bool bIncludeOnlyOnDiskAssets
)

 Asset path FNames have been deprecated, use Soft Object Path instead.
Public function Const const FAssetRegistryState * Receiving a pointer is not threadsafe. Use other functions on IAssetRegistry to access the same data, or contact Epic Core team to add the threadsafe functions you require..
Public function Const bool

GetAssetsByClass ( FName ClassPathName,
TArray< FAssetData >& OutAssetData,
bool bSearchSubClasses
)

 Class names are now represented by path names. Please use a version of this function that uses FTopLevelAssetPath.
Public function Const const TSet< FName > & Receiving a reference is not threadsafe. Use GetCachedEmptyPackagesCopy instead.
Public function Const void

GetDerivedClassNames ( const TArray< FName >& ClassNames,
const TSet< FName >& ExcludedClassNames,
TSet< FName >& OutDerivedClassNames
)

 Class names are now represented by path names. Please use a version of this function that uses FTopLevelAssetPath.
Public function Const FName

GetRedirectedObjectPath ( const FName ObjectPath
)

 Asset path FNames have been deprecated, use FSoftObjectPath instead.
Protected function bool

SetPrimaryAssetIdForObjectPath ( const FName ObjectPath,
FPrimaryAssetId PrimaryAssetId
)

 Asset path FNames have been deprecated, use FSoftObjectPath instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page