1. Epic GamesDeveloper
  3. FAssetRegistryState

FAssetRegistryState

The state of an asset registry, this is used internally by [IAssetRegistry](API\Runtime\AssetRegistry\IAssetRegistry) to represent the disk cache, and is also accessed directly to save/load cooked caches.

API > API/Runtime > API/Runtime/AssetRegistry

The state of an asset registry, this is used internally by IAssetRegistry to represent the disk cache, and is also accessed directly to save/load cooked caches.

   
Name FAssetRegistryState
Type class
Header File /Engine/Source/Runtime/AssetRegistry/Public/AssetRegistry/AssetRegistryState.h
Include Path #include "AssetRegistry/AssetRegistryState.h"

Syntax

class FAssetRegistryState

Constructors

Name Remarks Include Path Unreal Specifiers
  AssetRegistry/AssetRegistryState.h  
  AssetRegistry/AssetRegistryState.h  
  AssetRegistry/AssetRegistryState.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FAssetRegistryState()

   AssetRegistry/AssetRegistryState.h  

Typedefs

Name Type Remarks Include Path
EEnumerateAssetsFlags UE::AssetRegistry::EEnumerateAssetsFlags   AssetRegistry/AssetRegistryState.h
EInitializationMode UE::AssetRegistry::EAppendMode   AssetRegistry/AssetRegistryState.h
FAssetDataMap UE::AssetRegistry::Private::FAssetDataMap These types are an implementation detail and they and the functions which take/return them are subject to change without deprecation warnings. AssetRegistry/AssetRegistryState.h
FCachedAssetKey UE::AssetRegistry::Private::FCachedAssetKey   AssetRegistry/AssetRegistryState.h
FConstAssetDataMap UE::AssetRegistry::Private::FConstAssetDataMap   AssetRegistry/AssetRegistryState.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bCookedGlobalAssetRegistryState bool True if this asset registry state was loaded from a cooked asset registry AssetRegistry/AssetRegistryState.h  
CachedAssets FAssetDataMap Set of asset data for assets saved to disk. AssetRegistry/AssetRegistryState.h  
CachedAssetsByClass TMap< FTopLevelAssetPath, TArray< FAssetData * > > The map of class name to asset data for assets saved to disk AssetRegistry/AssetRegistryState.h  
CachedAssetsByPackageName TMap< FName, TArray< FAssetData *, TInlineAllocator< 1 > > > The map of package names to asset data for assets saved to disk AssetRegistry/AssetRegistryState.h  
CachedAssetsByPath TMap< FName, TArray< FAssetData * > > The map of long package path to asset data for assets saved to disk AssetRegistry/AssetRegistryState.h  
CachedAssetsByTag TMap< FName, TSet< FAssetData * > > The map of asset tag to asset data for assets saved to disk AssetRegistry/AssetRegistryState.h  
CachedDependsNodes TMap< FAssetIdentifier, FDependsNode * > A map of object names to dependency data AssetRegistry/AssetRegistryState.h  
CachedPackageData TMap< FName, FAssetPackageData * > A map of Package Names to Package Data AssetRegistry/AssetRegistryState.h  
NumAssets int32 Counters for asset/depends data memory allocation to ensure that every FAssetData and FDependsNode created is deleted. AssetRegistry/AssetRegistryState.h  
NumDependsNodes int32   AssetRegistry/AssetRegistryState.h  
NumPackageData int32   AssetRegistry/AssetRegistryState.h  
PreallocatedAssetDataBuffers TArray< FAssetData * > When loading a registry from disk, we can allocate all the FAssetData objects in one chunk, to save on 10s of thousands of heap allocations. AssetRegistry/AssetRegistryState.h  
PreallocatedDependsNodeDataBuffers TArray< FDependsNode * >   AssetRegistry/AssetRegistryState.h  
PreallocatedPackageDataBuffers TArray< FAssetPackageData * >   AssetRegistry/AssetRegistryState.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddAssetData ( FAssetData* AssetData
)

 Adds the asset data to the lookup maps AssetRegistry/AssetRegistryState.h  

