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

Screen where the host of an online game chooses the mode, the skill, the number of players, the power-ups, and the song, or edits them from the launchpad. More...

#include <nethostingscreen.h>

Inheritance diagram for NetHostingScreen:
Collaboration diagram for NetHostingScreen:

Public Member Functions

 ~NetHostingScreen () override=default
 Destroy the object.
 NetHostingScreen (DataArray *pData)
 Construct the screen from its script description.
bool DispatchPriv (Message *pMsg) override
 Route the choices, the left and right buttons, and the controller to their handlers.
void Enter (UIScreen *pPrevScreen, float fTime) override
 List the modes, the numbers of players, and the power-ups, and choose the settings of the game database.
void UpdateLabels () override
 Label the choices, and disable the power-ups for a mode other than the game and the number of players for a duel or while editing.
void OnModeChanged () override
 List the skills of the chosen mode, keeping the chosen skill where the lists differ.
void OnChoiceChanged (int bReset) override
 List host_random, the songs of the chosen mode and skill, and for a game or a remix host_custom, keeping the song already selected or the song of the game database.
bool HandleSelect (UIComponentSelectMsg *pMsg)
 Write the choices to the game database and host the game, or choose a saved remix for host_custom.
bool HandleSelectStart (UIComponentSelectStartMsg *pMsg)
 Change the number of players or the power-ups with the left and right buttons.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Restore the saved settings when the triangle button leaves the editing screen.
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.
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.
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 host of an online game chooses the mode, the skill, the number of players, the power-ups, and the song, or edits them from the launchpad.

The RTTI records the class as deriving from NetParamsScreen, and the vtable is at 0x003cdca0. The destructor at 0x0035a308 (PAL 0x003c7e58) is compiler-generated. The description may set is_edit for the screen that edits the game of an open launchpad.

Constructor & Destructor Documentation

◆ ~NetHostingScreen()

NetHostingScreen::~NetHostingScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035a308
Ghidra address:
PAL: 0x003c7e58

◆ NetHostingScreen()

NetHostingScreen::NetHostingScreen ( DataArray * pData)
explicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x00180528
Ghidra address:
PAL: 0x00184768

Member Function Documentation

◆ New()

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

Create a screen from its script description.

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

◆ DispatchPriv()

bool NetHostingScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route the choices, the left and right buttons, and the controller to their handlers.

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

Reimplemented from FreqScreen.

◆ Enter()

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

List the modes, the numbers of players, and the power-ups, and choose the settings of the game database.

Entered from fn_h_lpad to edit, the screen saves the settings for the triangle button to restore. A duel is not offered when the session already takes more than two players.

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

Reimplemented from FreqScreen.

◆ UpdateLabels()

void NetHostingScreen::UpdateLabels ( )
overridevirtual

Label the choices, and disable the power-ups for a mode other than the game and the number of players for a duel or while editing.

Ghidra address:
NTSC-U/C: 0x001834e8
Ghidra address:
PAL: 0x00187728

Reimplemented from NetParamsScreen.

◆ OnModeChanged()

void NetHostingScreen::OnModeChanged ( )
overridevirtual

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

Ghidra address:
NTSC-U/C: 0x00181ab8
Ghidra address:
PAL: 0x00185cf8

Reimplemented from NetParamsScreen.

◆ OnChoiceChanged()

void NetHostingScreen::OnChoiceChanged ( int bReset)
overridevirtual

List host_random, the songs of the chosen mode and skill, and for a game or a remix host_custom, keeping the song already selected or the song of the game database.

Parameters
bResetNon-zero to select the first entry.
Ghidra address:
NTSC-U/C: 0x00182900
Ghidra address:
PAL: 0x00186b40

Reimplemented from NetParamsScreen.

◆ HandleSelect()

bool NetHostingScreen::HandleSelect ( UIComponentSelectMsg * pMsg)

Write the choices to the game database and host the game, or choose a saved remix for host_custom.

Any other component moves the focus to host.

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

◆ HandleSelectStart()

bool NetHostingScreen::HandleSelectStart ( UIComponentSelectStartMsg * pMsg)

Change the number of players or the power-ups with the left and right buttons.

Parameters
pMsgThe message.
Returns
The result of NetParamsScreen::HandleSelectStart().
Ghidra address:
NTSC-U/C: 0x00183b68
Ghidra address:
PAL: 0x00187da8

◆ HandleJoypad()

bool NetHostingScreen::HandleJoypad ( JoypadInputMsg * pMsg)

Restore the saved settings when the triangle button leaves the editing screen.

Parameters
pMsgThe message.
Returns
True while a transition runs, otherwise the result of NetParamsScreen::HandleJoypad().
Ghidra address:
NTSC-U/C: 0x00183d10
Ghidra address:
PAL: 0x00187f50

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