AZ::EntitySystemEvents Class Reference

#include <EntityBus.h>

Inherits AZ::EBusTraits.

Public Member Functions
virtual	~EntitySystemEvents ()
virtual void	OnEntityInitialized (const AZ::EntityId &)
virtual void	OnEntityDestruction (const AZ::EntityId &)
virtual void	OnEntityDestroyed (const AZ::EntityId &)
virtual void	OnEntityActivated (const AZ::EntityId &)
virtual void	OnEntityDeactivated (const AZ::EntityId &)
virtual void	OnEntityNameChanged (const AZ::EntityId &, const AZStd::string &)
virtual void	OnEntityStartStatusChanged (const AZ::EntityId &)

Additional Inherited Members
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::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

Interface for the AZ::EntitySystemBus, which is the EBus that dispatches
notification events about every entity in the system.

Constructor & Destructor Documentation

~EntitySystemEvents()

virtual AZ::EntitySystemEvents::~EntitySystemEvents ( )

inlinevirtual

Destroys the instance of the class.

Member Function Documentation

OnEntityActivated()

virtual void AZ::EntitySystemEvents::OnEntityActivated ( const AZ::EntityId &  )

inlinevirtual

Signals that an entity was activated. This event is dispatched after the activation of the entity is complete.

Parameters

id	The ID of the activated entity.

OnEntityDeactivated()

virtual void AZ::EntitySystemEvents::OnEntityDeactivated ( const AZ::EntityId &  )

inlinevirtual

Signals that an entity is being deactivated. This event is dispatched immediately before the entity is deactivated.

Parameters

id	The ID of the deactivated entity.

OnEntityDestroyed()

virtual void AZ::EntitySystemEvents::OnEntityDestroyed ( const AZ::EntityId &  )

inlinevirtual

Signals that an initialized entity has been deleted.

OnEntityDestruction()

virtual void AZ::EntitySystemEvents::OnEntityDestruction ( const AZ::EntityId &  )

inlinevirtual

Signals that an initialized entity is about to be deleted.

OnEntityInitialized()

virtual void AZ::EntitySystemEvents::OnEntityInitialized ( const AZ::EntityId &  )

inlinevirtual

Global entity initialization notification.

Parameters

id	The ID of the initialized entity.

OnEntityNameChanged()

virtual void AZ::EntitySystemEvents::OnEntityNameChanged ( const AZ::EntityId &  , const AZStd::string &    )

inlinevirtual

Signals that the name of an entity changed.

Parameters

id	The ID of the entity.
name	The new name of the entity.

OnEntityStartStatusChanged()

virtual void AZ::EntitySystemEvents::OnEntityStartStatusChanged ( const AZ::EntityId &  )

inlinevirtual

Signals that the start status of an entity changed.

Parameters

EntityId

The ID of the entity that has had the status changed.

---

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

• Code/Framework/AzCore/AzCore/Component/EntityBus.h