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

Screen that picks a solo stage and a level within it. More...

#include <metsolostagesscreen.h>

Inheritance diagram for MetSoloStagesScreen:
Collaboration diagram for MetSoloStagesScreen:

Classes

struct  ButtonStyle
 Materials and fonts one stage-button state uses. More...
struct  StatusSlot
 Status panel material and the mesh that shows it. More...

Public Member Functions

 MetSoloStagesScreen (MetRenderer *pRenderer, int nPriority)
 Construct the screen.
virtual ~MetSoloStagesScreen ()
 Delete the two button lists and empty the level lists.
virtual void EnterAndShow ()
 Rebuild the stages, caption the title, and show the screen.
virtual void BeginExit ()
 Blank the television and exit.
virtual void HandleCommand (const MetScreenCommand *pCommand)
 Move between stages, scroll the levels, or act on the selection.
virtual void PlaySlideSound (int nSelector)
 Play the slide sound when the selected stage is selectable.
virtual void PlayCycleLeftSound (int nSelector)
 Play the cycle-left sound when the selected stage is available.
virtual void PlayCycleRightSound (int nSelector)
 Play the cycle-right sound when the selected stage is available.
virtual void UpdateIdle (float flTime)
 Swap in loaded textures and run the television scroll.
virtual void OnRepeatingSoundFinished (Rnd::Button *pButton)
 Finish a scroll or a selection once its button stops alternating.
virtual void OnEnterFinished ()
 Show the television and load the selected level's textures.
virtual void OnExitFinished ()
 Push the next screens once the exit finishes.
virtual void ResolveContainerViews ()
 Resolve the container objects.
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 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 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 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 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 MetSoloStagesScreen * New (MetRenderer *pRenderer, int nPriority)
 Allocate and construct the screen.
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 picks a solo stage and a level within it.

Its RTTI descriptor is at 0x008f0070. It has MetScreen as its one public non-virtual base at offset 0.

The 39-entry primary vtable is at 0x0080d910, the same length as the MetScreen table, so the class declares no virtual of its own.

The constructor takes only the renderer and the load priority, and supplies ss for the screen name, metagame/_Solo for the directory, and stage_sel for the container. The factory's 0x25c-byte allocation fixes the size.

Six stage buttons run along mStageList, the sixth being the custom stage. The seven indicator buttons of mIndicatorList pick a level within the selected stage from mCurrentLevels, and the two arrow buttons beside the television scroll the indicator ring. A scroll slides the television panel out and back over 100 frames while the next level's logo and label textures load.

Apart from the type function and the destructor, the slots that differ from the MetScreen table are 5, 9, 19, 20, 23, 24, 26, 30, 33, 36, and 38, all declared below.

Constructor & Destructor Documentation

◆ MetSoloStagesScreen()

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

Construct the screen.

Allocates the two button lists, builds the logo and label texture pairs from gSongLogo1.tex with gSongLogo2.tex and gSongLabel1.tex with gSongLabel2.tex, and appends the prompt key levels to mHelpKeys.

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

◆ ~MetSoloStagesScreen()

virtual MetSoloStagesScreen::~MetSoloStagesScreen ( )
virtual

Delete the two button lists and empty the level lists.

Ghidra address:
NTSC-U/C: 0x0039ef80
Ghidra address:
PAL: 0x003d1628

Member Function Documentation

◆ New()

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

Allocate and construct the screen.

The 0x25c-byte allocation is billed to the tag MsgSink.

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

◆ EnterAndShow()

virtual void MetSoloStagesScreen::EnterAndShow ( )
virtual

Rebuild the stages, caption the title, and show the screen.

Slot 5.

The screen hides first. When MetFrontEndState's +0x18 and +0x10 flags are both set, +0x10 is cleared, MetGlobalSettingsSaverScreen::StartSave() runs with this screen as the one to return to, mActivatePending is cleared, and no other code runs.

Otherwise the level lists and the stage buttons are rebuilt with MetFrontEndState's +0x14 flag as the unlock-everything switch. A set +0x18 flag moves to +0x1c, selects the help layout standard_title, pushes MetHelpScreen, and resets the game parameters' loading flag. The title reads, from configuration code 0x269, solo or multi, then game with the difficulty name or remix, then stages. The stage-button view takes stage_6buts.view in a game and stage_5buts.view in a remix, and the arrow buttons show only beside stages available at the difficulty.

The European release reads the title parts from its text table. Its French and Spanish game titles omit game, and its Spanish remix title puts remix ahead of solo or multi.

Ghidra address:
NTSC-U/C: 0x003a5810
Ghidra address:
PAL: 0x003d8f80

Reimplemented from MetScreen.

