Navigation
| Name | AssetRegistry |
| Type | Runtime |
| Location | /Engine/Source/Runtime/AssetRegistry/ |
| Module Build Rules | AssetRegistry.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FAssetRegistryModule | Asset registry module |
| FAssetRegistryState | 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. |
| FPathTree | |
| FRegisteredAssetDependencyGatherer | |
| TFunctionRef | |
| UAssetRegistry | |
| UAssetRegistryHelpers |
Structs
| Name | Remarks |
|---|---|
| FAssetDependency | An output struct to hold both an AssetIdentifier and the properties of the dependency on that AssetIdentifier |
| FAssetRegistryAppendResult | |
| FAssetRegistryDependencyOptions | |
| FAssetRegistryLoadOptions | |
| FAssetRegistryPruneOptions | |
| FAssetRegistrySerializationOptions | Load/Save options used to modify how the cache is serialized. |
| FCachedAssetKey | Key type for TSet |
| FCachedAssetKeyFuncs | Policy type for TSet |
| FDeserializeObjectPackageData | |
| FDeserializePackageData | |
| FDeserializeTagData | |
| FDirectoryWatcherUpdateTelemetry | Information about an asset registry update that was triggered by the directory watcher module. |
| FFileJournalErrorTelemetry | Information about a failure in our FileJournal area. |
| FFileJournalWrappedTelemetry | |
| FGatherTelemetry | Information about the initial asset registry scan triggered when launching the process. |
| FReadPackageDataDependenciesArgs | |
| FSetManageReferencesContext | Information passed into SetManageReferences from ther caller. |
| FShouldSetManagerContext | Information passed into ShouldSetManager calls from the graph search performed in SetManageReferences. |
| FStartupTelemetry | Information about very early asset registry startup. |
| FSynchronousScanTelemetry | Information about a synchronous scan that was executed, blocking the calling thread. |
| FTagAndValue |
Interfaces
| Name | Remarks |
|---|---|
| IAssetDependencyGatherer | Interface class for functions that return extra dependencies to add to Assets of a given Class, to e.g. add dependencies on external Assets in a subdirectory. |
| IAssetRegistry | Global singleton interface for accessing a catalog of all packages (and some other content file types) that are stored in any mounted directory. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FAssetDataMap | TSet< FAssetData *, FCachedAssetKeyFuncs > | When not using indirection, an FAssetDataMap is a TSet, but with the complication that it stores pointers to FAssetData while supporting lookup by FCachedAssetKey. | AssetRegistry/AssetDataMap.h |
| FConstAssetDataMap | TSet< const FAssetData *, FCachedAssetKeyFuncs > | AssetRegistry/AssetDataMap.h |
Enums
Public
| Name | Remarks |
|---|---|
| EAssetAvailability::Type | |
| EAssetAvailabilityProgressReportingType::Type | |
| EAssetRegistrySortOrder | |
| EAssetsWithOuterForPathsFlags | |
| UE::AssetRegistry::EAppendMode | Enum controlling how FAssetRegistryStates are merged during Append functions, e.g. when adding plugin's serialized AssetRegistry into global AssetRegistry. |
| UE::AssetRegistry::EAssetSetManagerAssetFlags | Properties about each node in the graph search conducted from SetManageReferences. |
| UE::AssetRegistry::EGetMostImportantAssetFlags | Inline implementations. |
| UE::AssetRegistry::EReadPackageDataMainErrorCode | Inline implementations. |
| UE::AssetRegistry::EScanFlags | Please update LexToString when modifying this enum. |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Stage_ChunkCompressedSizeFName | const FName | AssetRegistry/IAssetRegistry.h | ||
| Stage_ChunkCountFName | const FName | Various FNames for asset tags that get added during staging if asset registry writeback is enabled. | AssetRegistry/IAssetRegistry.h | |
| Stage_ChunkInstalledSizeFName | const FName | AssetRegistry/IAssetRegistry.h | ||
| Stage_ChunkOptionalSizeFName | const FName | AssetRegistry/IAssetRegistry.h | ||
| Stage_ChunkSizeFName | const FName | AssetRegistry/IAssetRegistry.h | ||
| Stage_ChunkStreamingSizeFName | const FName | AssetRegistry/IAssetRegistry.h | ||
| WildcardFName | const FName | Wildcards (*) used when looking up assets in the asset registry. | AssetRegistry/IAssetRegistry.h | |
| WildcardPathName | const FTopLevelAssetPath | AssetRegistry/IAssetRegistry.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FName AssetRegistryConstants::ModuleName
(
"AssetRegistry" |
AssetRegistry/AssetRegistryModule.h | ||
ENUM_CLASS_FLAGS
(
EAssetsWithOuterForPathsFlags |
AssetRegistry/AssetRegistryHelpers.h | ||
const TCHAR * GetDevelopmentAssetRegistryFilename() |
Returns the filename without filepath for the DevelopmentAssetRegistry written by the cooker. | AssetRegistry/IAssetRegistry.h | |
| AssetRegistry/IAssetRegistry.h | |||
| AssetRegistry/IAssetRegistry.h | |||
uint32 UE::AssetRegistry::Private::GetTypeHash
(
const FCachedAssetKey& A |
AssetRegistry/AssetDataMap.h | ||
uint32 UE::AssetRegistry::Private::HashCombineQuick
(
uint32 A, |
AssetRegistry/AssetDataMap.h | ||
bool UE::AssetRegistry::Private::operator!=
(
const FCachedAssetKey& A, |
AssetRegistry/AssetDataMap.h | ||
bool UE::AssetRegistry::Private::operator==
(
const FCachedAssetKey& A, |
AssetRegistry/AssetDataMap.h |