wavelength 1.0.0
Loading...
Searching...
No Matches
NetLobby Class Referenceabstract

The online lobby service: accounts, chat rooms, launchpads, and the remix repository. More...

#include <netlobby.h>

Inheritance diagram for NetLobby:

Public Member Functions

 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.
virtual void SetProfile (Campaign *pProfile)=0
 Take the name, the password, and the Freq of the local player.
virtual void Connect (MsgSink *pSink)=0
 Start connecting to the lobby server.
virtual void Login (MsgSink *pSink, int nLocation, const char *pszPassword)=0
 Start logging in the local player.
virtual void Disconnect (MsgSink *pSink)=0
 Start disconnecting from the lobby server.
virtual int GetAccountId ()=0
 Report the account of the local player.
virtual void CreateAccount (MsgSink *pSink, const char *pszPassword)=0
 Start creating an account for the local player.
virtual void DeleteAccount (MsgSink *pSink)=0
 Start deleting the account of the local player.
virtual void ChangePassword (MsgSink *pSink, const char *pszOldPassword, const char *pszNewPassword)=0
 Start changing the password of the local player.
virtual void RequestLobbyPlayers (MsgSink *pSink)=0
 Start listing the players of the current chat room.
virtual void RequestLaunchpadPlayers (MsgSink *pSink, int nLaunchpad)=0
 Start listing the players of a launchpad.
virtual void AddLadderListener (MsgSink *pSink, int nAccount)=0
 Add a listener the service reports ladder positions to.
virtual void SetMuted (int nAccount, bool bMuted)=0
 Mute or unmute the chat of a player.
virtual void RequestLaunchpads (MsgSink *pSink, int nStart, int nMode, const char *pszArena, int nRuleSet, int nSkillLevel)=0
 Start listing the launchpads of the lobby.
virtual void FindPlayer (MsgSink *pSink, const char *pszName)=0
 Start finding a player by name.
virtual void RequestChatrooms (MsgSink *pSink)=0
 Start listing the chat rooms of the lobby.
virtual void JoinChatroom (MsgSink *pSink, int nChatroomId)=0
 Join a chat room.
virtual void CreateChatroom (MsgSink *pSink, const String &name)=0
 Start creating a chat room and joining it.
virtual void RequestRanks (MsgSink *pSink, int nCount, int nDirection, int nMode)=0
 Start listing a page of the ranking.
virtual void UploadRemix (MsgSink *pSink, const char *pszNote)=0
 Start uploading the current remix to the repository.
virtual void RequestRemixes (MsgSink *pSink)=0
 Start listing the remixes of the repository.
virtual void DownloadRemix (MsgSink *pSink, const char *pszName)=0
 Start downloading a remix from the repository.
virtual void RequestFiles (MsgSink *pSink, int nRemixes)=0
 Start listing the files of the repository.
virtual void UploadDirectory (MsgSink *pSink, std::list< NetRepoRemix > *pRemixes)=0
 Start uploading the remix directory to the repository, in place of the stored directory.
virtual void DeleteFile (MsgSink *pSink, const char *pszName)=0
 Start deleting a file of the repository.
MsgSink * GetSink () const

Detailed Description

The online lobby service: accounts, chat rooms, launchpads, and the remix repository.

The RTTI includes the name. LobbyRT implements it, and TheNetLobby points at the one instance. Each request reports its result to the receiver it is given, as a message such as LobbyConnectResultMsg or LoginResultMsg. The member names other than SetSink() are inferred.

Constructor & Destructor Documentation

◆ NetLobby()

NetLobby::NetLobby ( )
inline

Construct a service with no receiver.

Inline.

◆ ~NetLobby()

virtual NetLobby::~NetLobby ( )
inlinevirtual

Release the service.

Inline.

Ghidra address:
NTSC-U/C: 0x0039af08
Ghidra address:
PAL: 0x00409b50

Member Function Documentation

◆ SetSink()

virtual void NetLobby::SetSink ( MsgSink * pSink)
inlinevirtual

Make a sink the receiver of the lobby's result messages.

