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

The dialog with which the host confirms removing a guest from the launchpad. More...

#include <bootscreen.h>

Inheritance diagram for BootScreen:
Collaboration diagram for BootScreen:

Public Member Functions

 ~BootScreen () override=default
 Destroy the object.
 BootScreen (DataArray *pData)
 Construct the screen from its script description, with no guest.
bool DispatchPriv (Message *pMsg) override
 Route a chosen button, and pass on every other message.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Start the entry and put the name of the guest into the question of the dialog.
bool HandleSelect (UIComponentSelectMsg *pMsg)
 Remove the guest for yes, and go back to the launchpad for yes and no.
void SetPlayerName (const char *pszPlayerName)
void SetPlayer (int nPlayer)
Public Member Functions inherited from FreqScreen
 FreqScreen (DataArray *pData)
 Construct a screen from its script description.
 ~FreqScreen () override
 Destroy the screen.
bool DispatchPriv (Message *pMsg) override
 Play the sound of a chosen component, follow a shortcut, and keep unused controllers out.
void Draw () override
 Draw what goes under each panel, then the panels.
void Exit (UIScreen *pNextScreen, float fTime) override
 Move the projector to the next screen's place and start the exit.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Play the entry sound, show or hide the projector, and start the entry.
virtual const char * Title ()
 Report the localised title of the screen, the token <name>_TITLE.
virtual void PlayButtonSound (int nButton)
 Play the menu sound of a controller button.
bool HandleSelectStart (UIComponentSelectStartMsg *pMsg)
 Play the sound of the button that chooses a component.
bool HandleTransitionComplete (UITransitionCompleteMsg *pMsg)
 Choose the component the shortcuts section of the metagame configuration lists for the screen.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Pass on a controller button of a controller the players use, and swallow any other.
Public Member Functions inherited from UIScreen
 UIScreen (DataArray *pData)
 Construct a screen from its script description.
 ~UIScreen () override
 Destroy the screen.
bool Dispatch (Message *pMsg) override
 Offer a message to the manager, then handle it here, then pass a navigation message on.
bool DispatchPriv (Message *pMsg) override
 Follow the transition of a pressed button or a chosen component.
virtual void Poll (float fTime)
 Advance the panels to a time, and finish the exit or the entry once their animations stop.
virtual void Print (PrnStream &stream)
 Write a description of the screen, its panels, and its transitions.
void ClearTransitions ()
 Empty the transition table.
void AddTransition (const char *pszComponent, int nButton, const char *pszScreen)
 Append an entry to the transition table.
void AddPanel (UIPanel *pPanel)
 Add a panel to the screen.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Follow the transition of a pressed controller button.
bool HandleSelect (UIComponentSelectMsg *pMsg)
 Follow the transition of a component chosen with the cross button.
void SetFocus (UIPanel *pPanel)
 Move the focus to a panel.
UIComponent * FindComponent (const char *pszName)
 Find a component on any of the screen's panels.
Transition * FindTransition (UIComponent *pComponent, bool bFail)
 Find the transition of a component.
Transition * FindTransition (int nButton, bool bFail)
 Find the transition of a controller button.
void Load ()
 Load the panels.
void Unload ()
 Unload the panels.
bool IsLoaded ()
 Report whether every panel has loaded.
const char * GetName () const
const char * GetGroup () const
UIPanel * GetFocusPanel () const
UIScreen * GetNextScreen () const
UIScreen * GetPrevScreen () const
const std::map< const char *, UIPanel *, StrLess > & GetPanels () const
Public Member Functions inherited from MsgSink
void * operator new (size_t nSize)
 Allocate a sink from the pool heaps under the tag "MsgSink".
void operator delete (void *pBlock)
 Return a sink to the pool heaps.
virtual ~MsgSink ()
void * operator new (size_t size)
 Allocate from the main heap under the name MsgSink.
void operator delete (void *mem)
 Return memory to its heap.
virtual ~MsgSink ()
 Destroy the sink.

Static Public Member Functions

static UIScreen * New (DataArray *pData)
 Create a screen from its script description.
Static Public Member Functions inherited from FreqScreen
static UIScreen * New (DataArray *pData)
 Create a screen from its script description.
Static Public Member Functions inherited from UIScreen
static UIScreen * New (DataArray *pData)
 Create a screen from its script description.

Additional Inherited Members

Public Attributes inherited from FreqScreen
Vector3 mGizmoOrig
Quat mGizmoRot
Protected Attributes inherited from UIScreen
const char * mName
const char * mGroup
std::map< const char *, UIPanel *, StrLess > mPanels
UIPanel * mFocusPanel
std::vector< Transition > mTransitions
UIScreen * mPrevScreen
UIScreen * mNextScreen
int mForceEntryExit

Detailed Description

The dialog with which the host confirms removing a guest from the launchpad.

The RTTI records the class as deriving from FreqScreen. The object is 0x88 bytes and its vtable is at 0x003cd868. The metagame registers the class for the screen type boot_screen. The dialog has the buttons yes and no, and both go back to fn_h_lpad.

Constructor & Destructor Documentation

◆ ~BootScreen()

BootScreen::~BootScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035bfb8
Ghidra address:
PAL: 0x003c9b10

◆ BootScreen()

BootScreen::BootScreen ( DataArray * pData)
explicit

Construct the screen from its script description, with no guest.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x001880f8
Ghidra address:
PAL: 0x0018c338

Member Function Documentation

◆ New()

UIScreen * BootScreen::New ( DataArray * pData)
inlinestatic

Create a screen from its script description.

The metagame registers the routine for the screen type boot_screen.

Parameters
pDataThe script description.
Returns
The new screen.
Ghidra address:
NTSC-U/C: 0x0035c060
Ghidra address:
PAL: 0x003c9bb8

◆ DispatchPriv()

bool BootScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route a chosen button, and pass on every other message.

Parameters
pMsgThe message.
Returns
Whether the message was handled.
Ghidra address:
NTSC-U/C: 0x00188200
Ghidra address:
PAL: 0x0018c440

Implements MsgSink.

◆ Enter()

void BootScreen::Enter ( UIScreen * pPrevScreen,
float fTime )
overridevirtual

Start the entry and put the name of the guest into the question of the dialog.

Parameters
pPrevScreenThe screen this one replaces, or null.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x00188160
Ghidra address:
PAL: 0x0018c3a0

Reimplemented from UIScreen.

◆ HandleSelect()

bool BootScreen::HandleSelect ( UIComponentSelectMsg * pMsg)

Remove the guest for yes, and go back to the launchpad for yes and no.

Parameters
pMsgThe message.
Returns
The result of UIScreen::HandleSelect().
Ghidra address:
NTSC-U/C: 0x00188268
Ghidra address:
PAL: 0x0018c4a8

◆ SetPlayerName()

void BootScreen::SetPlayerName ( const char * pszPlayerName)
inline
Parameters
pszPlayerNameThe name of the guest, set by the screen that opens this one.

◆ SetPlayer()

void BootScreen::SetPlayer ( int nPlayer)
inline
Parameters
nPlayerThe guest, set by the screen that opens this one.

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