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

Screen of the full ranking. More...

#include <netrankingscreen.h>

Inheritance diagram for NetRankingScreen:
Collaboration diagram for NetRankingScreen:

Public Types

enum  Page { kPageTop = 0 , kPageNext = 1 , kPagePrevious = 3 }
 The pages RequestPage() takes, as NetLobby::RequestRanks() takes them. More...

Public Member Functions

 NetRankingScreen (DataArray *pData)
 Construct a screen.
 ~NetRankingScreen () override
 Release the screen.
bool DispatchPriv (Message *pMsg) override
 Route the list of players to HandleLobbyPlayers().
void Enter (UIScreen *pPrevScreen, float fTime) override
 Enter with an empty list and request the top of the ranking.
void RequestPage (int nPage)
 Empty the list and request another page, unless the previous page is requested and no players precede the list.
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 of the full ranking.

The list pages through ten players at a time.

The RTTI records the class as deriving from FreqScreen.

Member Enumeration Documentation

◆ Page

The pages RequestPage() takes, as NetLobby::RequestRanks() takes them.

Enumerator
kPageTop 

The top of the ranking.

kPageNext 

The page after the list.

kPagePrevious 

The page before the list.

Constructor & Destructor Documentation

◆ NetRankingScreen()

NetRankingScreen::NetRankingScreen ( DataArray * pData)
explicit

Construct a screen.

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

◆ ~NetRankingScreen()

NetRankingScreen::~NetRankingScreen ( )
inlineoverride

Release the screen.

Ghidra address:
NTSC-U/C: 0x0035ac88
Ghidra address:
PAL: 0x003c87d8

Member Function Documentation

◆ New()

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

Produce a screen on the heap.

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

◆ DispatchPriv()

bool NetRankingScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route the list of players to HandleLobbyPlayers().

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

Reimplemented from FreqScreen.

◆ Enter()

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

Enter with an empty list and request the top of the ranking.

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

Reimplemented from FreqScreen.

◆ RequestPage()

void NetRankingScreen::RequestPage ( int nPage)

Empty the list and request another page, unless the previous page is requested and no players precede the list.

The name is inferred.

Parameters
nPageOne of Page.
Ghidra address:
NTSC-U/C: 0x0017e670
Ghidra address:
PAL: 0x00182330

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