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

Packet that delivers the new rating of a player after an online game. More...

#include <clientratingpkt.h>

Inheritance diagram for ClientRatingPkt:
Collaboration diagram for ClientRatingPkt:

Public Member Functions

 ClientRatingPkt ()
 Construct a packet with an empty record.
 ClientRatingPkt (int nRating, int nRank, int nGames, const RatingRecord &record)
 Construct a packet for every peer, ordered and guaranteed.
void * operator new (size_t nSize)
 Allocate a packet, billed to the class name.
void operator delete (void *pBlock)
 Release a packet.
Message * Clone () override
 Produce a heap copy of this packet.
int Type () override
 Report this packet's registered identity.
const char * GetName () const override
 Report this packet's class name.
void PrintExtra (PrnStream &stream) const override
 Write the sender, the receiver, the rating, the rank, the games, and the record.
void saveGuts (BinStream &stream) const override
 Write the rating, the rank, and the games as four bytes each, and the record.
void restoreGuts (BinStream &stream) override
 Read what saveGuts() wrote.
int GetGames () const
int GetRank () const
int GetRating () const
const RatingRecord & GetRecord () const
Public Member Functions inherited from InternalPacket
int Route () override
 Report that a received packet goes to the online session.
Public Member Functions inherited from Packet
void PrintExtra (PrnStream &stream) const override
 Write the sender and the receiver that are set, as from: and to:.
unsigned char GetFlags () const
int GetReceiver () const
int GetSender () const
void SetSender (int nSender)
Public Member Functions inherited from Message
virtual ~Message ()
 Vtable slot 1.
virtual ~Message ()
virtual void Unused1 ()
 Not called by the control.

Static Public Member Functions

static Message * New ()
 Produce a default-constructed packet on the heap.
Static Public Member Functions inherited from Message
static Message * NewMessage (int nType)
 Produce a message of the identified class through the factory list.

Additional Inherited Members

Public Types inherited from Packet
enum  RouteFlag { kRouteTransport = 1 , kRouteLaunchpad = 2 }
 Bits of Route(). More...
Static Public Attributes inherited from Packet
static constexpr int kUnset = -2
 Value of mSender and mReceiver that marks the member as unset.
static constexpr int kAllPeers = -1
 Value of mReceiver that addresses every peer.
static constexpr unsigned char kFlagOrdered = 1
 Bit of mFlags that LaunchpadRT::Send() turns into the second delivery bit of the session library.
static constexpr unsigned char kFlagGuaranteed = 2
 Bit of mFlags that NetTransport::Send() turns into its guaranteed delivery bit.
Protected Member Functions inherited from InternalPacket
 InternalPacket (unsigned char nFlags=0, int nReceiver=kUnset)
 Construct a packet from an unset sender.
Protected Member Functions inherited from Packet
 Packet (unsigned char nFlags, int nReceiver)
 Construct a packet from an unset sender.

Detailed Description

Packet that delivers the new rating of a player after an online game.

The RTTI records the class as deriving from InternalPacket. The members Clone(), Type(), and GetName() are inline. The member names are inferred.

Constructor & Destructor Documentation

◆ ClientRatingPkt() [1/2]

ClientRatingPkt::ClientRatingPkt ( )
inline

Construct a packet with an empty record.

The other members are left unset.

Inline. New() expands it.

◆ ClientRatingPkt() [2/2]

ClientRatingPkt::ClientRatingPkt ( int nRating,
int nRank,
int nGames,
const RatingRecord & record )
inline

Construct a packet for every peer, ordered and guaranteed.

Inline.

Parameters
nRatingThe rating, as LobbyPlayer::mRating.
nRankThe position in the ranking.
nGamesThe number of online games played.
recordThe results the next rating weighs.

Member Function Documentation

◆ New()

Message * ClientRatingPkt::New ( )
static

Produce a default-constructed packet on the heap.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x002675e0
Ghidra address:
PAL: 0x002712b8

◆ operator new()

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

Allocate a packet, billed to the class name.

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

◆ operator delete()

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

Release a packet.

Parameters
pBlockThe block.

◆ Clone()

Message * ClientRatingPkt::Clone ( )
inlineoverridevirtual

Produce a heap copy of this packet.

Returns
The copy.

Implements Message.

◆ Type()

int ClientRatingPkt::Type ( )
inlineoverridevirtual

Report this packet's registered identity.

Returns
g_nClientRatingPktType.

Implements Message.

◆ GetName()

const char * ClientRatingPkt::GetName ( ) const
inlineoverridevirtual

Report this packet's class name.

Returns
The literal ClientRatingPkt.

Implements Message.

◆ PrintExtra()

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

Write the sender, the receiver, the rating, the rank, the games, and the record.

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

Reimplemented from Message.

◆ saveGuts()

void ClientRatingPkt::saveGuts ( BinStream & stream) const
overridevirtual

Write the rating, the rank, and the games as four bytes each, and the record.

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

Reimplemented from Message.

◆ restoreGuts()

void ClientRatingPkt::restoreGuts ( BinStream & stream)
overridevirtual

Read what saveGuts() wrote.

Parameters
streamThe stream to read from.
Ghidra address:
NTSC-U/C: 0x002696a8
Ghidra address:
PAL: 0x00273260

Reimplemented from Message.

◆ GetGames()

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

◆ GetRank()

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

◆ GetRating()

int ClientRatingPkt::GetRating ( ) const
inline
Returns
The rating, as LobbyPlayer::mRating.

◆ GetRecord()

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

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