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

Message a screen sends itself once its panels have finished their entry animations. More...

#include <uitransitioncompletemsg.h>

Inheritance diagram for UITransitionCompleteMsg:
Collaboration diagram for UITransitionCompleteMsg:

Public Member Functions

 ~UITransitionCompleteMsg () override=default
 Destroy the object.
 UITransitionCompleteMsg (UIScreen *pScreen, UIScreen *pPrevScreen)
 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 both screens.
UIScreen * GetScreen () const
UIScreen * GetPrevScreen () 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 screen sends itself once its panels have finished their entry animations.

The RTTI records the class as deriving from Message. The object is 0x0c bytes.

Constructor & Destructor Documentation

◆ ~UITransitionCompleteMsg()

UITransitionCompleteMsg::~UITransitionCompleteMsg ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0037c260
Ghidra address:
PAL: 0x003ea990

◆ UITransitionCompleteMsg()

UITransitionCompleteMsg::UITransitionCompleteMsg ( UIScreen * pScreen,
UIScreen * pPrevScreen )
inline

Construct the message.

Inline. UIScreen::Poll() expands it on its stack.

Parameters
pScreenThe screen that entered.
pPrevScreenThe screen it entered from, or null.

Member Function Documentation

◆ operator new()

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

Release a message.

Parameters
pBlockThe block.

◆ Clone()

Message * UITransitionCompleteMsg::Clone ( )
inlineoverridevirtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x0037c300
Ghidra address:
PAL: 0x003eaa30

Implements Message.

◆ Type()

int UITransitionCompleteMsg::Type ( )
inlineoverridevirtual

Report this message's registered identity.

Returns
g_nUITransitionCompleteMsgType.
Ghidra address:
NTSC-U/C: 0x0037c358
Ghidra address:
PAL: 0x003eaa88

Implements Message.

◆ GetName()

const char * UITransitionCompleteMsg::GetName ( ) const
inlineoverridevirtual

Report this message's class name.

Returns
The literal UITransitionCompleteMsg.
Ghidra address:
NTSC-U/C: 0x0037c368
Ghidra address:
PAL: 0x003eaa98

Implements Message.

◆ PrintExtra()

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

Write the names of both screens.

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

Reimplemented from Message.

◆ GetScreen()

UIScreen * UITransitionCompleteMsg::GetScreen ( ) const
inline
Returns
The screen that entered.

◆ GetPrevScreen()

UIScreen * UITransitionCompleteMsg::GetPrevScreen ( ) const
inline
Returns
The screen it entered from, or null.

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