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

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

#include <freestylefxmsg.h>

Inheritance diagram for FreestyleFXMsg:
Collaboration diagram for FreestyleFXMsg:

Public Member Functions

 FreestyleFXMsg ()
 Construct a message with the payload unset.
 FreestyleFXMsg (int nTrack, int nBar, int nEndBar)
 Report a freestyle effect over a range of 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.
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

int mTrack
 The track.

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x00902260. It has Message as its one base. The object is 0x10 bytes and its vtable is at 0x007ce648. 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 names come from Gamer's two builds, which store a track, a first bar, and an end bar (the first bar plus 8 at 0x001111b8). Only mTrack has a traced reader outside the class.

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

Constructor & Destructor Documentation

◆ FreestyleFXMsg() [1/2]

FreestyleFXMsg::FreestyleFXMsg ( )
inline

Construct a message with the payload unset.

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

◆ FreestyleFXMsg() [2/2]

FreestyleFXMsg::FreestyleFXMsg ( int nTrack,
int nBar,
int nEndBar )
inline

Report a freestyle effect over a range of bars on a track.

Inline, with no address of its own. Gamer's builds at 0x001111ac and 0x00111f20 expand it on their stacks. The three arguments are the three members in declaration order.

Parameters
nTrackThe track.
nBarThe first bar.
nEndBarThe bar the effect ends at.

Member Function Documentation

◆ New()

Message * FreestyleFXMsg::New ( )
static

Produce a default-constructed message on the heap.

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

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d7398
Ghidra address:
PAL: 0x0040f298

◆ Clone()

virtual Message * FreestyleFXMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x00116500
Ghidra address:
PAL: 0x001169a8

Implements Message.

◆ Type()

virtual int FreestyleFXMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nFreestyleFXMsgType.
Ghidra address:
NTSC-U/C: 0x00116558
Ghidra address:
PAL: 0x00116a00

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal FreestyleFXMsg.
Ghidra address:
NTSC-U/C: 0x00116568
Ghidra address:
PAL: 0x00116a10

Implements Message.

Member Data Documentation

◆ mTrack

int FreestyleFXMsg::mTrack

The track.

+0x04

Public because AppTunnel's freestyle handler at 0x00448a08 reads it directly with no accessor in the image.


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