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

Screen that loads the Freqs of the memory card of each player of a local game, adds the prefab Freqs of the metagame configuration, and hands them all to the Freq selection panels. More...

#include <multiloadfreqscreen.h>

Inheritance diagram for MultiLoadFreqScreen:
Collaboration diagram for MultiLoadFreqScreen:

Public Member Functions

 MultiLoadFreqScreen (DataArray *pData)
 Construct the screen from its script description.
 ~MultiLoadFreqScreen () 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 Enter (UIScreen *pPrevScreen, float fTime) override
 Enter, returning to m_mode in a duel and to m_player otherwise.
void Poll (float fTime) override
 Move on to the next slot once a load has ended.
void OnFreqsLoaded (int nStatus, std::vector< Campaign > *pProfiles) override
 Add the Freqs of a slot, or read the slot again after a card change.
void SetLoaded (int nLoaded)
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 Exit (UIScreen *pNextScreen, float fTime) override
 Move the projector to the next screen's place and start the exit.
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 OnInitialCheck (int nStatus, int nFormat, int nFree, int nNeeded)
 Learn the outcome of MCManager::InitialCheck().
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 OnSettingsLoaded (int nStatus, GameOptions settings)
 Learn the outcome of MCManager::LoadSettings().
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.

Static Public Attributes

static constexpr int kMaxPlayers = 4
 The number of players whose Freqs the screen loads.

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 that loads the Freqs of the memory card of each player of a local game, adds the prefab Freqs of the metagame configuration, and hands them all to the Freq selection panels.

The RTTI records the class as deriving from ErrorScreen and from MemcardUser at +0xa0. Its vtables are at 0x003d1270 and, for MemcardUser, 0x003d11e0. The panel multi_load_freq_dlg shows the slot being read. The first player starts on the Freq of the player's name, and the other players on a Freq of their card or on a random prefab.

Constructor & Destructor Documentation

◆ MultiLoadFreqScreen()

MultiLoadFreqScreen::MultiLoadFreqScreen ( DataArray * pData)
inlineexplicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x001ab338
Ghidra address:
PAL: 0x001b3370

◆ ~MultiLoadFreqScreen()

MultiLoadFreqScreen::~MultiLoadFreqScreen ( )
inlineoverride

Destroy the screen.

Ghidra address:
NTSC-U/C: 0x003632f8
Ghidra address:
PAL: 0x003d18f0

Member Function Documentation

◆ New()

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

Create a screen from its script description.

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

◆ Title()

const char * MultiLoadFreqScreen::Title ( )
inlineoverridevirtual

Report the empty title of the screen.

Returns
An empty string.
Ghidra address:
NTSC-U/C: 0x003634c0
Ghidra address:
PAL: 0x003d1ab8

Reimplemented from ErrorScreen.

◆ DispatchPriv()

bool MultiLoadFreqScreen::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: 0x001abd58
Ghidra address:
PAL: 0x001b3ee0

Reimplemented from FreqScreen.

◆ Enter()

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

Enter, returning to m_mode in a duel and to m_player otherwise.

Parameters
pPrevScreenThe screen this one replaces.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x001ab388
Ghidra address:
PAL: 0x001b33c0

Reimplemented from FreqScreen.

◆ Poll()

void MultiLoadFreqScreen::Poll ( float fTime)
overridevirtual

Move on to the next slot once a load has ended.

The PAL build waits until no entry or exit is under way.

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

Reimplemented from UIScreen.

◆ OnFreqsLoaded()

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

Add the Freqs of a slot, or read the slot again after a card change.

In the PAL build a slot without a memory card opens multi_load_no_card.

Parameters
nStatusHow the load ended, one of MemcardTask::Status.
pProfilesThe Freqs loaded.
Ghidra address:
NTSC-U/C: 0x001aba00
Ghidra address:
PAL: 0x001b3a50

Reimplemented from MemcardUser.

◆ SetLoaded()

void MultiLoadFreqScreen::SetLoaded ( int nLoaded)
inline
Parameters
nLoadedNon-zero to move on to the next slot at the next poll.

Member Data Documentation

◆ kMaxPlayers

int MultiLoadFreqScreen::kMaxPlayers = 4
staticconstexpr

The number of players whose Freqs the screen loads.


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