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

Screen that swaps five of its six sounds for the in-game multiplayer bank. More...

#include <metscreenmultisoundbank.h>

Inheritance diagram for MetScreenMultiSoundBank:
Collaboration diagram for MetScreenMultiSoundBank:

Public Member Functions

 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 EnterAndShow ()
 Show this screen and start its enter animation.
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 HandleCommand (const MetScreenCommand *pCommand)
 Act on a navigation command.
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 OnExitFinished ()
 Act on the exit animation having finished.
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.

Additional Inherited Members

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.
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 swaps five of its six sounds for the in-game multiplayer bank.

Its RTTI descriptor is at 0x008efda0. It has MetScreen as its one public non-virtual base at offset 0. The class declares no data member. MetConfigControllerScreen proves the absence by placing its MemcardUser base at +140, the same offset a direct MetScreen child uses. The 39-entry vtable is at 0x0080b560.

Three classes derive from the class, MetConfigGameOptionsScreen, MetMsgScreen, and MetPauseBaseScreen.

The constructor at 0x0038ff58 forwards all five arguments to MetScreen unchanged and then writes its own vptr. The destructor at 0x0038fe60 runs the MetScreen destructor and has no body of its own.

Every override tests the file-local predicate at 0x003908f0, which reports whether a game world exists and so whether the in-game bank applies, and plays one of two named sounds through PlaySoundByName(). Four slots pick SND_MET_MULTI_INGAME_ACTION or SND_MET_MULTI_INGAME_NAVIGATION as the alternative, and the error sound at slot 25 is the one of the six that stays as MetScreen defined it.

  • 20 0x003907b0 SND_MET_MULTI_INGAME_ACTION, otherwise SND_MET_SLIDE.
  • 21 0x003907f0 SND_MET_MULTI_INGAME_ACTION, otherwise SND_MET_LEAVE.
  • 22 0x00390830 SND_MET_MULTI_INGAME_NAVIGATION, otherwise SND_MET_HIGH.
  • 23 0x00390870 SND_MET_MULTI_INGAME_NAVIGATION, otherwise SND_MET_CYCLE_L.
  • 24 0x003908b0 SND_MET_MULTI_INGAME_NAVIGATION, otherwise SND_MET_CYCLE_R.

Constructor & Destructor Documentation

◆ MetScreenMultiSoundBank()

MetScreenMultiSoundBank::MetScreenMultiSoundBank ( MetRenderer * pRenderer,
int nPriority,
const HxStr & name,
const HxStr & directory,
const HxStr & file )

Construct a screen that uses the multiplayer sound bank.

Parameters
pRendererThe front-end renderer this screen registers on.
nPriorityThe load priority.
nameThe screen name.
directoryThe directory the container loads from.
fileThe container name, without the .rnd suffix.
Ghidra address:
NTSC-U/C: 0x0038ff58
Ghidra address:
PAL: 0x003c1828

◆ ~MetScreenMultiSoundBank()

virtual MetScreenMultiSoundBank::~MetScreenMultiSoundBank ( )
virtual
Ghidra address:
NTSC-U/C: 0x0038fe60
Ghidra address:
PAL: 0x003c1730

Member Function Documentation

◆ PlaySlideSound()

virtual void MetScreenMultiSoundBank::PlaySlideSound ( int nSelector)
virtual
Parameters
nSelectorThe value the override compares against its own recorded selector.
Ghidra address:
NTSC-U/C: 0x003907b0
Ghidra address:
PAL: 0x003c2080

Reimplemented from MetScreen.

Reimplemented in MetConfigControllerScreen, MetMsgScreen, and MetPauseBaseScreen.

◆ PlayLeaveSound()

virtual void MetScreenMultiSoundBank::PlayLeaveSound ( int nSelector)
virtual
Parameters
nSelectorThe pad index of the command.
Ghidra address:
NTSC-U/C: 0x003907f0
Ghidra address:
PAL: 0x003c20c0

Reimplemented from MetScreen.

Reimplemented in MetConfigControllerScreen, MetMsgScreen, and MetPauseBaseScreen.

◆ PlayHighSound()

virtual void MetScreenMultiSoundBank::PlayHighSound ( int nSelector)
virtual
Parameters
nSelectorThe value the override compares against its own recorded selector.
Ghidra address:
NTSC-U/C: 0x00390830
Ghidra address:
PAL: 0x003c2100

Reimplemented from MetScreen.

Reimplemented in MetConfigControllerScreen, MetMsgScreen, and MetPauseBaseScreen.

◆ PlayCycleLeftSound()

virtual void MetScreenMultiSoundBank::PlayCycleLeftSound ( int nSelector)
virtual
Parameters
nSelectorThe value the override compares against its own recorded selector.
Ghidra address:
NTSC-U/C: 0x00390870
Ghidra address:
PAL: 0x003c2140

Reimplemented from MetScreen.

Reimplemented in MetConfigControllerScreen, MetMsgScreen, and MetPauseBaseScreen.

◆ PlayCycleRightSound()

virtual void MetScreenMultiSoundBank::PlayCycleRightSound ( int nSelector)
virtual
Parameters
nSelectorThe value the override compares against its own recorded selector.
Ghidra address:
NTSC-U/C: 0x003908b0
Ghidra address:
PAL: 0x003c2180

Reimplemented from MetScreen.

Reimplemented in MetConfigControllerScreen, MetMsgScreen, and MetPauseBaseScreen.


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