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. |
Defines the default connection policy that is used when AZ::EBusTraits::ConnectionPolicy is left unspecified. More...
Public Types |
|
typedef | BusPtr |
A pointer to a specific address on the
EBus
.
More...
|
|
typedef | BusIdType |
The type of ID that is used to address the
EBus
.
More...
|
|
typedef | HandlerNode |
A handler connected to the
EBus
.
More...
|
|
typedef | Context |
Global data for the
EBus
.
More...
|
|
Static Public Member Functions |
|
static void | Bind ( BusPtr &ptr, Context &context, const BusIdType &id=0) |
Binds a pointer to an
EBus
address.
More...
|
|
static void | Connect ( BusPtr &ptr, Context &context, HandlerNode &handler, const BusIdType &id=0) |
Connects a handler to an
EBus
address.
More...
|
|
static void | Disconnect ( Context &context, HandlerNode &handler, BusPtr &ptr) |
Disconnects a handler from an
EBus
address.
More...
|
|
static void | DisconnectId ( Context &context, HandlerNode &handler, const BusIdType &id) |
Disconnects a handler from an
EBus
address, referencing the address by its ID.
More...
|
|
Detailed Description
template<class Bus>
struct AZ::EBusConnectionPolicy< Bus >
Defines the default connection policy that is used when AZ::EBusTraits::ConnectionPolicy is left unspecified.
Use this as a template for custom connection policies.
- Template Parameters
-
Bus A class that defines an EBus .
Member Typedef Documentation
◆ BusIdType
typedef Bus::BusIdType AZ::EBusConnectionPolicy < Bus >:: BusIdType |
The type of ID that is used to address the EBus .
This type is used when the address policy is EBusAddressPolicy::ById or EBusAddressPolicy::ByIdAndOrdered only.
◆ BusPtr
typedef Bus::BusPtr AZ::EBusConnectionPolicy < Bus >:: BusPtr |
A pointer to a specific address on the EBus .
◆ Context
typedef Bus::Context AZ::EBusConnectionPolicy < Bus >:: Context |
◆ HandlerNode
typedef Bus::HandlerNode AZ::EBusConnectionPolicy < Bus >:: HandlerNode |
A handler connected to the EBus .
Member Function Documentation
◆ Bind()
|
static |
◆ Connect()
|
static |
Connects a handler to an EBus address.
◆ Disconnect()
|
static |
◆ DisconnectId()
|
static |
The documentation for this struct was generated from the following file:
- C:/lumberyard-root/dev/Code/Framework/AzCore/AzCore/EBus/ Policies.h