AZ::SliceMetadataInfoManipulationRequests Class Reference

Inherits AZ::ComponentBus.

Public Member Functions
virtual void	AddChildMetadataEntity (EntityId childEntityId)=0
virtual void	RemoveChildMetadataEntity (EntityId childEntityId)=0
virtual void	SetParentMetadataEntity (EntityId parentEntityId)=0
virtual void	AddAssociatedEntity (EntityId associatedEntityId)=0
virtual void	GetAssociatedEntities (AZStd::set< EntityId > &)=0
virtual void	RemoveAssociatedEntity (EntityId associatedEntityId)=0
virtual void	MarkAsPersistent (bool persistent)=0
Public Member Functions inherited from AZ::ComponentBus
virtual	~ComponentBus ()=default

Additional Inherited Members
Public Types inherited from AZ::ComponentBus
typedef EntityId	BusIdType
Public Types inherited from AZ::EBusTraits
using	AllocatorType = AZ::Internal::EBusEnvironmentAllocator
using	BusIdType = NullBusId
using	BusIdOrderCompare = NullBusIdCompare
using	BusHandlerOrderCompare = BusHandlerCompareDefault
using	MutexType = NullMutex
using	EventQueueMutexType = NullMutex
template<class Bus >
using	ConnectionPolicy = EBusConnectionPolicy< Bus >
template<class Context >
using	StoragePolicy = EBusEnvironmentStoragePolicy< Context >
template<class Bus >
using	RouterPolicy = EBusRouterPolicy< Bus >
using	EventProcessingPolicy = EBusEventProcessingPolicy
template<typename DispatchMutex , bool IsLocklessDispatch>
using	DispatchLockGuard = AZStd::conditional_t< IsLocklessDispatch, AZ::Internal::NullLockGuard< DispatchMutex >, AZStd::scoped_lock< DispatchMutex > >
template<typename ContextMutex >
using	ConnectLockGuard = AZStd::conditional_t< AZStd::is_same_v< ContextMutex, AZ::NullMutex >, AZ::Internal::NullLockGuard< ContextMutex >, AZStd::unique_lock< ContextMutex > >
template<typename ContextMutex >
using	BindLockGuard = AZStd::scoped_lock< ContextMutex >
template<typename ContextMutex >
using	CallstackTrackerLockGuard = AZStd::conditional_t< AZStd::is_same_v< ContextMutex, AZ::NullMutex >, AZ::Internal::NullLockGuard< ContextMutex >, AZStd::unique_lock< ContextMutex > >
Static Public Attributes inherited from AZ::ComponentBus
static const EBusAddressPolicy	AddressPolicy = EBusAddressPolicy::ById
Static Public Attributes inherited from AZ::EBusTraits
static constexpr EBusHandlerPolicy	HandlerPolicy = EBusHandlerPolicy::Multiple
static constexpr EBusAddressPolicy	AddressPolicy = EBusAddressPolicy::Single
static constexpr bool	EnableEventQueue = false
static constexpr bool	EventQueueingActiveByDefault = true
static constexpr bool	EnableQueuedReferences = false
static constexpr bool	LocklessDispatch = false
Protected Member Functions inherited from AZ::EBusTraits
	~EBusTraits ()=default

Member Function Documentation

AddAssociatedEntity()

virtual void AZ::SliceMetadataInfoManipulationRequests::AddAssociatedEntity ( EntityId  associatedEntityId )

pure virtual

Add an associated entity. the associated entity must be an editor entity.

AddChildMetadataEntity()

virtual void AZ::SliceMetadataInfoManipulationRequests::AddChildMetadataEntity ( EntityId  childEntityId )

pure virtual

Add a child entity to the metadata entity. Child entities must be metadata entities.

GetAssociatedEntities()

virtual void AZ::SliceMetadataInfoManipulationRequests::GetAssociatedEntities ( AZStd::set< EntityId > &  )

pure virtual

Fills out the provided container with all of the IDs of entities associated with this metadata entity.

MarkAsPersistent()

virtual void AZ::SliceMetadataInfoManipulationRequests::MarkAsPersistent ( bool  persistent )

pure virtual

Marks this component as persistent. When persistent, the component remains valid without children and associations. For example, the root slice is persistent.

RemoveAssociatedEntity()

virtual void AZ::SliceMetadataInfoManipulationRequests::RemoveAssociatedEntity ( EntityId  associatedEntityId )

pure virtual

Remove an entity from the association list. The given entity must be an associated editor entity.

RemoveChildMetadataEntity()

virtual void AZ::SliceMetadataInfoManipulationRequests::RemoveChildMetadataEntity ( EntityId  childEntityId )

pure virtual

Remove an existing child metadata entity. The given entity must be a valid child metadata entity.

SetParentMetadataEntity()

virtual void AZ::SliceMetadataInfoManipulationRequests::SetParentMetadataEntity ( EntityId  parentEntityId )

pure virtual

Set the parent of the metadata entity. Can be an invalid entity ID (No parent) Must be the ID of a metadata entity.

---

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

• Code/Framework/AzCore/AzCore/Slice/SliceMetadataInfoBus.h