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

The screen on which every player of a local game chooses a Freq at the same time. More...

#include <multifreqselectscreen.h>

Inheritance diagram for MultiFreqSelectScreen:
Collaboration diagram for MultiFreqSelectScreen:

Public Member Functions

 ~MultiFreqSelectScreen () override=default
 Destroy the object.
 MultiFreqSelectScreen (DataArray *pData)
 Construct the screen from its script description, reading num_players.
bool DispatchPriv (Message *pMsg) override
 Route the choices and the controller buttons, and pass on every other message.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Start the entry with no player having chosen.
bool HandleSelectStart (UIComponentSelectStartMsg *pMsg)
 Pass the start of a choice to the panel of the controller that made it.
bool HandleSelect (UIComponentSelectMsg *pMsg)
 Pass a choice made with the cross button to the panel of its player, mark the player as done, and go on when every player is done.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Handle a button of a player's controller.
void CheckDone ()
 Go on to the skill or remix menu once every player has chosen, giving every player without a name the default name of the player's number.
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)
 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 screen on which every player of a local game chooses a Freq at the same time.

The RTTI records the class as deriving from FreqScreen, and its vtable is at 0x003ced80. The metagame registers the class for the screen type f_m_sel_screen. Player n of p players uses the panel m_g_s_f_<p>pl_0<n>.

Constructor & Destructor Documentation

◆ ~MultiFreqSelectScreen()

MultiFreqSelectScreen::~MultiFreqSelectScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035d758
Ghidra address:
PAL: 0x003cb830

◆ MultiFreqSelectScreen()

MultiFreqSelectScreen::MultiFreqSelectScreen ( DataArray * pData)
explicit

Construct the screen from its script description, reading num_players.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x0018eea8
Ghidra address:
PAL: 0x001961c0

Member Function Documentation

◆ New()

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

Create a screen from its script description.

The metagame registers the routine for the screen type f_m_sel_screen.

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

◆ DispatchPriv()

bool MultiFreqSelectScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route the choices and the controller buttons, and pass on every other message.

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

Reimplemented from FreqScreen.

◆ Enter()

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

Start the entry with no player having chosen.

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

Reimplemented from FreqScreen.

◆ HandleSelectStart()

bool MultiFreqSelectScreen::HandleSelectStart ( UIComponentSelectStartMsg * pMsg)

Pass the start of a choice to the panel of the controller that made it.

Parameters
pMsgThe message.
Returns
The result of FreqSelPanel::HandleSelectStart(), or false for a controller without a player.
Ghidra address:
NTSC-U/C: 0x0018ff08
Ghidra address:
PAL: 0x00197220

◆ HandleSelect()

bool MultiFreqSelectScreen::HandleSelect ( UIComponentSelectMsg * pMsg)

Pass a choice made with the cross button to the panel of its player, mark the player as done, and go on when every player is done.

The player is the last digit of the chosen component's name.

Parameters
pMsgThe message.
Returns
The result of FreqSelPanel::HandleSelect(), or false.
Ghidra address:
NTSC-U/C: 0x0018ffd0
Ghidra address:
PAL: 0x001972e8

◆ HandleJoypad()

bool MultiFreqSelectScreen::HandleJoypad ( JoypadInputMsg * pMsg)

Handle a button of a player's controller.

The triangle button takes back the player's choice, or with no choice made by any player goes back to the mode or player menu. A player who has not chosen passes every other button to the player's panel.

Parameters
pMsgThe message of the button.
Returns
True while the screen moves in or out, false after going back, otherwise the result of FreqScreen::HandleJoypad().
Ghidra address:
NTSC-U/C: 0x00190190
Ghidra address:
PAL: 0x001974a8

◆ CheckDone()

void MultiFreqSelectScreen::CheckDone ( )

Go on to the skill or remix menu once every player has chosen, giving every player without a name the default name of the player's number.

Ghidra address:
NTSC-U/C: 0x001906a0
Ghidra address:
PAL: 0x001979b8

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