Menu
Lumberyard
C++ API Reference (Version 1.10)

AZ::ComponentApplicationEvents Class Reference

Interface for AZ::ComponentApplicationEventBus, which is the EBus that dispatches component application events. More...

Inherits AZ::EBusTraits.

Public Member Functions

virtual ~ComponentApplicationEvents ()
 A destructor. More...
 
virtual void OnEntityAdded (AZ::Entity *entity)
 Signals that an entity was added to the application. More...
 
virtual void OnEntityRemoved (const AZ::EntityId &entityId)
 Signals that an entity was removed from the application. 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 AZ::ComponentApplicationEventBus, which is the EBus that dispatches component application events.

Constructor & Destructor Documentation

◆ ~ComponentApplicationEvents()

virtual AZ::ComponentApplicationEvents::~ComponentApplicationEvents ( )
inlinevirtual

A destructor.

Member Function Documentation

◆ OnEntityAdded()

virtual void AZ::ComponentApplicationEvents::OnEntityAdded ( AZ::Entity entity)
inlinevirtual

Signals that an entity was added to the application.

Parameters
entityA pointer to the entity that was added to the application.

◆ OnEntityRemoved()

virtual void AZ::ComponentApplicationEvents::OnEntityRemoved ( const AZ::EntityId entityId)
inlinevirtual

Signals that an entity was removed from the application.

Parameters
entityIdA reference to the ID of the entity that was removed from the application.

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