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

Screen of the startup check of the memory card, which loads the settings and the newest Freq before it leads to the done screen. More...

#include <mccheckscreen.h>

Inheritance diagram for MCCheckScreen:
Collaboration diagram for MCCheckScreen:

Public Member Functions

 MCCheckScreen (DataArray *pData)
 Construct the screen from its script description.
 ~MCCheckScreen () override
 Destroy the screen.
const char * Title () override
 Report the empty title of the screen.
bool DispatchPriv (Message *pMsg) override
 Route the end of the entry to HandleTransitionComplete().
void Poll (float fTime) override
 Start a pending load, and go to the done screen once the time to advance has passed.
void Exit (UIScreen *pNextScreen, float fTime) override
 Exit, and give the first player a default Freq when no Freq of the player loaded.
void OnInitialCheck (int nStatus, int nFormat, int nFree, int nNeeded) override
 Load the settings of a usable card on the next poll, or open the dialog of the card's failure.
void OnSettingsLoaded (int nStatus, GameOptions settings) override
 Apply the settings loaded, and load the Freqs on the next poll whatever the outcome.
void OnFreqsLoaded (int nStatus, std::vector< Campaign > *pProfiles) override
 Make the newest Freq loaded the first player's, and go to the done screen a second later.
Public Member Functions inherited from ErrorScreen
 ErrorScreen (DataArray *pData)
 Construct the screen from its script description.
 ~ErrorScreen () override
 Destroy 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.
void Draw () override
 Draw what goes under each panel, then the panels.
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 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.
Public Member Functions inherited from MemcardUser
virtual void OnCardStatus (int nStatus)
 Learn the outcome of MCManager::GetCardStatus().
virtual void OnFreqSaved (int nStatus, int nNeeded)
 Learn the outcome of MCManager::SaveFreq().
virtual void OnFreqDeleted (int nStatus)
 Learn the outcome of MCManager::DeleteFreq().
virtual void UnusedReport ()
 Do nothing.
virtual void OnRemixSaved (int nStatus, int nNeeded)
 Learn the outcome of MCManager::SaveRemix().
virtual void OnRemixLoaded (int nStatus)
 Learn the outcome of MCManager::LoadRemix().
virtual void OnRemixesListed (int nStatus, std::vector< RemixInfo > *pInfos)
 Learn the outcome of MCManager::ListRemixes().
virtual void OnRemixDeleted (int nStatus)
 Learn the outcome of MCManager::DeleteRemix().
virtual void OnSettingsSaved (int nStatus, int nNeeded)
 Learn the outcome of MCManager::SaveSettings().
virtual void OnNetConfigsListed (int nStatus, std::list< InetConfig > *pConfigs)
 Learn the outcome of MCManager::ListNetConfigs().
virtual void OnCardFormatted (int nStatus)
 Learn the outcome of MCManager::FormatCard().
virtual void OnCardUnformatted (int nStatus)
 Learn the outcome of the unformat work.
virtual void OnFileSaved (int nStatus)
 Learn the outcome of MCManager::SaveFile().

Static Public Member Functions

static UIScreen * New (DataArray *pData)
 Create a screen from its script description.
Static Public Member Functions inherited from ErrorScreen
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 ErrorScreen
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

Detailed Description

Screen of the startup check of the memory card, which loads the settings and the newest Freq before it leads to the done screen.

The RTTI records the class as deriving from ErrorScreen and from MemcardUser at +0xa0. Its vtables are at 0x003d0c40 and, for MemcardUser, 0x003d0bb0. A missing, full, or unformatted card opens mc_check_no_card, mc_check_no_space, or mc_check_unformatted. The loads run on later polls, and the done screen follows a second after the Freq loads.

Constructor & Destructor Documentation

◆ MCCheckScreen()

MCCheckScreen::MCCheckScreen ( DataArray * pData)
inlineexplicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x001acb68
Ghidra address:
PAL: 0x001b52c0

◆ ~MCCheckScreen()

MCCheckScreen::~MCCheckScreen ( )
inlineoverride

Destroy the screen.

Ghidra address:
NTSC-U/C: 0x00363b58
Ghidra address:
PAL: 0x003d22b8

Member Function Documentation

◆ New()

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

Create a screen from its script description.

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

◆ Title()

const char * MCCheckScreen::Title ( )
inlineoverridevirtual

Report the empty title of the screen.

Returns
An empty string.
Ghidra address:
NTSC-U/C: 0x00363cb0
Ghidra address:
PAL: 0x003d2410

Reimplemented from ErrorScreen.

◆ DispatchPriv()

bool MCCheckScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route the end of the entry to HandleTransitionComplete().

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

Reimplemented from FreqScreen.

◆ Poll()

void MCCheckScreen::Poll ( float fTime)
overridevirtual

Start a pending load, and go to the done screen once the time to advance has passed.

The PAL build starts a load only when no advance is pending, shows initial_access_check with the slot name while the settings load, and does not advance while a load is pending.

Parameters
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x001acc20
Ghidra address:
PAL: 0x001b5378

Reimplemented from UIScreen.

◆ Exit()

void MCCheckScreen::Exit ( UIScreen * pNextScreen,
float fTime )
overridevirtual

Exit, and give the first player a default Freq when no Freq of the player loaded.

Parameters
pNextScreenThe screen that replaces this one.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x001acbb8
Ghidra address:
PAL: 0x001b5310

Reimplemented from FreqScreen.

◆ OnInitialCheck()

void MCCheckScreen::OnInitialCheck ( int nStatus,
int nFormat,
int nFree,
int nNeeded )
overridevirtual

Load the settings of a usable card on the next poll, or open the dialog of the card's failure.

Outside edit mode, the settings load. In edit mode the screen goes to the done screen at once. The PAL build goes to the done screen for an unformatted card instead of offering to format it.

Parameters
nStatusThe outcome, one of MemcardTask::Status.
nFormatNon-zero for a formatted card.
nFreeThe free space of the card in kilobytes.
nNeededThe kilobytes one more Freq needs.
Ghidra address:
NTSC-U/C: 0x001acda0
Ghidra address:
PAL: 0x001b5600

Reimplemented from MemcardUser.

◆ OnSettingsLoaded()

void MCCheckScreen::OnSettingsLoaded ( int nStatus,
GameOptions settings )
overridevirtual

Apply the settings loaded, and load the Freqs on the next poll whatever the outcome.

Parameters
nStatusThe outcome, one of MemcardTask::Status.
settingsA copy of the settings loaded.
Ghidra address:
NTSC-U/C: 0x001ad200
Ghidra address:
PAL: 0x001b5930

Reimplemented from MemcardUser.

◆ OnFreqsLoaded()

void MCCheckScreen::OnFreqsLoaded ( int nStatus,
std::vector< Campaign > * pProfiles )
overridevirtual

Make the newest Freq loaded the first player's, and go to the done screen a second later.

A failed load goes to the done screen at once.

Parameters
nStatusThe outcome, one of MemcardTask::Status.
pProfilesThe Freqs loaded, newest first.
Ghidra address:
NTSC-U/C: 0x001ad278
Ghidra address:
PAL: 0x001b59a8

Reimplemented from MemcardUser.


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