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

Screen where the player chooses the mode, the skill, and the song of the online games to search for, each of which may be any. More...

#include <netsearchscreen.h>

Inheritance diagram for NetSearchScreen:
Collaboration diagram for NetSearchScreen:

Public Member Functions

 ~NetSearchScreen () override=default
 Destroy the object.
 NetSearchScreen (DataArray *pData)
 Construct the screen from its script description.
bool DispatchPriv (Message *pMsg) override
 Route a choice to HandleSelect(), or any other message to NetParamsScreen.
void Enter (UIScreen *pPrevScreen, float fTime) override
 List the modes with param_any last, and choose any mode and any skill.
void OnModeChanged () override
 List the skills of the chosen mode with param_any last, keeping the chosen skill where the lists differ.
void OnChoiceChanged (int bReset) override
 List search_all and the songs of the chosen mode and skill, keeping the song already selected.
bool HandleSelect (UIComponentSelectMsg *pMsg)
 Search with the choices from search, or move the focus to search from any other component.
Public Member Functions inherited from NetParamsScreen
 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.
void Exit (UIScreen *pNextScreen, float fTime) override
 Exit and drop the names of the modes and the skills.
virtual void UpdateLabels ()
 Label the mode and skill components with the chosen mode and skill, and disable skill for a mode after mLastSkillMode.
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.

Static Public Member Functions

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 Member Functions inherited from NetParamsScreen
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 inherited from NetParamsScreen
static int StepChoice (int nChoice, int nCount, int nButton)
 Move a choice one step through a list, wrapping at both ends.
Protected Attributes inherited from NetParamsScreen
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

Detailed Description

Screen where the player chooses the mode, the skill, and the song of the online games to search for, each of which may be any.

The RTTI records the class as deriving from NetParamsScreen, and the vtable is at 0x003cdbc8. The class adds no members. The destructor at 0x0035b6f0 (PAL 0x003c9248) is compiler-generated. The search opens fn_sorted.

Constructor & Destructor Documentation

◆ ~NetSearchScreen()

NetSearchScreen::~NetSearchScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035b6f0
Ghidra address:
PAL: 0x003c9248

◆ NetSearchScreen()

NetSearchScreen::NetSearchScreen ( DataArray * pData)
inlineexplicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x001841d8
Ghidra address:
PAL: 0x00188418

Member Function Documentation

◆ New()

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

Create a screen from its script description.

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

◆ DispatchPriv()

bool NetSearchScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route a choice to HandleSelect(), or any other message to NetParamsScreen.

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

Reimplemented from NetParamsScreen.

◆ Enter()

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

List the modes with param_any last, and choose any mode and any skill.

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

Reimplemented from NetParamsScreen.

◆ OnModeChanged()

void NetSearchScreen::OnModeChanged ( )
overridevirtual

List the skills of the chosen mode with param_any last, keeping the chosen skill where the lists differ.

Ghidra address:
NTSC-U/C: 0x00184ad0
Ghidra address:
PAL: 0x00188d10

Reimplemented from NetParamsScreen.

◆ OnChoiceChanged()

void NetSearchScreen::OnChoiceChanged ( int bReset)
overridevirtual

List search_all and the songs of the chosen mode and skill, keeping the song already selected.

The entry of that song counts the entries before the songs as the previous listing left them.

Parameters
bResetNot read.
Ghidra address:
NTSC-U/C: 0x00185cb8
Ghidra address:
PAL: 0x00189ef8

Reimplemented from NetParamsScreen.

◆ HandleSelect()

bool NetSearchScreen::HandleSelect ( UIComponentSelectMsg * pMsg)

Search with the choices from search, or move the focus to search from any other component.

Parameters
pMsgThe message.
Returns
The result of NetParamsScreen::HandleSelect().
Ghidra address:
NTSC-U/C: 0x001863a0
Ghidra address:
PAL: 0x0018a5e0

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