AzToolsFramework::SliceMetadataEntityContextRequests Class Reference

#include <SliceMetadataEntityContextBus.h>

Inherits AZ::EBusTraits.

Public Member Functions
virtual AzFramework::EntityContextId	GetSliceMetadataEntityContextId ()=0
virtual void	ResetContext ()=0
virtual bool	IsSliceMetadataEntity (const AZ::EntityId entityId)=0
virtual AZ::Entity *	GetMetadataEntity (const AZ::EntityId entityId)=0
virtual void	GetRequiredComponentTypes (AZ::ComponentTypeList &required)=0
virtual AZ::EntityId	GetMetadataEntityIdFromEditorEntity (const AZ::EntityId editorEntityId)=0
virtual AZ::EntityId	GetMetadataEntityIdFromSliceAddress (const AZ::SliceComponent::SliceInstanceAddress &address)=0
virtual void	AddMetadataEntityToContext (const AZ::SliceComponent::SliceInstanceAddress &, AZ::Entity &)=0

Static Public Attributes
static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Single

Detailed Description

Bus for making requests to the edit-time slice metadata context.

The Slice Metadata Context creates and maintains entities whose components store information associated with instantiated slices.

Member Function Documentation

AddMetadataEntityToContext()

virtual void AzToolsFramework::SliceMetadataEntityContextRequests::AddMetadataEntityToContext ( const AZ::SliceComponent::SliceInstanceAddress &  , AZ::Entity &    )

pure virtual

Add a slice metadata entity to the context

Parameters

sliceAddress

The address of the slice associated with the metadata entity.

@param entity A pointer to the entity to add to the context

GetMetadataEntity()

virtual AZ::Entity * AzToolsFramework::SliceMetadataEntityContextRequests::GetMetadataEntity ( const AZ::EntityId  entityId )

pure virtual

Get a raw pointer to an entity that belongs to this context

Parameters

entityId

The Id of the requested entity

GetMetadataEntityIdFromEditorEntity()

virtual AZ::EntityId AzToolsFramework::SliceMetadataEntityContextRequests::GetMetadataEntityIdFromEditorEntity ( const AZ::EntityId  editorEntityId )

pure virtual

Get the ID of the metadata entity associated with an editor entity

Returns

The ID of the associated entity, or an invalid ID if there is no association.

GetMetadataEntityIdFromSliceAddress()

virtual AZ::EntityId AzToolsFramework::SliceMetadataEntityContextRequests::GetMetadataEntityIdFromSliceAddress ( const AZ::SliceComponent::SliceInstanceAddress &  address )

pure virtual

Get the ID of the metadata entity associated with a slice instance address

Parameters

address

The slice address of an instantiated slice

Returns

The ID of the associated entity, or an invalid ID if there is no association.

GetRequiredComponentTypes()

virtual void AzToolsFramework::SliceMetadataEntityContextRequests::GetRequiredComponentTypes ( AZ::ComponentTypeList &  required )

pure virtual

Get a list of the components required for entities in this context

Parameters

required

A component type list. The required component types will be appended to the end of it.

GetSliceMetadataEntityContextId()

virtual AzFramework::EntityContextId AzToolsFramework::SliceMetadataEntityContextRequests::GetSliceMetadataEntityContextId ( )

pure virtual

Retrieve the unique Id of the slice metadata context.

IsSliceMetadataEntity()

virtual bool AzToolsFramework::SliceMetadataEntityContextRequests::IsSliceMetadataEntity ( const AZ::EntityId  entityId )

pure virtual

Determines if an entity belongs to the Slice Metadata Entity Context

Parameters

entityId

And Entity to Check.

ResetContext()

virtual void AzToolsFramework::SliceMetadataEntityContextRequests::ResetContext ( )

pure virtual

Resetting the context removes all entities from the context. Because the metadata entities themselves are owned by their slices, this will not trigger destruction of the entities or remove them from the component application.

---

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

• Code/Framework/AzToolsFramework/AzToolsFramework/Slice/SliceMetadataEntityContextBus.h