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

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

#include <axisregistermsg.h>

Inheritance diagram for AxisRegisterMsg:
Collaboration diagram for AxisRegisterMsg:

Public Member Functions

 AxisRegisterMsg ()
 Construct a message with the position at kTickInfinity and the rest unset.
 AxisRegisterMsg (Player *pPlayer, float flValue, Sch::Tick position, int nTrack)
 Report a register-axis movement.
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, the player's colour name, and the float at +0x08, separated by spaces, 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

Player * mPlayer
float mValue
Sch::Tick mPosition
 The song position of the reading.
int mTrack
 The player's track.

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x008eed48. It has Message as its one base. The object is 0x14 bytes and its vtable is at 0x008132c8. 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() and writes the colour name of the player at +0x04, which types both. The float at +0x08 is printed without a label, and the word at +0x10 is not printed. InputMap::OnControllerReading(), the one builder, stores the reading's axis value at +0x08 and the track the player's slot 4 reports at +0x10.

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

Constructor & Destructor Documentation

◆ AxisRegisterMsg() [1/2]

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

◆ AxisRegisterMsg() [2/2]

AxisRegisterMsg::AxisRegisterMsg ( Player * pPlayer,
float flValue,
Sch::Tick position,
int nTrack )
inline

Report a register-axis movement.

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

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

Member Function Documentation

◆ New()

Message * AxisRegisterMsg::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: 0x003d69e8
Ghidra address:
PAL: 0x0040e8d8

◆ Clone()

virtual Message * AxisRegisterMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x003daaf0
Ghidra address:
PAL: 0x00412f28

Implements Message.

◆ Type()

virtual int AxisRegisterMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nAxisRegisterMsgType.
Ghidra address:
NTSC-U/C: 0x003dab50
Ghidra address:
PAL: 0x00412f88

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal AxisRegisterMsg.
Ghidra address:
NTSC-U/C: 0x003dab60
Ghidra address:
PAL: 0x00412f98

Implements Message.

◆ PrintExtra()

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

Write the position, the player's colour name, and the float at +0x08, separated by spaces, to a diagnostic stream.

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

Reimplemented from Message.

Member Data Documentation

◆ mPlayer

Player* AxisRegisterMsg::mPlayer

The player the controller belongs to. +0x04

◆ mValue

float AxisRegisterMsg::mValue

The axis value. +0x08

◆ mPosition

Sch::Tick AxisRegisterMsg::mPosition

The song position of the reading.

+0x0c

Public because AxisControl::OnAxisRegister() at 0x0019ea80 and Scratcher::PostNowBarMsg() at 0x001cfd20 read it directly.

◆ mTrack

int AxisRegisterMsg::mTrack

The player's track.

+0x10

Public because AxePhraseMaker::DispatchPriv() at 0x0019c448 compares it with its own track directly, and the image has no accessor.


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