Open 3D Engine AzToolsFramework 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.
AzToolsFramework::PlatformAddressedAssetCatalog Class Reference

Inherits AzFramework::AssetCatalog, and AzToolsFramework::AssetCatalog::PlatformAddressedAssetCatalogRequestBus::Handler.

Public Member Functions

 PlatformAddressedAssetCatalog (AzFramework::PlatformId platformId, bool directConnections=false)
 
void InitCatalog ()
 Load the correct catalog based on m_platformId and connect to the ebus.
 
AZStd::string GetCatalogRegistryPath () const
 
void EnableCatalogForAsset (const AZ::Data::AssetType &assetType) override
 
void GetHandledAssetTypes (AZStd::vector< AZ::Data::AssetType > &assetTypes) override
 
void DisableCatalog () override
 
void StartMonitoringAssets () override
 
void StopMonitoringAssets () override
 
bool LoadCatalog (const char *catalogRegistryFile) override
 
void ClearCatalog () override
 
bool SaveCatalog (const char *catalogRegistryFile) override
 
bool AddDeltaCatalog (AZStd::shared_ptr< AzFramework::AssetRegistry > deltaCatalog) override
 
bool InsertDeltaCatalog (AZStd::shared_ptr< AzFramework::AssetRegistry > deltaCatalog, size_t slotNum) override
 
bool InsertDeltaCatalogBefore (AZStd::shared_ptr< AzFramework::AssetRegistry > deltaCatalog, AZStd::shared_ptr< AzFramework::AssetRegistry > afterDeltaCatalog) override
 
bool RemoveDeltaCatalog (AZStd::shared_ptr< AzFramework::AssetRegistry > deltaCatalog) override
 
bool CreateBundleManifest (const AZStd::string &deltaCatalogPath, const AZStd::vector< AZStd::string > &dependentBundleNames, const AZStd::string &fileDirectory, int bundleVersion, const AZStd::vector< AZ::IO::Path > &levelDirs) override
 
bool CreateDeltaCatalog (const AZStd::vector< AZStd::string > &files, const AZStd::string &filePath) override
 
void AddExtension (const char *extension) override
 
void RegisterAsset (const AZ::Data::AssetId &id, AZ::Data::AssetInfo &info) override
 
void UnregisterAsset (const AZ::Data::AssetId &id) override
 
AZStd::string GetAssetPathById (const AZ::Data::AssetId &id) override
 
AZ::Data::AssetInfo GetAssetInfoById (const AZ::Data::AssetId &id) override
 
AZ::Data::AssetId GetAssetIdByPath (const char *path, const AZ::Data::AssetType &typeToRegister, bool autoRegisterIfNotFound) override
 
AZ::Outcome< AZStd::vector< AZ::Data::ProductDependency >, AZStd::string > GetDirectProductDependencies (const AZ::Data::AssetId &asset) override
 
AZ::Outcome< AZStd::vector< AZ::Data::ProductDependency >, AZStd::string > GetAllProductDependencies (const AZ::Data::AssetId &asset) override
 
AZ::Outcome< AZStd::vector< AZ::Data::ProductDependency >, AZStd::string > GetAllProductDependenciesFilter (const AZ::Data::AssetId &id, const AZStd::unordered_set< AZ::Data::AssetId > &exclusionList, const AZStd::vector< AZStd::string > &wildcardPatternExclusionList) override
 
bool DoesAssetIdMatchWildcardPattern (const AZ::Data::AssetId &assetId, const AZStd::string &wildcardPattern) override
 
void EnumerateAssets (BeginAssetEnumerationCB beginCB, AssetEnumerationCB enumerateCB, EndAssetEnumerationCB endCB) override
 
AzFramework::PlatformId GetPlatformId () const
 

Static Public Member Functions

static AZStd::string GetAssetRootForPlatform (AzFramework::PlatformId platformId)
 Returns Asset Root for a given Platform.
 
static AZStd::string GetCatalogRegistryPathForPlatform (AzFramework::PlatformId platformId)
 Returns an absolute path to the AssetCatalog for a given platform.
 
static bool CatalogExists (AzFramework::PlatformId platformId)
 Check if the catalog for the given platform exists.
 

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