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

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

#include <cleargemmsg.h>

Inheritance diagram for ClearGemMsg:
Collaboration diagram for ClearGemMsg:

Public Member Functions

 ClearGemMsg ()
 Construct a message with the position at kTickInfinity and the rest unset.
 ClearGemMsg (Sch::Tick position, int nTrack, int nGem)
 Clear one gem.
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

Sch::Tick mPosition
int mTrack
int mGem

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x008ef7f0. It has Message as its one base. The object is 0x10 bytes and its vtable is at 0x007e2818. 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(). Every member is public because AppTunnel::DispatchPriv() at 0x00449790 reads them directly with no accessor in the image. It converts mPosition's tick and mGem to floats and loads mTrack with lb, which reads only the low byte of the word.

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

Constructor & Destructor Documentation

◆ ClearGemMsg() [1/2]

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

◆ ClearGemMsg() [2/2]

ClearGemMsg::ClearGemMsg ( Sch::Tick position,
int nTrack,
int nGem )
inline

Clear one gem.

Inline, with no address of its own. PhraseMgr::AddGem() expands it on its stack at 0x001bad0c with a Sch::Tick::IsInRange-checked position and the manager's track.

Parameters
positionThe song position of the gem.
nTrackThe track.
nGemThe gem.

Member Function Documentation

◆ New()

Message * ClearGemMsg::New ( )
static

Produce a default-constructed message on the heap.

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

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d74b8
Ghidra address:
PAL: 0x0040f3b8

◆ Clone()

virtual Message * ClearGemMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x001bf8e0
Ghidra address:
PAL: 0x001c5700

Implements Message.

◆ Type()

virtual int ClearGemMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nClearGemMsgType.
Ghidra address:
NTSC-U/C: 0x001bf938
Ghidra address:
PAL: 0x001c5758

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal ClearGemMsg.
Ghidra address:
NTSC-U/C: 0x001bf948
Ghidra address:
PAL: 0x001c5768

Implements Message.

Member Data Documentation

◆ mPosition

Sch::Tick ClearGemMsg::mPosition

The song position of the gem to clear. +0x04

◆ mTrack

int ClearGemMsg::mTrack

The track. +0x08

◆ mGem

int ClearGemMsg::mGem

The gem. +0x0c


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