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

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

#include <looptogglemsg.h>

Inheritance diagram for LoopToggleMsg:
Collaboration diagram for LoopToggleMsg:

Public Member Functions

 LoopToggleMsg ()
 Construct a message with every payload word indeterminate.
 LoopToggleMsg (int nOn, Player *pPlayer)
 Report that a player started or stopped looping.
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

int mOn
Player * mPlayer

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x008f0850. It has Message as its one base. The object is 0xc bytes and its vtable is at 0x007cfff0. 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(). Both members are public because Overlay::OnLoopToggle() at 0x0041f708 reads them directly with no accessor in the image. It compares mPlayer with HudTrack::mPlayer and picks the displayed text on mOn.

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

Constructor & Destructor Documentation

◆ LoopToggleMsg() [1/2]

LoopToggleMsg::LoopToggleMsg ( )
inline

Construct a message with every payload word indeterminate.

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

◆ LoopToggleMsg() [2/2]

LoopToggleMsg::LoopToggleMsg ( int nOn,
Player * pPlayer )
inline

Report that a player started or stopped looping.

Inline, with no address of its own. LocalPlayer's loop handler expands it on its stack at 0x0011e7a4.

Parameters
nOnNon-zero when looping starts.
pPlayerThe player who toggled looping.

Member Function Documentation

◆ New()

Message * LoopToggleMsg::New ( )
static

Produce a default-constructed message on the heap.

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

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d7198
Ghidra address:
PAL: 0x0040f098

◆ Clone()

virtual Message * LoopToggleMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x001224f0
Ghidra address:
PAL: 0x00122b08

Implements Message.

◆ Type()

virtual int LoopToggleMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nLoopToggleMsgType.
Ghidra address:
NTSC-U/C: 0x00122540
Ghidra address:
PAL: 0x00122b58

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal LoopToggleMsg.
Ghidra address:
NTSC-U/C: 0x00122550
Ghidra address:
PAL: 0x00122b68

Implements Message.

Member Data Documentation

◆ mOn

int LoopToggleMsg::mOn

Non-zero when looping starts, zero when it stops. +0x04

◆ mPlayer

Player* LoopToggleMsg::mPlayer

The player who toggled looping. +0x08


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