Interface for the AzFramework::EntityContextEventBus , which is the EBus that dispatches notification events from the global entity context. More...

Inherits AZ::EBusTraits .

Public Types
typedef	BusIdType
	Specifies that events are addressed by entity context ID. 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	~EntityContextEvents ()
	Destroys the instance of the class. More...

virtual void	OnEntityContextLoadedFromStream (const AZ::SliceComponent::EntityList &)
	Signals that an entity context was loaded from a stream. More...

virtual void	OnEntityContextReset ()
	Signals that the entity context was reset. More...

virtual void	OnEntityContextCreateEntity ( AZ::Entity &)
	Signals that the entity context created an entity. More...

virtual void	OnEntityContextDestroyEntity (const AZ::EntityId &)
	Signals that the entity context is about to destroy an entity. More...

virtual void	OnSlicePreInstantiate (const AZ::Data::AssetId &, const AZ::SliceComponent::SliceInstanceAddress &)
	Signals that a slice was successfully instantiated prior to entity registration. More...

virtual void	OnSliceInstantiated (const AZ::Data::AssetId &, const AZ::SliceComponent::SliceInstanceAddress &)
	Signals that a slice was successfully instantiated after entity registration. More...

virtual void	OnSliceInstantiationFailed (const AZ::Data::AssetId &)
	Signals that a slice could not be instantiated. More...

Static Public Attributes
static const AZ::EBusAddressPolicy	AddressPolicy
	Overrides the default AZ::EBusAddressPolicy to specify that the EBus has multiple addresses. 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 AzFramework::EntityContextEventBus , which is the EBus that dispatches notification events from the global entity context.

If you want to receive notification events from a specific entity context, such as the game entity context, use the interface specific to that context. If you want to receive notification events from multiple types of entity contexts, use this interface.

Member Typedef Documentation

◆ BusIdType

typedef EntityContextId AzFramework::EntityContextEvents::BusIdType

Specifies that events are addressed by entity context ID.

Constructor & Destructor Documentation

◆ ~EntityContextEvents()

virtual AzFramework::EntityContextEvents::~EntityContextEvents ( )

inline virtual

Destroys the instance of the class.

Member Function Documentation

◆ OnEntityContextCreateEntity()

virtual void AzFramework::EntityContextEvents::OnEntityContextCreateEntity ( AZ::Entity & )

inline virtual

Signals that the entity context created an entity.

Parameters

entity A reference to the entity that was created.

◆ OnEntityContextDestroyEntity()

virtual void AzFramework::EntityContextEvents::OnEntityContextDestroyEntity ( const AZ::EntityId & )

inline virtual

Signals that the entity context is about to destroy an entity.

Parameters

id	A reference to the ID of the entity that will be destroyed.

◆ OnEntityContextLoadedFromStream()

virtual void AzFramework::EntityContextEvents::OnEntityContextLoadedFromStream ( const AZ::SliceComponent::EntityList & )

inline virtual

Signals that an entity context was loaded from a stream.

Parameters

contextEntities A reference to a list of entities that are owned by the entity context that was loaded.

◆ OnEntityContextReset()

virtual void AzFramework::EntityContextEvents::OnEntityContextReset ( )

inline virtual

Signals that the entity context was reset.

◆ OnSliceInstantiated()

virtual void AzFramework::EntityContextEvents::OnSliceInstantiated	(	const AZ::Data::AssetId &	,
		const AZ::SliceComponent::SliceInstanceAddress &
	)

inline virtual

Signals that a slice was successfully instantiated after entity registration.

Parameters

sliceAssetId	A reference to the slice asset ID.
sliceAddress	A reference to the slice instance address.

◆ OnSliceInstantiationFailed()

virtual void AzFramework::EntityContextEvents::OnSliceInstantiationFailed ( const AZ::Data::AssetId & )

inline virtual

Signals that a slice could not be instantiated.

Parameters

sliceAssetId A reference to the slice asset ID.

◆ OnSlicePreInstantiate()

virtual void AzFramework::EntityContextEvents::OnSlicePreInstantiate	(	const AZ::Data::AssetId &	,
		const AZ::SliceComponent::SliceInstanceAddress &
	)

inline virtual

Signals that a slice was successfully instantiated prior to entity registration.

Parameters

sliceAssetId	A reference to the slice asset ID.
sliceAddress	A reference to the slice instance address.

Member Data Documentation

◆ AddressPolicy

const AZ::EBusAddressPolicy AzFramework::EntityContextEvents::AddressPolicy

static

Overrides the default AZ::EBusAddressPolicy to specify that the EBus has multiple addresses.

Events that are addressed to an ID are received by all handlers connected to that ID.

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

C:/lumberyard-root/dev/Code/Framework/AzFramework/AzFramework/Entity/ EntityContextBus.h

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BusIdType

Constructor & Destructor Documentation

◆ ~EntityContextEvents()

Member Function Documentation

◆ OnEntityContextCreateEntity()

◆ OnEntityContextDestroyEntity()

◆ OnEntityContextLoadedFromStream()

◆ OnEntityContextReset()

◆ OnSliceInstantiated()

◆ OnSliceInstantiationFailed()

◆ OnSlicePreInstantiate()

Member Data Documentation

◆ AddressPolicy