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

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

#include <axisfxmsg.h>

Inheritance diagram for AxisFXMsg:
Collaboration diagram for AxisFXMsg:

Public Member Functions

 AxisFXMsg ()
 Construct a message with the position at kTickInfinity and the rest unset.
 AxisFXMsg (Player *pPlayer, float flValue, Sch::Tick position, int nTrack)
 Report an effect-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

float mValue
 The axis value.

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x00901b00. It has Message as its one base. The object is 0x14 bytes and its vtable is at 0x00813280. 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 0x003dabd8 is compiler-generated and has no declaration here.

Constructor & Destructor Documentation

◆ AxisFXMsg() [1/2]

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

◆ AxisFXMsg() [2/2]

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

Report an effect-axis movement.

Inline, with no address of its own. InputMap::OnControllerReading() at 0x001199ac 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 * AxisFXMsg::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: 0x003d6a28
Ghidra address:
PAL: 0x0040e918

◆ Clone()

virtual Message * AxisFXMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x003dacc8
Ghidra address:
PAL: 0x00413100

Implements Message.

◆ Type()

virtual int AxisFXMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nAxisFXMsgType.
Ghidra address:
NTSC-U/C: 0x003dad28
Ghidra address:
PAL: 0x00413160

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal AxisFXMsg.
Ghidra address:
NTSC-U/C: 0x003dad38
Ghidra address:
PAL: 0x00413170

Implements Message.

◆ PrintExtra()

virtual void AxisFXMsg::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: 0x003e3240
Ghidra address:
PAL: 0x0040fe08

Reimplemented from Message.

Member Data Documentation

◆ mValue

float AxisFXMsg::mValue

The axis value.

+0x08

Public because AxeFX::DispatchPriv() at 0x0019b538 and AxeFX::OnAxisFX() at 0x0019b498 read it directly, and the image has no accessor.


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