Vtable slot 2.

Inline.

Parameters
pSinkThe sink.
Ghidra address:
NTSC-U/C: 0x0039afb0
Ghidra address:
PAL: 0x00409bf8

◆ SetProfile()

virtual void NetLobby::SetProfile ( Campaign * pProfile)
pure virtual

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

Parameters
pProfileThe profile of the player.

Implemented in LobbyRT.

◆ Connect()

virtual void NetLobby::Connect ( MsgSink * pSink)
pure virtual

Start connecting to the lobby server.

Parameters
pSinkThe receiver of the LobbyConnectResultMsg.

Implemented in LobbyRT.

◆ Login()

virtual void NetLobby::Login ( MsgSink * pSink,
int nLocation,
const char * pszPassword )
pure virtual

Start logging in the local player.

Parameters
pSinkThe receiver of the LoginResultMsg.
nLocationThe identifier of the lobby location the player chose.
pszPasswordThe password.

Implemented in LobbyRT.

◆ Disconnect()

virtual void NetLobby::Disconnect ( MsgSink * pSink)
pure virtual

Start disconnecting from the lobby server.

Parameters
pSinkThe receiver of the LobbyDisconnectResultMsg.

Implemented in LobbyRT.

◆ GetAccountId()

virtual int NetLobby::GetAccountId ( )
pure virtual

Report the account of the local player.

Returns
The account identifier.

Implemented in LobbyRT.

◆ CreateAccount()

virtual void NetLobby::CreateAccount ( MsgSink * pSink,
const char * pszPassword )
pure virtual

Start creating an account for the local player.

Parameters
pSinkThe receiver of the CreateAccountResultMsg.
pszPasswordThe password of the account.

Implemented in LobbyRT.

◆ DeleteAccount()

virtual void NetLobby::DeleteAccount ( MsgSink * pSink)
pure virtual

Start deleting the account of the local player.

Parameters
pSinkThe receiver of the DeleteAccountResultMsg.

Implemented in LobbyRT.

◆ ChangePassword()

virtual void NetLobby::ChangePassword ( MsgSink * pSink,
const char * pszOldPassword,
const char * pszNewPassword )
pure virtual

Start changing the password of the local player.

Parameters
pSinkThe receiver of the ChangePasswordResultMsg.
pszOldPasswordThe current password.
pszNewPasswordThe new password.

Implemented in LobbyRT.

◆ RequestLobbyPlayers()

virtual void NetLobby::RequestLobbyPlayers ( MsgSink * pSink)
pure virtual

Start listing the players of the current chat room.

Parameters
pSinkThe receiver of the LobbyPlayersMsg.

Implemented in LobbyRT.

◆ RequestLaunchpadPlayers()

virtual void NetLobby::RequestLaunchpadPlayers ( MsgSink * pSink,
int nLaunchpad )
pure virtual

Start listing the players of a launchpad.

The name is inferred.

Parameters
pSinkThe receiver of the LobbyPlayersMsg.
nLaunchpadThe identifier of the launchpad.

Implemented in LobbyRT.

◆ AddLadderListener()

virtual void NetLobby::AddLadderListener ( MsgSink * pSink,
int nAccount )
pure virtual

Add a listener the service reports ladder positions to.

Parameters
pSinkThe listener.
nAccountThe account of the player.

Implemented in LobbyRT.

◆ SetMuted()

virtual void NetLobby::SetMuted ( int nAccount,
bool bMuted )
pure virtual

Mute or unmute the chat of a player.

Parameters
nAccountThe account of the player.
bMutedWhether the player is muted.

Implemented in LobbyRT.

◆ RequestLaunchpads()

virtual void NetLobby::RequestLaunchpads ( MsgSink * pSink,
int nStart,
int nMode,
const char * pszArena,
int nRuleSet,
int nSkillLevel )
pure virtual

Start listing the launchpads of the lobby.

The main lobby passes 4, 1, an empty arena, 0, and -1.

