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

One of the screens of the online lobby, which share the tabs of the fn_main panel and the chat panel fn_main_c. More...

#include <netmainscreen.h>

Inheritance diagram for NetMainScreen:
Collaboration diagram for NetMainScreen:

Public Member Functions

 NetMainScreen (DataArray *pData)
 Construct the screen from its script description.
 ~NetMainScreen () override
 Destroy the screen.
bool DispatchPriv (Message *pMsg) override
 Route the tabs, the chat, the controller, and the players of a launchpad to their handlers.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Enter, focus join when the panel with the focus has no focused component, and show the help of the focus.
void Exit (UIScreen *pNextScreen, float fTime) override
 Exit, and give the focus back to fn_main unless the next screen is of the class.
const char * Title () override
 Report the title, the localised fn_main_TITLE with the name of the chat room.
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 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 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

One of the screens of the online lobby, which share the tabs of the fn_main panel and the chat panel fn_main_c.

The RTTI records the class as deriving from FreqScreen. Its vtable is at 0x003ce328. Moving the focus over a tab of fn_main goes to the screen fn_main_<tab>. The panels skip their animations between two screens of the class.

Constructor & Destructor Documentation

◆ NetMainScreen()

NetMainScreen::NetMainScreen ( DataArray * pData)
explicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x0017c670
Ghidra address:
PAL: 0x001802c8

◆ ~NetMainScreen()

NetMainScreen::~NetMainScreen ( )
inlineoverride

Destroy the screen.

Ghidra address:
NTSC-U/C: 0x0035a450
Ghidra address:
PAL: 0x003c7fa0

Member Function Documentation

◆ New()

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

Create a screen from its script description.

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

◆ DispatchPriv()

bool NetMainScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route the tabs, the chat, the controller, and the players of a launchpad to their handlers.

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

Reimplemented from FreqScreen.

◆ Enter()

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

Enter, focus join when the panel with the focus has no focused component, and show the help of the focus.

Parameters
pPrevScreenThe screen this one replaces, or null.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x0017c6f8
Ghidra address:
PAL: 0x00180350

Reimplemented from FreqScreen.

◆ Exit()

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

Exit, and give the focus back to fn_main unless the next screen is of the class.

Parameters
pNextScreenThe screen that replaces this one, or null.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x0017c810
Ghidra address:
PAL: 0x00180468

Reimplemented from FreqScreen.

◆ Title()

const char * NetMainScreen::Title ( )
overridevirtual

Report the title, the localised fn_main_TITLE with the name of the chat room.

Returns
The title.
Ghidra address:
NTSC-U/C: 0x0017c8e8
Ghidra address:
PAL: 0x00180540

Reimplemented from FreqScreen.


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