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

Screen that edits the in-game options. More...

#include <metconfiggameoptionsscreen.h>

Inheritance diagram for MetConfigGameOptionsScreen:
Collaboration diagram for MetConfigGameOptionsScreen:

Public Member Functions

 MetConfigGameOptionsScreen (MetRenderer *pRenderer, int nPriority)
 Construct the in-game options screen.
virtual ~MetConfigGameOptionsScreen ()
virtual void EnterAndShow ()
 Select the first row, copy the stored options, and enter.
virtual void HandleCommand (const MetScreenCommand *pCommand)
 Act on a command.
virtual void OnExitFinished ()
 Push the screens that follow this one.
virtual void ResolveContainerViews ()
 Resolve the two labels, the two rows, and the four arrow buttons.
Public Member Functions inherited from MetScreenMultiSoundBank
 MetScreenMultiSoundBank (MetRenderer *pRenderer, int nPriority, const HxStr &name, const HxStr &directory, const HxStr &file)
 Construct a screen that uses the multiplayer sound bank.
virtual ~MetScreenMultiSoundBank ()
virtual void PlaySlideSound (int nSelector)
virtual void PlayLeaveSound (int nSelector)
virtual void PlayHighSound (int nSelector)
virtual void PlayCycleLeftSound (int nSelector)
virtual void PlayCycleRightSound (int nSelector)
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 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 OnRepeatingSoundFinished (Rnd::Button *pButton)
 Act on the alternation that StartRepeatingSound() started having finished.
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.
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 MetConfigGameOptionsScreen * 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

Screen that edits the in-game options.

Its RTTI descriptor is at 0x00901ee0. It has MetScreenMultiSoundBank as its one public non-virtual base at offset 0. New() allocates 0xb4 bytes, and the 39-entry vtable is at 0x007eaea8, the same length as the MetScreen table, and the class declares no new virtual.

Two rows edit a working copy of GameOptions. The audio row switches GameOptions::mStereo between STEREO and MONO, and the force-feedback row switches GameOptions::mForceFeedback between ON and OFF.

Six slots differ from the MetScreenMultiSoundBank table.

The five sounds the base swapped for the multiplayer bank stay as MetScreenMultiSoundBank defined them.

Constructor & Destructor Documentation

◆ MetConfigGameOptionsScreen()

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

Construct the in-game options screen.

The screen name is nop, the directory metagame/shared, and the container net_options_pangame. The two row keys are appended to MetScreen::mHelpKeys.

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

◆ ~MetConfigGameOptionsScreen()

virtual MetConfigGameOptionsScreen::~MetConfigGameOptionsScreen ( )
virtual
Ghidra address:
NTSC-U/C: 0x0020ce20
Ghidra address:
PAL: 0x00216400

Member Function Documentation

◆ New()

MetConfigGameOptionsScreen * MetConfigGameOptionsScreen::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: 0x002114f0
Ghidra address:
PAL: 0x0021aeb0

◆ EnterAndShow()

virtual void MetConfigGameOptionsScreen::EnterAndShow ( )
virtual

Select the first row, copy the stored options, and enter.

The European release selects the standard_title prompt layout in place of pangame_tab_text when MetFrontEndState::mReturnScreen records a pause screen.

Ghidra address:
NTSC-U/C: 0x0020d310
Ghidra address:
PAL: 0x00216980

Reimplemented from MetScreen.

◆ HandleCommand()

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

Act on a command.

Previous and next step the rows and post the new row's prompt. Left and right flash the row's arrow and switch its setting. Select applies the options and exits. Back exits without applying them.

Parameters
pCommandThe command.
Ghidra address:
NTSC-U/C: 0x0020cf70
Ghidra address:
PAL: 0x00216550

Reimplemented from MetScreen.

◆ OnExitFinished()

virtual void MetConfigGameOptionsScreen::OnExitFinished ( )
virtual

Push the screens that follow this one.

Entered from the pause menu, the pause screen recorded in MetFrontEndState::mReturnScreen is pushed and activated again, after the help screen exits for the remix pause screen, and the record is cleared. Otherwise a cancel returns to MetConfigOptionsButtonsScreen, and any other exit stores the options into GlobalSettings and saves them through MetGlobalSettingsSaverScreen.

Ghidra address:
NTSC-U/C: 0x0020d5a8
Ghidra address:
PAL: 0x00216d38

Reimplemented from MetScreen.

◆ ResolveContainerViews()

virtual void MetConfigGameOptionsScreen::ResolveContainerViews ( )
virtual

Resolve the two labels, the two rows, and the four arrow buttons.

The labels are not tested for null.

Ghidra address:
NTSC-U/C: 0x0020c800
Ghidra address:
PAL: 0x00215ce0

Reimplemented from MetScreen.


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