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

The online lobby service on the SCE-RT lobby server. More...

#include <lobbyrt.h>

Inheritance diagram for LobbyRT:
Collaboration diagram for LobbyRT:

Public Types

enum  DisconnectReason { kReasonDisconnect = 0 , kReasonConnect = 1 , kReasonLogin = 2 , kReasonLost = 3 }
 Values of mDisconnectReason, the result Poll() reports once mDisconnectTask finishes. More...
enum  TransferMode {
  kTransferNone = 0 , kTransferDirectory = 1 , kTransferRemix = 2 , kTransferUploadRemix = 3 ,
  kTransferUploadDirectory = 4 , kTransferList = 5 , kTransferDelete = 6
}
 Values of mTransferMode. More...
enum  PageDirection {
  kPageFirst = 0 , kPageNext = 1 , kPageCurrent = 2 , kPagePrevious = 3 ,
  kPageFirstAll = 4
}
 Values of the direction of Page(). More...

Public Member Functions

 LobbyRT ()
 Construct the service, read server.cfg, and build the chain of each request.
 ~LobbyRT () override
 Release the service.
void SetProfile (Campaign *pProfile) override
 Vtable slot 3.
void Connect (MsgSink *pSink) override
 Vtable slot 4.
void Login (MsgSink *pSink, int nLocation, const char *pszPassword) override
 Vtable slot 5.
void Disconnect (MsgSink *pSink) override
 Vtable slot 6.
int GetAccountId () override
 Vtable slot 7.
void CreateAccount (MsgSink *pSink, const char *pszPassword) override
 Vtable slot 8.
void DeleteAccount (MsgSink *pSink) override
 Vtable slot 9.
void ChangePassword (MsgSink *pSink, const char *pszOldPassword, const char *pszNewPassword) override
 Vtable slot 10.
void RequestLobbyPlayers (MsgSink *pSink) override
 Vtable slot 11.
void RequestLaunchpadPlayers (MsgSink *pSink, int nLaunchpad) override
 Vtable slot 12.
void AddLadderListener (MsgSink *pSink, int nAccount) override
 Vtable slot 13.
void SetMuted (int nAccount, bool bMuted) override
 Vtable slot 14.
void RequestLaunchpads (MsgSink *pSink, int nStart, int nMode, const char *pszArena, int nRuleSet, int nSkillLevel) override
 Vtable slot 15.
void FindPlayer (MsgSink *pSink, const char *pszName) override
 Vtable slot 16.
void RequestChatrooms (MsgSink *pSink) override
 Vtable slot 17.
void JoinChatroom (MsgSink *pSink, int nChatroomId) override
 Vtable slot 18.
void CreateChatroom (MsgSink *pSink, const String &name) override
 Vtable slot 19.
void RequestRanks (MsgSink *pSink, int nCount, int nDirection, int nMode) override
 Vtable slot 20.
void UploadRemix (MsgSink *pSink, const char *pszNote) override
 Vtable slot 21.
void RequestRemixes (MsgSink *pSink) override
 Vtable slot 22.
void DownloadRemix (MsgSink *pSink, const char *pszName) override
 Vtable slot 23.
void RequestFiles (MsgSink *pSink, int nRemixes) override
 Vtable slot 24.
void UploadDirectory (MsgSink *pSink, std::list< NetRepoRemix > *pRemixes) override
 Vtable slot 25.
void DeleteFile (MsgSink *pSink, const char *pszName) override
 Vtable slot 26.
void Poll ()
 Service the library and every request, and report the finished chains.
void Fail (MsgSink *pSink, int nResult, int nReason)
 Stop every request, forget the filters and the muted players, and start the chain of mDisconnectTask, which reports nResult as nReason requires.
void SetAccount (int nAccount, int nChannel, const rtNetConnectionInfo *pInfo)
 Take the account, the chat channel, and the connection a login or a join reports.
const char * GetName ()
 Report the name of the local player.
const char * GetPassword ()
 Report the password of the local player.
const char * GetPlayerStats ()
 Encode the record of the local player into mStatsText.
void UpdateStats (const LobbyPlayer *pPlayer)
 Take the rating, the games, the record, and the rank of the local player after a game, and add an AccountUpdateStatsTask to mTasks when any of them changed.
bool IsMuted (int nAccount)
 Report whether an account is in mMuted.
void LogNetError (int nLine, int nError)
 Record the result of a call to the peer-to-peer layer.
void LogMediusError (int nLine, int nError)
 Record the result of a call to the lobby client.
void ReportProgress (float fProgress)
 Send a RepoRemixStatusMsg with the progress to the running transfer.
