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

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

#include <buttonpowmsg.h>

Inheritance diagram for ButtonPowMsg:
Collaboration diagram for ButtonPowMsg:

Public Member Functions

 ButtonPowMsg ()
 Construct a message with the position at kTickInfinity and the rest unset.
 ButtonPowMsg (Player *pPlayer, int nPlayMode, Sch::Tick position)
 Report a powerup button press.
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.
virtual void PrintExtra (std::ostream &stream) const
 Write the position, the player's colour name, and the word at +0x08, separated by spaces, to a diagnostic stream.
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 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
 The player the controller belongs to.

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x008eec88. It has Message as its one base. The object is 0x10 bytes and its vtable is at 0x008131a8. The members below are the whole of the class. No other routine in the image refers to this type by anything but its vtable.

The payload layout comes from the run of field copies in Clone(). PrintExtra() hands +0x0c to Sch::Tick::Print() and writes the colour name of the player at +0x04, which types both. The purpose of the word at +0x08 is not recovered. InputMap::OnControllerReading() stores 1 there at both of its builds, once after testing that the play mode is 1 and once as a constant.

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

Constructor & Destructor Documentation

◆ ButtonPowMsg() [1/2]

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

◆ ButtonPowMsg() [2/2]

ButtonPowMsg::ButtonPowMsg ( Player * pPlayer,
int nPlayMode,
Sch::Tick position )
inline

Report a powerup button press.

Inline, with no address of its own. InputMap::OnControllerReading() expands it on its stack at 0x00119a18 and 0x00119c50.

Parameters
pPlayerThe player the controller belongs to.
nPlayModeThe word at +0x08, 1 at both builds. One build passes the game play mode.
positionThe song position of the reading.

Member Function Documentation

◆ New()

Message * ButtonPowMsg::New ( )
static

Produce a default-constructed message on the heap.

The translation unit at 0x003d9818 registers this factory. Only the position is initialised.

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d6ae8
Ghidra address:
PAL: 0x0040e9d8

◆ Clone()

virtual Message * ButtonPowMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x003db220
Ghidra address:
PAL: 0x00413658

Implements Message.

◆ Type()

virtual int ButtonPowMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nButtonPowMsgType.
Ghidra address:
NTSC-U/C: 0x003db278
Ghidra address:
PAL: 0x004136b0

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal ButtonPowMsg.
Ghidra address:
NTSC-U/C: 0x003db288
Ghidra address:
PAL: 0x004136c0

Implements Message.

◆ PrintExtra()

virtual void ButtonPowMsg::PrintExtra ( std::ostream & stream) const
virtual

Write the position, the player's colour name, and the word at +0x08, separated by spaces, to a diagnostic stream.

Parameters
streamThe stream to write to.
Ghidra address:
NTSC-U/C: 0x003d7df0
Ghidra address:
PAL: 0x0040ff08

Reimplemented from Message.

Member Data Documentation

◆ mPlayer

Player* ButtonPowMsg::mPlayer

The player the controller belongs to.

Public because LocalPlayer::DispatchPriv() reads it directly at 0x0011f004, and the image has no accessor. +0x04


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