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

Packet that reports a player's score at the end of a song to the hosting console. More...

#include <finalscorepacket.h>

Inheritance diagram for FinalScorePacket:
Collaboration diagram for FinalScorePacket:

Public Member Functions

 ~FinalScorePacket () override=default
 Destroy the object.
 FinalScorePacket ()
 Construct a packet with no score.
 FinalScorePacket (int nScore)
 Construct a packet with a score.
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 saveGuts (BinStream &stream) const override
 Write the score.
void restoreGuts (BinStream &stream) override
 Read the score.
int GetScore () const
void SetScore (int nScore)
Public Member Functions inherited from ExternalPacket
 ExternalPacket (unsigned char nFlags=0, int nReceiver=kAllPeers)
 Construct a packet from an unset sender.
int Route () override
 Report that a received packet goes to the sink of TheNetTransport.
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 Packet
 Packet (unsigned char nFlags, int nReceiver)
 Construct a packet from an unset sender.

Detailed Description

Packet that reports a player's score at the end of a song to the hosting console.

The RTTI records the class as deriving from ExternalPacket. Delivery is guaranteed, and the packet is addressed to peer 0. The members Clone(), Type(), and GetName() are inline.

Constructor & Destructor Documentation

◆ ~FinalScorePacket()

FinalScorePacket::~FinalScorePacket ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x003359a8
Ghidra address:
PAL: 0x003a2f58

◆ FinalScorePacket() [1/2]

FinalScorePacket::FinalScorePacket ( )
inline

Construct a packet with no score.

Inline. New() expands it.

◆ FinalScorePacket() [2/2]

FinalScorePacket::FinalScorePacket ( int nScore)
inlineexplicit

Construct a packet with a score.

Inline. MultiGameLogic::OnFinish() expands it on its stack.

Parameters
nScoreThe player's score.

Member Function Documentation

◆ New()

Message * FinalScorePacket::New ( )
static

Produce a default-constructed packet on the heap.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x00123200
Ghidra address:
PAL: 0x00124980

◆ operator new()

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

Release a packet.

Parameters
pBlockThe block.

◆ Clone()

Message * FinalScorePacket::Clone ( )
inlineoverridevirtual

Produce a heap copy of this packet.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x00335a48
Ghidra address:
PAL: 0x003a2ff8

Implements Message.

◆ Type()

int FinalScorePacket::Type ( )
inlineoverridevirtual

Report this packet's registered identity.

Returns
g_nFinalScorePacketType.
Ghidra address:
NTSC-U/C: 0x00335ab8
Ghidra address:
PAL: 0x003a3068

Implements Message.

◆ GetName()

const char * FinalScorePacket::GetName ( ) const
inlineoverridevirtual

Report this packet's class name.

Returns
The literal FinalScorePacket.
Ghidra address:
NTSC-U/C: 0x00335ac8
Ghidra address:
PAL: 0x003a3078

Implements Message.

◆ saveGuts()

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

Write the score.

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

Reimplemented from Message.

◆ restoreGuts()

void FinalScorePacket::restoreGuts ( BinStream & stream)
overridevirtual

Read the score.

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

Reimplemented from Message.

◆ GetScore()

int FinalScorePacket::GetScore ( ) const
inline
Returns
The player's score.

◆ SetScore()

void FinalScorePacket::SetScore ( int nScore)
inline
Parameters
nScoreThe player's score.

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