int GetDisconnectReason () const
void SetDisconnectReason (int nValue)
int GetDisconnected () const
void SetDisconnected (int nValue)
NetMultiTask & GetConnectTask ()
NetMultiTask & GetDisconnectTask ()
NetMultiTask & GetLoginTask ()
TaskList & GetTasks ()
int GetRtReady () const
void SetRtReady (int nValue)
int GetMediusConnected () const
void SetMediusConnected (int nValue)
const String & GetSessionKey () const
void SetSessionKey (const char *pszSessionKey)
rtNetKeyPair & GetKeyPair ()
int GetSecure () const
void SetSecure (int nValue)
const char * GetServerName () const
void SetServerName (const char *pszValue)
int GetServerPort () const
void SetServerPort (int nValue)
const String & GetServerAddress () const
void SetServerAddress (const char *pszAddress)
int GetLocationId () const
void SetLocationId (int nValue)
int GetJoinChatroomId () const
void SetJoinChatroomId (int nValue)
String & GetNewChatroomName ()
const String & GetNewChatroomName () const
int GetLaunchpadsPageSize () const
int GetLaunchpadsPage () const
int GetLaunchpadId () const
void SetLaunchpadId (int nValue)
String & GetNewPassword ()
const String & GetNewPassword () const
std::vector< RTFilter > & GetFilters ()
const std::vector< RTFilter > & GetFilters () const
std::vector< RTFilter > & GetActiveFilters ()
const std::vector< RTFilter > & GetActiveFilters () const
int GetRanksPage () const
int GetRanksPageSize () const
int GetRanksMode () const
int GetTransferSize () const
void SetTransferSize (int nValue)
String & GetTransferName ()
char * GetTransferBuffer () const
void SetTransferBuffer (char *pValue)
LobbyPlayer & GetLocalPlayer ()
const LobbyPlayer & GetLocalPlayer () const
rtNetConnectionInfo & GetLobbyInfo ()
NetChatroomInfo & GetChatroom ()
const NetChatroomInfo & GetChatroom () const
std::list< LobbyPlayer > & GetLobbyPlayers ()
std::list< LobbyPlayer > & GetLaunchpadPlayers ()
std::list< LobbyPlayer > & GetRankedPlayers ()
std::list< NetLaunchpadInfo > & GetLaunchpads ()
std::list< NetChatroomInfo > & GetChatrooms ()
LobbyPlayer & GetFoundPlayer ()
const String & GetAnnouncement () const
void SetAnnouncement (const char *pszAnnouncement)
String & GetPolicy ()
const String & GetPolicy () const
void SetPolicy (const char *pszPolicy)
Public Member Functions inherited from NetLobby
 NetLobby ()
 Construct a service with no receiver.
virtual ~NetLobby ()
 Release the service.
virtual void SetSink (MsgSink *pSink)
 Make a sink the receiver of the lobby's result messages.
MsgSink * GetSink () const

Static Public Member Functions

static int ApplicationId ()
 Report the identifier of the game on the lobby server.
static void ReportNetError (int nLine, int nError)
 Pass the result of a call to the peer-to-peer layer to LogNetError() of TheLobbyRT.
static void ReportMediusError (int nLine, int nError)
 Pass the result of a call to the lobby client to LogMediusError() of TheLobbyRT.
static void AllowUnlimitedUpload (DataArray *pCommand, void *pUserData)
 The unlimited_upload script command, which lifts the limit of one upload a day.
static bool ReadNumber (int *pnValue, const char **ppszText, int *pnRemaining, int nDigits)
 Read a number of a fixed count of digits from encoded text.
static int ConnectionTypeOf (int nClass)
 Convert a connection class of the lobby server to a LobbyPlayer::ConnectionType.
static int ConnectionClassOf (int nType)
 Convert a NetInet::GetConnectionType() value to a connection class of the lobby server.
static void EncodeGameName (String *pName, const NetGameParams *pParams, int nPlayers, int nConnectionType, int nAccountId)
 Encode the settings of a game as the name the lobby server lists it by.
static void DecodeGameName (NetGameParams *pParams, int *pnPlayers, int *pnConnectionType, int *pnAccountId, const char *pszName)
 Decode the name EncodeGameName() writes.
static void EncodePlayer (String *pText, const LobbyPlayer *pPlayer)
 Encode the rating, the record, and the Freq of a player as the statistics text of the lobby server.
static void DecodePlayer (LobbyPlayer *pPlayer, const char *pszText)
 Decode the text EncodePlayer() writes.
static void EncodeRules (int *pnValue, int *pnComparison, int nRuleSet, int nSkillLevel)
 Encode a game mode and a skill level as a value of the rules field and its comparison.
static void EncodeSong (int *pnLevel, const char *pszSong)
 Encode a song as its number.
static void DecodeSong (NetGameParams *pParams, int nLevel)
 Set the song of the settings from its number, or clear it for an unknown number.
static int LaunchpadStatusOf (int nWorldStatus)
 Convert a state of a game on the lobby server to a NetLaunchpadInfo::Status.
static void Page (int *pnPage, int *pnPageSize, int nDirection, int nPageSize, int nLargePageSize, int nCount)
 Move a page of a list.

Static Public Attributes

static constexpr int kApplicationId = 10164
 The identifier of the game on the lobby server.
static int sUnlimitedUpload
 Non-zero once the unlimited_upload script command ran.

Detailed Description

The online lobby service on the SCE-RT lobby server.

The RTTI includes the name and records NetLobby as the base. The vtable is at 0x003d4e78 and the object is 0x690 bytes. Each request of NetLobby runs as a chain of steps in a NetMultiTask, and Poll() reports each finished chain to its receiver. The names of the members are inferred.

Member Enumeration Documentation

◆ DisconnectReason

Values of mDisconnectReason, the result Poll() reports once mDisconnectTask finishes.

Enumerator
kReasonDisconnect 

A LobbyDisconnectResultMsg.

kReasonConnect 

A failed LobbyConnectResultMsg.

kReasonLogin 

A failed LoginResultMsg.

kReasonLost 

A LobbyConnectionLostMsg.

◆ TransferMode