void AddDependencies ( const FAssetIdentifier& AssetIdentifier,
TConstArrayView< FAssetDependency > Dependencies
)

 Add the given dependencies to the given AssetIdentifier (e.g. package). AssetRegistry/AssetRegistryState.h  

void AddReferencers ( const FAssetIdentifier& AssetIdentifier,
TConstArrayView< FAssetDependency > Referencers
)

 Add a dependency on the given AssetIdentifier (e.g. package) from each of the Referencers. AssetRegistry/AssetRegistryState.h  

void AddTagsToAssetData ( const FSoftObjectPath& InObjectPath,
FAssetDataTagMap&& InTagsAndValues
)

 Add the given tags/values to the asset data associated with the given object path, if it exists AssetRegistry/AssetRegistryState.h  

void ClearDependencies ( const FAssetIdentifier& AssetIdentifier,
UE::AssetRegistry::EDependencyCategory Category
)

 Clear all dependencies of the given category from the given AssetIdentifier (e.g. package). AssetRegistry/AssetRegistryState.h  

void ClearReferencers ( const FAssetIdentifier& AssetIdentifier,
UE::AssetRegistry::EDependencyCategory Category
)

 Clear all referencers of the given category from the given AssetIdentifier (e.g. package). AssetRegistry/AssetRegistryState.h  

bool ContainsDependency ( const FAssetIdentifier& AssetIdentifier,
const FAssetIdentifier& QueryAsset,
UE::AssetRegistry::EDependencyCategory Category,
const UE::AssetRegistry::FDependencyQuery& Flags
) const

 Return whether the supplied package references the query package. AssetRegistry/AssetRegistryState.h  

bool ContainsTag ( FName TagName
) const

 Return whether the given TagName occurs in the tags of any asset in the AssetRegistry AssetRegistry/AssetRegistryState.h  

TArray< const FAssetData * > CopyAssetsByPackageName ( const FName PackageName
) const

 Gets the array of AssetData pointers for the package; does not copy the AssetDatas, just the pointers. AssetRegistry/AssetRegistryState.h  

FAssetPackageData * CreateOrGetAssetPackageData ( FName PackageName
)

 Finds an existing package data, or creates a new one to modify AssetRegistry/AssetRegistryState.h  

bool EnumerateAllAssets ( const TSet< FName >& PackageNamesToSkip,
TFunctionRef< bool(const FAssetData&)> Callback,
EEnumerateAssetsFlags InEnumerateFlags
) const

 Enumerates asset data for all assets in the registry state, except for assets in packages that are in PackageNamesToSkip. AssetRegistry/AssetRegistryState.h  

void EnumerateAllAssets ( TFunctionRef< void(const FAssetData&)> Callback,
EEnumerateAssetsFlags InEnumerateFlags
) const

 Enumerates asset data for all assets in the registry state. AssetRegistry/AssetRegistryState.h  

void EnumerateAllPaths ( TFunctionRef< void(FName PathName)> Callback
) const

 Calls the callback with the LongPackageName of each path that has assets as direct children. AssetRegistry/AssetRegistryState.h  

bool EnumerateAssets ( const FARCompiledFilter& Filter,
const TSet< FName >& PackageNamesToSkip,
TFunctionRef< bool(const FAssetData&)> Callback,
EEnumerateAssetsFlags InEnumerateFlags
) const

 Enumerate asset data for all assets that match the filter. AssetRegistry/AssetRegistryState.h  

void EnumerateAssetsByClassPathName ( const FTopLevelAssetPath ClassPathName,
TFunctionRef< bool(const FAssetData*AssetData)> Callback
) const

 Enumerates the asset datas for the specified asset class AssetRegistry/AssetRegistryState.h  

