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

Packet that reports a gem placed or removed in the remix editor. More...

#include <editgempacket.h>

Inheritance diagram for EditGemPacket:
Collaboration diagram for EditGemPacket:

Public Member Functions

 ~EditGemPacket () override=default
 Destroy the object.
 EditGemPacket ()
 Construct a packet with no track and no gem.
 EditGemPacket (int nTrack, int nSlot, int nTick, bool bRepeat)
 Construct a packet for a gem placed or removed.
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 saveGuts (BinStream &stream) const override
 Write the fields packed into one word.
void restoreGuts (BinStream &stream) override
 Read the word saveGuts() writes back into the fields.
int GetRepeat () const
int GetSlot () const
int GetTick () const
int GetTrack () const
Public Member Functions inherited from ExternalPacket
 ExternalPacket (unsigned char nFlags=0, int nReceiver=kAllPeers)
 Construct a packet from an unset sender.
int Route () override
 Report that a received packet goes to the sink of TheNetTransport.
Public Member Functions inherited from Packet
void PrintExtra (PrnStream &stream) const override
 Write the sender and the receiver that are set, as from: and to:.
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 Packet
 Packet (unsigned char nFlags, int nReceiver)
 Construct a packet from an unset sender.

Detailed Description

Packet that reports a gem placed or removed in the remix editor.

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

Constructor & Destructor Documentation

◆ ~EditGemPacket()

EditGemPacket::~EditGemPacket ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x00335808
Ghidra address:
PAL: 0x003a2db8

◆ EditGemPacket() [1/2]

EditGemPacket::EditGemPacket ( )
inline

Construct a packet with no track and no gem.

Inline. New() expands it.

◆ EditGemPacket() [2/2]

EditGemPacket::EditGemPacket ( int nTrack,
int nSlot,
int nTick,
bool bRepeat )
inline

Construct a packet for a gem placed or removed.

Inline. PitchTrack::HandleInput() expands it.

Parameters
nTrackThe track.
nSlotThe gem button of the gem.
nTickThe tick of the gem.
bRepeatWhether the edit repeats on every other bar of the section.

Member Function Documentation

◆ New()

Message * EditGemPacket::New ( )
static

Produce a default-constructed packet on the heap.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x001233d8
Ghidra address:
PAL: 0x00124b58

◆ operator new()

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

Release a packet.

Parameters
pBlockThe block.

◆ Clone()

Message * EditGemPacket::Clone ( )
inlineoverridevirtual

Produce a heap copy of this packet.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x003358a8
Ghidra address:
PAL: 0x003a2e58

Implements Message.

◆ Type()

int EditGemPacket::Type ( )
inlineoverridevirtual

Report this packet's registered identity.

Returns
g_nEditGemPacketType.
Ghidra address:
NTSC-U/C: 0x00335930
Ghidra address:
PAL: 0x003a2ee0

Implements Message.

◆ GetName()

const char * EditGemPacket::GetName ( ) const
inlineoverridevirtual

Report this packet's class name.

Returns
The literal EditGemPacket.
Ghidra address:
NTSC-U/C: 0x00335940
Ghidra address:
PAL: 0x003a2ef0

Implements Message.

◆ saveGuts()

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

Write the fields packed into one word.

The track takes three bits, the gem button two, the tick 26, and the repeat flag one.

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

Reimplemented from Message.

◆ restoreGuts()

void EditGemPacket::restoreGuts ( BinStream & stream)
overridevirtual

Read the word saveGuts() writes back into the fields.

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

Reimplemented from Message.

◆ GetRepeat()

int EditGemPacket::GetRepeat ( ) const
inline
Returns
Whether the edit repeats on every other bar of the section.

◆ GetSlot()

int EditGemPacket::GetSlot ( ) const
inline
Returns
The gem button of the gem.

◆ GetTick()

int EditGemPacket::GetTick ( ) const
inline
Returns
The tick of the gem.

◆ GetTrack()

int EditGemPacket::GetTrack ( ) const
inline
Returns
The track, in a duel the side of the player who catches the gem.

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