AzFramework::EntityContextEvents Class Reference

#include <EntityContextBus.h>

Inherits AZ::EBusTraits.

Public Types
typedef EntityContextId	BusIdType

Public Member Functions
virtual	~EntityContextEvents ()
virtual void	OnEntityContextLoadedFromStream (const EntityList &)
virtual void	OnEntityContextReset ()
virtual void	OnEntityContextCreateEntity (AZ::Entity &)
virtual void	OnEntityContextDestroyEntity (const AZ::EntityId &)

Static Public Attributes
static const AZ::EBusAddressPolicy	AddressPolicy = AZ::EBusAddressPolicy::ById

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 ( )

inlinevirtual

Destroys the instance of the class.

Member Function Documentation

OnEntityContextCreateEntity()

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

inlinevirtual

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 &  )

inlinevirtual

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 EntityList &  )

inlinevirtual

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 ( )

inlinevirtual

Signals that the entity context was reset.

Member Data Documentation

AddressPolicy

const AZ::EBusAddressPolicy AzFramework::EntityContextEvents::AddressPolicy = AZ::EBusAddressPolicy::ById

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:

• Code/Framework/AzFramework/AzFramework/Entity/EntityContextBus.h