void EnumerateAssetsByPackageName ( const FName PackageName,
TFunctionRef< bool(const FAssetData*AssetData)> Callback
) const

 Enumerates the asset datas for the specified package name AssetRegistry/AssetRegistryState.h  

void EnumerateAssetsByPackagePath ( FName LongPackagePathName,
TFunctionRef< bool(const FAssetData*AssetData)> Callback
) const

   AssetRegistry/AssetRegistryState.h  

void EnumerateAssetsByTagName ( const FName TagName,
TFunctionRef< bool(const FAssetData*AssetData)> Callback
) const

 Enumerates the asset datas with the specified asset tag AssetRegistry/AssetRegistryState.h  

void EnumerateTags ( TFunctionRef< bool(FName TagName)> Callback
) const

 Enumerates all tags of any asset in the AssetRegistry AssetRegistry/AssetRegistryState.h  

void EnumerateTagToAssetDatas ( TFunctionRef< bool(FName TagName, IAssetRegistry::FEnumerateAssetDatasFuncEnumerateAssets)> Callback
) const

 Enumerates all tags of any asset in the AssetRegistry including function that can be called to enumerate assets for each tag AssetRegistry/AssetRegistryState.h  
Edit every AssetData's Tags to remove Tags that are filtered out by the filtering rules in Options AssetRegistry/AssetRegistryState.h  

bool GetAllAssets ( const TSet< FName >& PackageNamesToSkip,
TArray< FAssetData >& OutAssetData,
bool bARFiltering
) const

 Gets asset data for all assets in the registry state. AssetRegistry/AssetRegistryState.h  

SIZE_T GetAllocatedSize ( bool bLogDetailed
) const

 Returns memory size of entire registry, optionally logging sizes AssetRegistry/AssetRegistryState.h  

const FAssetData * GetAssetByObjectPath ( const FSoftObjectPath& ObjectPath
) const

 Gets the asset data for the specified object path AssetRegistry/AssetRegistryState.h  

const FAssetData * GetAssetByObjectPath ( const UE::AssetRegistry::Private::FCachedAssetKey& Key
) const

   AssetRegistry/AssetRegistryState.h  

FAssetPackageData * GetAssetPackageData ( FName PackageName
)

   AssetRegistry/AssetRegistryState.h  

const FAssetPackageData * GetAssetPackageData ( FName PackageName
) const

 Returns pointer to the asset package data AssetRegistry/AssetRegistryState.h  

const FAssetPackageData * GetAssetPackageData ( FName PackageName,
FName& OutCorrectCasePackageName
) const

   AssetRegistry/AssetRegistryState.h  

const TMap< FName, const FAssetPackageData * > & GetAssetPackageDataMap()

 Returns const version of internal PackageName->PackageData map for fast iteration AssetRegistry/AssetRegistryState.h  

bool GetAssets ( const FARCompiledFilter& Filter,
const TSet< FName >& PackageNamesToSkip,
TArray< FAssetData >& OutAssetData,
bool bSkipARFilteredAssets
) const

 Gets asset data for all assets that match the filter. AssetRegistry/AssetRegistryState.h  

bool GetDependencies ( const FAssetIdentifier& AssetIdentifier,
TArray< FAssetDependency >& OutDependencies,
UE::AssetRegistry::EDependencyCategory Category,
const UE::AssetRegistry::FDependencyQuery& Flags
) const

   AssetRegistry/AssetRegistryState.h  

bool GetDependencies ( const FAssetIdentifier& AssetIdentifier,
TArray< FAssetIdentifier >& OutDependencies,
UE::AssetRegistry::EDependencyCategory Category,
const UE::AssetRegistry::FDependencyQuery& Flags
) const

 Appends a list of packages and searchable names that are referenced by the supplied package or name. AssetRegistry/AssetRegistryState.h  

FName GetFirstPackageByName ( FStringView PackageName
) const

 Returns the first LongPackageName found for the given PackageName. AssetRegistry/AssetRegistryState.h  

