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

Screen of a dialog about the memory card or another error, between the screen that opened it and the screen it leads to. More...

#include <errorscreen.h>

Inheritance diagram for ErrorScreen:
Collaboration diagram for ErrorScreen:

Public Member Functions

 ErrorScreen (DataArray *pData)
 Construct the screen from its script description.
 ~ErrorScreen () override
 Destroy the screen.
const char * Title () override
 Report the empty title of the screen.
virtual void SetDoneScreen (const char *pszScreen)
 Set the screen the dialog leads to.
virtual void SetStartScreen (const char *pszScreen)
 Set the screen that opened the dialog.
virtual void SetSlot (int nSlot)
 Choose the memory card slot the dialog is about.
const char * GetSlotName ()
 Report the localised name of the memory card slot the dialog is about.
void ShowCardError (int nStatus)
 Show the dialog of a memory card failure with retry, continue, and cancel buttons.
void ShowCardErrorTwoOption (int nStatus, int nOperation)
 Show the dialog of a memory card failure with retry and cancel buttons.
void ShowNoSpaceError (int nSpace)
 Show the no_space_error dialog of a memory card without enough space.
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 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.

Protected Attributes

String mDoneScreen
String mStartScreen
int mSlot
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

Additional Inherited Members

Public Attributes inherited from FreqScreen
Vector3 mGizmoOrig
Quat mGizmoRot

Detailed Description

Screen of a dialog about the memory card or another error, between the screen that opened it and the screen it leads to.

The RTTI records the class as deriving from FreqScreen. The object is 0xa0 bytes and its vtable is at 0x003d1630. The metagame registers the class for the screen type error_screen, and the front-end description's cur_freq_not_saved screen is one. The description's start_screen and done_screen give the two screens. The memory card screens derive from the class.

Constructor & Destructor Documentation

◆ ErrorScreen()

ErrorScreen::ErrorScreen ( DataArray * pData)
explicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x001a9ec0
Ghidra address:
PAL: 0x001b1ce0

◆ ~ErrorScreen()

ErrorScreen::~ErrorScreen ( )
override

Destroy the screen.

Ghidra address:
NTSC-U/C: 0x00362970
Ghidra address:
PAL: 0x003d0e50

Member Function Documentation

◆ New()

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

Create a screen from its script description.

The metagame registers the routine for the entry type error_screen.

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

◆ Title()

const char * ErrorScreen::Title ( )
inlineoverridevirtual

Report the empty title of the screen.

Returns
An empty string.
Ghidra address:
NTSC-U/C: 0x003629d8
Ghidra address:
PAL: 0x003d0f48

Reimplemented from FreqScreen.

Reimplemented in FormatScreen, ListRemixesScreen, LoadFreqScreen, LoadNetConfigsScreen, LoadRemixScreen, MCCheckScreen, MultiLoadFreqScreen, NetInetConnect, NetReadOnlyWarnScreen, ReadOnlySaveScreen, SaveErrorScreen, SaveFreqScreen, SaveRemixScreen, and SaveSettingsScreen.

◆ SetDoneScreen()

virtual void ErrorScreen::SetDoneScreen ( const char * pszScreen)
inlinevirtual

Set the screen the dialog leads to.

Parameters
pszScreenThe screen.
Ghidra address:
NTSC-U/C: 0x00358ac0
Ghidra address:
PAL: 0x003d0f58

◆ SetStartScreen()

virtual void ErrorScreen::SetStartScreen ( const char * pszScreen)
inlinevirtual

Set the screen that opened the dialog.

Parameters
pszScreenThe screen.
Ghidra address:
NTSC-U/C: 0x00358ae0
Ghidra address:
PAL: 0x003d0f78

◆ SetSlot()

virtual void ErrorScreen::SetSlot ( int nSlot)
inlinevirtual

Choose the memory card slot the dialog is about.

Parameters
nSlotThe memory card slot.
Ghidra address:
NTSC-U/C: 0x00358b00
Ghidra address:
PAL: 0x001b1e98

◆ GetSlotName()

const char * ErrorScreen::GetSlotName ( )

Report the localised name of the memory card slot the dialog is about.

Returns
The name.
Ghidra address:
NTSC-U/C: 0x001a9f88
Ghidra address:
PAL: 0x001b1da8

◆ ShowCardError()

void ErrorScreen::ShowCardError ( int nStatus)

Show the dialog of a memory card failure with retry, continue, and cancel buttons.

Parameters
nStatusThe failure.
Ghidra address:
NTSC-U/C: 0x001a9fb0

◆ ShowCardErrorTwoOption()

void ErrorScreen::ShowCardErrorTwoOption ( int nStatus,
int nOperation )

Show the dialog of a memory card failure with retry and cancel buttons.

Parameters
nStatusThe failure.
nOperationThe operation that failed. In the North American build it is 1 for a save, 2 for a copy, and 3 for a deletion, and in the PAL build it is one of Operation.
Ghidra address:
NTSC-U/C: 0x001aa490
Ghidra address:
PAL: 0x001b2418

◆ ShowNoSpaceError()

void ErrorScreen::ShowNoSpaceError ( int nSpace)

Show the no_space_error dialog of a memory card without enough space.

Parameters
nSpaceThe space the save needs.
Ghidra address:
NTSC-U/C: 0x001aa9e8
Ghidra address:
PAL: 0x001b2990

Member Data Documentation

◆ mDoneScreen

String ErrorScreen::mDoneScreen
protected

The screen the dialog leads to, done_screen. +0x70

◆ mStartScreen

String ErrorScreen::mStartScreen
protected

The screen that opened the dialog, start_screen. +0x84

◆ mSlot

int ErrorScreen::mSlot
protected

The memory card slot the dialog is about. +0x98


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