Cavestory Mod API
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
CaveNet::DataStructures::PSSortableClient Class Reference

A pointer-safe sortable client. More...

#include <CaveNet_ExportedTypes.h>

Public Member Functions

 PSSortableClient (int key)
 Constructor used to find an entry. More...
 
 PSSortableClient (NetClientId ghostId, int key)
 Real constructor. More...
 
 PSSortableClient ()
 Default constructor.
 
NetClientGetClient (bool Server)
 Get the client associated with this. More...
 
NetClientGetClient (bool Server) const
 Get the client associated with this. More...
 

Public Attributes

NetClientId m_GhostId
 The client's ghost id.
 
int m_Key
 The key for this.
 

Protected Member Functions

bool operator< (const PSSortableClient &other) const
 
bool operator<= (const PSSortableClient &other) const
 
bool operator> (const PSSortableClient &other) const
 
bool operator>= (const PSSortableClient &other) const
 
bool operator!= (const PSSortableClient &other) const
 
bool operator== (const PSSortableClient &other) const
 

Detailed Description

A pointer-safe sortable client.

This class is to be used with DynamicSortedBinList and SortedBinList.

Constructor & Destructor Documentation

◆ PSSortableClient() [1/2]

CaveNet::DataStructures::PSSortableClient::PSSortableClient ( int  key)
inline

Constructor used to find an entry.

Parameters
key...

◆ PSSortableClient() [2/2]

CaveNet::DataStructures::PSSortableClient::PSSortableClient ( NetClientId  ghostId,
int  key 
)
inline

Real constructor.

Parameters
ghostId...
key...

Member Function Documentation

◆ GetClient() [1/2]

NetClient* CaveNet::DataStructures::PSSortableClient::GetClient ( bool  Server)

Get the client associated with this.

Parameters
ServerWhether or not to check the server-side client container instead of the client-side client container.
Returns
NetClient* Returns the found client. Returns NULL if no client with this ghost ID could be found.

◆ GetClient() [2/2]

NetClient* CaveNet::DataStructures::PSSortableClient::GetClient ( bool  Server) const

Get the client associated with this.

Parameters
ServerWhether or not to check the server-side client container instead of the client-side client container.
Returns
NetClient* Returns the found client. Returns NULL if no client with this ghost ID could be found.

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