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

Packet that reports the ranks of the players of the song. More...

#include <updaterankspkt.h>

Inheritance diagram for UpdateRanksPkt:
Collaboration diagram for UpdateRanksPkt:

Classes

struct  Info
 The rank of one player. More...

Public Member Functions

 ~UpdateRanksPkt () override=default
 Destroy the object.
 UpdateRanksPkt ()=default
 Construct a packet with no ranks.
 UpdateRanksPkt (const std::vector< Info > &ranks)
 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, and the ranks.
void saveGuts (BinStream &stream) const override
 Write the ranks.
void restoreGuts (BinStream &stream) override
 Read the ranks.
const std::vector< Info > & GetRanks () 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
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 reports the ranks of the players of the song.

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

◆ ~UpdateRanksPkt()

UpdateRanksPkt::~UpdateRanksPkt ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x003a15f8
Ghidra address:
PAL: 0x004102d8

◆ UpdateRanksPkt() [1/2]

UpdateRanksPkt::UpdateRanksPkt ( )
default

Construct a packet with no ranks.

Inline. New() expands it.

◆ UpdateRanksPkt() [2/2]

UpdateRanksPkt::UpdateRanksPkt ( const std::vector< Info > & ranks)
inlineexplicit

Construct a packet for every peer, ordered and guaranteed.

Inline.

Parameters
ranksThe rank of each player.

Member Function Documentation

◆ New()

Message * UpdateRanksPkt::New ( )
static

Produce a default-constructed packet on the heap.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x00267a60
Ghidra address:
PAL: 0x00271738

◆ operator new()

void * UpdateRanksPkt::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 UpdateRanksPkt::operator delete ( void * pBlock)
inline

Release a packet.

Parameters
pBlockThe block.

◆ Clone()

Message * UpdateRanksPkt::Clone ( )
inlineoverridevirtual

Produce a heap copy of this packet.

Returns
The copy.

Implements Message.

◆ Type()

int UpdateRanksPkt::Type ( )
inlineoverridevirtual

Report this packet's registered identity.

Returns
g_nUpdateRanksPktType.

Implements Message.

◆ GetName()

const char * UpdateRanksPkt::GetName ( ) const
inlineoverridevirtual

Report this packet's class name.

Returns
The literal UpdateRanksPkt.

Implements Message.

◆ PrintExtra()

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

Write the sender, the receiver, and the ranks.

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

Reimplemented from Packet.

◆ saveGuts()

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

Write the ranks.

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

Reimplemented from Message.

◆ restoreGuts()

void UpdateRanksPkt::restoreGuts ( BinStream & stream)
overridevirtual

Read the ranks.

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

Reimplemented from Message.

◆ GetRanks()

const std::vector< Info > & UpdateRanksPkt::GetRanks ( ) const
inline
Returns
The rank of each player.

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