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

Row of buttons along the top of the jukebox. More...

#include <metjukeboxtopbuttonsscreen.h>

Inheritance diagram for MetJukeboxTopButtonsScreen:
Collaboration diagram for MetJukeboxTopButtonsScreen:

Public Member Functions

 MetJukeboxTopButtonsScreen (MetRenderer *pRenderer, int nPriority)
 Construct the screen.
virtual ~MetJukeboxTopButtonsScreen ()
virtual void EnterAndShow ()
 Enter, wait for the five sub-screens to load, push them, and show the first button's panel.
virtual void BeginExit ()
 Begin the exit and exit all five sub-screens.
virtual void HandleCommand (const MetScreenCommand *pCommand)
 Act on a command.
virtual void UpdateIdle (float flTime)
 Do nothing.
virtual void OnEnterFinished ()
 Show the selected button's panel.
virtual void OnExitFinished ()
 Return to the remix type screen after a cancel.
virtual void ResolveContainerViews ()
 Resolve the container views and add the four buttons.
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 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 PlayCycleLeftSound (int nSelector)
 Play the sound that accompanies cycling a value to the left.
virtual void PlayCycleRightSound (int nSelector)
 Play the sound that accompanies cycling a value to the right.
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 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 MetJukeboxTopButtonsScreen * 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

Row of buttons along the top of the jukebox.

Its RTTI descriptor is at 0x008ef910. It has MetScreen as its one public non-virtual base at offset 0. The object is 0x9c bytes and the 39-entry vtable is at 0x007ef8b0, the same length as the MetScreen table, and the class declares no new virtual.

The constructor at 0x00240c28 takes only the renderer and the load priority, and supplies jbb for the screen name, metagame/Shared for the directory, and juke_butts for the container. It zeroes the members below and then allocates a MetButtonList of 0x18 bytes tagged MetButtonList into mButtons.

The destructor at 0x00246778 restores the vptr, frees the buffer at +0x90 through the untagged path, runs the MetScreen destructor, and releases the object with the tag MsgSink. That free is the inlined HxStr destructor of mCommandTargetScreen rather than a statement of the destructor's own, which is what identifies the eight bytes at +0x8c as an HxStr. The constructor zeroing both of its words, and the destructor freeing the second word alone, are the two halves of that evidence.

Nothing frees the button list, so it is never released.

The four buttons each show one or two of five sub-screens (custom remixes, factory remixes, the playlist editor, its lower-left panel, and its done panel), and mCommandTargetScreen records the one that receives the commands this screen does not consume.

Nine slots differ from the MetScreen table.

Constructor & Destructor Documentation

◆ MetJukeboxTopButtonsScreen()

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

Construct the screen.

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

◆ ~MetJukeboxTopButtonsScreen()

virtual MetJukeboxTopButtonsScreen::~MetJukeboxTopButtonsScreen ( )
virtual
Ghidra address:
NTSC-U/C: 0x00246778
Ghidra address:
PAL: 0x0025b890

Member Function Documentation

◆ New()

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

Build the screen on the heap.

The object is allocated with the tag MsgSink.

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

◆ EnterAndShow()

virtual void MetJukeboxTopButtonsScreen::EnterAndShow ( )
virtual

Enter, wait for the five sub-screens to load, push them, and show the first button's panel.

The title is the met_jukebox_title title. When MetFrontEndState::mPendingTransition is set, the value moves to MetFrontEndState::mLastTransition, the help screen takes the standard_title layout and is pushed, and this screen becomes the renderer's active panel. The load wait pumps the asynchronous loaders until every sub-screen reports its container loaded, and MetRemixManager::PrunePlayList() runs before the sub-screens are pushed.

Ghidra address:
NTSC-U/C: 0x00241b08
Ghidra address:
PAL: 0x00256940

Reimplemented from MetScreen.

◆ BeginExit()

virtual void MetJukeboxTopButtonsScreen::BeginExit ( )
virtual

Begin the exit and exit all five sub-screens.

Ghidra address:
NTSC-U/C: 0x00242140
Ghidra address:
PAL: 0x002570e8

Reimplemented from MetScreen.

◆ HandleCommand()

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

Act on a command.

Left and right step the button ring and show the new button's panel. Back records 0 in MetScreen::mExitChoice and begins the exit. Every other command goes to the sub-screen that mCommandTargetScreen records.

Parameters
pCommandThe command.
Ghidra address:
NTSC-U/C: 0x002467e8
Ghidra address:
PAL: 0x0025b910

Reimplemented from MetScreen.

◆ UpdateIdle()

virtual void MetJukeboxTopButtonsScreen::UpdateIdle ( float flTime)
virtual

Do nothing.

Parameters
flTimeNot read.
Ghidra address:
NTSC-U/C: 0x002468d8
Ghidra address:
PAL: 0x0025ba00

Reimplemented from MetScreen.

◆ OnEnterFinished()

virtual void MetJukeboxTopButtonsScreen::OnEnterFinished ( )
virtual

Show the selected button's panel.

Ghidra address:
NTSC-U/C: 0x002468b8
Ghidra address:
PAL: 0x0025b9e0

Reimplemented from MetScreen.

◆ OnExitFinished()

virtual void MetJukeboxTopButtonsScreen::OnExitFinished ( )
virtual

Return to the remix type screen after a cancel.

When MetScreen::mExitChoice is 0, the left gizmo, title, and remix type screens are pushed and the remix type screen is activated. Any other value does nothing.

Ghidra address:
NTSC-U/C: 0x00241120
Ghidra address:
PAL: 0x00255d20

Reimplemented from MetScreen.

◆ ResolveContainerViews()

virtual void MetJukeboxTopButtonsScreen::ResolveContainerViews ( )
virtual

Resolve the container views and add the four buttons.

The buttons are saved remixes, factory remixes, edit playlist, and done, in that order, and the first is selected.

Ghidra address:
NTSC-U/C: 0x00240e28
Ghidra address:
PAL: 0x00255950

Reimplemented from MetScreen.


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