Menu
Lumberyard
C++ API Reference (Version 1.10)

AzFramework::EntityIdContextQueries Class Referenceabstract

Interface for AzFramework::EntityIdContextQueryBus, which is the EBus that queries an entity about its context. More...

Inherits AZ::ComponentBus.

Public Member Functions

virtual ~EntityIdContextQueries ()
 Destroys the instance of the class. More...
 
virtual EntityContextId GetOwningContextId ()=0
 Gets the ID of the entity context that the entity belongs to. More...
 
virtual AZ::SliceComponent::SliceInstanceAddress GetOwningSlice ()=0
 Gets the address of the slice instance that owns the entity. More...
 
- Public Member Functions inherited from AZ::ComponentBus
virtual ~ComponentBus ()=default
 Destroys a component bus. More...
 

Additional Inherited Members

- Public Types inherited from AZ::ComponentBus
typedef EntityId 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 = AZStd::allocator
 Allocator used by the EBus. More...
 
using BusIdType = NullBusId
 The type of ID that is used to address the EBus. More...
 
using BusIdOrderCompare = NullBusIdCompare
 Sorting function for EBus address IDs. More...
 
using BusHandlerOrderCompare = BusHandlerCompareDefault
 Sorting function for EBus event handlers. More...
 
using MutexType = NullMutex
 Locking primitive that is used when connecting handlers to the EBus or executing events. More...
 
using EventQueueMutexType = NullMutex
 Locking primitive that is used when adding and removing events from the queue. More...
 
template<class Bus >
using ConnectionPolicy = EBusConnectionPolicy< Bus >
 Enables custom logic to run when a handler connects or disconnects from the EBus. More...
 
template<class Context >
using StoragePolicy = EBusEnvironmentStoragePolicy< Context >
 Specifies where EBus data is stored. More...
 
template<class Bus >
using RouterPolicy = EBusRouterPolicy< Bus >
 Controls the flow of EBus events. More...
 
- Static Public Attributes inherited from AZ::ComponentBus
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...
 
- Protected Member Functions inherited from AZ::EBusTraits
 ~EBusTraits ()=default
 A destructor. More...
 

Detailed Description

Interface for AzFramework::EntityIdContextQueryBus, which is the EBus that queries an entity about its context.

Constructor & Destructor Documentation

◆ ~EntityIdContextQueries()

virtual AzFramework::EntityIdContextQueries::~EntityIdContextQueries ( )
inlinevirtual

Destroys the instance of the class.

Member Function Documentation

◆ GetOwningContextId()

virtual EntityContextId AzFramework::EntityIdContextQueries::GetOwningContextId ( )
pure virtual

Gets the ID of the entity context that the entity belongs to.

Returns
The ID of the entity context that the entity belongs to.

◆ GetOwningSlice()

virtual AZ::SliceComponent::SliceInstanceAddress AzFramework::EntityIdContextQueries::GetOwningSlice ( )
pure virtual

Gets the address of the slice instance that owns the entity.

Returns
The address of the slice instance that owns the entity. If the entity is not owned by any other slice instance, then the slice instance that owns the entity is the root slice.

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