Values of mTransferMode.

Enumerator
kTransferNone 

No transfer.

kTransferDirectory 

Download of the remix directory.

kTransferRemix 

Download of a remix.

kTransferUploadRemix 

Upload of the current remix.

kTransferUploadDirectory 

Upload of the remix directory.

kTransferList 

List of the files.

kTransferDelete 

Deletion of a file.

◆ PageDirection

Values of the direction of Page().

Enumerator
kPageFirst 

The first page.

kPageNext 

The next page, unless the current page is short.

kPageCurrent 

The current page, or the first when nothing is listed.

kPagePrevious 

The previous page.

kPageFirstAll 

The first page, in the large size.

Constructor & Destructor Documentation

◆ LobbyRT()

LobbyRT::LobbyRT ( )

Construct the service, read server.cfg, and build the chain of each request.

Ghidra address:
NTSC-U/C: 0x0025d7f0
Ghidra address:
PAL: 0x00266888

◆ ~LobbyRT()

LobbyRT::~LobbyRT ( )
override

Release the service.

Ghidra address:
NTSC-U/C: 0x0025ed98
Ghidra address:
PAL: 0x00267e78

Member Function Documentation

◆ ApplicationId()

int LobbyRT::ApplicationId ( )
inlinestatic

Report the identifier of the game on the lobby server.

Inline at each use.

Returns
The identifier.

◆ SetProfile()

void LobbyRT::SetProfile ( Campaign * pProfile)
overridevirtual

Vtable slot 3.

Take the name and the Freq of the local player, and forget the password.

Parameters
pProfileThe profile of the player.
Ghidra address:
NTSC-U/C: 0x0025f248
Ghidra address:
PAL: 0x00268328

Implements NetLobby.

◆ Connect()

void LobbyRT::Connect ( MsgSink * pSink)
overridevirtual

Vtable slot 4.

Start the chain of mConnectTask.

Parameters
pSinkThe receiver of the LobbyConnectResultMsg.
Ghidra address:
NTSC-U/C: 0x0025f2c8
Ghidra address:
PAL: 0x002683a8

Implements NetLobby.

◆ Login()

void LobbyRT::Login ( MsgSink * pSink,
int nLocation,
const char * pszPassword )
overridevirtual

Vtable slot 5.

Reset the record of the local player and start the chain of mLoginTask.

Parameters
pSinkThe receiver of the LoginResultMsg.
nLocationThe identifier of the lobby location.
pszPasswordThe password.
Ghidra address:
NTSC-U/C: 0x0025f310
Ghidra address:
PAL: 0x002683f0

Implements NetLobby.

◆ Disconnect()

void LobbyRT::Disconnect ( MsgSink * pSink)
overridevirtual

Vtable slot 6.

Stop every request and start the chain of mDisconnectTask.

Parameters
pSinkThe receiver of the LobbyDisconnectResultMsg.
Ghidra address:
NTSC-U/C: 0x0025f2a8
Ghidra address:
PAL: 0x00268388

Implements NetLobby.

◆ GetAccountId()

int LobbyRT::GetAccountId ( )
overridevirtual

Vtable slot 7.

Report the account of the local player.

Returns
The identifier of mLocalPlayer.
Ghidra address:
NTSC-U/C: 0x0025f4b0
Ghidra address:
PAL: 0x00268590

Implements NetLobby.

◆ CreateAccount()

void LobbyRT::CreateAccount ( MsgSink * pSink,
const char * pszPassword )
overridevirtual

Vtable slot 8.

Start the chain of mCreateAccountTask.

Parameters
pSinkThe receiver of the CreateAccountResultMsg.
pszPasswordThe password of the account.
Ghidra address:
NTSC-U/C: 0x0025f4b8
Ghidra address:
PAL: 0x00268598

Implements NetLobby.

◆ DeleteAccount()

void LobbyRT::DeleteAccount ( MsgSink * pSink)
overridevirtual

Vtable slot 9.

Start the chain of mDeleteAccountTask.

Parameters
pSinkThe receiver of the DeleteAccountResultMsg.
Ghidra address:
NTSC-U/C: 0x0025f500
Ghidra address:
PAL: 0x002685e0

Implements NetLobby.

◆ ChangePassword()

void LobbyRT::ChangePassword ( MsgSink * pSink,
const char * pszOldPassword,
const char * pszNewPassword )
overridevirtual

Vtable slot 10.

Start the chain of mChangePasswordTask.

Parameters
pSinkThe receiver of the ChangePasswordResultMsg.
pszOldPasswordThe current password.
pszNewPasswordThe new password.
Ghidra address:
NTSC-U/C: 0x0025f520
Ghidra address:
PAL: 0x00268600

Implements NetLobby.

◆ RequestLobbyPlayers()

void LobbyRT::RequestLobbyPlayers ( MsgSink * pSink)
overridevirtual

Vtable slot 11.

Start the chain of mLobbyPlayersTask.

Parameters
pSinkThe receiver of the LobbyPlayersMsg.
Ghidra address:
NTSC-U/C: 0x0025f828
Ghidra address:
PAL: 0x00268908

Implements NetLobby.

◆ RequestLaunchpadPlayers()

void LobbyRT::RequestLaunchpadPlayers ( MsgSink * pSink,
int nLaunchpad )
overridevirtual

Vtable slot 12.

Start the chain of mLaunchpadPlayersTask unless it is running.

