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

Dialogue that swaps the game disc for an expansion disc of more songs and loads the expansion disc archives. More...

#include <metexpansionpakscreen.h>

Inheritance diagram for MetExpansionPakScreen:
Collaboration diagram for MetExpansionPakScreen:

Public Member Functions

 MetExpansionPakScreen (MetRenderer *pRenderer, int nPriority)
 Construct the screen.
virtual ~MetExpansionPakScreen ()
virtual void OnFadeOutDone ()
 Leave the screen once the fade out finishes.
virtual void OnFadeInDone ()
 Show the expansion_prepare dialogue once the fade in finishes.
virtual void EnterAndShow ()
 Reset the state machine and start the fade in.
virtual void BeginExit ()
 Start the fade out.
virtual void OnMsgScreenDismissed (const HxStr &name, int nChoice)
 Advance the state machine once a message screen is dismissed.
virtual void OnMsgScreenShown (const HxStr &name)
 Record which of the two message screens has appeared.
virtual void PlayCycleLeftSound (int)
 Silence the cycle-left sound.
virtual void PlayCycleRightSound (int)
 Silence the cycle-right sound.
virtual void UpdateIdle (float flTime)
 Drive the dialogue state machine by one frame.
virtual void ResolveContainerViews ()
 Resolve the container views.
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 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 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 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 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.
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.
Public Member Functions inherited from FadeUser
virtual ~FadeUser ()

Static Public Member Functions

static MetExpansionPakScreen * 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

Dialogue that swaps the game disc for an expansion disc of more songs and loads the expansion disc archives.

Its RTTI descriptor is at 0x008efdd0. It has two public non-virtual bases at fixed offsets, MetScreen at +0x00, and FadeUser at +140.

The 39-entry primary vtable is at 0x007ebf30, the same length as the MetScreen table. The class declares no new virtual. A diff against the MetScreen table at 0x0080b6a0 reads ten overrides, slots 1, 5, 9, 15, 16, 23, 24, 26, and 38 apart from the type function.

The four-entry FadeUser table at 0x007ebf08 adjusts this by -140 in every entry, and its slots 2 and 3 are at 0x0021a128 and 0x00219e80. Neither address is in the primary table.

The constructor at 0x00218320 takes only the renderer and the load priority, and supplies dlg for the screen name, metagame/Shared for the directory, and dialogue for the container. It writes +0x8c, which is the FadeUser vptr, clears mFade, and then allocates a MetFade over the cleared pointer.

The object is exactly 0xc4 bytes. Nothing derives from the class, so no base offset in any descriptor pins the total, and the size comes instead from the new expression emitted out of line at 0x0021d820, which requests 0xc4 bytes from the tagged allocator under the tag MsgSink. MsgSink is the base that declares the allocation operator, which is why the tag does not identify this class.

It is the second of only two classes that fill slot 16, the other being MetRemixDelScreen.

The destructor is at 0x0021d8a8.

The screen is a fade-driven state machine. UpdateIdle() advances mState every frame through mDiscSwap and mFade. Two message screens feed it, expansion_prepare and expansion_load, whose appearance sets mPrepareShown and mLoadShown in OnMsgScreenShown().

Constructor & Destructor Documentation

◆ MetExpansionPakScreen()

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

Construct the screen.

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

◆ ~MetExpansionPakScreen()

virtual MetExpansionPakScreen::~MetExpansionPakScreen ( )
virtual
Ghidra address:
NTSC-U/C: 0x0021d8a8
Ghidra address:
PAL: 0x00230400

Member Function Documentation

◆ New()

MetExpansionPakScreen * MetExpansionPakScreen::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: 0x0021d820
Ghidra address:
PAL: 0x00230378

◆ OnFadeOutDone()

virtual void MetExpansionPakScreen::OnFadeOutDone ( )
virtual

Leave the screen once the fade out finishes.

FadeUser slot 2, through the FadeUser table entry that adjusts this. The screen is erased from the renderer's stack. A cancel returns to the options screens, and any other exit returns to the main menu.

Ghidra address:
NTSC-U/C: 0x0021a128
Ghidra address:
PAL: 0x0022cac0

Implements FadeUser.

◆ OnFadeInDone()

virtual void MetExpansionPakScreen::OnFadeInDone ( )
virtual

Show the expansion_prepare dialogue once the fade in finishes.

FadeUser slot 3, through the FadeUser table entry that adjusts this. The dialogue has no buttons.

