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

Screen where the player enters the password of the online account and logs in. More...

#include <netloginscreen.h>

Inheritance diagram for NetLoginScreen:
Collaboration diagram for NetLoginScreen:

Public Member Functions

 NetLoginScreen (DataArray *pData)
 Construct a screen with no typed password.
 ~NetLoginScreen () override
 Release the screen.
bool DispatchPriv (Message *pMsg) override
 Route the controller, the end of the entry, and the focus messages.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Enter, and fill the name and the password from the profile or from the keyboard.
int ReceiveKeyboardText (const char *pszText) override
 Take the password the keyboard typed.
Public Member Functions inherited from NetPasswordScreen
 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.
Public Member Functions inherited from KeyboardUser
virtual ~KeyboardUser ()
 Destroy the mix-in.

Static Public Member Functions

static UIScreen * New (DataArray *pData)
 Produce a screen on the heap.
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 Member Functions inherited from NetPasswordScreen
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 inherited from NetPasswordScreen
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

Detailed Description

Screen where the player enters the password of the online account and logs in.

The RTTI records the class as deriving from NetPasswordScreen and from KeyboardUser. A profile that has never logged in may only create an account. The on-screen keyboard types the password.

Constructor & Destructor Documentation

◆ NetLoginScreen()

NetLoginScreen::NetLoginScreen ( DataArray * pData)
explicit

Construct a screen with no typed password.

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

◆ ~NetLoginScreen()

NetLoginScreen::~NetLoginScreen ( )
inlineoverride

Release the screen.

Ghidra address:
NTSC-U/C: 0x00359160
Ghidra address:
PAL: 0x003c64c8

Member Function Documentation

◆ New()

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

Produce a screen on the heap.

Parameters
pDataThe description of the screen.
Returns
The screen.
Ghidra address:
NTSC-U/C: 0x00359278
Ghidra address:
PAL: 0x003c65e0

◆ DispatchPriv()

bool NetLoginScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route the controller, the end of the entry, and the focus messages.

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

Reimplemented from FreqScreen.

◆ Enter()

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

Enter, and fill the name and the password from the profile or from the keyboard.

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

Reimplemented from FreqScreen.

◆ ReceiveKeyboardText()

int NetLoginScreen::ReceiveKeyboardText ( const char * pszText)
overridevirtual

Take the password the keyboard typed.

Parameters
pszTextThe password.
Returns
1.
Ghidra address:
NTSC-U/C: 0x00179008
Ghidra address:
PAL: 0x0017cc28

Implements KeyboardUser.


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