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

Screen that saves the Freq the Freq maker made, under the name the maker chose. More...

#include <saveeditedfreqscreen.h>

Inheritance diagram for SaveEditedFreqScreen:
Collaboration diagram for SaveEditedFreqScreen:

Public Member Functions

 SaveEditedFreqScreen (DataArray *pData)
 Construct the screen from its script description.
 ~SaveEditedFreqScreen () override
 Destroy the screen.
bool DispatchPriv (Message *pMsg) override
 Route the end of the entry, and pass every other message to SaveFreqScreen.
bool HandleTransitionComplete (UITransitionCompleteMsg *pMsg)
 Start the save under mFreqName once this screen has entered.
void SetFreqName (const char *pszFreqName)
Public Member Functions inherited from SaveFreqScreen
 SaveFreqScreen (DataArray *pData)
 Construct the screen from its script description.
 ~SaveFreqScreen () override
 Destroy the screen.
bool DispatchPriv (Message *pMsg) override
 Route the end of the entry, and pass on every other message.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Start the entry.
const char * Title () override
 Report the empty title of the screen.
bool HandleTransitionComplete (UITransitionCompleteMsg *pMsg)
 Start the save once this screen has entered.
void OnFreqSaved (int nStatus, int nSpace) override
 Move on when the save ends.
Public Member Functions inherited from OverwriteSaveScreen
 OverwriteSaveScreen (DataArray *pData)
 Construct the screen from its script description.
void SetOverwriteStatus (int nOverwriteStatus)
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 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.
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 OnFreqsLoaded (int nStatus, std::vector< Campaign > *pProfiles)
 Learn the outcome of MCManager::LoadFreqs().
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 SaveFreqScreen
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 OverwriteSaveScreen
int mOverwriteStatus
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 saves the Freq the Freq maker made, under the name the maker chose.

The RTTI records the class as deriving from SaveFreqScreen. The object is 0xf0 bytes and its vtables are at 0x003d1060 and, for MemcardUser, 0x003d0fd0. The metagame registers the class for the screen type save_edited_freq_screen, and the front-end description's fmaker_save_freq and fmaker_save_freq_net screens are two. FreqMakerMainScreen sets the name and whether the save may replace a saved Freq before the screen opens.

Constructor & Destructor Documentation

◆ SaveEditedFreqScreen()

SaveEditedFreqScreen::SaveEditedFreqScreen ( DataArray * pData)
explicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x00363740
Ghidra address:
PAL: 0x003d1e90

◆ ~SaveEditedFreqScreen()

SaveEditedFreqScreen::~SaveEditedFreqScreen ( )
override

Destroy the screen.

Ghidra address:
NTSC-U/C: 0x00363658
Ghidra address:
PAL: 0x003d1d98

Member Function Documentation

◆ New()

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

Create a screen from its script description.

The metagame registers the routine for the entry type save_edited_freq_screen.

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

◆ DispatchPriv()

bool SaveEditedFreqScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route the end of the entry, and pass every other message to SaveFreqScreen.

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

Reimplemented from FreqScreen.

◆ HandleTransitionComplete()

bool SaveEditedFreqScreen::HandleTransitionComplete ( UITransitionCompleteMsg * pMsg)

Start the save under mFreqName once this screen has entered.

Parameters
pMsgThe message.
Returns
False.
Ghidra address:
NTSC-U/C: 0x001ac3e8
Ghidra address:
PAL: 0x001b4a48

◆ SetFreqName()

void SaveEditedFreqScreen::SetFreqName ( const char * pszFreqName)
inline
Parameters
pszFreqNameThe name the Freq is saved under.

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