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

Packet that reports a phrase of a track captured by a player on another console. More...

#include <capturepacket.h>

Inheritance diagram for CapturePacket:
Collaboration diagram for CapturePacket:

Public Member Functions

 ~CapturePacket () override=default
 Destroy the object.
 CapturePacket ()
 Construct a packet with no track and no bar.
 CapturePacket (int nTrack, int nBar, bool bAutocatch)
 Construct a packet with every field set.
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 fields packed into one half-word.
void restoreGuts (BinStream &stream) override
 Read the half-word saveGuts() writes back into the fields.
int GetAutocatch () const
int GetBar () const
int GetTrack () const
int GetValid () const
void SetValid (int nValid)
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 phrase of a track captured by a player on another console.

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

Constructor & Destructor Documentation

◆ ~CapturePacket()

CapturePacket::~CapturePacket ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x00349e60
Ghidra address:
PAL: 0x003b7290

◆ CapturePacket() [1/2]

CapturePacket::CapturePacket ( )
inline

Construct a packet with no track and no bar.

Inline. New() expands it.

◆ CapturePacket() [2/2]

CapturePacket::CapturePacket ( int nTrack,
int nBar,
bool bAutocatch )
inline

Construct a packet with every field set.

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

Parameters
nTrackThe index of the track.
nBarThe bar.
bAutocatchWhether an autocatcher captured the phrase.

Member Function Documentation

◆ New()

Message * CapturePacket::New ( )
static

Produce a default-constructed packet on the heap.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x00122f78
Ghidra address:
PAL: 0x001246f8

◆ operator new()

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

Release a packet.

Parameters
pBlockThe block.

◆ Clone()

Message * CapturePacket::Clone ( )
inlineoverridevirtual

Produce a heap copy of this packet.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x00349f00
Ghidra address:
PAL: 0x003b7330

Implements Message.

◆ Type()

int CapturePacket::Type ( )
inlineoverridevirtual

Report this packet's registered identity.

Returns
g_nCapturePacketType.
Ghidra address:
NTSC-U/C: 0x00349f88
Ghidra address:
PAL: 0x003b73b8

Implements Message.

◆ GetName()

const char * CapturePacket::GetName ( ) const
inlineoverridevirtual

Report this packet's class name.

Returns
The literal CapturePacket.
Ghidra address:
NTSC-U/C: 0x00349f98
Ghidra address:
PAL: 0x003b73c8

Implements Message.

◆ saveGuts()

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

Write the fields packed into one half-word.

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

Reimplemented from Message.

◆ restoreGuts()

void CapturePacket::restoreGuts ( BinStream & stream)
overridevirtual

Read the half-word saveGuts() writes back into the fields.

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

Reimplemented from Message.

◆ GetAutocatch()

int CapturePacket::GetAutocatch ( ) const
inline
Returns
Whether an autocatcher captured the phrase.

◆ GetBar()

int CapturePacket::GetBar ( ) const
inline
Returns
The bar of the capture.

◆ GetTrack()

int CapturePacket::GetTrack ( ) const
inline
Returns
The index of the track.

◆ GetValid()

int CapturePacket::GetValid ( ) const
inline
Returns
Whether a sender filled the packet.

◆ SetValid()

void CapturePacket::SetValid ( int nValid)
inline
Parameters
nValidWhether a sender filled the packet.

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