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

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

#include <powerupcountmsg.h>

Inheritance diagram for PowerupCountMsg:
Collaboration diagram for PowerupCountMsg:

Public Member Functions

 PowerupCountMsg ()
 Construct a message with the payload unset.
 PowerupCountMsg (int nIndex, int nCount, Player *pOwner)
 Report a new stored count for one entry of a player's collection.
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 entry and the count to a diagnostic stream, separated by /.
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.

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x00901d10. It has Message as its one base. The object is 0x10 bytes and its vtable is at 0x00812c00. 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. Readers of the fields have not been traced, so they are private by default.

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

Constructor & Destructor Documentation

◆ PowerupCountMsg() [1/2]

PowerupCountMsg::PowerupCountMsg ( )
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.

◆ PowerupCountMsg() [2/2]

PowerupCountMsg::PowerupCountMsg ( int nIndex,
int nCount,
Player * pOwner )

Report a new stored count for one entry of a player's collection.

No address attaches to the constructor. PowerupCollection builds the message on its own stack at 0x001cb280, 0x001cb554, and 0x001cb658 and hands the address to MsgSource::Send(), and the compiler expands the constructor into each of the three sites. The three arguments are the three members in declaration order.

Parameters
nIndexThe entry, as its index into the collection.
nCountThe stored count after the change.
pOwnerThe player whose collection changed.

Member Function Documentation

◆ New()

Message * PowerupCountMsg::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: 0x003d6fc8
Ghidra address:
PAL: 0x0040eeb8

◆ Clone()

virtual Message * PowerupCountMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x003dd270
Ghidra address:
PAL: 0x004156a8

Implements Message.

◆ Type()

virtual int PowerupCountMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nPowerupCountMsgType.
Ghidra address:
NTSC-U/C: 0x003dd2c8
Ghidra address:
PAL: 0x00415700

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal PowerupCountMsg.
Ghidra address:
NTSC-U/C: 0x003dd2d8
Ghidra address:
PAL: 0x00415710

Implements Message.

◆ PrintExtra()

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

Write the entry and the count to a diagnostic stream, separated by /.

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

Reimplemented from Message.


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