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

A class that determines if an entity should belong to a particular INetworkEntityManager. More...

#include <IEntityDomain.h>

Inherited by Multiplayer::FullOwnershipEntityDomain, and Multiplayer::NullEntityDomain.

Public Member Functions

virtual void SetAabb (const AZ::Aabb &aabb)=0
 
virtual const AZ::Aabb & GetAabb () const =0
 
virtual bool IsInDomain (const ConstNetworkEntityHandle &entityHandle) const =0
 
virtual void HandleLossOfAuthoritativeReplicator (const ConstNetworkEntityHandle &entityHandle)=0
 
virtual void DebugDraw () const =0
 Debug draw to visualize host entity domains.
 

Detailed Description

A class that determines if an entity should belong to a particular INetworkEntityManager.

Member Function Documentation

◆ GetAabb()

virtual const AZ::Aabb& Multiplayer::IEntityDomain::GetAabb ( ) const
pure virtual

Retrieves the aabb representing the domain area, an invalid aabb will be returned for non-spatial domains.

Returns
the aabb associated with this entity domain

Implemented in Multiplayer::NullEntityDomain, and Multiplayer::FullOwnershipEntityDomain.

◆ HandleLossOfAuthoritativeReplicator()

virtual void Multiplayer::IEntityDomain::HandleLossOfAuthoritativeReplicator ( const ConstNetworkEntityHandle &  entityHandle)
pure virtual

This method will be invoked whenever we unexpectedly lose the authoritative entity replicator for an entity. This gives our entity domain a chance to determine whether or not it should assume authority in this instance.

Parameters
entityHandlethe network entity handle of the entity that has lost its authoritative replicator

Implemented in Multiplayer::NullEntityDomain, and Multiplayer::FullOwnershipEntityDomain.

◆ IsInDomain()

virtual bool Multiplayer::IEntityDomain::IsInDomain ( const ConstNetworkEntityHandle &  entityHandle) const
pure virtual

Returns whether or not an entity should be owned by an entity manager.

Parameters
entityHandlethe handle of the netbound entity to check
Returns
false if this entity should not belong to the entity manger, true if it could be owned by the entity manager

Implemented in Multiplayer::NullEntityDomain, and Multiplayer::FullOwnershipEntityDomain.

◆ SetAabb()

virtual void Multiplayer::IEntityDomain::SetAabb ( const AZ::Aabb &  aabb)
pure virtual

For domains that operate on a region of space, this sets the area the domain is responsible for.

Parameters
aabbthe aabb associated with this entity domain

Implemented in Multiplayer::NullEntityDomain, and Multiplayer::FullOwnershipEntityDomain.

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