Parameters
pSinkThe receiver of the LobbyLaunchpadsMsg.
nStartThe position of the list, or a count.
nModeNot yet identified.
pszArenaThe arena of the search, or an empty string for any.
nRuleSetThe game mode of the search.
nSkillLevelThe skill level of the search, or -1 for any.

Implemented in LobbyRT.

◆ FindPlayer()

virtual void NetLobby::FindPlayer ( MsgSink * pSink,
const char * pszName )
pure virtual

Start finding a player by name.

Parameters
pSinkThe receiver of the FindPlayerMsg.
pszNameThe name of the player.

Implemented in LobbyRT.

◆ RequestChatrooms()

virtual void NetLobby::RequestChatrooms ( MsgSink * pSink)
pure virtual

Start listing the chat rooms of the lobby.

Parameters
pSinkThe receiver of the LobbyChatroomsMsg.

Implemented in LobbyRT.

◆ JoinChatroom()

virtual void NetLobby::JoinChatroom ( MsgSink * pSink,
int nChatroomId )
pure virtual

Join a chat room.

Vtable slot 18.

The result arrives at pSink as a JoinChatroomResultMsg. The name is inferred.

Parameters
pSinkThe sink that receives the result.
nChatroomIdThe identifier of the room.

Implemented in LobbyRT.

◆ CreateChatroom()

virtual void NetLobby::CreateChatroom ( MsgSink * pSink,
const String & name )
pure virtual

Start creating a chat room and joining it.

Parameters
pSinkThe receiver of the JoinChatroomResultMsg.
nameThe name of the chat room.

Implemented in LobbyRT.

◆ RequestRanks()

virtual void NetLobby::RequestRanks ( MsgSink * pSink,
int nCount,
int nDirection,
int nMode )
pure virtual

Start listing a page of the ranking.

Parameters
pSinkThe receiver of the LobbyPlayersMsg.
nCountThe most players to list.
nDirection0 for the top of the ranking, 1 for the next page, or 3 for the previous page.
nModeNot yet identified. The ten best players are listed with 1, the ranking screen with 0.

Implemented in LobbyRT.

◆ UploadRemix()

virtual void NetLobby::UploadRemix ( MsgSink * pSink,
const char * pszNote )
pure virtual

Start uploading the current remix to the repository.

Parameters
pSinkThe receiver of the RepoRemixStatusMsg.
pszNoteThe note of the remix.

Implemented in LobbyRT.

◆ RequestRemixes()

virtual void NetLobby::RequestRemixes ( MsgSink * pSink)
pure virtual

Start listing the remixes of the repository.

Parameters
pSinkThe receiver of the RepoRemixesMsg.

Implemented in LobbyRT.

◆ DownloadRemix()

virtual void NetLobby::DownloadRemix ( MsgSink * pSink,
const char * pszName )
pure virtual

Start downloading a remix from the repository.

Parameters
pSinkThe receiver of the RemixDownloadMsg.
pszNameThe name of the remix.

Implemented in LobbyRT.

◆ RequestFiles()

virtual void NetLobby::RequestFiles ( MsgSink * pSink,
int nRemixes )
pure virtual

Start listing the files of the repository.

Parameters
pSinkThe receiver of the FileListMsg.
nRemixesNon-zero to list only the uploaded remixes.

Implemented in LobbyRT.

◆ UploadDirectory()

virtual void NetLobby::UploadDirectory ( MsgSink * pSink,
std::list< NetRepoRemix > * pRemixes )
pure virtual

Start uploading the remix directory to the repository, in place of the stored directory.

Parameters
pSinkThe receiver of the RepoRemixStatusMsg.
pRemixesThe remixes of the directory.

Implemented in LobbyRT.

◆ DeleteFile()

virtual void NetLobby::DeleteFile ( MsgSink * pSink,
const char * pszName )
pure virtual

Start deleting a file of the repository.

Parameters
pSinkThe receiver of the RepoRemixStatusMsg.
pszNameThe name of the file.

Implemented in LobbyRT.

◆ GetSink()

MsgSink * NetLobby::GetSink ( ) const
inline
Returns
The receiver of the result messages.

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