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

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

#include <remixfxmsg.h>

Inheritance diagram for RemixFXMsg:
Collaboration diagram for RemixFXMsg:

Public Member Functions

 RemixFXMsg ()
 Construct a message with every field unset.
 RemixFXMsg (int nTrack, int nBar, int nEffect, int bEnabled, Player *pPlayer)
 Report one remix effect toggle.
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.

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x008ef640. It has Message as its one base. The object is 0x18 bytes and its vtable is at 0x00812b28. 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() and from the stack build in JamEffectsMgr::PostRemixFxMsg() at 0x001a55d4. That build stores the vtable 0x007df1e0 rather than 0x00812b28, a second emission of the same table in the unit that constructs it. Readers of the fields have not been traced, so they are private.

Constructor & Destructor Documentation

◆ RemixFXMsg() [1/2]

RemixFXMsg::RemixFXMsg ( )
inline

Construct a message with every field unset.

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

◆ RemixFXMsg() [2/2]

RemixFXMsg::RemixFXMsg ( int nTrack,
int nBar,
int nEffect,
int bEnabled,
Player * pPlayer )
inline

Report one remix effect toggle.

Inline, with no address of its own. JamEffectsMgr::PostRemixFxMsg() expands it on its stack at 0x001a55d4.

Parameters
nTrackThe track.
nBarThe bar.
nEffectThe effect type.
bEnabledNon-zero when the effect is now on for the bar.
pPlayerThe deploying player, JamEffectMsg::mPlayer passed through.

Member Function Documentation

◆ New()

Message * RemixFXMsg::New ( )
static

Produce a default-constructed message on the heap.

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

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d7070
Ghidra address:
PAL: 0x0040ef60

◆ Clone()

virtual Message * RemixFXMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x001a6250
Ghidra address:
PAL: 0x001abfb8

Implements Message.

◆ Type()

virtual int RemixFXMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nRemixFXMsgType.
Ghidra address:
NTSC-U/C: 0x001a62b8
Ghidra address:
PAL: 0x001ac020

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal RemixFXMsg.
Ghidra address:
NTSC-U/C: 0x001a62c8
Ghidra address:
PAL: 0x001ac030

Implements Message.


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