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

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

#include <axebuttonmsg.h>

Inheritance diagram for AxeButtonMsg:
Collaboration diagram for AxeButtonMsg:

Public Member Functions

 AxeButtonMsg ()
 Construct a message with the payload unset.
 AxeButtonMsg (int nPressed, int nRestartSpin, Player *pPlayer)
 Report a button change for a player.
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 mPressed
int mRestartSpin
Player * mPlayer

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x008ef450. It has Message as its one base. The object is 0x10 bytes and its vtable is at 0x007dd3f0. 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 stack builds fix the player at +0x0c. Scratcher's build at 0x001d07f4 stores the same scratcher word that its ShowEraseEffectMsg build stores as the player, and Overlay compares that word with HudTrack::mPlayer. AutoRiffer stores 1 at +0x04 when a riff starts and 0 when it stops. The purpose of the word at +0x08 is not recovered. Every member is public because AppTunnel::DispatchPriv() at 0x004499c4 reads all three directly with no accessor in the image.

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

Constructor & Destructor Documentation

◆ AxeButtonMsg() [1/2]

AxeButtonMsg::AxeButtonMsg ( )
inline

Construct a message with the payload unset.

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

◆ AxeButtonMsg() [2/2]

AxeButtonMsg::AxeButtonMsg ( int nPressed,
int nRestartSpin,
Player * pPlayer )
inline

Report a button change for a player.

Inline, with no address of its own. AutoRiffer::OnPitchRiff() at 0x00199278, AutoRiffer::OnStopRiff() at 0x00199414, and the Voxer and Scratcher members expand it on their stacks. The three arguments are the three members in declaration order.

Parameters
nPressedNon-zero when the button goes down.
nRestartSpinThe word at +0x08, 1 from Scratcher and 0 from every other builder.
pPlayerThe player.

Member Function Documentation

◆ New()

Message * AxeButtonMsg::New ( )
static

Produce a default-constructed message on the heap.

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

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d76b8
Ghidra address:
PAL: 0x0040f5b8

◆ Clone()

virtual Message * AxeButtonMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x0019a748
Ghidra address:
PAL: 0x001a04b0

Implements Message.

◆ Type()

virtual int AxeButtonMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nAxeButtonMsgType.
Ghidra address:
NTSC-U/C: 0x0019a7a0
Ghidra address:
PAL: 0x001a0508

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal AxeButtonMsg.
Ghidra address:
NTSC-U/C: 0x0019a7b0
Ghidra address:
PAL: 0x001a0518

Implements Message.

Member Data Documentation

◆ mPressed

int AxeButtonMsg::mPressed

Non-zero when the button goes down. +0x04

◆ mRestartSpin

int AxeButtonMsg::mRestartSpin

AppTunnel passes it to TnlPointer::Spin() on a press. +0x08

◆ mPlayer

Player* AxeButtonMsg::mPlayer

The player. +0x0c


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