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::SliceMetadataInfoNotifications Class Reference

#include <SliceMetadataInfoBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual void OnMetadataParentChanged (EntityId)
 
virtual void OnChildMetadataEntityAdded (EntityId)
 
virtual void OnChildMetadataEntityRemoved (EntityId)
 
virtual void OnMetadataDependenciesRemoved ()
 
- Public Member Functions inherited from AZ::ComponentBus
virtual ~ComponentBus ()=default
 

Additional Inherited Members

- Public Types inherited from AZ::ComponentBus
typedef EntityId BusIdType
 
- 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 > >
 
- Static Public Attributes inherited from AZ::ComponentBus
static const EBusAddressPolicy AddressPolicy = EBusAddressPolicy::ById
 
- 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
 
- Protected Member Functions inherited from AZ::EBusTraits
 ~EBusTraits ()=default
 

Detailed Description

Bus for receiving events/notifications when changes occur to the slice metadata information component.

Member Function Documentation

◆ OnChildMetadataEntityAdded()

virtual void AZ::SliceMetadataInfoNotifications::OnChildMetadataEntityAdded ( EntityId  )
inlinevirtual

Sent when the metadata has a new child added

◆ OnChildMetadataEntityRemoved()

virtual void AZ::SliceMetadataInfoNotifications::OnChildMetadataEntityRemoved ( EntityId  )
inlinevirtual

Sent when the metadata has a child removed

◆ OnMetadataDependenciesRemoved()

virtual void AZ::SliceMetadataInfoNotifications::OnMetadataDependenciesRemoved ( )
inlinevirtual

Sent when the metadata entity has no more dependencies (Associated entities or children) This generally means that the slice attached to the metadata entity has been completely removed. This notification should not be dispatched for components marked as persistent. Note: This notification may trigger the destruction of the metadata entity and care should be taken when dispatching it to that effect.

◆ OnMetadataParentChanged()

virtual void AZ::SliceMetadataInfoNotifications::OnMetadataParentChanged ( EntityId  )
inlinevirtual

Sent when the metadata parent has been altered


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