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

List of the chat rooms of the lobby, with the number of players of each. More...

#include <netmainlobbieslist.h>

Inheritance diagram for NetMainLobbiesList:
Collaboration diagram for NetMainLobbiesList:

Public Member Functions

 NetMainLobbiesList (DataArray *pData, const char *pszPanel)
 Construct a list from its script description.
 ~NetMainLobbiesList () override
 Destroy the list.
void UpdateRow (int nRow, int nItem) override
 Show the name and the players of a chat room in a row.
bool HandleJoypad (JoypadInputMsg *pMsg) override
 Choose the selected room for NetSwitchLobbyScreen with the cross button, then handle the button as a list does.
void SetChatrooms (std::list< NetChatroomInfo > *pChatrooms)
 Replace the chat rooms and keep the selection.
Public Member Functions inherited from FreqList
 ~FreqList () override=default
 Destroy the object.
 FreqList (DataArray *pData, const char *pszPanel)
 Construct the list from its script description.
void ScrollUp () override
 Select the previous item, and play the sound of the up button when the selection moved.
void ScrollDown () override
 Select the next item, and play the sound of the down button when the selection moved.
Public Member Functions inherited from UIList
 UIList (DataArray *pData, const char *pszPanel)
 Construct a list from its script description, cloning the template row once for each row.
 ~UIList () override
 Destroy the row clones and every object cloned with them.
bool DispatchPriv (Message *pMsg) override
 Pass a controller button to HandleJoypad().
void Print (PrnStream &stream) override
 Write a description of the list.
virtual void UpdateCursor ()
 Move the cursor to the row with the selection, or dim it when the list is empty.
virtual void SetCursorSelected (bool bSelected)
 Give the cursor the material of the selected or of the normal state.
RndView * CloneRow (int nRow, RndView *pTemplate)
 Clone the template row for one row.
void BuildRowCells (RndView *pRow)
 Record the cells of a row, emptying each text and hiding each mesh.
void SetCellMat (int nRow, int nColumn, RndMat *pMat)
 Show the mesh of a cell with a material.
void SetCellText (int nRow, int nColumn, const char *pszText)
 Set the text of a cell.
void SetCellFont (int nRow, int nColumn, RndFont *pFont)
 Set the font of a cell's text.
void SetRowFont (int nRow, RndFont *pFont)
 Set the font of every text of a row.
void SetSelected (int nSelected)
 Select an item, keeping the number of items.
void Refresh (int nItemCount, int nSelected)
 Set the number of items and the selection, and fill the rows.
int GetSelected () const
int GetItemCount () const
int GetRowCount () const
RndMesh * GetUpArrow () const
RndMesh * GetDownArrow () const
void SetShowUpArrow (int nShow)
void SetShowDownArrow (int nShow)
Public Member Functions inherited from UIComponent
 UIComponent (DataArray *pData)
 Construct a showing component in the normal state.
bool Dispatch (Message *pMsg) override
 Offer a message to the focused panel of the current screen, then handle it here.
virtual bool IsShowing () const
 Report whether the component is showing.
virtual void SetShowing (bool bShowing)
 Show or hide the component.
virtual const char * Text () const
 Report the text the component shows.
virtual void SetText (const char *pszText)
 Replace the text the component shows.
virtual int GetState () const
 Report the state the component shows.
virtual void SetState (int nState, bool bForce)
 Change the state the component shows.
virtual void Focus ()
 React to the panel giving the component the focus.
virtual void Unfocus ()
 React to the panel taking the focus away.
virtual void Poll (float fTime)
 Advance the component to a time.
const char * GetName () const
int GetShowing () 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 UIComponent * New (DataArray *pData, const char *pszPanel)
 Create a list from its script description.
Static Public Member Functions inherited from UIList
static UIComponent * New (DataArray *pData, const char *pszPanel)
 Create a list from its script description.
Static Public Member Functions inherited from UIComponent
static void Init (DataArray *pConfig)
 Read the parameters of the flash a button shows when it is chosen.

