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

Packet that reports a player bumped onto a track by a freestyle power-up. More...

#include <freestylebumppacket.h>

Inheritance diagram for FreestyleBumpPacket:
Collaboration diagram for FreestyleBumpPacket:

Public Member Functions

 ~FreestyleBumpPacket () override=default
 Destroy the object.
 FreestyleBumpPacket ()
 Construct a packet with no player and no track.
 FreestyleBumpPacket (int nNetOrder, int nTrack)
 Construct a packet for a player and a track.
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 player and the track packed into one byte.
void restoreGuts (BinStream &stream) override
 Read the byte saveGuts() writes back into the fields.
void PrintExtra (PrnStream &stream) const override
 Write the player and the track.
int GetNetOrder () const
int GetTrack () const
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 bumped onto a track by a freestyle power-up.

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

Constructor & Destructor Documentation

◆ ~FreestyleBumpPacket()

FreestyleBumpPacket::~FreestyleBumpPacket ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0034b460
Ghidra address:
PAL: 0x003b8890

◆ FreestyleBumpPacket() [1/2]

FreestyleBumpPacket::FreestyleBumpPacket ( )
inline

Construct a packet with no player and no track.

Inline. New() expands it.

◆ FreestyleBumpPacket() [2/2]

FreestyleBumpPacket::FreestyleBumpPacket ( int nNetOrder,
int nTrack )
inline

Construct a packet for a player and a track.

Inline. NetArbiter::UpdatePlayer() expands it on its stack.

Parameters
nNetOrderThe session order of the player bumped.
nTrackThe track the player moves to.

Member Function Documentation

◆ New()

Message * FreestyleBumpPacket::New ( )
static

Produce a default-constructed packet on the heap.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x001231a0
Ghidra address:
PAL: 0x00124920

◆ operator new()

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

Release a packet.

Parameters
pBlockThe block.

◆ Clone()

Message * FreestyleBumpPacket::Clone ( )
inlineoverridevirtual

Produce a heap copy of this packet.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x0034b500
Ghidra address:
PAL: 0x003b8930

Implements Message.

◆ Type()

int FreestyleBumpPacket::Type ( )
inlineoverridevirtual

Report this packet's registered identity.

Returns
g_nFreestyleBumpPacketType.
Ghidra address:
NTSC-U/C: 0x0034b578
Ghidra address:
PAL: 0x003b89a8

Implements Message.

◆ GetName()

const char * FreestyleBumpPacket::GetName ( ) const
inlineoverridevirtual

Report this packet's class name.

Returns
The literal FreestyleBumpPacket.
Ghidra address:
NTSC-U/C: 0x0034b588
Ghidra address:
PAL: 0x003b89b8

Implements Message.

◆ saveGuts()

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

Write the player and the track packed into one byte.

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

Reimplemented from Message.

◆ restoreGuts()

void FreestyleBumpPacket::restoreGuts ( BinStream & stream)
overridevirtual

Read the byte saveGuts() writes back into the fields.

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

Reimplemented from Message.

◆ PrintExtra()

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

Write the player and the track.

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

Reimplemented from Message.

◆ GetNetOrder()

int FreestyleBumpPacket::GetNetOrder ( ) const
inline
Returns
The session order of the player bumped.

◆ GetTrack()

int FreestyleBumpPacket::GetTrack ( ) const
inline
Returns
The track the player was moved to.

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