Ghidra address:
NTSC-U/C: 0x00219e80
Ghidra address:
PAL: 0x0022c7b8

Implements FadeUser.

◆ EnterAndShow()

virtual void MetExpansionPakScreen::EnterAndShow ( )
virtual

Reset the state machine and start the fade in.

Slot 5. mState through mMsgScreenExited are cleared, the record at +0x90 is reset through 0x0016a048, and the fade starts on mFade over 360.0 units from MetRenderer::mAnimationFrame with this screen's FadeUser subobject as the receiver. The MetScreen body does not run.

Ghidra address:
NTSC-U/C: 0x0021d948
Ghidra address:
PAL: 0x002304a0

Reimplemented from MetScreen.

◆ BeginExit()

virtual void MetExpansionPakScreen::BeginExit ( )
virtual

Start the fade out.

Slot 9. The same fade and the same 360.0 span as EnterAndShow(), through 0x0016a608 rather than 0x0016d750, and with a zero where EnterAndShow() passes a one. The MetScreen body does not run, so the fade rather than the base drives the departure.

Ghidra address:
NTSC-U/C: 0x0021d9a8
Ghidra address:
PAL: 0x00230500

Reimplemented from MetScreen.

◆ OnMsgScreenDismissed()

virtual void MetExpansionPakScreen::OnMsgScreenDismissed ( const HxStr & name,
int nChoice )
virtual

Advance the state machine once a message screen is dismissed.

Slot 15. expansion_prepare shows expansion_check with two buttons, CONTINUE and CANCEL the first time and RETRY and CANCEL once mRetry is set. expansion_check clears mLoadShown and shows expansion_load whatever the choice. expansion_done records 2 in MetScreen::mExitChoice and begins the exit, and any other name records 0 and begins it.

Parameters
nameThe message screen that was dismissed.
nChoiceThe response.
Ghidra address:
NTSC-U/C: 0x002193e8
Ghidra address:
PAL: 0x0022bb70

Reimplemented from MetScreen.

◆ OnMsgScreenShown()

virtual void MetExpansionPakScreen::OnMsgScreenShown ( const HxStr & name)
virtual

Record which of the two message screens has appeared.

Slot 16. expansion_prepare sets mPrepareShown and returns, and expansion_load sets mLoadShown. Any other name is not recorded.

Parameters
nameThe message screen that appeared.
Ghidra address:
NTSC-U/C: 0x0021d9e0
Ghidra address:
PAL: 0x00230538

Reimplemented from MetScreen.

◆ PlayCycleLeftSound()

virtual void MetExpansionPakScreen::PlayCycleLeftSound ( int )
inlinevirtual

Silence the cycle-left sound.

Slot 23. Both overrides are two-instruction stubs, so each was written inline with an empty body.

Ghidra address:
NTSC-U/C: 0x0021d810
Ghidra address:
PAL: 0x0022a290

Reimplemented from MetScreen.

◆ PlayCycleRightSound()

virtual void MetExpansionPakScreen::PlayCycleRightSound ( int )
inlinevirtual

Silence the cycle-right sound.

Slot 24.

Ghidra address:
NTSC-U/C: 0x0021d818
Ghidra address:
PAL: 0x0022a298

Reimplemented from MetScreen.

◆ UpdateIdle()

virtual void MetExpansionPakScreen::UpdateIdle ( float flTime)
virtual

Drive the dialogue state machine by one frame.

Slot 26. mFade is ticked first, and the routine does nothing else once mFinished is set. Otherwise mState advances through the record at +0x90. The open tray exits MetMsgScreen, a disc found in the open tray shows expansion_load, a failed swap shows expansion_prepare again, and a completed mount rebuilds the stage and arena lists, merges the level lists of every identity and persona again, and shows expansion_done.

Parameters
flTimeThe current renderer time.
Ghidra address:
NTSC-U/C: 0x00218518
Ghidra address:
PAL: 0x0022aaa8

Reimplemented from MetScreen.

◆ ResolveContainerViews()

virtual void MetExpansionPakScreen::ResolveContainerViews ( )
virtual

Resolve the container views.

Slot 38. The override forwards to the MetScreen body with a direct call and does nothing else. That is what the binary does. The slot is filled with a routine that adds no behaviour.

Ghidra address:
NTSC-U/C: 0x0021d928
Ghidra address:
PAL: 0x00230480

Reimplemented from MetScreen.


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