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

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

#include <showeraseeffectmsg.h>

Inheritance diagram for ShowEraseEffectMsg:
Collaboration diagram for ShowEraseEffectMsg:

Public Member Functions

 ShowEraseEffectMsg ()
 Construct a message with every field unset.
 ShowEraseEffectMsg (Player *pPlayer, int nTrack, int nFirstBar, int nEndBar, int nEffectFlag)
 Report one erased range.
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

Player * mPlayer
int mTrack
int mFirstBar
int mEndBar

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x00901df0. It has Message as its one base. The object is 0x18 bytes and its vtable is at 0x007ddb50. 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(). Scratcher::EraseGemRange() builds it on the stack at 0x001d0194 with the erased range as a first bar and an end bar one past the last. A single erased bar therefore gives an end one greater than its start.

mPlayer, mFirstBar, and mEndBar are public because Overlay::OnShowEraseEffect() at 0x0041fba0 reads them directly with no accessor in the image. It compares mPlayer with HudTrack::mPlayer and shows BAR ERASED when mEndBar - mFirstBar < 2, TRACK ERASED otherwise. mTrack is public because AppTunnel's erase handler at 0x004481d0 reads it directly. Scratcher stores its own track there. The purpose of the word at +0x14 is not recovered.

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

Constructor & Destructor Documentation

◆ ShowEraseEffectMsg() [1/2]

ShowEraseEffectMsg::ShowEraseEffectMsg ( )
inline

Construct a message with every field unset.

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

◆ ShowEraseEffectMsg() [2/2]

ShowEraseEffectMsg::ShowEraseEffectMsg ( Player * pPlayer,
int nTrack,
int nFirstBar,
int nEndBar,
int nEffectFlag )
inline

Report one erased range.

Inline, with no address of its own. AxePhraseMaker::Erase() expands it on its stack at 0x0019c074 with 1 in the word at +0x14.

Parameters
pPlayerThe player who erased the range.
nTrackThe erased track.
nFirstBarThe first erased bar.
nEndBarThe bar one past the last erased bar.
nEffectFlagStored in the word at +0x14. Both builders pass 1, and neither handler reads it.

Member Function Documentation

◆ New()

Message * ShowEraseEffectMsg::New ( )
static

Produce a default-constructed message on the heap.

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

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d7210
Ghidra address:
PAL: 0x0040f110

◆ Clone()

virtual Message * ShowEraseEffectMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x0019d6b0
Ghidra address:
PAL: 0x001a3418

Implements Message.

◆ Type()

virtual int ShowEraseEffectMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nShowEraseEffectMsgType.
Ghidra address:
NTSC-U/C: 0x0019d718
Ghidra address:
PAL: 0x001a3480

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal ShowEraseEffectMsg.
Ghidra address:
NTSC-U/C: 0x0019d728
Ghidra address:
PAL: 0x001a3490

Implements Message.

Member Data Documentation

◆ mPlayer

Player* ShowEraseEffectMsg::mPlayer

The player who erased the range. +0x04

◆ mTrack

int ShowEraseEffectMsg::mTrack

The erased track. +0x08

◆ mFirstBar

int ShowEraseEffectMsg::mFirstBar

The first erased bar. +0x0c

◆ mEndBar

int ShowEraseEffectMsg::mEndBar

The bar one past the last erased bar. +0x10


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