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

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

#include <scloadlevelpacket.h>

Inheritance diagram for SCLoadLevelPacket:
Collaboration diagram for SCLoadLevelPacket:

Public Member Functions

 SCLoadLevelPacket ()
 Construct a packet with default settings.
 SCLoadLevelPacket (const GameParams &params)
 Construct a packet carrying a copy of some settings.
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 settings to a diagnostic stream through GameParams::Print().
virtual void saveGuts (OBStream &stream) const
 Write the Packet words and the settings to a stream.
virtual void restoreGuts (IBStream &stream)
 Read the Packet words and the settings back from a stream.
GameParams GetParams ()
 Report the game settings.
Public Member Functions inherited from ToAllGameControllersPacket
 ToAllGameControllersPacket ()
 Route the packet with the pair 3 and 2.
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 packet with default settings 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

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 0x008ef610. It has ToAllGameControllersPacket as its one base. The object is 0x4c bytes and its vtable is at 0x00814410. The payload comes from the copy constructor at 0x003f3c48. Clone() delegates to it, and the payload accounts for the allocation exactly. The four words Packet provides are declared there rather than here.

saveGuts() and restoreGuts() transfer the game settings through GameParams' own virtual Save() and Load() after the Packet words.

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

Constructor & Destructor Documentation

◆ SCLoadLevelPacket() [1/2]

SCLoadLevelPacket::SCLoadLevelPacket ( )

Construct a packet with default settings.

The image lists no caller for the out-of-line body. New() expands the same stores in place.

Ghidra address:
NTSC-U/C: 0x003f1438
Ghidra address:
PAL: 0x00429900

◆ SCLoadLevelPacket() [2/2]

SCLoadLevelPacket::SCLoadLevelPacket ( const GameParams & params)

Construct a packet carrying a copy of some settings.

The image lists no caller for the out-of-line body.

Parameters
paramsThe settings to copy.
Ghidra address:
NTSC-U/C: 0x003f14b0
Ghidra address:
PAL: 0x00429978

Member Function Documentation

◆ New()

Message * SCLoadLevelPacket::New ( )
static

Produce a packet with default settings on the heap.

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

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x003e5040
Ghidra address:
PAL: 0x0041d2d8

◆ Clone()

virtual Message * SCLoadLevelPacket::Clone ( )
virtual

Produce a heap copy of this packet.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x003f13a0
Ghidra address:
PAL: 0x00429868

Implements Message.

◆ Type()

virtual int SCLoadLevelPacket::Type ( )
virtual

Report this packet's registered identity.

Returns
g_nSCLoadLevelPacketType.
Ghidra address:
NTSC-U/C: 0x003f1418
Ghidra address:
PAL: 0x004298e0

Implements Message.

◆ GetName()

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

Report this packet's class name.

Returns
The literal SCLoadLevelPacket.
Ghidra address:
NTSC-U/C: 0x003f1428
Ghidra address:
PAL: 0x004298f0

Implements Message.

◆ PrintExtra()

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

Write the settings to a diagnostic stream through GameParams::Print().

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

Reimplemented from Message.

◆ saveGuts()

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

Write the Packet words and the settings to a stream.

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

Reimplemented from Packet.

◆ restoreGuts()

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

Read the Packet words and the settings back from a stream.

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

Reimplemented from Packet.

◆ GetParams()

GameParams SCLoadLevelPacket::GetParams ( )

Report the game settings.

The image lists no caller. The title is inferred.

Returns
A copy of the settings.
Ghidra address:
NTSC-U/C: 0x003f1528
Ghidra address:
PAL: 0x004299f0

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