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

Pause screen. More...

#include <metpausegamescreen.h>

Inheritance diagram for MetPauseGameScreen:
Collaboration diagram for MetPauseGameScreen:

Public Member Functions

 MetPauseGameScreen (MetRenderer *pRenderer, int nPriority)
 Construct the screen.
virtual void EnterAndShow ()
 Fill the paused heading and the option labels, then enter.
virtual void ResolveContainerViews ()
 Resolve the container views and the three option texts pmgr_opt1.txt to pmgr_opt3.txt.
Public Member Functions inherited from MetPauseBaseScreen
 MetPauseBaseScreen (MetRenderer *pRenderer, int nPriority, const HxStr &name, const HxStr &directory, const HxStr &file)
 Construct the screen with an empty option list.
virtual ~MetPauseBaseScreen ()
virtual void OnMsgScreenDismissed (const HxStr &name, int nChoice)
 Act on the quit or restart confirmation.
virtual void HandleCommand (const MetScreenCommand *pCommand)
 Record the exit action for a command and begin the exit.
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)
virtual void OnExitFinished ()
 Act on the recorded exit action once the exit finishes.
virtual void PlayPauseSound (int nSelector)
 Play the multiplayer bank's slide sound.
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 ()
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 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 MetPauseGameScreen * New (MetRenderer *pRenderer, int nPriority)
 Build the screen on the heap.
Static Public Member Functions inherited from MetPauseBaseScreen
static MetPauseBaseScreen * New (MetRenderer *pRenderer, int nPriority, const HxStr &name, const HxStr &directory, const HxStr &file)
 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 Types inherited from MetPauseBaseScreen
enum  ExitAction {
  kExitNone = 0 , kExitResume = 1 , kExitQuit = 3 , kExitRestart = 4 ,
  kExitGameOptions = 5 , kExitController = 6
}
 The exit action HandleCommand() recorded. More...
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 MetPauseBaseScreen
int mExitAction
std::vector< HxStr > mOptionLabels
HxStr mReturnPanel
std::vector< Rnd::Text * > mOptionTexts
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

Pause screen.

Its RTTI descriptor is at 0x00902310. It has MetPauseBaseScreen as its one public non-virtual base at offset 0. The 40-entry vtable at 0x00803280 is the same length as the MetPauseBaseScreen table, and the class declares no new virtual. New() allocates 0xb0 bytes, the size of the base, and the class adds no member.

The destructor at 0x0031fac8 is compiler-generated.

Constructor & Destructor Documentation

◆ MetPauseGameScreen()

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

Construct the screen.

The screen name is pmgr, the directory metagame/Transition, and the container pause_multi. The panel a dismissed confirmation reactivates is MetPauseGameScreen.

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

Member Function Documentation

◆ New()

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

Build the screen on the heap.

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

◆ EnterAndShow()

virtual void MetPauseGameScreen::EnterAndShow ( )
virtual

Fill the paused heading and the option labels, then enter.

Slot 5. The heading pmgr_paused.txt reads configuration code 0x258 under pause_tutorial in front-end phase 5, pause_remix in jam mode, and pause_game otherwise. The labels come from code 0x259 under pause_multi_game in phase 5 or in game mode, and pause_multi_remix otherwise. The play mode is read from a copy of the game settings. The heading is not tested for null. The European release looks the texts up in the current language, and its labels are Resume and Quit, followed by Restart in phase 5 or in game mode.

Ghidra address:
NTSC-U/C: 0x0031c658
Ghidra address:
PAL: 0x003428c8

Reimplemented from MetPauseBaseScreen.

◆ ResolveContainerViews()

virtual void MetPauseGameScreen::ResolveContainerViews ( )
virtual

Resolve the container views and the three option texts pmgr_opt1.txt to pmgr_opt3.txt.

Slot 38. MetScreen::ResolveContainerViews() runs first. No text is tested for null.

Ghidra address:
NTSC-U/C: 0x0031c508
Ghidra address:
PAL: 0x00342750

Reimplemented from MetScreen.


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