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

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

#include <scallclientsstatuspacket.h>

Inheritance diagram for SCAllClientsStatusPacket:
Collaboration diagram for SCAllClientsStatusPacket:

Classes

struct  ClientInfoEntry
 One client's status, eight bytes, from the stride the copy constructor divides by. More...

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 every entry to a diagnostic stream as (id: id stat: status ) .
virtual void saveGuts (OBStream &stream) const
 Write the Packet words, the entry count, and both words of every entry to a stream.
virtual void restoreGuts (IBStream &stream)
 Read the Packet words and the entry count, resize the vector, and read every entry in place.
void AddClientStatus (int nId, int nStatus)
 Append one entry.
Public Member Functions inherited from ToAllOtherNetManagersPacket
 ToAllOtherNetManagersPacket ()
 Route the packet with the pair 2 and 0.
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 no entries 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 0x008efe40. It has ToAllOtherNetManagersPacket as its one base. The object is 0x20 bytes and its vtable is at 0x00814770. The payload comes from the copy constructor at 0x003f3298. Clone() delegates to it, and the payload accounts for the allocation exactly. The four words Packet provides are declared there rather than here.

The vector at +0x14 is deep-copied. The class manages its elements. PrintExtra() labels both words of each element, which recovers their names.

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

Member Function Documentation

◆ New()

Message * SCAllClientsStatusPacket::New ( )
static

Produce a packet with no entries on the heap.

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

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x003e4e48
Ghidra address:
PAL: 0x0041d0e0

◆ Clone()

virtual Message * SCAllClientsStatusPacket::Clone ( )
virtual

Produce a heap copy of this packet.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x003efaa8
Ghidra address:
PAL: 0x004280b0

Implements Message.

◆ Type()

virtual int SCAllClientsStatusPacket::Type ( )
virtual

Report this packet's registered identity.

Returns
g_nSCAllClientsStatusPacketType.
Ghidra address:
NTSC-U/C: 0x003efb20
Ghidra address:
PAL: 0x00428128

Implements Message.

◆ GetName()

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

Report this packet's class name.

Returns
The literal SCAllClientsStatusPacket.
Ghidra address:
NTSC-U/C: 0x003efb30
Ghidra address:
PAL: 0x00428138

Implements Message.

◆ PrintExtra()

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

Write every entry to a diagnostic stream as (id: id stat: status ) .

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

Reimplemented from Message.

◆ saveGuts()

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

Write the Packet words, the entry count, and both words of every entry to a stream.

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

Reimplemented from Packet.

◆ restoreGuts()

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

Read the Packet words and the entry count, resize the vector, and read every entry in place.

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

Reimplemented from Packet.

◆ AddClientStatus()

void SCAllClientsStatusPacket::AddClientStatus ( int nId,
int nStatus )

Append one entry.

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

Parameters
nIdThe client, stored in ClientInfoEntry::mId.
nStatusThe client's status, stored in ClientInfoEntry::mStatus.
Ghidra address:
NTSC-U/C: 0x003f2218
Ghidra address:
PAL: 0x0042a760

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