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

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

#include <pointamountmsg.h>

Inheritance diagram for PointAmountMsg:
Collaboration diagram for PointAmountMsg:

Public Member Functions

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 player to a diagnostic stream through Player::Print().
int GetScore ()
 Report the player's score.
float GetScoreFraction ()
 Report the player's score as a fraction of mMaxScore.
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
int mMaxScore
 The score ceiling, capped at 800.

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x008eecc8. It has Message as its one base. The object is 0xc bytes and its vtable is at 0x00812198. 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() dispatches Player::Print() through the word at +0x04, which types it. Player::AddScore() fills the word at +0x08 with the capped score ceiling. mPlayer is public because Overlay::OnPointAmount() at 0x0042aff0 reads it directly with no accessor in the image, comparing it with HudBadge::mPlayer.

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

Member Function Documentation

◆ New()

Message * PointAmountMsg::New ( )
static

Produce a default-constructed message on the heap.

The translation unit at 0x003d9818 registers this factory. The payload is left unset.

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d7850
Ghidra address:
PAL: 0x0040f750

◆ Clone()

virtual Message * PointAmountMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x003e0a48
Ghidra address:
PAL: 0x00418ea0

Implements Message.

◆ Type()

virtual int PointAmountMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nPointAmountMsgType.
Ghidra address:
NTSC-U/C: 0x003e0a98
Ghidra address:
PAL: 0x00418ef0

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal PointAmountMsg.
Ghidra address:
NTSC-U/C: 0x003e0aa8
Ghidra address:
PAL: 0x00418f00

Implements Message.

◆ PrintExtra()

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

Write the player to a diagnostic stream through Player::Print().

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

Reimplemented from Message.

◆ GetScore()

int PointAmountMsg::GetScore ( )

Report the player's score.

Forwards to Player::GetScore(). Overlay::DispatchPriv() at 0x00420848 and Overlay::OnPointAmount() at 0x0042b040 call it. The name is inferred from the accessor it forwards to.

Returns
The score.
Ghidra address:
NTSC-U/C: 0x003e40d8
Ghidra address:
PAL: 0x0041c308

◆ GetScoreFraction()

float PointAmountMsg::GetScoreFraction ( )

Report the player's score as a fraction of mMaxScore.

Both values are converted to float before the division. The image lists no caller. The name is inferred.

Returns
The score divided by mMaxScore.
Ghidra address:
NTSC-U/C: 0x003e40f8
Ghidra address:
PAL: 0x0041c328

Member Data Documentation

◆ mPlayer

Player* PointAmountMsg::mPlayer

The player whose score changed. +0x04

◆ mMaxScore

int PointAmountMsg::mMaxScore

The score ceiling, capped at 800.

Public because Player::AddScore() writes it directly at 0x0012f89c, and the image has no accessor. +0x08


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