AZ::BehaviorContextEvents Class Reference

Interface for the AZ::BehaviorContextBus , which is the EBus that dispatches behavior context events. More...

Inherits AZ::EBusTraits .

Public Types
typedef	BusIdType
	Overrides the default AZ::EBusTraits ID type so that a pointer to the behavior context is 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 void	OnAddGlobalMethod (const char *methodName, BehaviorMethod *method)
	Signals that a new global method was reflected to the behavior context. More...
virtual void	OnRemoveGlobalMethod (const char *methodName, BehaviorMethod *method)
	Signals that a global method was removed from the behavior context. More...
virtual void	OnAddGlobalProperty (const char *propertyName, BehaviorProperty *prop)
	Signals that a new global property was reflected to the behavior context. More...
virtual void	OnRemoveGlobalProperty (const char *propertyName, BehaviorProperty *prop)
	Signals that a global property was removed from the behavior context. More...
virtual void	OnAddClass (const char *className, BehaviorClass *behaviorClass)
	Signals that a new class was reflected to the behavior context. More...
virtual void	OnRemoveClass (const char *className, BehaviorClass *behaviorClass)
	Signals that a class was removed from the behavior context. More...
virtual void	OnAddEBus (const char *ebusName, BehaviorEBus *ebus)
	Signals that a new EBus was reflected to the behavior context. More...
virtual void	OnRemoveEBus (const char *ebusName, BehaviorEBus *ebus)
	Signals that an EBus was removed from the behavior context. More...

Static Public Attributes
static const EBusAddressPolicy	AddressPolicy
	Overrides the default AZ::EBusTraits address policy so that multiple handlers can connect to the bus. 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

Interface for the AZ::BehaviorContextBus , which is the EBus that dispatches behavior context events.

Member Typedef Documentation

BusIdType

typedef BehaviorContext * AZ::BehaviorContextEvents::BusIdType

Overrides the default AZ::EBusTraits ID type so that a pointer to the behavior context is used to access the addresses of the bus.

Member Function Documentation

OnAddClass()

virtual void AZ::BehaviorContextEvents::OnAddClass ( const char * className , BehaviorClass * behaviorClass )

inline virtual

Signals that a new class was reflected to the behavior context.

Parameters

className	The name of the class.
behaviorClass	A pointer to an object that contains information about the class.

OnAddEBus()

virtual void AZ::BehaviorContextEvents::OnAddEBus ( const char * ebusName , BehaviorEBus * ebus )

inline virtual

Signals that a new EBus was reflected to the behavior context.

Parameters

ebusName	The name of the EBus .
ebus	A pointer to an object that contains information about the EBus .

OnAddGlobalMethod()

virtual void AZ::BehaviorContextEvents::OnAddGlobalMethod ( const char * methodName , BehaviorMethod * method )

inline virtual

Signals that a new global method was reflected to the behavior context.

Parameters

methodName	The name of the method.
method	A pointer to an object that contains information about the method.

OnAddGlobalProperty()

virtual void AZ::BehaviorContextEvents::OnAddGlobalProperty ( const char * propertyName , BehaviorProperty * prop )

inline virtual

Signals that a new global property was reflected to the behavior context.

Parameters

propertyName	The name of the property.
prop	A pointer to an object that contains information about the property.

OnRemoveClass()

virtual void AZ::BehaviorContextEvents::OnRemoveClass ( const char * className , BehaviorClass * behaviorClass )

inline virtual

Signals that a class was removed from the behavior context.

Parameters

className	The name of the class.
behaviorClass	A pointer to an object that contains information about the class.

OnRemoveEBus()

virtual void AZ::BehaviorContextEvents::OnRemoveEBus ( const char * ebusName , BehaviorEBus * ebus )

inline virtual

Signals that an EBus was removed from the behavior context.

Parameters

ebusName	The name of the EBus .
ebus	A pointer to an object that contains information about the EBus .

OnRemoveGlobalMethod()

virtual void AZ::BehaviorContextEvents::OnRemoveGlobalMethod ( const char * methodName , BehaviorMethod * method )

inline virtual

Signals that a global method was removed from the behavior context.

Parameters

methodName	The name of the method.
method	A pointer to an object that contains information about the method.

OnRemoveGlobalProperty()

virtual void AZ::BehaviorContextEvents::OnRemoveGlobalProperty ( const char * propertyName , BehaviorProperty * prop )

inline virtual

Signals that a global property was removed from the behavior context.

Parameters

propertyName	The name of the property.
prop	A pointer to an object that contains information about the property.

Member Data Documentation

AddressPolicy

const EBusAddressPolicy AZ::BehaviorContextEvents::AddressPolicy

static

Overrides the default AZ::EBusTraits address policy so that multiple handlers can connect to the bus.

---

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

• C:/lumberyard-root/dev/Code/Framework/AZCore/AZCore/RTTI/ BehaviorContext.h