AZ::EntitySystemEvents Class Reference

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

Inherits AZ::EBusTraits .

Public Member Functions
virtual	~EntitySystemEvents ()
	Destroys the instance of the class. More...
virtual void	OnEntityActivated (const AZ::EntityId &)
	Signals that an entity was activated. More...
virtual void	OnEntityDeactivated (const AZ::EntityId &)
	Signals that an entity is being deactivated. More...
virtual void	OnEntityNameChanged (const AZ::EntityId &, const AZStd::string &)
	Signals that the name of an entity changed. More...

Additional Inherited Members
Public Types inherited from AZ::EBusTraits
using	AllocatorType = AZStd::allocator
	Allocator used by the EBus . More...
using	BusIdType = NullBusId
	The type of ID that is used to address the EBus . More...
using	BusIdOrderCompare = NullBusIdCompare
	Sorting function for EBus address IDs. More...
using	BusHandlerOrderCompare = BusHandlerCompareDefault
	Sorting function for EBus event handlers. More...
using	MutexType = NullMutex
	Locking primitive that is used when connecting handlers to the EBus or executing events. More...
using	EventQueueMutexType = NullMutex
	Locking primitive that is used when adding and removing events from the queue. More...
template<class Bus >
using	ConnectionPolicy = EBusConnectionPolicy < Bus >
	Enables custom logic to run when a handler connects or disconnects from the EBus . More...
template<class Context >
using	StoragePolicy = EBusEnvironmentStoragePolicy < Context >
	Specifies where EBus data is stored. More...
template<class Bus >
using	RouterPolicy = EBusRouterPolicy< Bus >
	Controls the flow of EBus events. More...
Static Public Attributes inherited from AZ::EBusTraits
static const EBusHandlerPolicy	HandlerPolicy
	Defines how many handlers can connect to an address on the EBus and the order in which handlers at each address receive events. More...
static const EBusAddressPolicy	AddressPolicy
	Defines how many addresses exist on the EBus . More...
static const bool	EnableEventQueue
	Specifies whether the EBus supports an event queue. More...
Protected Member Functions inherited from AZ::EBusTraits
	~EBusTraits ()=default
	A destructor. More...

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 ( )

inline virtual

Destroys the instance of the class.

Member Function Documentation

OnEntityActivated()

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

inline virtual

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 & )

inline virtual

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.

OnEntityNameChanged()

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

inline virtual

Signals that the name of an entity changed.

Parameters

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

---

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

• C:/lumberyard-root/dev/Code/Framework/AzCore/AzCore/Component/ EntityBus.h