Open 3D Engine AzFramework 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
AzFramework::RemoteToolsEndpointInfo Class Referencefinal

Public Member Functions

 AZ_CLASS_ALLOCATOR (RemoteToolsEndpointInfo, AZ::OSAllocator)
 
 AZ_TYPE_INFO (RemoteToolsEndpointInfo, "{DD0E9B2A-3B25-43B1-951E-CACCEC5D6754}")
 
 RemoteToolsEndpointInfo (AZStd::string displayName=AZStd::string{}, AZ::u32 networkId=0)
 
bool IsSelf () const
 
bool IsOnline () const
 
bool IsValid () const
 
const char * GetDisplayName () const
 
AZ::u32 GetPersistentId () const
 
AZ::u32 GetNetworkId () const
 
void SetInfo (AZStd::string displayName, AZ::u32 persistentId, AZ::u32 networkId)
 
bool IsIdentityEqualTo (const RemoteToolsEndpointInfo &other) const
 

Member Function Documentation

◆ GetDisplayName()

const char * AzFramework::RemoteToolsEndpointInfo::GetDisplayName ( ) const
inline

Gets the display name of this endpoint

Returns
A string display name of this endpoint

◆ GetNetworkId()

AZ::u32 AzFramework::RemoteToolsEndpointInfo::GetNetworkId ( ) const
inline

Gets the AzNetworking Network ID of this endpoint

Returns
The AzNetworking Network ID for the connection of this endpoint

◆ GetPersistentId()

AZ::u32 AzFramework::RemoteToolsEndpointInfo::GetPersistentId ( ) const
inline

Gets the Persistent ID of this endpoint

Returns
A Crc32 representing the Persistent ID of this endpoint

◆ IsOnline()

bool AzFramework::RemoteToolsEndpointInfo::IsOnline ( ) const
inline

Gets if this endpoint is online

Returns
true if this endpoint is online

◆ IsSelf()

bool AzFramework::RemoteToolsEndpointInfo::IsSelf ( ) const
inline

Gets if this endpoint is ourself

Returns
true if this endpoint is ourself

◆ IsValid()

bool AzFramework::RemoteToolsEndpointInfo::IsValid ( ) const
inline

Gets if this endpoint is valid

Returns
true if this endpoint is named, has a network ID and persistent ID

◆ SetInfo()

void AzFramework::RemoteToolsEndpointInfo::SetInfo ( AZStd::string  displayName,
AZ::u32  persistentId,
AZ::u32  networkId 
)
inline

Sets information used to determine validity of the endpoint

Parameters
displayNameThe string display name of this endpoint
persistentIdThe Crc32 based persistent ID of this endpoint
networkIdThe AzNetworking Network ID for this endpoint's connection
The documentation for this class was generated from the following files: