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

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

#include <textmsg.h>

Inheritance diagram for TextMsg:
Collaboration diagram for TextMsg:

Public Member Functions

 TextMsg ()
 Construct a message with empty text.
 TextMsg (const HxStr &text)
 Construct a message showing a string.
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

HxStr mText

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x008ef7b0. It has Message as its one base. The object is 0x10 bytes and its vtable is at 0x007dc478. 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 HxStr at +0x04 comes from the copy constructor at 0x00193e10, which copy-constructs it rather than copying its words.

mText is public because Overlay::OnText() at 0x0041f5e8 copies it directly at 0x0041f608 with no accessor in the image. The purpose of the word at +0x0c is not recovered.

The destructor at 0x00193d38 is compiler-generated and has no declaration here. Besides the deleting release, it frees the text of the HxStr member.

Constructor & Destructor Documentation

◆ TextMsg() [1/2]

TextMsg::TextMsg ( )
inline

Construct a message with empty text.

Inline. New() expands it, and it does not write the word at +0x0c.

◆ TextMsg() [2/2]

TextMsg::TextMsg ( const HxStr & text)
inlineexplicit

Construct a message showing a string.

Inline. GrooveWorld::DisplayText() at 0x0018f140 expands it on its stack, copy-constructing the text and clearing the word at +0x0c.

Parameters
textThe text to show.

Member Function Documentation

◆ New()

Message * TextMsg::New ( )
static

Produce a default-constructed message on the heap.

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

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d7118
Ghidra address:
PAL: 0x0040f008

◆ Clone()

virtual Message * TextMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x00193e10
Ghidra address:
PAL: 0x00199a48

Implements Message.

◆ Type()

virtual int TextMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nTextMsgType.
Ghidra address:
NTSC-U/C: 0x00193eb8
Ghidra address:
PAL: 0x00199af0

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal TextMsg.
Ghidra address:
NTSC-U/C: 0x00193ec8
Ghidra address:
PAL: 0x00199b00

Implements Message.

Member Data Documentation

◆ mText

HxStr TextMsg::mText

The text the track display shows. +0x04


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