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

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

#include <phrasemuffedmsg.h>

Inheritance diagram for PhraseMuffedMsg:
Collaboration diagram for PhraseMuffedMsg:

Public Member Functions

 PhraseMuffedMsg ()
 Construct a message with the position at kTickInfinity and the rest unset.
 PhraseMuffedMsg (int nTrack, Player *pPlayer, Sch::Tick position, int nTried)
 Report a muffed phrase.
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 tr#, the track, a space, the player, a space, the position, tried:, and the word at +0x10 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 mTrack
Player * mPlayer
Sch::Tick mPosition
int mTried

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x00902280. It has Message as its one base. The object is 0x14 bytes and its vtable is at 0x00812348. 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() labels +0x04 as a track number and +0x10 as tried, dispatches Player::Print() through +0x08, and hands +0x0c to Sch::Tick::Print(). New() initialises that position to kTickInfinity. mPlayer is public because Overlay::OnPhraseMuffed() at 0x0042b178 reads it directly, comparing it with HudTrack::mPlayer. The other three are public because AppTunnel's muffed-phrase handler at 0x00447ba8 reads them directly.

After GetName() the image retains uncalled out-of-line copies of the two constructors, at 0x003e00b8 and 0x003e00d8, and of four member accessors: the position at 0x003e0100, the track at 0x003e0108, the player at 0x003e0110, and tried at 0x003e0118. No code calls the accessors. They are not declared here.

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

Constructor & Destructor Documentation

◆ PhraseMuffedMsg() [1/2]

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

◆ PhraseMuffedMsg() [2/2]

PhraseMuffedMsg::PhraseMuffedMsg ( int nTrack,
Player * pPlayer,
Sch::Tick position,
int nTried )
inline

Report a muffed phrase.

Inline, with no address of its own. Catcher::PostPhraseMuffedMsg() at 0x001ad470 expands it on its stack with the catcher's track and player. The builder stores the position straight from its argument register with no Sch::Tick::IsInRange() call, so the position arrives already a Sch::Tick. The four arguments are the four members in declaration order.

Parameters
nTrackThe track.
pPlayerThe player who muffed the phrase.
positionThe song position of the miss.
nTriedNon-zero when the player had attempted the phrase.

Member Function Documentation

◆ New()

Message * PhraseMuffedMsg::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: 0x003d76f0
Ghidra address:
PAL: 0x0040f5f0

◆ Clone()

virtual Message * PhraseMuffedMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x003e0038
Ghidra address:
PAL: 0x00418490

Implements Message.

◆ Type()

virtual int PhraseMuffedMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nPhraseMuffedMsgType.
Ghidra address:
NTSC-U/C: 0x003e0098
Ghidra address:
PAL: 0x004184f0

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal PhraseMuffedMsg.
Ghidra address:
NTSC-U/C: 0x003e00a8
Ghidra address:
PAL: 0x00418500

Implements Message.

◆ PrintExtra()

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

Write tr#, the track, a space, the player, a space, the position, tried:, and the word at +0x10 to a diagnostic stream.

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

Reimplemented from Message.

Member Data Documentation

◆ mTrack

int PhraseMuffedMsg::mTrack

The track. +0x04

◆ mPlayer

Player* PhraseMuffedMsg::mPlayer

The player who muffed the phrase. +0x08

◆ mPosition

Sch::Tick PhraseMuffedMsg::mPosition

The song position of the miss. +0x0c

◆ mTried

int PhraseMuffedMsg::mTried

Non-zero when the player had attempted the phrase. +0x10


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