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

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

#include <stopriffmsg.h>

Inheritance diagram for StopRiffMsg:
Collaboration diagram for StopRiffMsg:

Public Member Functions

 StopRiffMsg ()
 Construct a message with the position at kTickInfinity and the rest unset.
 StopRiffMsg (int nButton, Player *pPlayer, Sch::Tick position, int nTrack)
 Report the end 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 0x008efff0. It has Message as its one base. The object is 0x14 bytes and its vtable is at 0x00813358. 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(). PrintExtra() hands +0x0c to Sch::Tick::Print(), writes the colour name of the player at +0x08, and labels +0x04 as b#. The word at +0x10 is not printed.

Every member is public because the handlers AutoRiffer dispatches to at 0x001992e0 and Voxer's slot 3 at 0x001d90a4 read the payload with no accessor in the image, and the two stack builds at 0x00119e74 and 0x0011da7c write all four words.

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

Constructor & Destructor Documentation

◆ StopRiffMsg() [1/2]

StopRiffMsg::StopRiffMsg ( )
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.

◆ StopRiffMsg() [2/2]

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

Report the end of a riff.

Inline, with no address of its own. The routine at 0x0011da68, which InputMap::OnControllerReading() calls, and the build at 0x00119e74 expand it on their stacks. The four arguments are the four members in declaration order.

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

Member Function Documentation

◆ New()

Message * StopRiffMsg::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: 0x003d6968
Ghidra address:
PAL: 0x0040e858

◆ Clone()

virtual Message * StopRiffMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x003da7f8
Ghidra address:
PAL: 0x00412c30

Implements Message.

◆ Type()

virtual int StopRiffMsg::Type ( )
virtual

Report this message's registered identity.

Returns
sID.
Ghidra address:
NTSC-U/C: 0x003da858
Ghidra address:
PAL: 0x00412c90

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal StopRiffMsg.
Ghidra address:
NTSC-U/C: 0x003da868
Ghidra address:
PAL: 0x00412ca0

Implements Message.

◆ PrintExtra()

virtual void StopRiffMsg::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: 0x003e3098
Ghidra address:
PAL: 0x0041b558

Reimplemented from Message.

Member Data Documentation

◆ sID

int StopRiffMsg::sID
static

Identity that Type() reports.

Ghidra address:
NTSC-U/C: 0x006d013c
Ghidra address:
PAL: 0x007138d4

◆ mButton

int StopRiffMsg::mButton

The button, labelled b# by PrintExtra(). +0x04

◆ mPlayer

Player* StopRiffMsg::mPlayer

The player whose riff stops. +0x08

◆ mPosition

Sch::Tick StopRiffMsg::mPosition

The song position of the stop. +0x0c

◆ mTrack

int StopRiffMsg::mTrack

The player's track, from its slot 4. +0x10


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