Parameters
pSinkThe receiver of the LobbyPlayersMsg.
nLaunchpadThe identifier of the launchpad.
Ghidra address:
NTSC-U/C: 0x0025f8b0
Ghidra address:
PAL: 0x00268990

Implements NetLobby.

◆ AddLadderListener()

void LobbyRT::AddLadderListener ( MsgSink * pSink,
int nAccount )
overridevirtual

Vtable slot 13.

Add a LadderPosition2Task to mTasks.

Parameters
pSinkThe receiver of the PlayerRankMsg.
nAccountThe account of the player.
Ghidra address:
NTSC-U/C: 0x0025f848
Ghidra address:
PAL: 0x00268928

Implements NetLobby.

◆ SetMuted()

void LobbyRT::SetMuted ( int nAccount,
bool bMuted )
overridevirtual

Vtable slot 14.

Add an account to mMuted or remove it.

Parameters
nAccountThe account of the player.
bMutedWhether the player is muted.
Ghidra address:
NTSC-U/C: 0x0025f580
Ghidra address:
PAL: 0x00268660

Implements NetLobby.

◆ RequestLaunchpads()

void LobbyRT::RequestLaunchpads ( MsgSink * pSink,
int nStart,
int nMode,
const char * pszArena,
int nRuleSet,
int nSkillLevel )
overridevirtual

Vtable slot 15.

Build mFilters and start the chain of mLaunchpadsTask.

Parameters
pSinkThe receiver of the LobbyLaunchpadsMsg.
nStartOne of PageDirection.
nModeNon-zero to list the launchpads of the current chat room only.
pszArenaThe song of the search, or an empty string for any.
nRuleSetThe game mode of the search, or 0 for any.
nSkillLevelThe skill level of the search, or -1 for any.
Ghidra address:
NTSC-U/C: 0x0025f918
Ghidra address:
PAL: 0x002689f8

Implements NetLobby.

◆ FindPlayer()

void LobbyRT::FindPlayer ( MsgSink * pSink,
const char * pszName )
overridevirtual

Vtable slot 16.

Start the chain of mFindPlayerTask.

Parameters
pSinkThe receiver of the FindPlayerMsg.
pszNameThe name of the player.
Ghidra address:
NTSC-U/C: 0x002601d0
Ghidra address:
PAL: 0x002692b0

Implements NetLobby.

◆ RequestChatrooms()

void LobbyRT::RequestChatrooms ( MsgSink * pSink)
overridevirtual

Vtable slot 17.

Start the chain of mChatroomsTask.

Parameters
pSinkThe receiver of the LobbyChatroomsMsg.
Ghidra address:
NTSC-U/C: 0x00260218
Ghidra address:
PAL: 0x002692f8

Implements NetLobby.

◆ JoinChatroom()

void LobbyRT::JoinChatroom ( MsgSink * pSink,
int nChatroomId )
overridevirtual

Vtable slot 18.

Start the chain of mJoinChatroomTask.

Parameters
pSinkThe receiver of the JoinChatroomResultMsg.
nChatroomIdThe identifier of the room.
Ghidra address:
NTSC-U/C: 0x00260238
Ghidra address:
PAL: 0x00269318

Implements NetLobby.

◆ CreateChatroom()

void LobbyRT::CreateChatroom ( MsgSink * pSink,
const String & name )
overridevirtual

Vtable slot 19.

Start the chain of mCreateChatroomTask.

Parameters
pSinkThe receiver of the JoinChatroomResultMsg.
nameThe name of the chat room.
Ghidra address:
NTSC-U/C: 0x00260258
Ghidra address:
PAL: 0x00269338

Implements NetLobby.

◆ RequestRanks()

void LobbyRT::RequestRanks ( MsgSink * pSink,
int nCount,
int nDirection,
int nMode )
overridevirtual

Vtable slot 20.

Start the chain of mRanksTask unless it is running.

Parameters
pSinkThe receiver of the LobbyPlayersMsg.
nCountThe players of a page.
nDirectionOne of PageDirection.
nModeNon-zero to list the ranking without the details of the players.
Ghidra address:
NTSC-U/C: 0x002602a0
Ghidra address:
PAL: 0x00269380

Implements NetLobby.

◆ UploadRemix()

void LobbyRT::UploadRemix ( MsgSink * pSink,
const char * pszNote )
overridevirtual

Vtable slot 21.

Upload the current remix with a note, once a day.

Parameters
pSinkThe receiver of the RepoRemixStatusMsg.
pszNoteThe note of the remix.
Ghidra address:
NTSC-U/C: 0x00260368
Ghidra address:
PAL: 0x00269448

Implements NetLobby.

◆ RequestRemixes()

void LobbyRT::RequestRemixes ( MsgSink * pSink)
overridevirtual

Vtable slot 22.

Start downloading the remix directory.

Parameters
pSinkThe receiver of the RepoRemixesMsg.
Ghidra address:
NTSC-U/C: 0x002608e8
Ghidra address:
PAL: 0x002699c8

Implements NetLobby.

◆ DownloadRemix()

void LobbyRT::DownloadRemix ( MsgSink * pSink,
const char * pszName )
overridevirtual

Vtable slot 23.

Start downloading a remix.

Parameters
pSinkThe receiver of the RepoRemixStatusMsg and the RemixDownloadMsg.
pszNameThe file of the remix.
Ghidra address:
NTSC-U/C: 0x00260938
Ghidra address:
PAL: 0x00269a18

