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

Screen with a save button that chooses whether the online password is saved in the profile. More...

#include <netpasswordscreen.h>

Inheritance diagram for NetPasswordScreen:
Collaboration diagram for NetPasswordScreen:

Public Member Functions

 NetPasswordScreen (DataArray *pData)
 Construct a screen that saves the password.
 ~NetPasswordScreen () override
 Release the screen.
bool DispatchPriv (Message *pMsg) override
 Route a select start to HandleSelectStart().
void Enter (UIScreen *pPrevScreen, float fTime) override
 Take the choice from whether the profile has a saved password, and label the save button.
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 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.

Protected Member Functions

bool HandleSaveToggle (UIComponentSelectStartMsg *pMsg)
 Toggle the choice when a directional button moves on the save button.
void LabelSaveChoice (UIComponent *pComponent)
 Label a component with the localised text of the choice.

Protected Attributes

int mSavePassword
int mSavePasswordInitial
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

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.
Public Attributes inherited from FreqScreen
Vector3 mGizmoOrig
Quat mGizmoRot

Detailed Description

Screen with a save button that chooses whether the online password is saved in the profile.

The RTTI records the class as deriving from FreqScreen. NetLoginScreen, NetCreateUserScreen, and NetChangePasswordScreen derive from it. The left and right directional buttons toggle the choice.

Constructor & Destructor Documentation

◆ NetPasswordScreen()

NetPasswordScreen::NetPasswordScreen ( DataArray * pData)
explicit

Construct a screen that saves the password.

Parameters
pDataThe description of the screen.
Ghidra address:
NTSC-U/C: 0x00178408
Ghidra address:
PAL: 0x0017c018

◆ ~NetPasswordScreen()

NetPasswordScreen::~NetPasswordScreen ( )
inlineoverride

Release the screen.

Ghidra address:
NTSC-U/C: 0x003590c8
Ghidra address:
PAL: 0x003c6430

Member Function Documentation

◆ DispatchPriv()

bool NetPasswordScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route a select start to HandleSelectStart().

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

Reimplemented from FreqScreen.

◆ Enter()

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

Take the choice from whether the profile has a saved password, and label the save button.

Parameters
pPrevScreenThe screen that is exiting.
fTimeThe time.
Ghidra address:
NTSC-U/C: 0x00178448
Ghidra address:
PAL: 0x0017c058

Reimplemented from FreqScreen.

◆ HandleSaveToggle()

bool NetPasswordScreen::HandleSaveToggle ( UIComponentSelectStartMsg * pMsg)
protected

Toggle the choice when a directional button moves on the save button.

The name is inferred.

Parameters
pMsgThe message.
Returns
The result of FreqScreen::HandleSelectStart().
Ghidra address:
NTSC-U/C: 0x001785b8
Ghidra address:
PAL: 0x0017c1c8

◆ LabelSaveChoice()

void NetPasswordScreen::LabelSaveChoice ( UIComponent * pComponent)
protected

Label a component with the localised text of the choice.

The binary expands it inline.

Parameters
pComponentThe component.

Member Data Documentation

◆ mSavePassword

int NetPasswordScreen::mSavePassword
protected

Whether the password is saved in the profile.

◆ mSavePasswordInitial

int NetPasswordScreen::mSavePasswordInitial
protected

The choice when the screen entered.


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