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

Confirmation buttons for the jukebox playlist editor. More...

#include <metjukeboxeditplaylistscreendone.h>

Inheritance diagram for MetJukeboxEditPlaylistScreenDone:
Collaboration diagram for MetJukeboxEditPlaylistScreenDone:

Public Member Functions

 MetJukeboxEditPlaylistScreenDone (MetRenderer *pRenderer, int nPriority)
 Construct the screen.
virtual ~MetJukeboxEditPlaylistScreenDone ()
virtual void EnterAndShow ()
 Select the first button and enable the save button only when MetFrontEndState::mUsingMemcard is set.
virtual void SetShowing (int nShowing)
 Show or hide the screen, posting the help text when it shows.
virtual void HandleCommand (const MetScreenCommand *pCommand)
 Act on a command.
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 OnRepeatingSoundFinished (Rnd::Button *pButton)
 Record the chosen button once it has finished flashing.
virtual void OnEnterFinished ()
 Select the first button and forget the recorded choice.
virtual void OnExitFinished ()
 Act on the recorded choice once the screen has exited.
virtual void ResolveContainerViews ()
 Resolve the container views and add the three 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 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 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 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 MetJukeboxEditPlaylistScreenDone * 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

Confirmation buttons for the jukebox playlist editor.

Its RTTI descriptor is at 0x008eebf8. 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 0x007ee0f8, the same length as the MetScreen table, and the class declares no new virtual.

The constructor at 0x00231728 takes only the renderer and the load priority, and supplies jbd for the screen name, metagame/Shared for the directory, and juke_done_butts for the container. It clears the four members below and then allocates a MetButtonList of 0x18 bytes tagged MetButtonList into mButtons. The allocation immediately overwrites the cleared mButtons.

The three buttons play the playlist in random order, play it in order, and save it. Slot 30 records the choice once the button has finished flashing, and slot 36 acts on it once the screen has exited.

The destructor at 0x00237210 restores the vptr, runs the MetScreen destructor, and releases the object with the tag MsgSink. It does not release its members, and the button list at +0x8c is never freed.

Fourteen slots differ from the MetScreen table. Slots 20 through 24 sit eight bytes apart at 0x00237160 through 0x00237180 and are two-instruction jr ra stubs. The screen does not play those five sounds. The others are 5 0x00237330, 17 0x002373e0, 19 0x00237268, 30 0x002321f8, 33 0x002373a8, 36 0x00231b50, and 38 0x00231908.

Constructor & Destructor Documentation

◆ MetJukeboxEditPlaylistScreenDone()

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

Construct the screen.

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

◆ ~MetJukeboxEditPlaylistScreenDone()

virtual MetJukeboxEditPlaylistScreenDone::~MetJukeboxEditPlaylistScreenDone ( )
virtual
Ghidra address:
NTSC-U/C: 0x00237210
Ghidra address:
PAL: 0x0024b368

Member Function Documentation

◆ New()

MetJukeboxEditPlaylistScreenDone * MetJukeboxEditPlaylistScreenDone::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: 0x00237188
Ghidra address:
PAL: 0x0024b2e0

◆ EnterAndShow()

virtual void MetJukeboxEditPlaylistScreenDone::EnterAndShow ( )
virtual

Select the first button and enable the save button only when MetFrontEndState::mUsingMemcard is set.

Slot 5. The MetScreen body runs first. A clear flag puts the save button in state 3. MetButtonList passes over a button in state 3. The European release only selects the first button.

Ghidra address:
NTSC-U/C: 0x00237330
Ghidra address:
PAL: 0x0024b3c0

Reimplemented from MetScreen.

◆ SetShowing()

virtual void MetJukeboxEditPlaylistScreenDone::SetShowing ( int nShowing)
virtual

Show or hide the screen, posting the help text when it shows.

Slot 17.

Parameters
nShowingNon-zero to draw the screen.
Ghidra address:
NTSC-U/C: 0x002373e0
Ghidra address:
PAL: 0x0024b428

Reimplemented from MetScreen.

◆ HandleCommand()

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

Act on a command.

Slot 19. Previous and next step the ring and post the help text. Select flashes the selected button. Every other command is ignored. On select, the European release first activates the panel with the empty name.

Parameters
pCommandThe command.
Ghidra address:
NTSC-U/C: 0x00237268
Ghidra address:
PAL: 0x00245590

Reimplemented from MetScreen.

◆ PlaySlideSound()

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

Reimplemented from MetScreen.

◆ PlayLeaveSound()

virtual void MetJukeboxEditPlaylistScreenDone::PlayLeaveSound ( int nSelector)
virtual
Parameters
nSelectorThe pad index of the command. The body does not read it.
Ghidra address:
NTSC-U/C: 0x00237168
Ghidra address:
PAL: 0x0024b2c0

Reimplemented from MetScreen.

◆ PlayHighSound()

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

Reimplemented from MetScreen.

◆ PlayCycleLeftSound()

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

Reimplemented from MetScreen.

◆ PlayCycleRightSound()

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

Reimplemented from MetScreen.

◆ OnRepeatingSoundFinished()

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

Record the chosen button once it has finished flashing.

Slot 30. Either play button requires a playlist with entries, records the play request and the shuffle choice, and exits the top buttons, help, and title screens. The save button records the save request and exits the top buttons screen. With an empty playlist, the European release activates the top buttons screen's panel.

Parameters
pButtonThe button that finished alternating. The body does not read it.
Ghidra address:
NTSC-U/C: 0x002321f8
Ghidra address:
PAL: 0x00245ec0

Reimplemented from MetScreen.

◆ OnEnterFinished()

virtual void MetJukeboxEditPlaylistScreenDone::OnEnterFinished ( )
virtual

Select the first button and forget the recorded choice.

Slot 33.

Ghidra address:
NTSC-U/C: 0x002373a8
Ghidra address:
PAL: 0x0024b3f0

Reimplemented from MetScreen.

◆ OnExitFinished()

virtual void MetJukeboxEditPlaylistScreenDone::OnExitFinished ( )
virtual

Act on the recorded choice once the screen has exited.

Slot 36. A save exits the title and help screens and saves the playlist through MetRemixManager, returning to the top buttons, title, and help screens. A play clears the active panel, starts the playlist, and records this screen in MetFrontEndState::mReturnScreen. The choice is then forgotten.

Ghidra address:
NTSC-U/C: 0x00231b50
Ghidra address:
PAL: 0x00245700

Reimplemented from MetScreen.

◆ ResolveContainerViews()

virtual void MetJukeboxEditPlaylistScreenDone::ResolveContainerViews ( )
virtual

Resolve the container views and add the three buttons.

Slot 38.

Ghidra address:
NTSC-U/C: 0x00231908
Ghidra address:
PAL: 0x002452a0

Reimplemented from MetScreen.


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