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

Event the game passes between a MsgSource and a MsgSink. More...

#include <pitchriffmsg.h>

Inheritance diagram for PitchRiffMsg:
Collaboration diagram for PitchRiffMsg:

Public Member Functions

 PitchRiffMsg ()
 Construct a message with the position at kTickInfinity and the rest unset.
 PitchRiffMsg (int nButton, Player *pPlayer, Sch::Tick position, int nTrack)
 Report the start of a riff.
virtual Message * Clone ()
 Produce a heap copy of this message.
virtual int Type ()
 Report this message's registered identity.
virtual const char * GetName () const
 Report this message's class name.
virtual void PrintExtra (std::ostream &stream) const
 Write the position, a space, the player's colour name, b#, and the word at +0x04 to a diagnostic stream.
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.
virtual void saveGuts (OBStream &stream) const
 Write this message's payload to an output stream.
virtual void restoreGuts (IBStream &stream)
 Read this message's payload from an input stream.
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 message 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

int mButton
Player * mPlayer
Sch::Tick mPosition
int mTrack

Static Public Attributes

static int sID
 Identity that Type() reports.

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x008eed18. It has Message as its one base. The object is 0x14 bytes and its vtable is at 0x008133a0. The members below are the whole of the class. No other routine in the image refers to this type by anything but its vtable.

The payload layout comes from the run of field copies in Clone(), so the offsets and widths are recovered but the purpose of each field is not. Readers of the fields have not been traced, so they are private by default.

PrintExtra() hands +0x0c to Sch::Tick::Print(), writes the colour name of the player at +0x08, and labels +0x04 as b#. New() initialises the position to kTickInfinity.

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

Constructor & Destructor Documentation

◆ PitchRiffMsg() [1/2]

PitchRiffMsg::PitchRiffMsg ( )
inline

Construct a message with the position at kTickInfinity and the rest unset.

Inline. New() expands it. A declaration is required because the class declares a second constructor.

◆ PitchRiffMsg() [2/2]

PitchRiffMsg::PitchRiffMsg ( int nButton,
Player * pPlayer,
Sch::Tick position,
int nTrack )
inline

Report the start of a riff.

Inline, with no address of its own. The routine at 0x0011d9b0, which InputMap::OnControllerReading() calls, expands it on its stack at 0x0011d9fc. The four arguments are the four members in declaration order. The last is the track the player's slot 4 reports.

Parameters
nButtonThe button, labelled b# by PrintExtra().
pPlayerThe player whose riff starts.
positionThe song position of the start.
nTrackThe player's track.

Member Function Documentation

◆ New()

Message * PitchRiffMsg::New ( )
static

Produce a default-constructed message on the heap.

The translation unit at 0x003d9818 registers this factory. Only the position is initialised.

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d6928
Ghidra address:
PAL: 0x0040e818

◆ Clone()

virtual Message * PitchRiffMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x003da620
Ghidra address:
PAL: 0x00412a58

Implements Message.

◆ Type()

virtual int PitchRiffMsg::Type ( )
virtual

Report this message's registered identity.

Returns
sID.
Ghidra address:
NTSC-U/C: 0x003da680
Ghidra address:
PAL: 0x00412ab8

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal PitchRiffMsg.
Ghidra address:
NTSC-U/C: 0x003da690
Ghidra address:
PAL: 0x00412ac8

Implements Message.

◆ PrintExtra()

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

Write the position, a space, the player's colour name, b#, and the word at +0x04 to a diagnostic stream.

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

Reimplemented from Message.

Member Data Documentation

◆ sID

int PitchRiffMsg::sID
static

Identity that Type() reports.

Ghidra address:
NTSC-U/C: 0x006d0134
Ghidra address:
PAL: 0x007138cc

◆ mButton

int PitchRiffMsg::mButton

◆ mPlayer

Player* PitchRiffMsg::mPlayer

◆ mPosition

Sch::Tick PitchRiffMsg::mPosition

◆ mTrack

int PitchRiffMsg::mTrack

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