Implements NetLobby.

◆ RequestFiles()

void LobbyRT::RequestFiles ( MsgSink * pSink,
int nRemixes )
overridevirtual

Vtable slot 24.

Start the chain of mFileListTask.

Parameters
pSinkThe receiver of the FileListMsg.
nRemixesNon-zero to list only the files whose names begin with r_.
Ghidra address:
NTSC-U/C: 0x00260d18
Ghidra address:
PAL: 0x00269df8

Implements NetLobby.

◆ UploadDirectory()

void LobbyRT::UploadDirectory ( MsgSink * pSink,
std::list< NetRepoRemix > * pRemixes )
overridevirtual

Vtable slot 25.

Write the remix directory to a buffer and start uploading it.

Parameters
pSinkThe receiver of the RepoRemixStatusMsg.
pRemixesThe remixes of the directory.
Ghidra address:
NTSC-U/C: 0x00260650
Ghidra address:
PAL: 0x00269730

Implements NetLobby.

◆ DeleteFile()

void LobbyRT::DeleteFile ( MsgSink * pSink,
const char * pszName )
overridevirtual

Vtable slot 26.

Start the chain of mDeleteFileTask.

Parameters
pSinkThe receiver of the result.
pszNameThe file.
Ghidra address:
NTSC-U/C: 0x00260e60
Ghidra address:
PAL: 0x00269f50

Implements NetLobby.

◆ Poll()

void LobbyRT::Poll ( )

Service the library and every request, and report the finished chains.

Ghidra address:
NTSC-U/C: 0x00260f28
Ghidra address:
PAL: 0x0026a038

◆ Fail()

void LobbyRT::Fail ( MsgSink * pSink,
int nResult,
int nReason )

Stop every request, forget the filters and the muted players, and start the chain of mDisconnectTask, which reports nResult as nReason requires.

Parameters
pSinkThe receiver of the report.
nResultThe error reported.
nReasonOne of DisconnectReason.
Ghidra address:
NTSC-U/C: 0x00262708
Ghidra address:
PAL: 0x0026b860

◆ SetAccount()

void LobbyRT::SetAccount ( int nAccount,
int nChannel,
const rtNetConnectionInfo * pInfo )

Take the account, the chat channel, and the connection a login or a join reports.

Parameters
nAccountThe account of the local player.
nChannelThe chat channel.
pInfoThe connection to the lobby server.
Ghidra address:
NTSC-U/C: 0x002628b8
Ghidra address:
PAL: 0x0026ba10

◆ GetName()

const char * LobbyRT::GetName ( )

Report the name of the local player.

Returns
The name.
Ghidra address:
NTSC-U/C: 0x002629a0
Ghidra address:
PAL: 0x0026baf8

◆ GetPassword()

const char * LobbyRT::GetPassword ( )

Report the password of the local player.

Returns
mPassword.
Ghidra address:
NTSC-U/C: 0x002629a8
Ghidra address:
PAL: 0x0026bb00

◆ GetPlayerStats()

const char * LobbyRT::GetPlayerStats ( )

Encode the record of the local player into mStatsText.

Returns
mStatsText.
Ghidra address:
NTSC-U/C: 0x002629b0
Ghidra address:
PAL: 0x0026bb08

◆ UpdateStats()

void LobbyRT::UpdateStats ( const LobbyPlayer * pPlayer)

Take the rating, the games, the record, and the rank of the local player after a game, and add an AccountUpdateStatsTask to mTasks when any of them changed.

Parameters
pPlayerThe player after the game.
Ghidra address:
NTSC-U/C: 0x002629e0
Ghidra address:
PAL: 0x0026bb38

◆ IsMuted()

bool LobbyRT::IsMuted ( int nAccount)

Report whether an account is in mMuted.

Parameters
nAccountThe account.
Returns
Whether the account is muted.
Ghidra address:
NTSC-U/C: 0x00262ae8
Ghidra address:
PAL: 0x0026bc40

◆ LogNetError()

void LobbyRT::LogNetError ( int nLine,
int nError )

Record the result of a call to the peer-to-peer layer.

The body is empty.

Parameters
nLineThe line of the original source that made the call.
nErrorThe result.
Ghidra address:
NTSC-U/C: 0x00262b60
Ghidra address:
PAL: 0x0026bcb8

◆ LogMediusError()

void LobbyRT::LogMediusError ( int nLine,
int nError )

Record the result of a call to the lobby client.

The body is empty.

Parameters
nLineThe line of the original source that made the call.
nErrorThe result.
Ghidra address:
NTSC-U/C: 0x00262b68
Ghidra address:
PAL: 0x0026bcc0

◆ ReportNetError()

void LobbyRT::ReportNetError ( int nLine,
int nError )
inlinestatic

Pass the result of a call to the peer-to-peer layer to LogNetError() of TheLobbyRT.

Inline at each call.

Parameters
nLineThe line of the call.
nErrorThe result.

◆ ReportMediusError()

void LobbyRT::ReportMediusError ( int nLine,
int nError )
inlinestatic

Pass the result of a call to the lobby client to LogMediusError() of TheLobbyRT.

Inline at each call.

Parameters
nLineThe line of the call.
nErrorThe result.

◆ ReportProgress()