int32 GetNumAssets()

 Returns the number of assets in this state AssetRegistry/AssetRegistryState.h  

int32 GetNumPackages()

 Returns the number of packages in this state AssetRegistry/AssetRegistryState.h  

void GetPackageNames ( TArray< FName >& OutPackageNames
) const

 Returns all package names AssetRegistry/AssetRegistryState.h  

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

 Gets the LongPackageNames for all packages with the given PackageName. AssetRegistry/AssetRegistryState.h  

void GetPrimaryAssetsIds ( TSet< FPrimaryAssetId >& OutPrimaryAssets
) const

 Get the set of primary assets contained in this state AssetRegistry/AssetRegistryState.h  

bool GetReferencers ( const FAssetIdentifier& AssetIdentifier,
TArray< FAssetIdentifier >& OutReferencers,
UE::AssetRegistry::EDependencyCategory Category,
const UE::AssetRegistry::FDependencyQuery& Flags
) const

 Appends a list of packages and searchable names that reference the supplied package or name. AssetRegistry/AssetRegistryState.h  

bool GetReferencers ( const FAssetIdentifier& AssetIdentifier,
TArray< FAssetDependency >& OutReferencers,
UE::AssetRegistry::EDependencyCategory Category,
const UE::AssetRegistry::FDependencyQuery& Flags
) const

   AssetRegistry/AssetRegistryState.h  

bool HasAssets ( const FName PackagePath,
bool bARFiltering
) const

 Does the given path contain assets? This function doesn't recurse into sub-paths. AssetRegistry/AssetRegistryState.h  

void InitializeFromExisting ( const FAssetRegistryState& Existing,
const FAssetRegistrySerializationOptions& Options,
EInitializationMode InitializationMode,
FAssetRegistryAppendResult* OutAppendResult
)

   AssetRegistry/AssetRegistryState.h  

void InitializeFromExistingAndPrune ( const FAssetRegistryState& ExistingState,
const TSet< FName >& RequiredPackages,
const TSet< FName >& RemovePackages,
const TSet< int32 > ChunksToKeep,
const FAssetRegistrySerializationOptions& Options
)

 Initializes a cache from an existing using a set of filters. AssetRegistry/AssetRegistryState.h  

bool Load ( FArchive& Ar,
const FAssetRegistryLoadOptions& Options,
FAssetRegistryVersion::Type* OutVersion
)

   AssetRegistry/AssetRegistryState.h  

int32 NumAssetsByPackageName ( const FName PackageName
) const

   AssetRegistry/AssetRegistryState.h  

void Prune ( const FAssetRegistryPruneOptions& PruneOptions
)

   AssetRegistry/AssetRegistryState.h  

void PruneAssetData ( const TSet< FName >& RequiredPackages,
const TSet< FName >& RemovePackages,
const FAssetRegistrySerializationOptions& Options
)

   AssetRegistry/AssetRegistryState.h  

void PruneAssetData ( const TSet< FName >& RequiredPackages,
const TSet< FName >& RemovePackages,
const TSet< int32 > ChunksToKeep,
const FAssetRegistrySerializationOptions& Options
)

 Prunes an asset cache, this removes asset data, nodes, and package data that isn't needed. AssetRegistry/AssetRegistryState.h  

void RemoveAssetData ( FAssetData* AssetData,
bool bRemoveDependencyData,
bool& bOutRemovedAssetData,
bool& bOutRemovedPackageData
)

 Removes the asset data from the lookup maps AssetRegistry/AssetRegistryState.h  

void RemoveAssetData ( const FSoftObjectPath& SoftObjectPath,
bool bRemoveDependencyData,
bool& bOutRemovedAssetData,
bool& bOutRemovedPackageData
)

   AssetRegistry/AssetRegistryState.h  

