Open 3D Engine Multiplayer Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | Friends | List of all members
Multiplayer::NetworkHierarchyRootComponent Class Referencefinal

Component that declares the top level entity of a network hierarchy. More...

#include <NetworkHierarchyRootComponent.h>

Inherits NetworkHierarchyRootComponentBase, and NetworkHierarchyRequestBus::Handler.

Public Member Functions

 AZ_MULTIPLAYER_COMPONENT (Multiplayer::NetworkHierarchyRootComponent, s_networkHierarchyRootComponentConcreteUuid, Multiplayer::NetworkHierarchyRootComponentBase)
 
bool SerializeEntityCorrection (AzNetworking::ISerializer &serializer)
 
void OnInit () override
 
void OnActivate (Multiplayer::EntityIsMigrating entityIsMigrating) override
 
void OnDeactivate (Multiplayer::EntityIsMigrating entityIsMigrating) override
 
bool IsHierarchyEnabled () const override
 
bool IsHierarchicalRoot () const override
 
bool IsHierarchicalChild () const override
 
AZStd::vector< AZ::Entity * > GetHierarchicalEntities () const override
 
AZ::Entity * GetHierarchicalRoot () const override
 
void BindNetworkHierarchyChangedEventHandler (NetworkHierarchyChangedEvent::Handler &handler) override
 
void BindNetworkHierarchyLeaveEventHandler (NetworkHierarchyLeaveEvent::Handler &handler) override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 

Friends

class NetworkHierarchyChildComponent
 
class NetworkHierarchyRootComponentController
 
class HierarchyBenchmarkBase
 

Detailed Description

Component that declares the top level entity of a network hierarchy.

Member Function Documentation

◆ IsHierarchyEnabled()

bool Multiplayer::NetworkHierarchyRootComponent::IsHierarchyEnabled ( ) const
override

NetworkHierarchyRequestBus overrides.

◆ OnInit()

void Multiplayer::NetworkHierarchyRootComponent::OnInit ( )
override

NetworkHierarchyRootComponentBase overrides.

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