void LobbyRT::ReportProgress ( float fProgress)

Send a RepoRemixStatusMsg with the progress to the running transfer.

Parameters
fProgressThe part transferred, from 0 to 1.
Ghidra address:
NTSC-U/C: 0x00260eb8
Ghidra address:
PAL: 0x00269fa8

◆ AllowUnlimitedUpload()

void LobbyRT::AllowUnlimitedUpload ( DataArray * pCommand,
void * pUserData )
static

The unlimited_upload script command, which lifts the limit of one upload a day.

Parameters
pCommandThe command.
pUserDataNot read.
Ghidra address:
NTSC-U/C: 0x0025ccd8
Ghidra address:
PAL: 0x00265d38

◆ ReadNumber()

bool LobbyRT::ReadNumber ( int * pnValue,
const char ** ppszText,
int * pnRemaining,
int nDigits )
static

Read a number of a fixed count of digits from encoded text.

Parameters
pnValueReceives the number.
ppszTextThe text, advanced past the digits.
pnRemainingThe characters left, reduced by the digits.
nDigitsThe count of digits.
Returns
False, with nothing read, when fewer characters remain.
Ghidra address:
NTSC-U/C: 0x0025cce8
Ghidra address:
PAL: 0x00265d48

◆ ConnectionTypeOf()

int LobbyRT::ConnectionTypeOf ( int nClass)
static

Convert a connection class of the lobby server to a LobbyPlayer::ConnectionType.

Parameters
nClassThe connection class.
Returns
The type.
Ghidra address:
NTSC-U/C: 0x0025cd80
Ghidra address:
PAL: 0x00265de0

◆ ConnectionClassOf()

int LobbyRT::ConnectionClassOf ( int nType)
static

Convert a NetInet::GetConnectionType() value to a connection class of the lobby server.

Parameters
nTypeThe kind of connection.
Returns
The connection class.
Ghidra address:
NTSC-U/C: 0x0025cdc8
Ghidra address:
PAL: 0x00265e28

◆ EncodeGameName()

void LobbyRT::EncodeGameName ( String * pName,
const NetGameParams * pParams,
int nPlayers,
int nConnectionType,
int nAccountId )
static

Encode the settings of a game as the name the lobby server lists it by.

Parameters
pNameReceives the name.
pParamsThe settings.
nPlayersThe players in the game.
nConnectionTypeThe kind of connection of the host.
nAccountIdThe account of the host.
Ghidra address:
NTSC-U/C: 0x0025ce00
Ghidra address:
PAL: 0x00265e60

◆ DecodeGameName()

void LobbyRT::DecodeGameName ( NetGameParams * pParams,
int * pnPlayers,
int * pnConnectionType,
int * pnAccountId,
const char * pszName )
static

Decode the name EncodeGameName() writes.

Each output starts at its default, and decoding stops at the first field missing.

Parameters
pParamsReceives the settings.
pnPlayersReceives the players in the game.
pnConnectionTypeReceives the kind of connection of the host.
pnAccountIdReceives the account of the host.
pszNameThe name.
Ghidra address:
NTSC-U/C: 0x0025cec8
Ghidra address:
PAL: 0x00265f28

◆ EncodePlayer()

void LobbyRT::EncodePlayer ( String * pText,
const LobbyPlayer * pPlayer )
static

Encode the rating, the record, and the Freq of a player as the statistics text of the lobby server.

Parameters
pTextReceives the text.
pPlayerThe player.
Ghidra address:
NTSC-U/C: 0x0025d100
Ghidra address:
PAL: 0x00266160

◆ DecodePlayer()

void LobbyRT::DecodePlayer ( LobbyPlayer * pPlayer,
const char * pszText )
static

Decode the text EncodePlayer() writes.

Parameters
pPlayerReceives the rating, the record, and the Freq.
pszTextThe text.
Ghidra address:
NTSC-U/C: 0x0025d288
Ghidra address:
PAL: 0x002662e8

◆ EncodeRules()

void LobbyRT::EncodeRules ( int * pnValue,
int * pnComparison,
int nRuleSet,
int nSkillLevel )
static

Encode a game mode and a skill level as a value of the rules field and its comparison.

Another game mode writes nothing.

Parameters
pnValueReceives the value.
pnComparisonReceives one of RTFilter::Comparison.
nRuleSetThe game mode.
nSkillLevelThe skill level, or a negative value for any.
Ghidra address:
NTSC-U/C: 0x0025d5a0
Ghidra address:
PAL: 0x00266638

◆ EncodeSong()

void LobbyRT::EncodeSong ( int * pnLevel,
const char * pszSong )
static

Encode a song as its number.

Parameters
pnLevelReceives the number.
pszSongThe song.
Ghidra address:
NTSC-U/C: 0x0025d690
Ghidra address:
PAL: 0x00266728

◆ DecodeSong()

void LobbyRT::DecodeSong ( NetGameParams * pParams,
int nLevel )
static

Set the song of the settings from its number, or clear it for an unknown number.

Parameters
pParamsThe settings.
nLevelThe number.
Ghidra address:
NTSC-U/C: 0x0025d6d0
Ghidra address:
PAL: 0x00266768

◆ LaunchpadStatusOf()

int LobbyRT::LaunchpadStatusOf ( int nWorldStatus)
static

Convert a state of a game on the lobby server to a NetLaunchpadInfo::Status.

