Open 3D Engine AzFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
AzFramework::AssetRegistry Class Reference

#include <AssetRegistry.h>

Public Types

using AssetIdToInfoMap = AZStd::unordered_map< AZ::Data::AssetId, AZ::Data::AssetInfo >
 
using LegacyAssetIdToRealAssetIdMap = AZStd::unordered_map< AZ::Data::AssetId, AZ::Data::AssetId >
 

Public Member Functions

 AZ_TYPE_INFO (AssetRegistry, "{5DBC20D9-7143-48B3-ADEE-CCBD2FA6D443}")
 
 AZ_CLASS_ALLOCATOR (AssetRegistry, AZ::SystemAllocator)
 
void RegisterAsset (AZ::Data::AssetId id, const AZ::Data::AssetInfo &assetInfo)
 
void UnregisterAsset (AZ::Data::AssetId id)
 
void RegisterLegacyAssetMapping (const AZ::Data::AssetId &legacyId, const AZ::Data::AssetId &newId)
 
void UnregisterLegacyAssetMappingsForAsset (const AZ::Data::AssetId &id)
 
void SetAssetDependencies (const AZ::Data::AssetId &id, const AZStd::vector< AZ::Data::ProductDependency > &dependencies)
 
void RegisterAssetDependency (const AZ::Data::AssetId &id, const AZ::Data::ProductDependency &dependency)
 
AZStd::vector< AZ::Data::ProductDependency > GetAssetDependencies (const AZ::Data::AssetId &id) const
 
AZ::Data::AssetId GetAssetIdByPath (const char *assetPath) const
 
void Clear ()
 
AZ::Data::AssetId GetAssetIdByLegacyAssetId (const AZ::Data::AssetId &legacyAssetId) const
 
LegacyAssetIdToRealAssetIdMap GetLegacyMappingSubsetFromRealIds (const AZStd::vector< AZ::Data::AssetId > &realIds) const
 

Static Public Member Functions

static void ReflectSerialize (AZ::SerializeContext *serializeContext)
 

Public Attributes

AssetIdToInfoMap m_assetIdToInfo
 
AZStd::unordered_map< AZ::Data::AssetId, AZStd::vector< AZ::Data::ProductDependency > > m_assetDependencies
 

Friends

class AssetCatalog
 

Detailed Description

Data storage for asset registry. Maintained separate to facilitate easy serialization to/from disk.

Member Function Documentation

◆ GetAssetIdByPath()

AZ::Data::AssetId AzFramework::AssetRegistry::GetAssetIdByPath ( const char *  assetPath) const

LEGACY - do not use in new code unless interfacing with legacy systems. All new systems should be referring to assets by ID/Type only and should not need to look up by path/

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