Open 3D Engine (O3DE), the successor to Lumberyard, is now available in Developer Preview. Download O3DE or visit the AWS Game Tech blog to learn more. |
Base class for message buses. More...
Inherits AZ::EBusTraits .
Inherited by AZ::EntityEvents , AZ::TransformInterface , AZ::TransformNotification , and AzFramework::EntityIdContextQueries .
Public Types |
|
typedef | BusIdType |
Overrides the default
AZ::EBusTraits
ID type so that entity IDs are used to access the addresses of the bus.
More...
|
|
Public Types inherited from AZ::EBusTraits | |
using | AllocatorType |
Allocator used by the
EBus
.
More...
|
|
using | BusIdType |
The type of ID that is used to address the
EBus
.
More...
|
|
using | BusIdOrderCompare |
Sorting function for
EBus
address IDs.
More...
|
|
using | BusHandlerOrderCompare |
Sorting function for
EBus
event handlers.
More...
|
|
using | MutexType |
Locking primitive that is used when connecting handlers to the
EBus
or executing events.
More...
|
|
using | EventQueueMutexType |
Locking primitive that is used when adding and removing events from the queue.
More...
|
|
using | ConnectionPolicy |
Enables custom logic to run when a handler connects or disconnects from the
EBus
.
More...
|
|
using | StoragePolicy |
Specifies where
EBus
data is stored.
More...
|
|
using | RouterPolicy |
Controls the flow of
EBus
events.
More...
|
|
Public Member Functions |
|
virtual | ~ComponentBus ()=default |
Destroys a component bus.
More...
|
|
Static Public Attributes |
|
static const EBusAddressPolicy | AddressPolicy |
Overrides the default
AZ::EBusTraits
address policy so that the bus has multiple addresses at which to receive messages.
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...
|
|
Additional Inherited Members |
|
Protected Member Functions inherited from AZ::EBusTraits | |
~EBusTraits ()=default | |
A destructor.
More...
|
|
Detailed Description
Base class for message buses.
Most components that derive from AZ::Component use this class to implement their buses, and then override the default AZ::EBusTraits to suit their needs.
Member Typedef Documentation
◆ BusIdType
typedef EntityId AZ::ComponentBus::BusIdType |
Overrides the default AZ::EBusTraits ID type so that entity IDs are used to access the addresses of the bus.
Constructor & Destructor Documentation
◆ ~ComponentBus()
|
virtual default |
Destroys a component bus.
Member Data Documentation
◆ AddressPolicy
|
static |
Overrides the default AZ::EBusTraits address policy so that the bus has multiple addresses at which to receive messages.
This bus is identified by EntityId . Messages addressed to an ID are received by handlers connected to that ID.
The documentation for this class was generated from the following file:
- C:/lumberyard-root/dev/Code/Framework/AzCore/AzCore/Component/ ComponentBus.h