Parameters
nWorldStatusThe state.
Returns
kStatusOpen for an open game, otherwise kStatusBusy.
Ghidra address:
NTSC-U/C: 0x0025d738
Ghidra address:
PAL: 0x002667d0

◆ Page()

void LobbyRT::Page ( int * pnPage,
int * pnPageSize,
int nDirection,
int nPageSize,
int nLargePageSize,
int nCount )
static

Move a page of a list.

Parameters
pnPageThe page, from 0.
pnPageSizeReceives the entries of a page.
nDirectionOne of PageDirection. Another value changes nothing.
nPageSizeThe entries of a page.
nLargePageSizeThe entries of a page for kPageFirstAll.
nCountThe entries of the current page.
Ghidra address:
NTSC-U/C: 0x0025d768
Ghidra address:
PAL: 0x00266800

◆ GetDisconnectReason()

int LobbyRT::GetDisconnectReason ( ) const
inline
Returns
One of DisconnectReason.

◆ SetDisconnectReason()

void LobbyRT::SetDisconnectReason ( int nValue)
inline
Parameters
nValueOne of DisconnectReason.

◆ GetDisconnected()

int LobbyRT::GetDisconnected ( ) const
inline
Returns
Non-zero once the connection failed.

◆ SetDisconnected()

void LobbyRT::SetDisconnected ( int nValue)
inline
Parameters
nValueNon-zero once the connection failed.

◆ GetConnectTask()

NetMultiTask & LobbyRT::GetConnectTask ( )
inline
Returns
The chain of Connect().

◆ GetDisconnectTask()

NetMultiTask & LobbyRT::GetDisconnectTask ( )
inline
Returns
The chain of Disconnect() and Fail().

◆ GetLoginTask()

NetMultiTask & LobbyRT::GetLoginTask ( )
inline
Returns
The chain of Login().

◆ GetTasks()

TaskList & LobbyRT::GetTasks ( )
inline
Returns
The steps that run on their own.

◆ GetRtReady()

int LobbyRT::GetRtReady ( ) const
inline
Returns
Non-zero while the library is started.

◆ SetRtReady()

void LobbyRT::SetRtReady ( int nValue)
inline
Parameters
nValueNon-zero while the library is started.

◆ GetMediusConnected()

int LobbyRT::GetMediusConnected ( ) const
inline
Returns
Non-zero while the lobby server is connected.

◆ SetMediusConnected()

void LobbyRT::SetMediusConnected ( int nValue)
inline
Parameters
nValueNon-zero while the lobby server is connected.

◆ GetSessionKey()

const String & LobbyRT::GetSessionKey ( ) const
inline
Returns
The key of the lobby session.

◆ SetSessionKey()

void LobbyRT::SetSessionKey ( const char * pszSessionKey)
inline
Parameters
pszSessionKeyThe key of the lobby session.

◆ GetKeyPair()

rtNetKeyPair & LobbyRT::GetKeyPair ( )
inline
Returns
The key pair of the console.

◆ GetSecure()

int LobbyRT::GetSecure ( ) const
inline
Returns
Non-zero when the connection is encrypted.

◆ SetSecure()

void LobbyRT::SetSecure ( int nValue)
inline
Parameters
nValueNon-zero when the connection is encrypted.

◆ GetServerName()

const char * LobbyRT::GetServerName ( ) const
inline
Returns
The host name of the lobby server. Borrowed.

◆ SetServerName()

void LobbyRT::SetServerName ( const char * pszValue)
inline
Parameters
pszValueThe host name of the lobby server. Borrowed.

◆ GetServerPort()

int LobbyRT::GetServerPort ( ) const
inline
Returns
The port of the lobby server.

◆ SetServerPort()

void LobbyRT::SetServerPort ( int nValue)
inline
Parameters
nValueThe port of the lobby server.

◆ GetServerAddress()

const String & LobbyRT::GetServerAddress ( ) const
inline
Returns
The address the name of the server resolves to.

◆ SetServerAddress()

void LobbyRT::SetServerAddress ( const char * pszAddress)
inline
Parameters
pszAddressThe address the name of the server resolves to.

◆ GetLocationId()

int LobbyRT::GetLocationId ( ) const
inline
Returns
The location of the login.

◆ SetLocationId()

void LobbyRT::SetLocationId ( int nValue)
inline
Parameters
nValueThe location of the login.

◆ GetJoinChatroomId()

int LobbyRT::GetJoinChatroomId ( ) const
inline
Returns
The room JoinChatroom() joins.

◆ SetJoinChatroomId()

void LobbyRT::SetJoinChatroomId ( int nValue)
inline
Parameters
nValueThe room JoinChatroom() joins.

◆ GetNewChatroomName() [1/2]

String & LobbyRT::GetNewChatroomName ( )
inline
Returns
The name of the room CreateChatroom() creates.

◆ GetNewChatroomName() [2/2]

const String & LobbyRT::GetNewChatroomName ( ) const
inline
Returns
The name of the room CreateChatroom() creates.

◆ GetLaunchpadsPageSize()

int LobbyRT::GetLaunchpadsPageSize ( ) const
inline
Returns
The launchpads of a page.

◆ GetLaunchpadsPage()

int LobbyRT::GetLaunchpadsPage ( ) const
inline
Returns
The page of the launchpads, from 0.

◆ GetLaunchpadId()

