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

Message a component sends when the player presses the button that chooses it. More...

#include <uicomponentselectstartmsg.h>

Inheritance diagram for UIComponentSelectStartMsg:
Collaboration diagram for UIComponentSelectStartMsg:

Public Member Functions

 UIComponentSelectStartMsg (UIComponent *pComponent, UIPanel *pPanel, UIScreen *pScreen, int nButton, int nPad)
 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
int GetPad () 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 presses the button that chooses it.

The RTTI records the class as deriving from Message. The object is 0x18 bytes. A button sends it through its own Dispatch() before its flash starts. A handler that reports the message as handled stops the choice.

Constructor & Destructor Documentation

◆ UIComponentSelectStartMsg()

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

Construct the message.

Inline. The components expand it on their stack.

Parameters
pComponentThe component being chosen.
pPanelThe panel with the focus.
pScreenThe current screen.
nButtonThe controller button pressed.
nPadThe controller.

Member Function Documentation

◆ operator new()

void * UIComponentSelectStartMsg::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 UIComponentSelectStartMsg::operator delete ( void * pBlock)
inline

Release a message.

Parameters
pBlockThe block.

◆ Clone()

Message * UIComponentSelectStartMsg::Clone ( )
inlineoverridevirtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x0037bf70
Ghidra address:
PAL: 0x003ea6a0

Implements Message.

◆ Type()

int UIComponentSelectStartMsg::Type ( )
inlineoverridevirtual

Report this message's registered identity.

Returns
g_nUIComponentSelectStartMsgType.
Ghidra address:
NTSC-U/C: 0x0037bfe0
Ghidra address:
PAL: 0x003ea710

Implements Message.

◆ GetName()

const char * UIComponentSelectStartMsg::GetName ( ) const
inlineoverridevirtual

Report this message's class name.

Returns
The literal UIComponentSelectStartMsg.
Ghidra address:
NTSC-U/C: 0x0037bff0
Ghidra address:
PAL: 0x003ea720

Implements Message.

◆ PrintExtra()

void UIComponentSelectStartMsg::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: 0x0020e6c0
Ghidra address:
PAL: 0x002174d8

Reimplemented from Message.

◆ GetComponent()

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

◆ GetPanel()

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

◆ GetScreen()

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

◆ GetButton()

int UIComponentSelectStartMsg::GetButton ( ) const
inline
Returns
The controller button pressed.

◆ GetPad()

int UIComponentSelectStartMsg::GetPad ( ) const
inline
Returns
The controller.

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