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

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

#include <advancesectionmsg.h>

Inheritance diagram for AdvanceSectionMsg:
Collaboration diagram for AdvanceSectionMsg:

Public Member Functions

 AdvanceSectionMsg ()
 Construct a message with the position at kTickInfinity and the rest unset.
 AdvanceSectionMsg (Player *pPlayer, Sch::Tick position, int nTrack)
 Report an advance-section press.
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.
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 PrintExtra (std::ostream &stream) const
 Write this message's payload to a stream.
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

Player * mPlayer
Sch::Tick mPosition

Static Public Attributes

static int sID
 Identity that Type() reports, 113.

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x008eed08. It has Message as its one base. The object is 0x10 bytes and its vtable is at 0x007cf530. The allocation in New() and the allocation in Clone() report the same size.

The payload layout comes from the run of field copies in Clone(). The types come from InputMap::OnControllerReading(), the one builder, which stores the resolved player, the controller reading's position, and the track the player's slot 4 reports. mPlayer and mPosition are public because Gamer's DispatchPriv() at 0x001129e8 reads them directly with no accessor in the image.

The destructor at 0x0011d5e8 is compiler-generated and has no declaration here. The routine at 0x0011d620 is a further emission of the type-information accessor.

Constructor & Destructor Documentation

◆ AdvanceSectionMsg() [1/2]

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

◆ AdvanceSectionMsg() [2/2]

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

Report an advance-section press.

Inline, with no address of its own. InputMap::OnControllerReading() at 0x00119b18 expands it on its stack.

Parameters
pPlayerThe player the controller belongs to.
positionThe song position of the reading.
nTrackThe player's track.

Member Function Documentation

◆ New()

Message * AdvanceSectionMsg::New ( )
static

Produce a default-constructed message on the heap.

The translation unit at 0x003d9818 registers this factory against identity 113.

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d6ba8
Ghidra address:
PAL: 0x0040ea98

◆ Clone()

virtual Message * AdvanceSectionMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x0011d698
Ghidra address:
PAL: 0x0011dc20

Implements Message.

◆ Type()

virtual int AdvanceSectionMsg::Type ( )
virtual

Report this message's registered identity.

Returns
sID.
Ghidra address:
NTSC-U/C: 0x0011d6f0
Ghidra address:
PAL: 0x0011dc78

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal AdvanceSectionMsg.
Ghidra address:
NTSC-U/C: 0x0011d700
Ghidra address:
PAL: 0x0011dc88

Implements Message.

Member Data Documentation

◆ sID

int AdvanceSectionMsg::sID
static

Identity that Type() reports, 113.

Ghidra address:
NTSC-U/C: 0x006d0184
Ghidra address:
PAL: 0x0071391c

◆ mPlayer

Player* AdvanceSectionMsg::mPlayer

The player the controller belongs to. +0x04

◆ mPosition

Sch::Tick AdvanceSectionMsg::mPosition

The song position of the reading. +0x08


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