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

Packet the host sends every console to start the song at an agreed time. More...

#include <startgamepkt.h>

Inheritance diagram for StartGamePkt:
Collaboration diagram for StartGamePkt:

Public Member Functions

 StartGamePkt ()
 Construct a packet for every peer with no time and no seed.
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 time, and the seed.
void saveGuts (BinStream &stream) const override
 Write the time and the seed.
void restoreGuts (BinStream &stream) override
 Read the time and the seed.
int GetSeed () const
void SetSeed (int nSeed)
float GetTime () const
void SetTime (float fTime)
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 every console to start the song at an agreed time.

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

Constructor & Destructor Documentation

◆ StartGamePkt()

StartGamePkt::StartGamePkt ( )
inline

Construct a packet for every peer with no time and no seed.

Inline. New() expands it.

Member Function Documentation

◆ New()

Message * StartGamePkt::New ( )
static

Produce a default-constructed packet on the heap.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x00267950
Ghidra address:
PAL: 0x00271628

◆ operator new()

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

Release a packet.

Parameters
pBlockThe block.

◆ Clone()

Message * StartGamePkt::Clone ( )
inlineoverridevirtual

Produce a heap copy of this packet.

Returns
The copy.

Implements Message.

◆ Type()

int StartGamePkt::Type ( )
inlineoverridevirtual

Report this packet's registered identity.

Returns
g_nStartGamePktType.

Implements Message.

◆ GetName()

const char * StartGamePkt::GetName ( ) const
inlineoverridevirtual

Report this packet's class name.

Returns
The literal StartGamePkt.

Implements Message.

◆ PrintExtra()

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

Write the sender, the receiver, the time, and the seed.

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

Reimplemented from Packet.

◆ saveGuts()

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

Write the time and the seed.

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

Reimplemented from Message.

◆ restoreGuts()

void StartGamePkt::restoreGuts ( BinStream & stream)
overridevirtual

Read the time and the seed.

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

Reimplemented from Message.

◆ GetSeed()

int StartGamePkt::GetSeed ( ) const
inline
Returns
The seed of the random numbers every console's logic draws.

◆ SetSeed()

void StartGamePkt::SetSeed ( int nSeed)
inline
Parameters
nSeedThe seed of the random numbers every console's logic draws.

◆ GetTime()

float StartGamePkt::GetTime ( ) const
inline
Returns
The clock of the host the song starts at.

◆ SetTime()

void StartGamePkt::SetTime ( float fTime)
inline
Parameters
fTimeThe clock of the host the song starts at.

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