resonance 1.0.1
Loading...
Searching...
No Matches
MetConfigOptionsButtonsScreen Class Reference

Row of buttons along the network options screen. More...

#include <metconfigoptionsbuttonsscreen.h>

Inheritance diagram for MetConfigOptionsButtonsScreen:
Collaboration diagram for MetConfigOptionsButtonsScreen:

Public Member Functions

 MetConfigOptionsButtonsScreen (MetRenderer *pRenderer, int nPriority)
 Construct the button row.
virtual ~MetConfigOptionsButtonsScreen ()
virtual void EnterAndShow ()
 Rebuild the buttons and their prompts, select the first, and enter.
virtual void HandleCommand (const MetScreenCommand *pCommand)
 Act on a command.
virtual void PlayCycleLeftSound (int nSelector)
 Play nothing.
virtual void PlayCycleRightSound (int nSelector)
 Play nothing.
virtual void OnRepeatingSoundFinished (Rnd::Button *pButton)
 Begin the exit once a button has finished flashing.
virtual void OnExitFinished ()
 Push the screen the selected button opens.
Public Member Functions inherited from MetScreen
 MetScreen (MetRenderer *pRenderer, int nPriority, const HxStr &name, const HxStr &directory, const HxStr &file)
 Construct a screen and start its container load.
virtual ~MetScreen ()
 Unregister from the renderer and release the container.
void DeliverCommand (const MetScreenCommand *pCommand)
 Play the sound one navigation command calls for and then act on the command.
void UpdateAnimationFrame (float flTime)
 Drive the frame of whichever animation is running and run the idle hook when none is.
void UpdateFrame (float flTime)
 Advance one screen by one frame.
virtual void PushNamedScreen (const HxStr &name)
 Bring one named screen onto the renderer's screen stack.
virtual void ActivateNamedPanel (const HxStr &name)
 Make one named screen the renderer's active panel.
virtual void OnPanelActivated ()
 Act on this screen having become the renderer's active panel.
virtual void ExitScreenByName (const HxStr &name)
 Start one named screen's exit animation.
virtual void BeginExit ()
 Start this screen's exit animation at the renderer's current time.
virtual void OnUnusedHook ()
 Do nothing.
virtual void OnKeyboardDismissed ()
 Take control back after the keyboard screen has finished.
virtual void OnDrawPass ()
 Contribute to the renderer's draw pass.
virtual void OnDestroying ()
 Release what the screen acquired, ahead of the rest of destruction.
virtual int PollContainerLoad ()
 Advance this screen's container load and resolve its views once the load finishes.
virtual void OnMsgScreenDismissed (const HxStr &name, int nChoice)
 Act on the choice the user made in a message dialogue.
virtual void OnMsgScreenShown (const HxStr &name)
 Act on a message dialogue becoming visible.
virtual void SetShowing (int nShowing)
 Show or hide the view and every drawable the container loaded.
virtual void BeginContainerLoad (const HxStr &directory, const HxStr &file)
 Intern a container load under this screen's container name and enqueue it.
virtual void PlaySlideSound (int nSelector)
 Play the sound that accompanies sliding between screens.
virtual void PlayLeaveSound (int nSelector)
 Play the sound that accompanies departing a screen.
virtual void PlayHighSound (int nSelector)
 Play the sound that accompanies the emphasised selection.
virtual void PlayErrorSound (int nSelector)
 Play the sound that accompanies a rejected input.
virtual void UpdateIdle (float flTime)
 Advance whatever the screen updates once per frame while it is idle.
virtual void UpdateIdleAnimation (float flTime)
 Advance whatever the screen animates while it is neither entering nor exiting.
virtual void StartRepeatingSound (float flStartTime, float flInterval, Rnd::Button *pButton, int nCycles)
 Start alternating one button between its states 2 and 1.
virtual void UpdateRepeatingSound (float flTime)
 Advance the alternation that StartRepeatingSound() started.
virtual void StartEnterAnimation (float flTime)
 Rewind the enter animation and record the time it starts at.
virtual void UpdateEnterAnimation (float flTime)
 Drive the enter animation and finish it once it passes its end.
