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

The menu that chooses two, three, or four players for a local game. More...

#include <numplayersscreen.h>

Inheritance diagram for NumPlayersScreen:
Collaboration diagram for NumPlayersScreen:

Public Member Functions

 ~NumPlayersScreen () override=default
 Destroy the object.
 NumPlayersScreen (DataArray *pData)
 Construct the screen from its script description.
bool DispatchPriv (Message *pMsg) override
 Route a chosen button, and pass on every other message.
void Poll (float fTime) override
 Advance the screen, and update the buttons when a multitap is plugged in or out.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Start the entry and enable the buttons the controllers allow.
void UpdateButtons (int nMultitap)
 Enable the three and four player buttons when a multitap is connected, disable them otherwise, and focus the two player button.
bool HandleSelect (UIComponentSelectMsg *pMsg)
 Set up the players of the button chosen with the cross button.
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 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

The menu that chooses two, three, or four players for a local game.

Three and four players need a multitap.

The RTTI records the class as deriving from FreqScreen. The object is 0x74 bytes and its vtable is at 0x003ced20. The metagame registers the class for the screen type num_players_screen. Its panel is m_player with the buttons 2play, 3play, and 4play.

Constructor & Destructor Documentation

◆ ~NumPlayersScreen()

NumPlayersScreen::~NumPlayersScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035d858
Ghidra address:
PAL: 0x003cb930

◆ NumPlayersScreen()

NumPlayersScreen::NumPlayersScreen ( DataArray * pData)
explicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x0018d980
Ghidra address:
PAL: 0x00194878

Member Function Documentation

◆ New()

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

Create a screen from its script description.

The metagame registers the routine for the screen type num_players_screen.

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

◆ DispatchPriv()

bool NumPlayersScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route a chosen button, and pass on every other message.

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

Reimplemented from FreqScreen.

◆ Poll()

void NumPlayersScreen::Poll ( float fTime)
overridevirtual

Advance the screen, and update the buttons when a multitap is plugged in or out.

Parameters
fTimeThe front-end time.
Ghidra address:
NTSC-U/C: 0x0018db80
Ghidra address:
PAL: 0x00194a78

Reimplemented from UIScreen.

◆ Enter()

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

Start the entry and enable the buttons the controllers allow.

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

Reimplemented from FreqScreen.

◆ UpdateButtons()

void NumPlayersScreen::UpdateButtons ( int nMultitap)

Enable the three and four player buttons when a multitap is connected, disable them otherwise, and focus the two player button.

Parameters
nMultitapNon-zero when a multitap is connected.
Ghidra address:
NTSC-U/C: 0x0018d9f8
Ghidra address:
PAL: 0x001948f0

◆ HandleSelect()

bool NumPlayersScreen::HandleSelect ( UIComponentSelectMsg * pMsg)

Set up the players of the button chosen with the cross button.

The first player retains a custom Freq, and every other player gets a default name.

Parameters
pMsgThe message.
Returns
The result of UIScreen::HandleSelect().
Ghidra address:
NTSC-U/C: 0x0018dc30
Ghidra address:
PAL: 0x00194b28

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