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

Packet the host sends a console that joins the session, with the colour of the console and the settings of the game. More...

#include <welcomepkt.h>

Inheritance diagram for WelcomePkt:
Collaboration diagram for WelcomePkt:

Public Member Functions

 WelcomePkt ()=default
 Construct a packet with the default settings.
 WelcomePkt (int nReceiver, int nColor, const NetGameParams &params)
 Construct a packet for one 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 colour, and the settings.
void saveGuts (BinStream &stream) const override
 Write the colour as a byte and the settings.
void restoreGuts (BinStream &stream) override
 Read what saveGuts() wrote.
int GetColor () const
const NetGameParams & GetParams () 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 the host sends a console that joins the session, with the colour of the console and the settings of the 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

◆ WelcomePkt() [1/2]

WelcomePkt::WelcomePkt ( )
default

Construct a packet with the default settings.

mColor is left unset.

Inline. New() expands it.

◆ WelcomePkt() [2/2]

WelcomePkt::WelcomePkt ( int nReceiver,
int nColor,
const NetGameParams & params )
inline

Construct a packet for one peer, ordered and guaranteed.

Inline.

Parameters
nReceiverThe peer the packet is for.
nColorThe colour of the slot of the console, 0 to 3.
paramsThe settings of the game.

Member Function Documentation

◆ New()

Message * WelcomePkt::New ( )
static

Produce a default-constructed packet on the heap.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x00267430
Ghidra address:
PAL: 0x00271108

◆ operator new()

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

Release a packet.

Parameters
pBlockThe block.

◆ Clone()

Message * WelcomePkt::Clone ( )
inlineoverridevirtual

Produce a heap copy of this packet.

Returns
The copy.

Implements Message.

◆ Type()

int WelcomePkt::Type ( )
inlineoverridevirtual

Report this packet's registered identity.

Returns
g_nWelcomePktType.

Implements Message.

◆ GetName()

const char * WelcomePkt::GetName ( ) const
inlineoverridevirtual

Report this packet's class name.

Returns
The literal WelcomePkt.

Implements Message.

◆ PrintExtra()

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

Write the sender, the receiver, the colour, and the settings.

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

Reimplemented from Packet.

◆ saveGuts()

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

Write the colour as a byte and the settings.

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

Reimplemented from Message.

◆ restoreGuts()

void WelcomePkt::restoreGuts ( BinStream & stream)
overridevirtual

Read what saveGuts() wrote.

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

Reimplemented from Message.

◆ GetColor()

int WelcomePkt::GetColor ( ) const
inline
Returns
The colour of the slot of the console, 0 to 3.

◆ GetParams()

const NetGameParams & WelcomePkt::GetParams ( ) const
inline
Returns
The settings of the game.

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