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

Message with a line of script text for a sink to run. More...

#include <scriptmsg.h>

Inheritance diagram for ScriptMsg:
Collaboration diagram for ScriptMsg:

Public Member Functions

 ScriptMsg ()=default
 Wrap an empty script.
 ScriptMsg (const HxStr &script)
 Wrap a line of script text.
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 message with an empty script 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 mScript
 Script text to run.

Detailed Description

Message with a line of script text for a sink to run.

Its RTTI descriptor is at 0x00901cd0. It has Message as its one base. The object is 0xc bytes and its vtable is at 0x007d6730. It overrides Clone(), Type(), and GetName(), and retains Message's PrintExtra(), saveGuts(), and restoreGuts().

The payload is one HxStr. Clone() copy-constructs +0x04 through HxStr::HxStr(const HxStr &), the destructor at 0x0015a5f0 releases the buffer at +0x08 with the inlined HxStr destructor, and New() zeroes both words, so the text ScriptSink reads at +0x08 is the string's buffer. The destructor is compiler-generated and has no declaration here.

Constructor & Destructor Documentation

◆ ScriptMsg() [1/2]

ScriptMsg::ScriptMsg ( )
default

Wrap an empty script.

◆ ScriptMsg() [2/2]

ScriptMsg::ScriptMsg ( const HxStr & script)
inlineexplicit

Wrap a line of script text.

Inline. ScriptCmd's Execute() at 0x0015a408 expands it on the stack.

Parameters
scriptThe text.

Member Function Documentation

◆ New()

Message * ScriptMsg::New ( )
static

Produce a message with an empty script on the heap.

The translation unit at 0x003d9818 registers this factory.

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d7158
Ghidra address:
PAL: 0x0040f050

◆ Clone()

virtual Message * ScriptMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x0015a6c8
Ghidra address:
PAL: 0x0015c448

Implements Message.

◆ Type()

virtual int ScriptMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nScriptMsgType.
Ghidra address:
NTSC-U/C: 0x0015a768
Ghidra address:
PAL: 0x0015c4e8

Implements Message.

◆ GetName()

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

Report this message's class name.

Returns
The literal ScriptMsg.
Ghidra address:
NTSC-U/C: 0x0015a778
Ghidra address:
PAL: 0x0015c4f8

Implements Message.

Member Data Documentation

◆ mScript

HxStr ScriptMsg::mScript

Script text to run.

An empty string makes the reader fall back on the default text.

Public because ScriptSink reads the buffer directly and the image has no accessor for it.

+0x04


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