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

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

#include <caughtbarmsg.h>

Inheritance diagram for CaughtBarMsg:
Collaboration diagram for CaughtBarMsg:

Public Member Functions

 CaughtBarMsg ()
 Construct a message with the payload unset.
 CaughtBarMsg (Player *pPlayer, int nBar)
 Report a bar a player caught.
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

Player * mPlayer
int mBar

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x008f07a0. It has Message as its one base. The object is 0xc bytes and its vtable is at 0x007e09e0. 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 two names come from Catcher::PostCaughtBarMsg(), the one builder, which stores the catcher's player and the caught bar. Readers of the fields have not been traced, so they are private by default.

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

Constructor & Destructor Documentation

◆ CaughtBarMsg() [1/2]

CaughtBarMsg::CaughtBarMsg ( )
inline

Construct a message with the payload unset.

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

◆ CaughtBarMsg() [2/2]

CaughtBarMsg::CaughtBarMsg ( Player * pPlayer,
int nBar )
inline

Report a bar a player caught.

Inline, with no address of its own. Catcher::PostCaughtBarMsg() at 0x001ac83c expands it on its stack and delivers it to the player's own sink.

Parameters
pPlayerThe player.
nBarThe caught bar.

Member Function Documentation

◆ New()

Message * CaughtBarMsg::New ( )
static

Produce a default-constructed message on the heap.

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

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d6d08
Ghidra address:
PAL: 0x0040ebf8

◆ Clone()

virtual Message * CaughtBarMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x001b11b0
Ghidra address:
PAL: 0x001b6f60

Implements Message.

◆ Type()

virtual int CaughtBarMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nCaughtBarMsgType.
Ghidra address:
NTSC-U/C: 0x001b1200
Ghidra address:
PAL: 0x001b6fb0

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal CaughtBarMsg.
Ghidra address:
NTSC-U/C: 0x001b1210
Ghidra address:
PAL: 0x001b6fc0

Implements Message.

Member Data Documentation

◆ mPlayer

Player* CaughtBarMsg::mPlayer

The catching player. +0x04

◆ mBar

int CaughtBarMsg::mBar

The caught bar. +0x08


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