int LobbyRT::GetLaunchpadId ( ) const
inline
Returns
The launchpad RequestLaunchpadPlayers() lists.

◆ SetLaunchpadId()

void LobbyRT::SetLaunchpadId ( int nValue)
inline
Parameters
nValueThe launchpad RequestLaunchpadPlayers() lists.

◆ GetNewPassword() [1/2]

String & LobbyRT::GetNewPassword ( )
inline
Returns
The password ChangePassword() sets.

◆ GetNewPassword() [2/2]

const String & LobbyRT::GetNewPassword ( ) const
inline
Returns
The password ChangePassword() sets.

◆ GetFilters() [1/2]

std::vector< RTFilter > & LobbyRT::GetFilters ( )
inline
Returns
The filters of the next list of launchpads.

◆ GetFilters() [2/2]

const std::vector< RTFilter > & LobbyRT::GetFilters ( ) const
inline
Returns
The filters of the next list of launchpads.

◆ GetActiveFilters() [1/2]

std::vector< RTFilter > & LobbyRT::GetActiveFilters ( )
inline
Returns
The filters the server applies.

◆ GetActiveFilters() [2/2]

const std::vector< RTFilter > & LobbyRT::GetActiveFilters ( ) const
inline
Returns
The filters the server applies.

◆ GetRanksPage()

int LobbyRT::GetRanksPage ( ) const
inline
Returns
The page of the ranking, from 0.

◆ GetRanksPageSize()

int LobbyRT::GetRanksPageSize ( ) const
inline
Returns
The players of a page of the ranking.

◆ GetRanksMode()

int LobbyRT::GetRanksMode ( ) const
inline
Returns
The mode of RequestRanks().

◆ GetTransferSize()

int LobbyRT::GetTransferSize ( ) const
inline
Returns
The size of the transfer buffer in bytes.

◆ SetTransferSize()

void LobbyRT::SetTransferSize ( int nValue)
inline
Parameters
nValueThe size of the transfer buffer in bytes.

◆ GetTransferName()

String & LobbyRT::GetTransferName ( )
inline
Returns
The file of the transfer.

◆ GetTransferBuffer()

char * LobbyRT::GetTransferBuffer ( ) const
inline
Returns
The bytes of the transfer, or null. Freed with PoolMemFree().

◆ SetTransferBuffer()

void LobbyRT::SetTransferBuffer ( char * pValue)
inline
Parameters
pValueThe bytes of the transfer, or null. Freed with PoolMemFree().

◆ GetLocalPlayer() [1/2]

LobbyPlayer & LobbyRT::GetLocalPlayer ( )
inline
Returns
The local player.

◆ GetLocalPlayer() [2/2]

const LobbyPlayer & LobbyRT::GetLocalPlayer ( ) const
inline
Returns
The local player.

◆ GetLobbyInfo()

rtNetConnectionInfo & LobbyRT::GetLobbyInfo ( )
inline
Returns
The connection to the lobby server.

◆ GetChatroom() [1/2]

NetChatroomInfo & LobbyRT::GetChatroom ( )
inline
Returns
The chat room of the local player.

◆ GetChatroom() [2/2]

const NetChatroomInfo & LobbyRT::GetChatroom ( ) const
inline
Returns
The chat room of the local player.

◆ GetLobbyPlayers()

std::list< LobbyPlayer > & LobbyRT::GetLobbyPlayers ( )
inline
Returns
The players of the chat room.

◆ GetLaunchpadPlayers()

std::list< LobbyPlayer > & LobbyRT::GetLaunchpadPlayers ( )
inline
Returns
The players of a launchpad.

◆ GetRankedPlayers()

std::list< LobbyPlayer > & LobbyRT::GetRankedPlayers ( )
inline
Returns
The page of the ranking.

◆ GetLaunchpads()

std::list< NetLaunchpadInfo > & LobbyRT::GetLaunchpads ( )
inline
Returns
The page of the launchpads.

◆ GetChatrooms()

std::list< NetChatroomInfo > & LobbyRT::GetChatrooms ( )
inline
Returns
The chat rooms.

◆ GetFoundPlayer()

LobbyPlayer & LobbyRT::GetFoundPlayer ( )
inline
Returns
The player FindPlayer() finds.

◆ GetAnnouncement()

const String & LobbyRT::GetAnnouncement ( ) const
inline
Returns
The news of the lobby server.

◆ SetAnnouncement()

void LobbyRT::SetAnnouncement ( const char * pszAnnouncement)
inline
Parameters
pszAnnouncementThe news of the lobby server.

◆ GetPolicy() [1/2]

String & LobbyRT::GetPolicy ( )
inline
Returns
The licence agreement of the lobby server.

◆ GetPolicy() [2/2]

const String & LobbyRT::GetPolicy ( ) const
inline
Returns
The licence agreement of the lobby server.

◆ SetPolicy()

void LobbyRT::SetPolicy ( const char * pszPolicy)
inline
Parameters
pszPolicyThe licence agreement of the lobby server.

Member Data Documentation

◆ kApplicationId

int LobbyRT::kApplicationId = 10164
staticconstexpr

The identifier of the game on the lobby server.

◆ sUnlimitedUpload

int LobbyRT::sUnlimitedUpload
static

Non-zero once the unlimited_upload script command ran.

Ghidra address:
NTSC-U/C: 0x003b0af4
Ghidra address:
PAL: 0x0042f9c0

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