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

Screen where the player chooses the location of the lobby server to log in to. More...

#include <netserverselscreen.h>

Inheritance diagram for NetServerSelScreen:
Collaboration diagram for NetServerSelScreen:

Public Member Functions

 NetServerSelScreen (DataArray *pData)
 Construct a screen with no locations.
 ~NetServerSelScreen () override
 Release the screen.
bool DispatchPriv (Message *pMsg) override
 Route a choice to HandleSelect().
void Enter (UIScreen *pPrevScreen, float fTime) override
 Label one button with each location, disable the rest, and enter.
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.

Static Public Member Functions

static UIScreen * New (DataArray *pData)
 Produce a screen on the heap.
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

Screen where the player chooses the location of the lobby server to log in to.

The RTTI records the class as deriving from FreqScreen. Each button of the fn_sel_server panel, in the order of their names, shows one location.

Constructor & Destructor Documentation

◆ NetServerSelScreen()

NetServerSelScreen::NetServerSelScreen ( DataArray * pData)
explicit

Construct a screen with no locations.

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

◆ ~NetServerSelScreen()

NetServerSelScreen::~NetServerSelScreen ( )
inlineoverride

Release the screen.

Ghidra address:
NTSC-U/C: 0x003597e0
Ghidra address:
PAL: 0x003c6b48

Member Function Documentation

◆ New()

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

Produce a screen on the heap.

Parameters
pDataThe description of the screen.
Returns
The screen.
Ghidra address:
NTSC-U/C: 0x003598a0
Ghidra address:
PAL: 0x003c6c08

◆ DispatchPriv()

bool NetServerSelScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route a choice to HandleSelect().

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

Reimplemented from FreqScreen.

◆ Enter()

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

Label one button with each location, disable the rest, and enter.

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

Reimplemented from FreqScreen.


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