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

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

#include <invalidatetrackmsg.h>

Inheritance diagram for InvalidateTrackMsg:
Collaboration diagram for InvalidateTrackMsg:

Public Member Functions

 InvalidateTrackMsg ()
 Construct a message with the payload unset.
 InvalidateTrackMsg (int nFirstBar, int nEndBar, int nTrack)
 Invalidate a range of song bars on a track.
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 word at +0x0c, song-bars , and the two words at +0x04 and +0x08 joined by - 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 mFirstBar
int mEndBar
int mTrack

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x008ef400. It has Message as its one base. The object is 0x10 bytes and its vtable is at 0x00812858. 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 mTrack as a track number and mFirstBar through mEndBar as a range of song bars. The end is one past the last bar, because the stack build at 0x00101e6c invalidates a single bar as that bar and the bar after it.

Every member is public because PhraseMgr::OnInvalidateTrack() at 0x001c0110 reads all three directly with no accessor in the image.

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

Constructor & Destructor Documentation

◆ InvalidateTrackMsg() [1/2]

InvalidateTrackMsg::InvalidateTrackMsg ( )
inline

Construct a message with the payload unset.

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

◆ InvalidateTrackMsg() [2/2]

InvalidateTrackMsg::InvalidateTrackMsg ( int nFirstBar,
int nEndBar,
int nTrack )
inline

Invalidate a range of song bars on a track.

Inline, with no address of its own. The two stack builds at 0x00101ce0 and 0x00101e6c expand it. The three arguments are the three members in declaration order.

Parameters
nFirstBarThe first song bar of the range.
nEndBarThe song bar one past the last of the range.
nTrackThe track.

Member Function Documentation

◆ New()

Message * InvalidateTrackMsg::New ( )
static

Produce a default-constructed message on the heap.

The translation unit at 0x003d9818 registers this factory. The payload is left unset.

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d72b8
Ghidra address:
PAL: 0x0040f1b8

◆ Clone()

virtual Message * InvalidateTrackMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x003de450
Ghidra address:
PAL: 0x004168a8

Implements Message.

◆ Type()

virtual int InvalidateTrackMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nInvalidateTrackMsgType.
Ghidra address:
NTSC-U/C: 0x003de4a8
Ghidra address:
PAL: 0x00416900

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal InvalidateTrackMsg.
Ghidra address:
NTSC-U/C: 0x003de4b8
Ghidra address:
PAL: 0x00416910

Implements Message.

◆ PrintExtra()

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

Write tr#, the word at +0x0c, song-bars , and the two words at +0x04 and +0x08 joined by - to a diagnostic stream.

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

Reimplemented from Message.

Member Data Documentation

◆ mFirstBar

int InvalidateTrackMsg::mFirstBar

The first song bar of the range. +0x04

◆ mEndBar

int InvalidateTrackMsg::mEndBar

The song bar one past the last of the range. +0x08

◆ mTrack

int InvalidateTrackMsg::mTrack

The track. +0x0c


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