virtual void OnEnterFinished ()
 Act on the enter animation having finished.
virtual void StartExitAnimation (float flTime)
 Record the time the exit animation starts at.
virtual void UpdateExitAnimation (float flTime)
 Drive the exit animation and hide the screen once it passes its end.
virtual void Draw ()
 Draw the view.
virtual void ResolveContainerViews ()
 Resolve the three views the container produced and hide the screen.
Public Member Functions inherited from MsgSink
void * operator new (size_t nSize)
 Allocate a sink from the tagged heap under the tag "MsgSink".
void operator delete (void *pBlock)
 Release a sink to the tagged heap.
virtual ~MsgSink ()
virtual void Dispatch (Message *pMsg)
 Accept a message.

Static Public Member Functions

static MetConfigOptionsButtonsScreen * New (MetRenderer *pRenderer, int nPriority)
 Build the screen on the heap.
Static Public Member Functions inherited from MetScreen
static std::map< HxStr, MetContainerLoad * > & ContainerLoaderMap ()
 Shared table of container loads, interned under the container name.
static std::map< HxStr, MetScreenEntry > & ScreenRegistry ()
 Shared table of live screens, interned under the screen registry key.
static MetScreen * FindScreenByName (const HxStr &name)
 Resolve one screen by its registry key.
static MetScreen * FindEndScreen (MetRenderer *pRenderer, const HxStr &name)
 Resolve one end-of-game screen by its registry key, failing fatally when it is absent.
static void CreateMainMenuScreens (MetRenderer *pRenderer)
 Create the main-menu screens.
static void DestroyAllScreens ()
 Delete every registered screen and release every container loader.
static void CreateStartupScreens (MetRenderer *pRenderer)
 Create the four screens the front end needs before its containers have loaded.
static void CreateFrontEndScreens (MetRenderer *pRenderer)
 Create every remaining front-end screen, once.
static void DestroyCategory2Screens ()
 Delete and unregister every screen in category 2.
static void DestroyCategory1Screens ()
 Delete and unregister every screen in category 1.
static void DestroyNonDefaultScreens ()
 Delete and unregister every screen outside category 0, then rewind the rndMetLocAndNet zone.
static void PollContainerLoads ()
 Poll every container load that has not finished, and hide the drawables of each that does.

Additional Inherited Members

Public Attributes inherited from MetScreen
Rnd::View * mView
 The container's root view.
int mEnterPending
 Set when the screen was pushed before its container load finished.
int mActivatePending
 Set when the screen was activated as a panel before its container load finished.
float mRepeatScale
 Scale on the input auto-repeat interval.
Protected Member Functions inherited from MetScreen
virtual void DispatchPriv (Message *pMsg)
 Act on a message.
void ResolveAnimationViews ()
 Resolves the two animation views from the screen name and records the enter animation's end frame.
Protected Attributes inherited from MetScreen
float mAnimEndFrame
float mEnterStartTime
MetRenderer * mRenderer
int mExitChoice
int mAcceptsCommands
Rnd::View * mEnterAnim
std::vector< HxStr > mHelpKeys
int mViewsUnresolved
int mPlaysCommandSounds
int mShowsLoadedDrawables

Detailed Description

Row of buttons along the network options screen.

Its RTTI descriptor is at 0x008eeda8. It has MetScreen as its one public non-virtual base at offset 0. The object is 0x94 bytes and the 39-entry vtable is at 0x007ea688, the same length as the MetScreen table, and the class declares no new virtual.

The screen loads metagame/shared/net_options_butts.rnd and resolves net_options_butts.view along with the nob_EE.anim and nob_BF.anim animations. Its buttons open the game options, the controller configuration, the memory card, and the credits, and a fifth button changes the disc when GameOptions::mExpansionPack is set.

Eight slots differ from the MetScreen table.

Constructor & Destructor Documentation

◆ MetConfigOptionsButtonsScreen()

MetConfigOptionsButtonsScreen::MetConfigOptionsButtonsScreen ( MetRenderer * pRenderer,
int nPriority )

Construct the button row.

The screen name is nob, the directory metagame/shared, and the container net_options_butts.