void RemoveAssetDatas ( TArrayView< FAssetData* > AssetDatas,
bool bRemoveDependencyData,
TBitArray<>& bOutRemovedAssetData,
TBitArray<>& bOutRemovedPackageData
)

 Removes a set of asset data from the lookup maps. AssetRegistry/AssetRegistryState.h  

bool RemovePackageData ( FName PackageName
)

 Removes existing package data AssetRegistry/AssetRegistryState.h  

void Reset()

 Resets to default state AssetRegistry/AssetRegistryState.h  

bool Save ( FArchive& Ar,
const FAssetRegistrySerializationOptions& Options
)

 Save without editor-only data AssetRegistry/AssetRegistryState.h  

bool Serialize ( FArchive& Ar,
const FAssetRegistrySerializationOptions& Options
)

 Serialize the registry to/from a file, skipping editor only data AssetRegistry/AssetRegistryState.h  

void SetDependencies ( const FAssetIdentifier& AssetIdentifier,
TConstArrayView< FAssetDependency > Dependencies,
UE::AssetRegistry::EDependencyCategory Category
)

 Clears existing dependencies of the given Category(s) and assigns the input Dependencies. AssetRegistry/AssetRegistryState.h  

void SetReferencers ( const FAssetIdentifier& AssetIdentifier,
TConstArrayView< FAssetDependency > Referencers,
UE::AssetRegistry::EDependencyCategory Category
)

 Clears existing referencers of the given Category(s) and assigns the input Referencers. AssetRegistry/AssetRegistryState.h  

void UpdateAssetData ( const FAssetData& NewAssetData,
bool bCreateIfNotExists
)

 Finds an existing asset data based on object path and updates it with the new value and updates lookup maps AssetRegistry/AssetRegistryState.h  

void UpdateAssetData ( FAssetData&& NewAssetData,
bool bCreateIfNotExists
)

   AssetRegistry/AssetRegistryState.h  

void UpdateAssetData ( FAssetData* AssetData,
const FAssetData& NewAssetData,
bool* bOutModified
)

 Updates an existing asset data with the new value and updates lookup maps AssetRegistry/AssetRegistryState.h  

void UpdateAssetData ( FAssetData* AssetData,
FAssetData&& NewAssetData,
bool* bOutModified
)

   AssetRegistry/AssetRegistryState.h  

bool UpdateAssetDataPackageFlags ( FName PackageName,
uint32 PackageFlags
)

 Updates all asset data package flags in the specified package AssetRegistry/AssetRegistryState.h  

Static

Name Remarks Include Path Unreal Specifiers

static TSharedPtr< FAssetBundleData > FilterBundles ( const TSharedPtr< FAssetBundleData >& InAssetBundles,
const FAssetRegistrySerializationOptions& Options
)

 Filter asset bundles and output a copy of the filtered set or input AssetBundles if nothing was filtered AssetRegistry/AssetRegistryState.h  

static void FilterTags ( const FAssetDataTagMapSharedView& InTagsAndValues,
FAssetDataTagMap& OutTagsAndValues,
const TSet< FName >* ClassSpecificFilterList,
const FAssetRegistrySerializationOptions& Options
)

 Filter a set of tags and output a copy of the filtered set. AssetRegistry/AssetRegistryState.h  

static bool IsFilterValid ( const FARCompiledFilter& Filter
)

 Checks a filter to make sure there are no illegal entries AssetRegistry/AssetRegistryState.h  

static bool LoadFromDisk ( const TCHAR* InPath,
const FAssetRegistryLoadOptions& InOptions,
FAssetRegistryState& OutState,
FAssetRegistryVersion::Type* OutVersion
)

 Example Usage: FAssetRegistryState AR; bool bSucceeded = FAssetRegistryState::LoadFromDisk(TEXT("Path/To/AR"), FAssetRegistryLoadOptions(), AR); AssetRegistry/AssetRegistryState.h  

Operators

Name Remarks Include Path Unreal Specifiers
  AssetRegistry/AssetRegistryState.h  
  AssetRegistry/AssetRegistryState.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page