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

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

#include <deployedpowerupmsg.h>

Inheritance diagram for DeployedPowerupMsg:
Collaboration diagram for DeployedPowerupMsg:

Public Member Functions

 DeployedPowerupMsg ()
 Construct a message with every payload word indeterminate.
 DeployedPowerupMsg (PowerupType kind, Player *pPlayer, Player *pTarget, int nFirstBar, int nBarCount, int nTrack)
 Report a deployed powerup.
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

PowerupType mKind
Player * mPlayer
Player * mTarget
int mFirstBar
int mBarCount
int mTrack

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x008ef7c0. It has Message as its one base. The object is 0x1c bytes and its vtable is at 0x007d0080. 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 first three words are public because Overlay::OnDeployedPowerup() at 0x0041eda8 reads them directly with no accessor in the image. It passes mKind to HudPowerupName(), compares mPlayer with HudTrack::mPlayer, and, when mKind is kHudItemBumper, compares mTarget with HudTrack::mPlayer as well. The last three words are public because AppTunnel's powerup handler at 0x00448d58 reads them directly. It scales mFirstBar by the 1920 ticks of a bar, walks mBarCount bars from it, and matches mTrack against each tunnel item's track.

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

Constructor & Destructor Documentation

◆ DeployedPowerupMsg() [1/2]

DeployedPowerupMsg::DeployedPowerupMsg ( )
inline

Construct a message with every payload word indeterminate.

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

◆ DeployedPowerupMsg() [2/2]

DeployedPowerupMsg::DeployedPowerupMsg ( PowerupType kind,
Player * pPlayer,
Player * pTarget,
int nFirstBar,
int nBarCount,
int nTrack )
inline

Report a deployed powerup.

Inline, with no address of its own. LocalPlayer's multiplier handler at 0x0011eb48 expands it on its stack. The six arguments are the six members in declaration order.

Parameters
kindThe deployed powerup.
pPlayerThe deploying player.
pTargetThe player a bumper strikes.
nFirstBarThe first bar the powerup covers.
nBarCountThe number of bars it covers.
nTrackThe track it acts on.

Member Function Documentation

◆ New()

Message * DeployedPowerupMsg::New ( )
static

Produce a default-constructed message on the heap.

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

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d7000
Ghidra address:
PAL: 0x0040eef0

◆ Clone()

virtual Message * DeployedPowerupMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x00122290
Ghidra address:
PAL: 0x001228a8

Implements Message.

◆ Type()

virtual int DeployedPowerupMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nDeployedPowerupMsgType.
Ghidra address:
NTSC-U/C: 0x00122300
Ghidra address:
PAL: 0x00122918

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal DeployedPowerupMsg.
Ghidra address:
NTSC-U/C: 0x00122310
Ghidra address:
PAL: 0x00122928

Implements Message.

Member Data Documentation

◆ mKind

PowerupType DeployedPowerupMsg::mKind

The deployed powerup. +0x04

◆ mPlayer

Player* DeployedPowerupMsg::mPlayer

The deploying player. +0x08

◆ mTarget

Player* DeployedPowerupMsg::mTarget

The player a bumper strikes. +0x0c

◆ mFirstBar

int DeployedPowerupMsg::mFirstBar

The first bar the powerup covers. +0x10

◆ mBarCount

int DeployedPowerupMsg::mBarCount

The number of bars it covers. +0x14

◆ mTrack

int DeployedPowerupMsg::mTrack

The track it acts on. +0x18


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