Parameters
pRendererThe front-end renderer this screen registers on.
nPriorityThe load priority.
Ghidra address:
NTSC-U/C: 0x002071f0
Ghidra address:
PAL: 0x00210008

◆ ~MetConfigOptionsButtonsScreen()

virtual MetConfigOptionsButtonsScreen::~MetConfigOptionsButtonsScreen ( )
virtual
Ghidra address:
NTSC-U/C: 0x0020c088
Ghidra address:
PAL: 0x002154b8

Member Function Documentation

◆ New()

MetConfigOptionsButtonsScreen * MetConfigOptionsButtonsScreen::New ( MetRenderer * pRenderer,
int nPriority )
static

Build the screen on the heap.

The routine at 0x00385180 that creates every front-end screen is the caller.

Parameters
pRendererThe front-end renderer the screen registers on.
nPriorityThe load priority.
Returns
The new screen.
Ghidra address:
NTSC-U/C: 0x0020c000
Ghidra address:
PAL: 0x00215430

◆ EnterAndShow()

virtual void MetConfigOptionsButtonsScreen::EnterAndShow ( )
virtual

Rebuild the buttons and their prompts, select the first, and enter.

The disc button, its prompt, and the nob_5group.view frame appear only when GameOptions::mExpansionPack is set, and nob_4group.view appears otherwise. The title is the config_option_buttons title and the help layout is standard_title. The European release looks the prompts, the help texts, the title, and the layout up in the current language, and the help list stores the help texts rather than their keys.

Ghidra address:
NTSC-U/C: 0x00207660
Ghidra address:
PAL: 0x00210540

Reimplemented from MetScreen.

◆ HandleCommand()

virtual void MetConfigOptionsButtonsScreen::HandleCommand ( const MetScreenCommand * pCommand)
virtual

Act on a command.

Previous and next step the ring and post the new button's prompt. Select records the pad of a controller button press in mControllerIndex, clears the active panel, and flashes the selected button. Back records 0 in MetScreen::mExitChoice, exits the title and right gizmo screens, and begins the exit.

Parameters
pCommandThe command.
Ghidra address:
NTSC-U/C: 0x002073c8
Ghidra address:
PAL: 0x00210240

Reimplemented from MetScreen.

◆ PlayCycleLeftSound()

virtual void MetConfigOptionsButtonsScreen::PlayCycleLeftSound ( int nSelector)
virtual

Play nothing.

Parameters
nSelectorNot read.
Ghidra address:
NTSC-U/C: 0x0020bff0
Ghidra address:
PAL: 0x00215420

Reimplemented from MetScreen.

◆ PlayCycleRightSound()

virtual void MetConfigOptionsButtonsScreen::PlayCycleRightSound ( int nSelector)
virtual

Play nothing.

Parameters
nSelectorNot read.
Ghidra address:
NTSC-U/C: 0x0020bff8
Ghidra address:
PAL: 0x00215428

Reimplemented from MetScreen.

◆ OnRepeatingSoundFinished()

virtual void MetConfigOptionsButtonsScreen::OnRepeatingSoundFinished ( Rnd::Button * pButton)
virtual

Begin the exit once a button has finished flashing.

Every button records 2 in MetScreen::mExitChoice and exits the right gizmo and title screens. The memory, credits, and disc buttons also exit the help screen.

Parameters
pButtonThe button that finished alternating.
Ghidra address:
NTSC-U/C: 0x00207fc0
Ghidra address:
PAL: 0x00211070

Reimplemented from MetScreen.

◆ OnExitFinished()

virtual void MetConfigOptionsButtonsScreen::OnExitFinished ( )
virtual

Push the screen the selected button opens.

A cancel returns to the pause screen when MetFrontEndState::mReturnScreen is MetPauseSoloGameScreen, and to the main menu otherwise. The controller button hands mControllerIndex to MetConfigControllerScreen::mControllerIndex, and the memory button records this screen in MetFrontEndState::mReturnScreen to return to.

Ghidra address:
NTSC-U/C: 0x00208270
Ghidra address:
PAL: 0x00211398

Reimplemented from MetScreen.


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