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

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

#include <multiplierstatemsg.h>

Inheritance diagram for MultiplierStateMsg:
Collaboration diagram for MultiplierStateMsg:

Public Member Functions

 MultiplierStateMsg ()
 Construct a message with every payload word indeterminate.
 MultiplierStateMsg (Player *pPlayer, int nMultiplier, int nBonus)
 Report a player's multiplier.
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 mMultiplier
int mBonus

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x008ef100. It has Message as its one base. The object is 0x10 bytes and its vtable is at 0x007cffa8. 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 producer at 0x0011eb20 writes the player, its base multiplier plus one, and its bonus multiplier.

Every member is public because Overlay::OnMultiplierState() at 0x00420408 reads it directly with no accessor in the image. It compares mPlayer with HudTrack::mPlayer, shows the sum of mMultiplier and mBonus, and selects the hot material when mBonus is non-zero.

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

Constructor & Destructor Documentation

◆ MultiplierStateMsg() [1/2]

MultiplierStateMsg::MultiplierStateMsg ( )
inline

Construct a message with every payload word indeterminate.

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

◆ MultiplierStateMsg() [2/2]

MultiplierStateMsg::MultiplierStateMsg ( Player * pPlayer,
int nMultiplier,
int nBonus )
inline

Report a player's multiplier.

Inline, with no address of its own. LocalPlayer expands it on its stack at 0x0011eb98 and 0x0011ec90.

Parameters
pPlayerThe player whose multiplier changed.
nMultiplierThe base multiplier.
nBonusThe multiplier added on top of the base, or zero.

Member Function Documentation

◆ New()

Message * MultiplierStateMsg::New ( )
static

Produce a default-constructed message on the heap.

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

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d6c98
Ghidra address:
PAL: 0x0040eb88

◆ Clone()

virtual Message * MultiplierStateMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x00122610
Ghidra address:
PAL: 0x00122c28

Implements Message.

◆ Type()

virtual int MultiplierStateMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nMultiplierStateMsgType.
Ghidra address:
NTSC-U/C: 0x00122668
Ghidra address:
PAL: 0x00122c80

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal MultiplierStateMsg.
Ghidra address:
NTSC-U/C: 0x00122678
Ghidra address:
PAL: 0x00122c90

Implements Message.

Member Data Documentation

◆ mPlayer

Player* MultiplierStateMsg::mPlayer

The player whose multiplier changed. +0x04

◆ mMultiplier

int MultiplierStateMsg::mMultiplier

The base multiplier. +0x08

◆ mBonus

int MultiplierStateMsg::mBonus

The multiplier added on top of the base, or zero. +0x0c


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