resonance 1.0.1
Loading...
Searching...
No Matches
CatchProgressPacket Class Reference

Network packet the game sends between game systems. More...

#include <catchprogresspacket.h>

Inheritance diagram for CatchProgressPacket:
Collaboration diagram for CatchProgressPacket:

Public Member Functions

virtual Message * Clone ()
 Produce a heap copy of this packet.
virtual int Type ()
 Report this packet's registered identity.
virtual const char * GetName () const
 Report this packet's class name.
virtual void PrintExtra (std::ostream &stream) const
 Write @, the position, track:, the track, succ:, and the success value to a diagnostic stream.
virtual void saveGuts (OBStream &stream) const
 Write the Packet words, the player's identifier, the position, the track, and the success value to a stream.
virtual void restoreGuts (IBStream &stream)
 Read the fields back in place in the order saveGuts() wrote them.
Public Member Functions inherited from ToAllOtherGameSystemsPacket
 ToAllOtherGameSystemsPacket ()
 Route the packet with the pair 2 and 3.
Public Member Functions inherited from Message
void * operator new (size_t nSize)
 Allocate a message from the tagged heap under the tag MSG.
void operator delete (void *pBlock)
 Release a message to the tagged heap under the tag MSG.
virtual ~Message ()
 Vtable slot 1.
std::ostream & Print (std::ostream &stream) const
 Write this message to a diagnostic stream as {GetName() PrintExtra()}.

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.

Public Attributes

IDablePtr< Player > mPlayer
Sch::Tick mPosition
int mTrack
float mSucc

Additional Inherited Members

Protected Member Functions inherited from Packet
 Packet (int nDestination, int nDestinationSystem)
 Set the two routing words and mark the remaining two as unset.
Protected Attributes inherited from Packet
int mDestination
int mDestinationSystem
int mClientId
 The client the packet concerns, or -1 until set.
int mTargetClientId
 A second client identifier, -1 until set.

Detailed Description

Network packet the game sends between game systems.

Its RTTI descriptor is at 0x00902060. It has ToAllOtherGameSystemsPacket as its one base. The object is 0x28 bytes and its vtable is at 0x00814530. The payload comes from the copy constructor at 0x003f38d0. Clone() delegates to it. The four words Packet provides are declared there rather than here.

The member at +0x1c is a Sch::Tick. PrintExtra() hands it to Sch::Tick::Print() after the label @, and New() initialises it to kTickInfinity. The transfer through the emission at 0x004acf28 alone could not distinguish it from a CmdID. PrintExtra() labels +0x20 as track and +0x24 as succ. The player reference at +0x14 is transferred but not printed.

Every member is public because Catcher::DispatchPriv() at 0x001adbec reads the payload directly with no accessor in the image.

The destructor at 0x003f09f8 is compiler-generated and has no declaration here.

Member Function Documentation

◆ New()

Message * CatchProgressPacket::New ( )
static

Produce a default-constructed packet on the heap.

The registry the translation unit at 0x003ed2e0 builds stores this address against g_nCatchProgressPacketType.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x003e5330
Ghidra address:
PAL: 0x0041d5c8

◆ Clone()

virtual Message * CatchProgressPacket::Clone ( )
virtual

Produce a heap copy of this packet.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x003f0a70
Ghidra address:
PAL: 0x00429078

Implements Message.

◆ Type()

virtual int CatchProgressPacket::Type ( )
virtual

Report this packet's registered identity.

Returns
g_nCatchProgressPacketType.
Ghidra address:
NTSC-U/C: 0x003f0ae8
Ghidra address:
PAL: 0x004290f0

Implements Message.

◆ GetName()

virtual const char * CatchProgressPacket::GetName ( ) const
virtual

Report this packet's class name.

Returns
The literal CatchProgressPacket.
Ghidra address:
NTSC-U/C: 0x003f0af8
Ghidra address:
PAL: 0x00429100

Implements Message.

◆ PrintExtra()

virtual void CatchProgressPacket::PrintExtra ( std::ostream & stream) const
virtual

Write @, the position, track:, the track, succ:, and the success value to a diagnostic stream.

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

Reimplemented from Message.

◆ saveGuts()

virtual void CatchProgressPacket::saveGuts ( OBStream & stream) const
virtual

Write the Packet words, the player's identifier, the position, the track, and the success value to a stream.

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

Reimplemented from Packet.

◆ restoreGuts()

virtual void CatchProgressPacket::restoreGuts ( IBStream & stream)
virtual

Read the fields back in place in the order saveGuts() wrote them.

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

Reimplemented from Packet.

Member Data Documentation

◆ mPlayer

IDablePtr<Player> CatchProgressPacket::mPlayer

The catching player. +0x14

◆ mPosition

Sch::Tick CatchProgressPacket::mPosition

The song position, printed after @. +0x1c

◆ mTrack

int CatchProgressPacket::mTrack

Labelled track by PrintExtra(). +0x20

◆ mSucc

float CatchProgressPacket::mSucc

Labelled succ by PrintExtra(). +0x24


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