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 | List of all members
Multiplayer::FullOwnershipEntityDomain Class Reference

Inherits Multiplayer::IEntityDomain.

Public Member Functions

 FullOwnershipEntityDomain (const FullOwnershipEntityDomain &rhs)=default
 
void SetAabb (const AZ::Aabb &aabb) override
 
const AZ::Aabb & GetAabb () const override
 
bool IsInDomain (const ConstNetworkEntityHandle &entityHandle) const override
 
void HandleLossOfAuthoritativeReplicator (const ConstNetworkEntityHandle &entityHandle) override
 
void DebugDraw () const override
 Debug draw to visualize host entity domains.
 
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.
 

Member Function Documentation

◆ DebugDraw()

void Multiplayer::FullOwnershipEntityDomain::DebugDraw ( ) const
overridevirtual

Debug draw to visualize host entity domains.

Implements Multiplayer::IEntityDomain.

◆ GetAabb()

const AZ::Aabb & Multiplayer::FullOwnershipEntityDomain::GetAabb ( ) const
overridevirtual

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

Implements Multiplayer::IEntityDomain.

◆ HandleLossOfAuthoritativeReplicator()

void Multiplayer::FullOwnershipEntityDomain::HandleLossOfAuthoritativeReplicator ( const ConstNetworkEntityHandle &  entityHandle)
overridevirtual

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

Implements Multiplayer::IEntityDomain.

◆ IsInDomain()

bool Multiplayer::FullOwnershipEntityDomain::IsInDomain ( const ConstNetworkEntityHandle &  entityHandle) const
overridevirtual

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

Implements Multiplayer::IEntityDomain.

◆ SetAabb()

void Multiplayer::FullOwnershipEntityDomain::SetAabb ( const AZ::Aabb &  aabb)
overridevirtual

IEntityDomain overrides.

Implements Multiplayer::IEntityDomain.

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