wavelength 1.0.0
Loading...
Searching...
No Matches
UIComponentSelectMsg Class Reference

Message a component sends when the player chooses it. More...

#include <uicomponentselectmsg.h>

Inheritance diagram for UIComponentSelectMsg:
Collaboration diagram for UIComponentSelectMsg:

Public Member Functions

 ~UIComponentSelectMsg () override=default
 Destroy the object.
 UIComponentSelectMsg (UIComponent *pComponent, UIPanel *pPanel, UIScreen *pScreen, int nButton)
 Construct the message.
void * operator new (size_t nSize)
 Allocate a message, billed to the class name.
void operator delete (void *pBlock)
 Release a message.
Message * Clone () override
 Produce a heap copy of this message.
int Type () override
 Report this message's registered identity.
const char * GetName () const override
 Report this message's class name.
void PrintExtra (PrnStream &stream) const override
 Write the names of the component, the panel, and the screen.
UIComponent * GetComponent () const
UIPanel * GetPanel () const
UIScreen * GetScreen () const
int GetButton () const
Public Member Functions inherited from Message
virtual ~Message ()
 Vtable slot 1.
virtual void saveGuts (BinStream &stream) const
 Write this message's payload to a stream.
virtual void restoreGuts (BinStream &stream)
 Read this message's payload from a stream.
virtual ~Message ()
virtual void Unused1 ()
 Not called by the control.

Additional Inherited Members

Static Public Member Functions inherited from Message
static Message * NewMessage (int nType)
 Produce a message of the identified class through the factory list.

Detailed Description

Message a component sends when the player chooses it.

The RTTI records the class as deriving from Message. The object is 0x14 bytes. A button sends it once its flash ends, through its own Dispatch(), and the screen that shows the component moves to the screen its transition table lists for the component.

Constructor & Destructor Documentation

◆ ~UIComponentSelectMsg()

UIComponentSelectMsg::~UIComponentSelectMsg ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0037bda0
Ghidra address:
PAL: 0x003ea4d0

◆ UIComponentSelectMsg()

UIComponentSelectMsg::UIComponentSelectMsg ( UIComponent * pComponent,
UIPanel * pPanel,
UIScreen * pScreen,
int nButton )
inline

Construct the message.

Inline. The components expand it on their stack.

Parameters
pComponentThe chosen component.
pPanelThe panel with the focus.
pScreenThe current screen.
nButtonThe controller button that chose the component.

Member Function Documentation

◆ operator new()

void * UIComponentSelectMsg::operator new ( size_t nSize)
inline

Allocate a message, billed to the class name.

Parameters
nSizeThe object size the compiler supplies.
Returns
The block.

◆ operator delete()

void UIComponentSelectMsg::operator delete ( void * pBlock)
inline

Release a message.

Parameters
pBlockThe block.

◆ Clone()

Message * UIComponentSelectMsg::Clone ( )
inlineoverridevirtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x0037be40
Ghidra address:
PAL: 0x003ea570

Implements Message.

◆ Type()

int UIComponentSelectMsg::Type ( )
inlineoverridevirtual

Report this message's registered identity.

Returns
g_nUIComponentSelectMsgType.
Ghidra address:
NTSC-U/C: 0x0037bea8
Ghidra address:
PAL: 0x003ea5d8

Implements Message.

◆ GetName()

const char * UIComponentSelectMsg::GetName ( ) const
inlineoverridevirtual

Report this message's class name.

Returns
The literal UIComponentSelectMsg.
Ghidra address:
NTSC-U/C: 0x0037beb8
Ghidra address:
PAL: 0x003ea5e8

Implements Message.

◆ PrintExtra()

void UIComponentSelectMsg::PrintExtra ( PrnStream & stream) const
overridevirtual

Write the names of the component, the panel, and the screen.

Parameters
streamThe stream to write to.
Ghidra address:
NTSC-U/C: 0x0020e600
Ghidra address:
PAL: 0x00217418

Reimplemented from Message.

◆ GetComponent()

UIComponent * UIComponentSelectMsg::GetComponent ( ) const
inline
Returns
The chosen component.

◆ GetPanel()

UIPanel * UIComponentSelectMsg::GetPanel ( ) const
inline
Returns
The panel with the focus.

◆ GetScreen()

UIScreen * UIComponentSelectMsg::GetScreen ( ) const
inline
Returns
The current screen.

◆ GetButton()

int UIComponentSelectMsg::GetButton ( ) const
inline
Returns
The controller button that chose the component.

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