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

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

#include <trackselectmsg.h>

Inheritance diagram for TrackSelectMsg:
Collaboration diagram for TrackSelectMsg:

Public Member Functions

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 player's colour name, tr#, the two words at +0x04 and +0x08 joined by /, a space, and the position 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
 The selected track.
int mPlace
 The place on the track.
Sch::Tick mPosition
 The song position of the selection.
Player * mPlayer
 Player the message is addressed to.

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x00902a20. It has Message as its one base. The object is 0x14 bytes and its vtable is at 0x00812d68. 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(). Every member is public, and each member's documentation identifies the reader outside the class that accesses it directly.

PrintExtra() hands mPosition to Sch::Tick::Print(), and New() initialises it to kTickInfinity.

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

Member Function Documentation

◆ New()

Message * TrackSelectMsg::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: 0x003d6e90
Ghidra address:
PAL: 0x0040ed80

◆ Clone()

virtual Message * TrackSelectMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x003dc930
Ghidra address:
PAL: 0x00414d68

Implements Message.

◆ Type()

virtual int TrackSelectMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_dwTrackSelectMsgType.
Ghidra address:
NTSC-U/C: 0x003dc990
Ghidra address:
PAL: 0x00414dc8

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal TrackSelectMsg.
Ghidra address:
NTSC-U/C: 0x003dc9a0
Ghidra address:
PAL: 0x00414dd8

Implements Message.

◆ PrintExtra()

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

Write the player's colour name, tr#, the two words at +0x04 and +0x08 joined by /, a space, and the position to a diagnostic stream.

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

Reimplemented from Message.

Member Data Documentation

◆ mTrack

int TrackSelectMsg::mTrack

The selected track.

Copied into NetPlayer +0x48 by its handler at 0x00125f70. +0x04

GrooveWorld::CreateRenderer() at 0x0018caa8 writes the player's GetTrack() result here, and LocalPlayer's handler copies it into the player's track.

◆ mPlace

int TrackSelectMsg::mPlace

The place on the track.

Copied into NetPlayer +0x4c by the same handler. +0x08

GrooveWorld::CreateRenderer() writes zero here, and the song position and player below. LocalPlayer's handler copies it into the player's place.

◆ mPosition

Sch::Tick TrackSelectMsg::mPosition

The song position of the selection.

+0x0c

Catcher::OnTrackSelect() at 0x001ac550 reads it directly with no accessor in the image, dividing its tick by the catcher's ticks per bar to find the selected bar.

◆ mPlayer

Player* TrackSelectMsg::mPlayer

Player the message is addressed to.

NetPlayer::DispatchPriv() compares this member against the receiving player and acts only on a match, which is what types it as a player rather than as a payload word.

+0x10


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