◆ BeginExit()

virtual void MetSoloStagesScreen::BeginExit ( )
virtual

Blank the television and exit.

Slot 9.

Ghidra address:
NTSC-U/C: 0x003a6690
Ghidra address:
PAL: 0x003da0a8

Reimplemented from MetScreen.

◆ HandleCommand()

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

Move between stages, scroll the levels, or act on the selection.

Slot 19.

A previous or next command steps mStageList and refreshes the stage. A left or right command on an available stage starts the scroll and alternates the arrow button once at 15-frame intervals. A select command on a selectable stage records the level in the game parameters, unless the custom stage is selected, and alternates the stage button twice at 30-frame intervals. A back command exits with MetScreenTitleScreen.

Parameters
pCommandThe command to handle.
Ghidra address:
NTSC-U/C: 0x003a4810
Ghidra address:
PAL: 0x003d7d28

Reimplemented from MetScreen.

◆ PlaySlideSound()

virtual void MetSoloStagesScreen::PlaySlideSound ( int nSelector)
virtual

Play the slide sound when the selected stage is selectable.

Slot 20.

Parameters
nSelectorThe selector MetScreen::PlaySlideSound() receives.
Ghidra address:
NTSC-U/C: 0x003aed40
Ghidra address:
PAL: 0x003e2d10

Reimplemented from MetScreen.

◆ PlayCycleLeftSound()

virtual void MetSoloStagesScreen::PlayCycleLeftSound ( int nSelector)
virtual

Play the cycle-left sound when the selected stage is available.

Slot 23.

Parameters
nSelectorThe selector MetScreen::PlayCycleLeftSound() receives.
Ghidra address:
NTSC-U/C: 0x003aedb0
Ghidra address:
PAL: 0x003e2d80

Reimplemented from MetScreen.

◆ PlayCycleRightSound()

virtual void MetSoloStagesScreen::PlayCycleRightSound ( int nSelector)
virtual

Play the cycle-right sound when the selected stage is available.

Slot 24.

Parameters
nSelectorThe selector MetScreen::PlayCycleRightSound() receives.
Ghidra address:
NTSC-U/C: 0x003aee00
Ghidra address:
PAL: 0x003e2dd0

Reimplemented from MetScreen.

◆ UpdateIdle()

virtual void MetSoloStagesScreen::UpdateIdle ( float flTime)
virtual

Swap in loaded textures and run the television scroll.

Slot 26.

Both texture pairs advance, and the two right-hand television meshes show only while their pair has a current texture. A finished load either fills the television at once or starts the scroll mScrollDirection records. A running scroll moves the panel animation over 100 frames and then shows the new level.

Parameters
flTimeThe renderer's current frame.
Ghidra address:
NTSC-U/C: 0x003a4df8
Ghidra address:
PAL: 0x003d8440

Reimplemented from MetScreen.

◆ OnRepeatingSoundFinished()

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

Finish a scroll or a selection once its button stops alternating.

Slot 30.

An arrow button moves mIndicatorList one step, records the level for the selected stage, and loads its textures. Any other button exits towards the next screen when the selected stage is open, and otherwise reactivates this screen.

Parameters
pButtonThe button whose alternation finished.
Ghidra address:
NTSC-U/C: 0x003a54b8
Ghidra address:
PAL: 0x003d8b98

Reimplemented from MetScreen.

◆ OnEnterFinished()

virtual void MetSoloStagesScreen::OnEnterFinished ( )
virtual

Show the television and load the selected level's textures.

Slot 33.

Ghidra address:
NTSC-U/C: 0x003aee50
Ghidra address:
PAL: 0x003e2e20

Reimplemented from MetScreen.

◆ OnExitFinished()

virtual void MetSoloStagesScreen::OnExitFinished ( )
virtual

Push the next screens once the exit finishes.

Slot 36.

A back exit returns to MetGameSkillScreen in a game and to MetRemixTypeScreen in a remix. The custom stage lists the remixes on the memory card and the disc. Any other stage goes to MetLoadGameScreen with the last arena when GameManagerImpl::GetPersonas() lists three or more personas, and to MetArenasScreen otherwise.

Ghidra address:
NTSC-U/C: 0x003a6738
Ghidra address:
PAL: 0x003da150

Reimplemented from MetScreen.

◆ ResolveContainerViews()

virtual void MetSoloStagesScreen::ResolveContainerViews ( )
virtual

Resolve the container objects.

Slot 38.

The European release fills the two stage-score headings from its text table and moves each value text to five units past the end of its heading.

Ghidra address:
NTSC-U/C: 0x0039f720
Ghidra address:
PAL: 0x003d1df0

Reimplemented from MetScreen.


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