wavelength 1.0.0
Loading...
Searching...
No Matches
LobbyPlayer Class Reference

A player of the lobby server, as FindPlayerMsg reports it. More...

#include <lobbyplayer.h>

Public Types

enum  ConnectionType { kConnectionNone = 0 , kConnectionSlow = 1 , kConnectionFast = 2 , kConnectionOffline = 3 }
 Values of mConnectionType. More...

Public Member Functions

 LobbyPlayer ()
 Construct a player with no name, the default Freq, and no rank.
bool IsNewbie () const
 Report whether the player is new to the online game.
void SetRating (const RatingStat *pStat)
 Take the rating and the record of a rated player.
const AvatarPartSet & GetAvatar () const
AvatarPartSet & GetAvatar ()
void SetAvatar (const AvatarPartSet &avatar)
int GetChannelId () const
void SetChannelId (int nChannelId)
int GetConnectionType () const
void SetConnectionType (int nConnectionType)
int GetGames () const
void SetGames (int nGames)
int GetId () const
void SetId (int nId)
const DateTime & GetLastOnline () const
DateTime & GetLastOnline ()
void SetLastOnline (const DateTime &lastOnline)
int GetMuted () const
void SetMuted (int nMuted)
const String & GetName () const
String & GetName ()
void SetName (const char *pszName)
int GetRank () const
void SetRank (int nRank)
int GetRankIcon () const
void SetRankIcon (int nRankIcon)
int GetRating () const
void SetRating (int nRating)
const RatingRecord & GetRecord () const
RatingRecord & GetRecord ()
void SetRecord (const RatingRecord &record)

Detailed Description

A player of the lobby server, as FindPlayerMsg reports it.

The class has no RTTI, and the name is inferred. The object is 0x88 bytes.

Member Enumeration Documentation

◆ ConnectionType

Values of mConnectionType.

Enumerator
kConnectionNone 

No connection is known.

kConnectionSlow 

A slow connection.

kConnectionFast 

A fast connection.

kConnectionOffline 

The player is offline.

Constructor & Destructor Documentation

◆ LobbyPlayer()

LobbyPlayer::LobbyPlayer ( )

Construct a player with no name, the default Freq, and no rank.

Ghidra address:
NTSC-U/C: 0x002688b0
Ghidra address:
PAL: 0x00272508

Member Function Documentation

◆ IsNewbie()

bool LobbyPlayer::IsNewbie ( ) const

Report whether the player is new to the online game.

A player leaves the first games behind once mRating gains 1000000.

Returns
Whether mRating is at most 999999.
Ghidra address:
NTSC-U/C: 0x00268958
Ghidra address:
PAL: 0x002725b0

◆ SetRating() [1/2]

void LobbyPlayer::SetRating ( const RatingStat * pStat)

Take the rating and the record of a rated player.

The name is inferred.

Parameters
pStatThe player's stats after RatingStat::Rate().
Ghidra address:
NTSC-U/C: 0x0026aa70
Ghidra address:
PAL: 0x00274600

◆ GetAvatar() [1/2]

const AvatarPartSet & LobbyPlayer::GetAvatar ( ) const
inline
Returns
The player's Freq.

◆ GetAvatar() [2/2]

AvatarPartSet & LobbyPlayer::GetAvatar ( )
inline
Returns
The player's Freq, for filling.

◆ SetAvatar()

void LobbyPlayer::SetAvatar ( const AvatarPartSet & avatar)
inline
Parameters
avatarThe player's Freq.

◆ GetChannelId()

int LobbyPlayer::GetChannelId ( ) const
inline
Returns
The chat channel the player is in, or -1.

◆ SetChannelId()

void LobbyPlayer::SetChannelId ( int nChannelId)
inline
Parameters
nChannelIdThe chat channel the player is in, or -1.

◆ GetConnectionType()

int LobbyPlayer::GetConnectionType ( ) const
inline
Returns
The kind of network connection, 0 to 3.

◆ SetConnectionType()

void LobbyPlayer::SetConnectionType ( int nConnectionType)
inline
Parameters
nConnectionTypeThe kind of network connection, 0 to 3.

◆ GetGames()

int LobbyPlayer::GetGames ( ) const
inline
Returns
The number of online games played.

◆ SetGames()

void LobbyPlayer::SetGames ( int nGames)
inline
Parameters
nGamesThe number of online games played.

◆ GetId()

int LobbyPlayer::GetId ( ) const
inline
Returns
The account identifier.

◆ SetId()

void LobbyPlayer::SetId ( int nId)
inline
Parameters
nIdThe account identifier.

◆ GetLastOnline() [1/2]

const DateTime & LobbyPlayer::GetLastOnline ( ) const
inline
Returns
When the player was last online.

◆ GetLastOnline() [2/2]

DateTime & LobbyPlayer::GetLastOnline ( )
inline
Returns
When the player was last online, for filling.

◆ SetLastOnline()

void LobbyPlayer::SetLastOnline ( const DateTime & lastOnline)
inline
Parameters
lastOnlineWhen the player was last online.

◆ GetMuted()

int LobbyPlayer::GetMuted ( ) const
inline
Returns
Non-zero when this console mutes the player's chat.

◆ SetMuted()

void LobbyPlayer::SetMuted ( int nMuted)
inline
Parameters
nMutedNon-zero when this console mutes the player's chat.

◆ GetName() [1/2]

const String & LobbyPlayer::GetName ( ) const
inline
Returns
The account name.

◆ GetName() [2/2]

String & LobbyPlayer::GetName ( )
inline
Returns
The account name, for filling.

◆ SetName()

void LobbyPlayer::SetName ( const char * pszName)
inline
Parameters
nameThe account name.

◆ GetRank()

int LobbyPlayer::GetRank ( ) const
inline
Returns
The position in the ranking.

◆ SetRank()

void LobbyPlayer::SetRank ( int nRank)
inline
Parameters
nRankThe position in the ranking.

◆ GetRankIcon()

int LobbyPlayer::GetRankIcon ( ) const
inline
Returns
The rank icon FindRankMaterial() finds, -1 to 3.

◆ SetRankIcon()

void LobbyPlayer::SetRankIcon ( int nRankIcon)
inline
Parameters
nRankIconThe rank icon FindRankMaterial() finds, -1 to 3.

◆ GetRating()

int LobbyPlayer::GetRating ( ) const
inline
Returns
The rating, plus 1000000 once the player is no longer new.

◆ SetRating() [2/2]

void LobbyPlayer::SetRating ( int nRating)
inline
Parameters
nRatingThe rating.

◆ GetRecord() [1/2]

const RatingRecord & LobbyPlayer::GetRecord ( ) const
inline
Returns
The results the next rating weighs.

◆ GetRecord() [2/2]

RatingRecord & LobbyPlayer::GetRecord ( )
inline
Returns
The results the next rating weighs, for filling.

◆ SetRecord()

void LobbyPlayer::SetRecord ( const RatingRecord & record)
inline
Parameters
recordThe results the next rating weighs.

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