Additional Inherited Members

Public Types inherited from UIComponent
enum  State { kStateNormal = 0 , kStateSelected = 1 , kStateDisabled = 2 }
 The state a component shows, the values of mState and the index UIStyle selects with. More...
Static Public Attributes inherited from UIList
static constexpr int kKeepSelection = -99999
 The value of Refresh()'s selection that keeps the selected item.
Protected Attributes inherited from UIList
UIStyle * mStyle
int mItemCount
int mRowCount
int mColumnCount
int mCursorRow
int mSelected
int mRowPitch
std::list< std::vector< Cell > > mRowCells
std::vector< RndView * > mRows
std::vector< RndText * > mTextCells
const char * mPanelName
RndMesh * mCursor
RndMesh * mUpArrow
RndMesh * mDownArrow
Transform mCursorXfm
int mShowUpArrow
int mShowDownArrow
Protected Attributes inherited from UIComponent
const char * mName
int mShowing
int mState
Static Protected Attributes inherited from UIComponent
static int sNumFlashes
 Number of times a chosen button flashes before it reports the choice.
static float sSelectedMs
 Milliseconds of each flash a chosen button spends in the selected state.
static float sNormalMs
 Milliseconds of each flash a chosen button spends in the normal state.

Detailed Description

List of the chat rooms of the lobby, with the number of players of each.

The RTTI records the class as deriving from FreqList. Its vtable is at 0x003cf6e8. The cross button chooses the room NetSwitchLobbyScreen joins.

Constructor & Destructor Documentation

◆ NetMainLobbiesList()

NetMainLobbiesList::NetMainLobbiesList ( DataArray * pData,
const char * pszPanel )
inline

Construct a list from its script description.

Parameters
pDataThe script description.
pszPanelThe name of the panel the list belongs to.
Ghidra address:
NTSC-U/C: 0x0019c760
Ghidra address:
PAL: 0x001a4498

◆ ~NetMainLobbiesList()

NetMainLobbiesList::~NetMainLobbiesList ( )
inlineoverride

Destroy the list.

Ghidra address:
NTSC-U/C: 0x00360388
Ghidra address:
PAL: 0x003ce8a0

Member Function Documentation

◆ New()

UIComponent * NetMainLobbiesList::New ( DataArray * pData,
const char * pszPanel )
inlinestatic

Create a list from its script description.

Metagame::RegisterScreenClasses() registers the routine for the entry type lobbies_list_comp.

Parameters
pDataThe script description.
pszPanelThe name of the panel the list belongs to.
Returns
The new list.
Ghidra address:
NTSC-U/C: 0x00360480
Ghidra address:
PAL: 0x003ce998

◆ UpdateRow()

void NetMainLobbiesList::UpdateRow ( int nRow,
int nItem )
overridevirtual

Show the name and the players of a chat room in a row.

Parameters
nRowThe row.
nItemThe chat room.
Ghidra address:
NTSC-U/C: 0x0019c7e0
Ghidra address:
PAL: 0x001a4518

Reimplemented from UIList.

◆ HandleJoypad()

bool NetMainLobbiesList::HandleJoypad ( JoypadInputMsg * pMsg)
overridevirtual

Choose the selected room for NetSwitchLobbyScreen with the cross button, then handle the button as a list does.

Parameters
pMsgThe message of the button.
Returns
The result of UIList::HandleJoypad().
Ghidra address:
NTSC-U/C: 0x0019c8e0
Ghidra address:
PAL: 0x001a4618

Reimplemented from UIList.

◆ SetChatrooms()

void NetMainLobbiesList::SetChatrooms ( std::list< NetChatroomInfo > * pChatrooms)

Replace the chat rooms and keep the selection.

The name is inferred.

Parameters
pChatroomsThe chat rooms to copy.
Ghidra address:
NTSC-U/C: 0x0019c868
Ghidra address:
PAL: 0x001a45a0

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