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

Screen where the player chooses the mode and the skill of an online game, and a song from the list of a song panel. More...

#include <netparamsscreen.h>

Inheritance diagram for NetParamsScreen:
Collaboration diagram for NetParamsScreen:

Public Member Functions

 NetParamsScreen (DataArray *pData)
 Construct a screen from the song_panel_name, button_panel_name, and tri_back of its description.
 ~NetParamsScreen () override
 Release the screen.
bool DispatchPriv (Message *pMsg) override
 Route the choice, the left and right buttons, and the controller messages.
void Exit (UIScreen *pNextScreen, float fTime) override
 Exit and drop the names of the modes and the skills.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Enter, give the focus to the button panel, and label the choices.
virtual void UpdateLabels ()
 Label the mode and skill components with the chosen mode and skill, and disable skill for a mode after mLastSkillMode.
virtual void OnModeChanged ()
 React to a choice on the mode component.
virtual void OnChoiceChanged (int bReset)
 React to a change of the mode or the skill by listing the songs.
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.
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 HandleSelect (UIComponentSelectMsg *pMsg)
 Move to the song panel from song, or back to the button panel from cursor.
bool HandleSelectStart (UIComponentSelectStartMsg *pMsg)
 Change the mode or the skill with the left and right buttons, or move to the song panel from song with the right button.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Return from the song panel to the button panel with the triangle or left button, or exit the screen with the triangle button.

Static Protected Member Functions

static int StepChoice (int nChoice, int nCount, int nButton)
 Move a choice one step through a list, wrapping at both ends.

Protected Attributes

int mMode
int mSkill
int mLastSkillMode
int mDuelMode
int mRemixMode
std::vector< String > mModes
std::vector< String > mSkills
UIPanel * mSongPanel
const char * mSongPanelName
const char * mButtonPanelName
const char * mTriBackScreen
int mChoiceCount
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 chooses the mode and the skill of an online game, and a song from the list of a song panel.

The RTTI records the class as deriving from FreqScreen. Subclasses fill mModes and mSkills and react to the choices.

Constructor & Destructor Documentation

◆ NetParamsScreen()

NetParamsScreen::NetParamsScreen ( DataArray * pData)
explicit

Construct a screen from the song_panel_name, button_panel_name, and tri_back of its description.

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

◆ ~NetParamsScreen()

NetParamsScreen::~NetParamsScreen ( )
inlineoverride

Release the screen.

Ghidra address:
NTSC-U/C: 0x0035b3b8
Ghidra address:
PAL: 0x003c8f10

Member Function Documentation

◆ DispatchPriv()

bool NetParamsScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route the choice, the left and right buttons, and the controller messages.

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

Reimplemented from FreqScreen.

Reimplemented in NetSearchScreen.

◆ Exit()

void NetParamsScreen::Exit ( UIScreen * pNextScreen,
float fTime )
overridevirtual

Exit and drop the names of the modes and the skills.

Parameters
pNextScreenThe screen that is entering.
fTimeThe time.
Ghidra address:
NTSC-U/C: 0x0017fe40
Ghidra address:
PAL: 0x00184080

Reimplemented from FreqScreen.

◆ Enter()

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

Enter, give the focus to the button panel, and label the choices.

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

Reimplemented from FreqScreen.

Reimplemented in NetSearchScreen.

◆ UpdateLabels()

virtual void NetParamsScreen::UpdateLabels ( )
virtual

Label the mode and skill components with the chosen mode and skill, and disable skill for a mode after mLastSkillMode.

The name is inferred.

Ghidra address:
NTSC-U/C: 0x0017ff08
Ghidra address:
PAL: 0x00184148

Reimplemented in NetHostingScreen.

◆ OnModeChanged()

virtual void NetParamsScreen::OnModeChanged ( )
inlinevirtual

React to a choice on the mode component.

The base routine does nothing.

The name is inferred.

Ghidra address:
NTSC-U/C: 0x0035b530
Ghidra address:
PAL: 0x003c9088

Reimplemented in NetHostingScreen, and NetSearchScreen.

◆ OnChoiceChanged()

virtual void NetParamsScreen::OnChoiceChanged ( int bReset)
inlinevirtual

React to a change of the mode or the skill by listing the songs.

The base routine does nothing.

The name is inferred.

Parameters
bResetNon-zero to select the first entry of the song list rather than the song already selected. The routines here pass 0.
Ghidra address:
NTSC-U/C: 0x0035b538
Ghidra address:
PAL: 0x003c9090

Reimplemented in NetHostingScreen, and NetSearchScreen.

◆ StepChoice()

int NetParamsScreen::StepChoice ( int nChoice,
int nCount,
int nButton )
inlinestaticprotected

Move a choice one step through a list, wrapping at both ends.

Parameters
nChoiceThe choice.
nCountThe number of entries.
nButtonkPadDLeft to step back, or any other button to step forward.
Returns
The new choice.

◆ HandleSelect()

bool NetParamsScreen::HandleSelect ( UIComponentSelectMsg * pMsg)
protected

Move to the song panel from song, or back to the button panel from cursor.

The name is inferred.

Parameters
pMsgThe message.
Returns
The result of UIScreen::HandleSelect().
Ghidra address:
NTSC-U/C: 0x00180108
Ghidra address:
PAL: 0x00184348

◆ HandleSelectStart()

bool NetParamsScreen::HandleSelectStart ( UIComponentSelectStartMsg * pMsg)
protected

Change the mode or the skill with the left and right buttons, or move to the song panel from song with the right button.

The name is inferred.

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

◆ HandleJoypad()

bool NetParamsScreen::HandleJoypad ( JoypadInputMsg * pMsg)
protected

Return from the song panel to the button panel with the triangle or left button, or exit the screen with the triangle button.

The name is inferred.

Parameters
pMsgThe message.
Returns
True while a transition runs, otherwise false.
Ghidra address:
NTSC-U/C: 0x00180410
Ghidra address:
PAL: 0x00184650

Member Data Documentation

◆ mMode

int NetParamsScreen::mMode
protected

The chosen entry of mModes.

◆ mSkill

int NetParamsScreen::mSkill
protected

The chosen entry of mSkills.

◆ mLastSkillMode

int NetParamsScreen::mLastSkillMode
protected

The last mode the skill applies to.

◆ mDuelMode

int NetParamsScreen::mDuelMode
protected

The entry of mModes for a duel, or -1 for none.

◆ mRemixMode

int NetParamsScreen::mRemixMode
protected

The entry of mModes for a remix.

◆ mModes

std::vector<String> NetParamsScreen::mModes
protected

The names of the modes.

◆ mSkills

std::vector<String> NetParamsScreen::mSkills
protected

The names of the skills.

◆ mSongPanel

UIPanel* NetParamsScreen::mSongPanel
protected

The panel mSongPanelName identifies.

◆ mSongPanelName

const char* NetParamsScreen::mSongPanelName
protected

song_panel_name, the panel with the song list.

◆ mButtonPanelName

const char* NetParamsScreen::mButtonPanelName
protected

button_panel_name, the panel with the choices.

◆ mTriBackScreen

const char* NetParamsScreen::mTriBackScreen
protected

tri_back, the screen the triangle button returns to.

◆ mChoiceCount

int NetParamsScreen::mChoiceCount
protected

The entries of the song list before the songs.


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