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

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

#include <displaypointermsg.h>

Inheritance diagram for DisplayPointerMsg:
Collaboration diagram for DisplayPointerMsg:

Public Member Functions

 DisplayPointerMsg ()
 Construct a message with the payload unset.
 DisplayPointerMsg (int nBar, int nPlayerValue, Player *pPlayer)
 Report where a player's powerup pointer rests.
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 remove when mPlayerValue is -1, and otherwise tr# , mPlayerValue, :, the bar, a space, and the player's colour name, 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

int mBar
int mPlayerValue
Player * mPlayer

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x00901e30. It has Message as its one base. The object is 0x10 bytes and its vtable is at 0x00812a98. 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(), so the offsets and widths are recovered but the purpose of each field is not.

PrintExtra() labels mPlayerValue as a track number, tr# , and writes remove in its place when it is -1.

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

Constructor & Destructor Documentation

◆ DisplayPointerMsg() [1/2]

DisplayPointerMsg::DisplayPointerMsg ( )
inline

Construct a message with the payload unset.

Inline. New() expands it and stores only the vtable pointer. A declaration is required because the class declares a second constructor.

◆ DisplayPointerMsg() [2/2]

DisplayPointerMsg::DisplayPointerMsg ( int nBar,
int nPlayerValue,
Player * pPlayer )

Report where a player's powerup pointer rests.

No address attaches to the constructor. GamePowerupPlacer builds the message on its own stack at six sites and hands the address to MsgSource::Send(). Four of them, at 0x001ccd64, 0x001cce04, 0x001ccec8, and 0x001cd0ec, expand this constructor. The two remove sites, at 0x001ccdac and 0x001ccfc0, store only mPlayerValue and mPlayer into a default-constructed message. The three arguments are the three members in declaration order.

Parameters
nBarThe bar the pointer rests on.
nPlayerValueWhatever Player::GetTrack() reports for the player.
pPlayerThe player whose pointer moved.

Member Function Documentation

◆ New()

Message * DisplayPointerMsg::New ( )
static

Produce a default-constructed message on the heap.

The translation unit at 0x003d9818 registers this factory.

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d70e0
Ghidra address:
PAL: 0x0040efd0

◆ Clone()

virtual Message * DisplayPointerMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x003dd980
Ghidra address:
PAL: 0x00415db8

Implements Message.

◆ Type()

virtual int DisplayPointerMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nDisplayPointerMsgType.
Ghidra address:
NTSC-U/C: 0x003dd9d8
Ghidra address:
PAL: 0x00415e10

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal DisplayPointerMsg.
Ghidra address:
NTSC-U/C: 0x003dd9e8
Ghidra address:
PAL: 0x00415e20

Implements Message.

◆ PrintExtra()

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

Write remove when mPlayerValue is -1, and otherwise tr# , mPlayerValue, :, the bar, a space, and the player's colour name, to a diagnostic stream.

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

Reimplemented from Message.

Member Data Documentation

◆ mBar

int DisplayPointerMsg::mBar

The bar the pointer rests on. +0x04

◆ mPlayerValue

int DisplayPointerMsg::mPlayerValue

Player::GetTrack() of the player, or -1 to remove the pointer. +0x08

◆ mPlayer

Player* DisplayPointerMsg::mPlayer

The player whose pointer moved. +0x0c


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