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

Packet the host sends to offer the remix of the game to the guests. More...

#include <shareremixpkt.h>

Inheritance diagram for ShareRemixPkt:
Collaboration diagram for ShareRemixPkt:

Public Member Functions

 ~ShareRemixPkt () override=default
 Destroy the object.
 ShareRemixPkt ()=default
 Construct a packet with a reset description.
 ShareRemixPkt (const RemixInfo &info, int nShareOnly)
 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, the description, and mShareOnly.
void saveGuts (BinStream &stream) const override
 Write the description and mShareOnly as a byte.
void restoreGuts (BinStream &stream) override
 Read what saveGuts() wrote, and mark the remix as received over the network.
const RemixInfo & GetInfo () const
RemixInfo & GetInfo ()
int GetShareOnly () 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
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 to offer the remix of the game to the guests.

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

Constructor & Destructor Documentation

◆ ~ShareRemixPkt()

ShareRemixPkt::~ShareRemixPkt ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x003a1048
Ghidra address:
PAL: 0x0040fd28

◆ ShareRemixPkt() [1/2]

ShareRemixPkt::ShareRemixPkt ( )
default

Construct a packet with a reset description.

mShareOnly is left unset.

Inline. New() expands it.

◆ ShareRemixPkt() [2/2]

ShareRemixPkt::ShareRemixPkt ( const RemixInfo & info,
int nShareOnly )
inline

Construct a packet for every peer, ordered and guaranteed.

Inline.

Parameters
infoThe description of the remix.
nShareOnlyNon-zero when the remix is only shared, not played.

Member Function Documentation

◆ New()

Message * ShareRemixPkt::New ( )
static

Produce a default-constructed packet on the heap.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x002677e8
Ghidra address:
PAL: 0x002714c0

◆ operator new()

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

Release a packet.

Parameters
pBlockThe block.

◆ Clone()

Message * ShareRemixPkt::Clone ( )
inlineoverridevirtual

Produce a heap copy of this packet.

Returns
The copy.

Implements Message.

◆ Type()

int ShareRemixPkt::Type ( )
inlineoverridevirtual

Report this packet's registered identity.

Returns
g_nShareRemixPktType.

Implements Message.

◆ GetName()

const char * ShareRemixPkt::GetName ( ) const
inlineoverridevirtual

Report this packet's class name.

Returns
The literal ShareRemixPkt.

Implements Message.

◆ PrintExtra()

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

Write the sender, the receiver, the description, and mShareOnly.

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

Reimplemented from Packet.

◆ saveGuts()

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

Write the description and mShareOnly as a byte.

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

Reimplemented from Message.

◆ restoreGuts()

void ShareRemixPkt::restoreGuts ( BinStream & stream)
overridevirtual

Read what saveGuts() wrote, and mark the remix as received over the network.

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

Reimplemented from Message.

◆ GetInfo() [1/2]

const RemixInfo & ShareRemixPkt::GetInfo ( ) const
inline
Returns
The description of the remix.

◆ GetInfo() [2/2]

RemixInfo & ShareRemixPkt::GetInfo ( )
inline
Returns
The description of the remix, for filling.

◆ GetShareOnly()

int ShareRemixPkt::GetShareOnly ( ) const
inline
Returns
Non-zero when the remix is only shared, not played.

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