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

Screen where the player types a name on the name entry of its panel, for a subclass to submit. More...

#include <setupnamescreen.h>

Inheritance diagram for SetupNameScreen:
Collaboration diagram for SetupNameScreen:

Public Member Functions

 SetupNameScreen (DataArray *pData)
 Construct a screen with no text.
 ~SetupNameScreen () override
 Release the screen.
bool DispatchPriv (Message *pMsg) override
 Route the controller and the end of the entry.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Enter, fill the name entry with the text, and edit it.
int ReceiveKeyboardText (const char *pszText) override
 Take the text the keyboard typed.
virtual void SetText (const char *pszText)
 Set the text the name entry shows on the next entry of the screen.
virtual void Submit ()
 Submit the name.
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.

Protected Attributes

String mText
UITextEntry * mEntry
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 where the player types a name on the name entry of its panel, for a subclass to submit.

The RTTI records the class as deriving from FreqScreen and from KeyboardUser.

Constructor & Destructor Documentation

◆ SetupNameScreen()

SetupNameScreen::SetupNameScreen ( DataArray * pData)
explicit

Construct a screen with no text.

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

◆ ~SetupNameScreen()

SetupNameScreen::~SetupNameScreen ( )
inlineoverride

Release the screen.

Ghidra address:
NTSC-U/C: 0x0035a638
Ghidra address:
PAL: 0x003c8188

Member Function Documentation

◆ DispatchPriv()

bool SetupNameScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route the controller and the end of the entry.

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

Reimplemented from FreqScreen.

◆ Enter()

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

Enter, fill the name entry with the text, and edit it.

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

Reimplemented from FreqScreen.

Reimplemented in SetupNewChatroomScreen.

◆ ReceiveKeyboardText()

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

Take the text the keyboard typed.

Parameters
pszTextThe text.
Returns
1.
Ghidra address:
NTSC-U/C: 0x0017d220
Ghidra address:
PAL: 0x00180e78

Implements KeyboardUser.

◆ SetText()

virtual void SetupNameScreen::SetText ( const char * pszText)
inlinevirtual

Set the text the name entry shows on the next entry of the screen.

Parameters
pszTextThe text.
Ghidra address:
NTSC-U/C: 0x0035a718
Ghidra address:
PAL: 0x003c8268

◆ Submit()

virtual void SetupNameScreen::Submit ( )
inlinevirtual

Submit the name.

The name is inferred.

Ghidra address:
NTSC-U/C: 0x0035a738
Ghidra address:
PAL: 0x003c8288

Reimplemented in PlayerSearchSetupScreen, and SetupNewChatroomScreen.

Member Data Documentation

◆ mText

String SetupNameScreen::mText
protected

The text for the name entry, or empty.

◆ mEntry

UITextEntry* SetupNameScreen::mEntry
protected

The name entry, from the last entry of the screen.


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