Multiplayer::NetworkHierarchyRequests Class Reference

Inherits AZ::ComponentBus.

Public Member Functions
virtual bool	IsHierarchyEnabled () const =0
virtual AZStd::vector< AZ::Entity * >	GetHierarchicalEntities () const =0
virtual AZ::Entity *	GetHierarchicalRoot () const =0
virtual bool	IsHierarchicalChild () const =0
virtual bool	IsHierarchicalRoot () const =0
virtual void	BindNetworkHierarchyChangedEventHandler (NetworkHierarchyChangedEvent::Handler &handler)=0
virtual void	BindNetworkHierarchyLeaveEventHandler (NetworkHierarchyLeaveEvent::Handler &handler)=0

Member Function Documentation

BindNetworkHierarchyChangedEventHandler()

virtual void Multiplayer::NetworkHierarchyRequests::BindNetworkHierarchyChangedEventHandler ( NetworkHierarchyChangedEvent::Handler &  handler )

pure virtual

Binds the provided NetworkHierarchyChangedEvent handler to a Network Hierarchy component.

Parameters

handler

the handler to invoke when the entity's network hierarchy has been modified.

BindNetworkHierarchyLeaveEventHandler()

virtual void Multiplayer::NetworkHierarchyRequests::BindNetworkHierarchyLeaveEventHandler ( NetworkHierarchyLeaveEvent::Handler &  handler )

pure virtual

Binds the provided NetworkHierarchyLeaveEvent handler to a Network Hierarchy component.

Parameters

handler

the handler to invoke when the entity left its network hierarchy.

GetHierarchicalEntities()

virtual AZStd::vector<AZ::Entity*> Multiplayer::NetworkHierarchyRequests::GetHierarchicalEntities ( ) const

pure virtual

Returns

hierarchical entities, the first element is the top level root

GetHierarchicalRoot()

virtual AZ::Entity* Multiplayer::NetworkHierarchyRequests::GetHierarchicalRoot ( ) const

pure virtual

Returns

the top level root of a hierarchy, or nullptr if this entity is not in a hierarchy

IsHierarchicalChild()

virtual bool Multiplayer::NetworkHierarchyRequests::IsHierarchicalChild ( ) const

pure virtual

Returns

true if this entity is a child entity within a hierarchy

IsHierarchicalRoot()

virtual bool Multiplayer::NetworkHierarchyRequests::IsHierarchicalRoot ( ) const

pure virtual

Returns

true if this entity is the top level root of a hierarchy

IsHierarchyEnabled()

virtual bool Multiplayer::NetworkHierarchyRequests::IsHierarchyEnabled ( ) const

pure virtual

Returns

true if the entity a hierarchical component attached should be considered for inclusion in a hierarchy this should return false when an entity is deactivating

---

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

• Gems/Multiplayer/Code/Include/Multiplayer/Components/NetworkHierarchyBus.h