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

Message that delivers the players of an online session the lobby lists. More...

#include <lobbyplayersmsg.h>

Inheritance diagram for LobbyPlayersMsg:
Collaboration diagram for LobbyPlayersMsg:

Public Member Functions

 ~LobbyPlayersMsg () override=default
 Destroy the object.
 LobbyPlayersMsg (std::list< LobbyPlayer > *pPlayers, int nLaunchpad, int nHasPrevious)
 Construct a message that points at the players.
void * operator new (size_t nSize)
 Allocate a message, billed to the class name.
void operator delete (void *pBlock)
 Release a message.
Message * Clone () override
 Produce a heap copy of this message, which points at the same players.
int Type () override
 Report this message's registered identity.
const char * GetName () const override
 Report this message's class name.
void PrintExtra (PrnStream &stream) const override
 Write the session when there is one, and the players.
int GetHasPrevious () const
int GetLaunchpad () const
std::list< LobbyPlayer > * GetPlayers () const
Public Member Functions inherited from Message
virtual ~Message ()
 Vtable slot 1.
virtual void saveGuts (BinStream &stream) const
 Write this message's payload to a stream.
virtual void restoreGuts (BinStream &stream)
 Read this message's payload from a stream.
virtual ~Message ()
virtual void Unused1 ()
 Not called by the control.

Static Public Attributes

static constexpr int kNoLaunchpad = -1
 The value of mLaunchpad when the players are not those of a session.

Additional Inherited Members

Static Public Member Functions inherited from Message
static Message * NewMessage (int nType)
 Produce a message of the identified class through the factory list.

Detailed Description

Message that delivers the players of an online session the lobby lists.

The RTTI records the class as deriving from Message. The vtable is at 0x003d6240. The members Clone(), Type(), and GetName() are inline.

Constructor & Destructor Documentation

◆ ~LobbyPlayersMsg()

LobbyPlayersMsg::~LobbyPlayersMsg ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0039e7a0
Ghidra address:
PAL: 0x0040d480

◆ LobbyPlayersMsg()

LobbyPlayersMsg::LobbyPlayersMsg ( std::list< LobbyPlayer > * pPlayers,
int nLaunchpad,
int nHasPrevious )
inline

Construct a message that points at the players.

Inline.

Parameters
pPlayersThe players. The caller retains them.
nLaunchpadThe session, or kNoLaunchpad.
nHasPreviousNon-zero when more players precede a ranking page.

Member Function Documentation

◆ operator new()

void * LobbyPlayersMsg::operator new ( size_t nSize)
inline

Allocate a message, billed to the class name.

Parameters
nSizeThe object size the compiler supplies.
Returns
The block.

◆ operator delete()

void LobbyPlayersMsg::operator delete ( void * pBlock)
inline

Release a message.

Parameters
pBlockThe block.

◆ Clone()

Message * LobbyPlayersMsg::Clone ( )
inlineoverridevirtual

Produce a heap copy of this message, which points at the same players.

Returns
The copy.

Implements Message.

◆ Type()

int LobbyPlayersMsg::Type ( )
inlineoverridevirtual

Report this message's registered identity.

Returns
g_nLobbyPlayersMsgType.

Implements Message.

◆ GetName()

const char * LobbyPlayersMsg::GetName ( ) const
inlineoverridevirtual

Report this message's class name.

Returns
The literal LobbyPlayersMsg.

Implements Message.

◆ PrintExtra()

void LobbyPlayersMsg::PrintExtra ( PrnStream & stream) const
overridevirtual

Write the session when there is one, and the players.

Parameters
streamThe stream to write to.
Ghidra address:
NTSC-U/C: 0x00268e20
Ghidra address:
PAL: 0x00272a28

Reimplemented from Message.

◆ GetHasPrevious()

int LobbyPlayersMsg::GetHasPrevious ( ) const
inline
Returns
Non-zero when more players precede a ranking page.

◆ GetLaunchpad()

int LobbyPlayersMsg::GetLaunchpad ( ) const
inline
Returns
The index of the session in the lobby list.

◆ GetPlayers()

std::list< LobbyPlayer > * LobbyPlayersMsg::GetPlayers ( ) const
inline
Returns
The players, in 0x90-byte list nodes.

Member Data Documentation

◆ kNoLaunchpad

int LobbyPlayersMsg::kNoLaunchpad = -1
staticconstexpr

The value of mLaunchpad when the players are not those of a session.


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