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

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

#include <toggleghostmsg.h>

Inheritance diagram for ToggleGhostMsg:
Collaboration diagram for ToggleGhostMsg:

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.
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
 Player the message is about.
int mOn
 Non-zero to light the player's track display, zero to darken it.

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x008ef0f0. It has Message as its one base. The object is 0xc bytes and its vtable is at 0x007cf4e8. 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, the player because LocalPlayer::SetGhost() writes it and the flag because Overlay reads it.

The destructor at 0x0011d710 is compiler-generated and has no declaration here. The routine at 0x0011d748 is a further emission of the type-information accessor.

Member Function Documentation

◆ New()

Message * ToggleGhostMsg::New ( )
static

Produce a default-constructed message on the heap.

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

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d6c28
Ghidra address:
PAL: 0x0040eb18

◆ Clone()

virtual Message * ToggleGhostMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x0011d7c0
Ghidra address:
PAL: 0x0011dd48

Implements Message.

◆ Type()

virtual int ToggleGhostMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nToggleGhostMsgType.
Ghidra address:
NTSC-U/C: 0x0011d810
Ghidra address:
PAL: 0x0011dd98

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal ToggleGhostMsg.
Ghidra address:
NTSC-U/C: 0x0011d820
Ghidra address:
PAL: 0x0011dda8

Implements Message.

Member Data Documentation

◆ mPlayer

Player* ToggleGhostMsg::mPlayer

Player the message is about.

LocalPlayer::SetGhost() at 0x0011e908 writes the player here before sending. That write types this member as a player rather than as a payload word.

+0x04

◆ mOn

int ToggleGhostMsg::mOn

Non-zero to light the player's track display, zero to darken it.

LocalPlayer::SetGhost() at 0x0011e908 writes its argument here. Overlay::OnToggleGhost() at 0x0042aef8 reads it directly with no accessor in the image and selects one of two values from the track display for each of the display's kind-11 components.

+0x08


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