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

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

#include <multipliermsg.h>

Inheritance diagram for MultiplierMsg:
Collaboration diagram for MultiplierMsg:

Public Member Functions

 MultiplierMsg ()
 Construct a message with every payload word indeterminate.
 MultiplierMsg (Player *pPlayer, int nBar, int nFactor)
 Report a multiplier powerup deployed by 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 mBar
 The bar the multiplier bonus starts at.

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x008eec78. It has Message as its one base. The object is 0x10 bytes and its vtable is at 0x007e44e0. 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(), and the stack build in MultiplierPowerup::Deploy() fixes the meaning of the first two words. LocalPlayer's handler reads only mBar, so the other two words are private.

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

Constructor & Destructor Documentation

◆ MultiplierMsg() [1/2]

MultiplierMsg::MultiplierMsg ( )
inline

Construct a message with every payload word indeterminate.

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

◆ MultiplierMsg() [2/2]

MultiplierMsg::MultiplierMsg ( Player * pPlayer,
int nBar,
int nFactor )
inline

Report a multiplier powerup deployed by a player.

Inline, with no address of its own. MultiplierPowerup::Deploy() expands it on its stack at 0x001ca238, passing 4 as nFactor.

Parameters
pPlayerThe player who deployed the powerup.
nBarThe bar the multiplier bonus starts at.
nFactorThe multiplier the powerup requests. No reader is recorded, and the title is inferred from the value the one builder passes.

Member Function Documentation

◆ New()

Message * MultiplierMsg::New ( )
static

Produce a default-constructed message on the heap.

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

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d6c60
Ghidra address:
PAL: 0x0040eb50

◆ Clone()

virtual Message * MultiplierMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x001cab30
Ghidra address:
PAL: 0x001d09e8

Implements Message.

◆ Type()

virtual int MultiplierMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nMultiplierMsgType.
Ghidra address:
NTSC-U/C: 0x001cab88
Ghidra address:
PAL: 0x001d0a40

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal MultiplierMsg.
Ghidra address:
NTSC-U/C: 0x001cab98
Ghidra address:
PAL: 0x001d0a50

Implements Message.

Member Data Documentation

◆ mBar

int MultiplierMsg::mBar

The bar the multiplier bonus starts at.

Public because LocalPlayer's multiplier handler at 0x0011eb44 reads it directly and ends the bonus eight bars later, and the image has no accessor. +0x08


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