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

Jukebox list of the remixes that shipped with the game. More...

#include <metjukeboxfactoryremixesscreen.h>

Inheritance diagram for MetJukeboxFactoryRemixesScreen:
Collaboration diagram for MetJukeboxFactoryRemixesScreen:

Public Member Functions

 MetJukeboxFactoryRemixesScreen (MetRenderer *pRenderer, int nPriority)
 Construct the screen.
virtual ~MetJukeboxFactoryRemixesScreen ()
virtual int GetItemCount ()
 Report the number of factory remixes.
virtual void ResolveContainerViews ()
 Resolve the base views, build both scrolling lists, and resolve every detail object.
Public Member Functions inherited from MetJukeboxBaseScreen
 MetJukeboxBaseScreen (MetRenderer *pRenderer, int nPriority, const HxStr &name, const HxStr &directory, const HxStr &file)
 Construct the screen with no list and no resolved object.
virtual ~MetJukeboxBaseScreen ()
 Release the two scrolling lists.
virtual void EnterAndShow ()
 Show the five detail texts, bind the lists, and select the first catalogue row.
virtual void OnPanelActivated ()
 Refresh the details and the help text, then show the playlist.
virtual void HandleCommand (const MetScreenCommand *pCommand)
 Act on a command.
virtual void UpdateIdle (float flTime)
 Advance the two song pictures while the view is showing and the details are current.
virtual void OnEnterFinished ()
 Bind the lists again and refresh both.
virtual void OnExitFinished ()
 Hide the five detail texts.
virtual void SetShowing (int nShowing)
 Show or hide the view, both scrolling lists, and the list frame.
virtual void PlaySlideSound (int nSelector)
 Overridden empty, so a jukebox screen plays no slide sound.
virtual void PlayLeaveSound (int nSelector)
 Overridden empty, so a jukebox screen plays no departure sound.
virtual void PlayHighSound (int nSelector)
 Overridden empty, so a jukebox screen plays no emphasis sound.
virtual void PlayCycleLeftSound (int nSelector)
 Overridden empty, so a jukebox screen plays no left-cycle sound.
virtual void PlayCycleRightSound (int nSelector)
 Overridden empty, so a jukebox screen plays no right-cycle sound.
virtual void ShowRemixDetails ()
 Fill the detail texts from the selected catalogue row.
virtual void UpdateHelpText ()
 Select the help text for the playlist's state.
virtual void BindLists ()
 Bind the catalogue and the playlist from the shared MetRemixManager.
virtual int ProvideText (int nItem, int nColumn, Rnd::Text *pText, int nContext)
 Show one row of whichever list the context selects.
virtual int ProvideMesh (int nItem, int nColumn, Rnd::Mesh *pMesh, int nContext)
 Leave the cell as it is.
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 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 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.
Public Member Functions inherited from ListDataProvider
virtual ~ListDataProvider ()

Static Public Member Functions

static MetJukeboxFactoryRemixesScreen * 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 MetJukeboxBaseScreen
int mListRowPitch
int mListRowCount
ScrollingList * mCatalogueList
ScrollingList * mPlayListList
std::vector< MetRemixRecord > * mCatalogue
Rnd::Text * mGenreText
Rnd::Text * mTempoText
Rnd::Text * mSongTitleText
Rnd::Text * mDateText
Rnd::Text * mRemixTitleText
Rnd::Text * mPlayListCaption
Rnd::Mat * mPictureMaterial
Rnd::Mat * mLogoMaterial
JukeboxPlayList * mPlayList
int mCatalogueKey
std::vector< Rnd::Text * > mAppearanceTexts
Rnd::Font * mAvailableFont
Rnd::Font * mUnavailableFont
TexturePairRecord mLogoTextures
TexturePairRecord mPictureTextures
Rnd::Mesh * mPictureMesh
Rnd::Mesh * mLogoMesh
Rnd::Text * mWarningText
int mPicturesPending
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

Jukebox list of the remixes that shipped with the game.

Its RTTI descriptor is at 0x008eee68. It has MetJukeboxBaseScreen as its one public non-virtual base at offset 0. The class declares no data member, and the object is the 0x150 bytes of MetJukeboxBaseScreen alone. The 43-entry primary vtable is at 0x007eeff0, the same length as the MetJukeboxBaseScreen table, and the class declares no new virtual. The four-entry ListDataProvider table at 0x007eefc8 adjusts this by -140 in every entry and overrides no inherited entry.

The constructor at 0x0023ae58 takes only the renderer and the load priority. It runs the MetJukeboxBaseScreen constructor at 0x0021dcc0 with jbf for the screen name, metagame/Shared for the directory, and juke_factory for the container, and sets mCatalogueKey to -1. That value is what separates this screen from the other two, which both clear the same member. The destructor at 0x00240780 releases the object with the tag MsgSink and does nothing of its own.

Two inherited slots differ from the MetJukeboxBaseScreen table beyond the destructor. Slot 38 at 0x0023afd8 extends the base view resolution, and slot 39 at 0x00240840 supplies the pure virtual with a body byte-for-byte identical to the MetJukeboxCustomRemixesScreen override. Slots 40, 41, and 42 are inherited unchanged.

Constructor & Destructor Documentation

◆ MetJukeboxFactoryRemixesScreen()

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

Construct the screen.

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

◆ ~MetJukeboxFactoryRemixesScreen()

virtual MetJukeboxFactoryRemixesScreen::~MetJukeboxFactoryRemixesScreen ( )
virtual
Ghidra address:
NTSC-U/C: 0x00240780
Ghidra address:
PAL: 0x00255218

Member Function Documentation

◆ GetItemCount()

virtual int MetJukeboxFactoryRemixesScreen::GetItemCount ( )
virtual

Report the number of factory remixes.

Slot 39. The size of the catalogue mCatalogue addresses, read without a null check. The body coincides byte for byte with MetJukeboxCustomRemixesScreen::GetItemCount(), and the vtable slot each occupies is what separates them.

Returns
The row count.
Ghidra address:
NTSC-U/C: 0x00240840
Ghidra address:
PAL: 0x002552d8

Implements MetJukeboxBaseScreen.

◆ New()

MetJukeboxFactoryRemixesScreen * MetJukeboxFactoryRemixesScreen::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: 0x00240868
Ghidra address:
PAL: 0x00255300

◆ ResolveContainerViews()

virtual void MetJukeboxFactoryRemixesScreen::ResolveContainerViews ( )
virtual

Resolve the base views, build both scrolling lists, and resolve every detail object.

Slot 38. The same layout as MetJukeboxCustomRemixesScreen::ResolveContainerViews() over the jbf_ objects, except that the catalogue row view is also shown, and the playlist caption is resolved from dbf_CREATE PLAYLIST.txt, the name the image records. The European release also sets the caption to the My Playlist text of the current language.

Ghidra address:
NTSC-U/C: 0x0023afd8
Ghidra address:
PAL: 0x0024f6c8

Reimplemented from MetJukeboxBaseScreen.


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