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

Packet the host sends when the settings of the game change. More...

#include <gameparamspkt.h>

Inheritance diagram for GameParamsPkt:
Collaboration diagram for GameParamsPkt:

Public Member Functions

 GameParamsPkt ()=default
 Construct a packet with the default settings.
 GameParamsPkt (const NetGameParams &params)
 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 settings.
void saveGuts (BinStream &stream) const override
 Write the settings.
void restoreGuts (BinStream &stream) override
 Read the settings.
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
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 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 when the settings of the game change.

The RTTI records the class as deriving from InternalPacket. The members Clone(), Type(), and GetName() are inline.

Constructor & Destructor Documentation

◆ GameParamsPkt() [1/2]

GameParamsPkt::GameParamsPkt ( )
default

Construct a packet with the default settings.

Inline. New() expands it.

◆ GameParamsPkt() [2/2]

GameParamsPkt::GameParamsPkt ( const NetGameParams & params)
inlineexplicit

Construct a packet for every peer, ordered and guaranteed.

Inline.

Parameters
paramsThe settings of the game.

Member Function Documentation

◆ New()

Message * GameParamsPkt::New ( )
static

Produce a default-constructed packet on the heap.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x002676d0
Ghidra address:
PAL: 0x002713a8

◆ operator new()

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

Release a packet.

Parameters
pBlockThe block.

◆ Clone()

Message * GameParamsPkt::Clone ( )
inlineoverridevirtual

Produce a heap copy of this packet.

Returns
The copy.

Implements Message.

◆ Type()

int GameParamsPkt::Type ( )
inlineoverridevirtual

Report this packet's registered identity.

Returns
g_nGameParamsPktType.

Implements Message.

◆ GetName()

const char * GameParamsPkt::GetName ( ) const
inlineoverridevirtual

Report this packet's class name.

Returns
The literal GameParamsPkt.

Implements Message.

◆ PrintExtra()

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

Write the sender, the receiver, and the settings.

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

Reimplemented from Message.

◆ saveGuts()

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

Write the settings.

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

Reimplemented from Message.

◆ restoreGuts()

void GameParamsPkt::restoreGuts ( BinStream & stream)
overridevirtual

Read the settings.

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

Reimplemented from Message.

◆ GetParams()

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

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