Open 3D Engine AzCore 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.
AZ::Data::AssetManagerEvents Class Referenceabstract

Inherits AZ::EBusTraits.

Public Types

typedef AZStd::recursive_mutex MutexType
 
- Public Types inherited from AZ::EBusTraits
using AllocatorType = AZ::Internal::EBusEnvironmentAllocator
 
using BusIdType = NullBusId
 
using BusIdOrderCompare = NullBusIdCompare
 
using BusHandlerOrderCompare = BusHandlerCompareDefault
 
using MutexType = NullMutex
 
using EventQueueMutexType = NullMutex
 
template<class Bus >
using ConnectionPolicy = EBusConnectionPolicy< Bus >
 
template<class Context >
using StoragePolicy = EBusEnvironmentStoragePolicy< Context >
 
template<class Bus >
using RouterPolicy = EBusRouterPolicy< Bus >
 
using EventProcessingPolicy = EBusEventProcessingPolicy
 
template<typename DispatchMutex , bool IsLocklessDispatch>
using DispatchLockGuard = AZStd::conditional_t< IsLocklessDispatch, AZ::Internal::NullLockGuard< DispatchMutex >, AZStd::scoped_lock< DispatchMutex > >
 
template<typename ContextMutex >
using ConnectLockGuard = AZStd::conditional_t< AZStd::is_same_v< ContextMutex, AZ::NullMutex >, AZ::Internal::NullLockGuard< ContextMutex >, AZStd::unique_lock< ContextMutex > >
 
template<typename ContextMutex >
using BindLockGuard = AZStd::scoped_lock< ContextMutex >
 
template<typename ContextMutex >
using CallstackTrackerLockGuard = AZStd::conditional_t< AZStd::is_same_v< ContextMutex, AZ::NullMutex >, AZ::Internal::NullLockGuard< ContextMutex >, AZStd::unique_lock< ContextMutex > >
 

Public Member Functions

virtual void OnAssetReady (const Asset< AssetData > &asset)=0
 Signal that an asset is ready for use.
 
virtual void OnAssetReloaded (const Asset< AssetData > &asset)=0
 Signal that an asset has been reloaded.
 
virtual void OnAssetReloadError (const Asset< AssetData > &asset)=0
 Signal that an asset failed to reload.
 
virtual void OnAssetError (const Asset< AssetData > &asset)=0
 Signal that an asset error has occurred.
 
virtual void OnAssetCanceled (AssetId assetId)=0
 Signal that an asset load has been canceled.
 
virtual void OnAssetContainerReady (AssetContainer *container)=0
 Signal that an asset container load has finished.
 
virtual void OnAssetContainerCanceled (AssetContainer *container)=0
 

Static Public Attributes

static const EBusHandlerPolicy HandlerPolicy = EBusHandlerPolicy::Single
 
- Static Public Attributes inherited from AZ::EBusTraits
static constexpr EBusHandlerPolicy HandlerPolicy = EBusHandlerPolicy::Multiple
 
static constexpr EBusAddressPolicy AddressPolicy = EBusAddressPolicy::Single
 
static constexpr bool EnableEventQueue = false
 
static constexpr bool EventQueueingActiveByDefault = true
 
static constexpr bool EnableQueuedReferences = false
 
static constexpr bool LocklessDispatch = false
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::EBusTraits
 ~EBusTraits ()=default
 

Member Function Documentation

◆ OnAssetContainerCanceled()

virtual void AZ::Data::AssetManagerEvents::OnAssetContainerCanceled ( AssetContainer container)
pure virtual

When an asset is loaded as part of a container this signal is sent if the root asset is canceled / destroyed. The signal isn't sent until all the dependent assets in the container have finished loading, to help ensure that dependent assets don't get stuck in a perpetual loading state.


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