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

Base of every front-end screen. More...

#include <metscreen.h>

Inheritance diagram for MetScreen:
Collaboration diagram for MetScreen:

Public Member Functions

 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 EnterAndShow ()
 Show this screen and start its enter animation.
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 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 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 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 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.
virtual void ResolveContainerViews ()
 Resolve the three views the container produced and hide the screen.
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 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.

Public Attributes

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

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

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

Base of every front-end screen.

Its RTTI descriptor is at 0x008eed98. It has MsgSink as its one public non-virtual base at offset 0. MetMemDetectScreen, MetSaveRemix, MetSoloWinScreen, and seven further classes fix the object at 0x8c bytes by placing their second base at +140. The vtable is at 0x0080b6a0. A walk of the table reads 39 entries, slots 0 to 38, followed by an all-zero terminating entry at 0x0080b838 and then the next class's table at 0x0080b840. The terminator is not a slot.

Thirty-two classes derive directly from the class, and five intermediate classes sit between it and their own children, MetGizmoPanel, MetJukeboxBaseScreen, MetMultiTipsBaseScreen, MetPauseBaseScreen, and MetScreenMultiSoundBank.

A screen manages a Rnd::View loaded from a .rnd container. The constructor records the container name and, when both name arguments are non-empty, starts the load with a direct call to slot 18's body rather than a dispatch through the table. That is what a virtual call from a constructor compiles to, and the destructor invokes slot 13 the same way.

Slot 14 polls the RndAsyncLoader until the load completes and then runs slot 38, which resolves the view by appending .view to the container name and resolves the two animation views by formatting s_EE.anim and s_BF.anim from the screen name. A screen with no view stops the machine through Fatal() with the screen s doesn't have a valid view!.

Every float this class passes or receives for an animation is a frame position rather than a time in seconds. MetRenderer advances the field at its own +0x68 by a rate at +0x64 that defaults to 500, and hands the result to Rnd::Animatable::SetFrame(). That is what makes the arithmetic here coherent: mEnterStartTime and mExitStartTime store frame positions, mAnimEndFrame stores the enter animation's end frame from Rnd::View::FilteredFrameEnd(), and UpdateEnterAnimation() subtracts one from the sum of the other two.

The 39 entries follow in table order. Slot 0 is the compiler-generated GetTypeInfo at 0x0038fd78 and is not source. An entry marked empty is a two-instruction jr ra stub. Each such stub sits at its own address and several derived tables address the same stub, so the stub is an out-of-line definition rather than an inline body, and this class owes one definition for each.

A walk of all 78 tables in the image that share at least twelve entries with this one settles which of the empty slots a derived class fills. Slot 19 is filled 53 times, slot 15 23 times, slot 27 6 times, slot 16 twice, and slot 11 once. Slots 10, 12, and 13 are filled by no derived table at all.

Five of the six sound slots take one integer argument. MetKeyboardScreen::StartRepeatingSound() at 0x0028c5e0 loads its own selector into a1 immediately before each of its five virtual calls, to slots 20, 22, 23, 24, and 25, so the argument is set at a call site rather than inherited from a register. The same class overrides four of the five and each override reads a1 and compares it against the selector it recorded.

The selector is the controller index. DeliverCommand() loads it from +0x04 of the command record, MetRenderer::DispatchPriv rejects a command whose +0x04 exceeds its own bound at +0xd4 before delivering it, and the translator at 0x002e3738 copies that word out of the input message unchanged. A screen that records -1 plays its sound for every controller.

PlayLeaveSound() takes the selector as well. DeliverCommand() loads a1 from the same +0x04 for slot 21 at 0x0038b7e8 exactly as it does for the other five, and the MetConfigControllerScreen override at 0x00206970 compares it against its own controller.

Four data members are protected and the rest are private. MetRemixLoadScreen and MetRemixDelScreen both clear mShowsLoadedDrawables in their constructors, and MetSaveRemixScreen clears mPlaysCommandSounds in its own. Four derived constructors append to mHelpKeys, and MetJukeboxBaseScreen::SetShowing() reads mViewsUnresolved. Those four are written or read by derived code and the others are not. No code outside the class and its children reads a member.

Constructor & Destructor Documentation

◆ MetScreen()

MetScreen::MetScreen ( MetRenderer * pRenderer,
int nPriority,
const HxStr & name,
const HxStr & directory,
const HxStr & file )

Construct a screen and start its container load.

The load starts only when HxStr::DiffersFromLiteral reports both directory and file different from the empty literal. BeginContainerLoad() is invoked with a direct call rather than through vtable slot 18, the form a virtual call from a constructor compiles to. MsgSource::AddSink() runs before the load starts.

mAnimEndFrame, mRepeatSteps, and mRepeatInterval are not written. A screen therefore starts with three indeterminate fields. Slot 38 writes mAnimEndFrame and slot 28 writes the other two.

The body is not written. Every part is recovered. mRenderer takes pRenderer, mExitChoice takes 2, mRepeatScale takes 1.0f, mViewsUnresolved, mPlaysCommandSounds, and mShowsLoadedDrawables each take 1, mScreenName is copy-constructed from name, mContainerName from file, mLoadPriority from nPriority, every remaining integer, float, and pointer member is zeroed, mContainerFile is assigned file with .rnd appended, mRenderer->AddSink(this) registers the screen, and the load then starts. MetRenderer's header blocks the body. It declares the class with no base and a reserved byte array over +0x00 through +0x67, and AddSink() is unreachable through the member. The RTTI descriptor lists MsgSource at offset 0, RendererBase at 20, and FadeUser at 92, and the body follows once MetRenderer declares them.

Parameters
pRendererThe front-end renderer this screen registers on.
nPriorityThe load priority, passed to RndAsyncLoader unchanged.
nameThe screen name, from which the animation view names are formatted.
directoryThe directory the container loads from.
fileThe container name, without the .rnd suffix.
Ghidra address:
NTSC-U/C: 0x0038a450
Ghidra address:
PAL: 0x003bb9a8

◆ ~MetScreen()

virtual MetScreen::~MetScreen ( )
virtual

Unregister from the renderer and release the container.

Slot 1. The hand-written part is three calls and nothing else. Everything the disassembly shows besides them is compiler-generated: the two table-pointer stores, the inlined HxStr destructors for mScreenName, mContainerFile, and mContainerName, the std::vector and std::list teardown, and the conditional release under the __in_chrg flag.

The body is not written, and the three calls are mRenderer->RemoveScreen(this), OnDestroying(), and mRenderer->RemoveSink(this), in that order. RemoveSink() blocks it for the reason recorded on the constructor.

Ghidra address:
NTSC-U/C: 0x0038a848
Ghidra address:
PAL: 0x003bbe10

Member Function Documentation

◆ ContainerLoaderMap()

std::map< HxStr, MetContainerLoad * > & MetScreen::ContainerLoaderMap ( )
static

Shared table of container loads, interned under the container name.

The table is a function-local static, so the accessor is the only route to it and the compiler wrapped it in the guard flag at 0x006c64d8. The tree it builds is tagged stl_maptree with a 12-byte value, and its header node is 0x20 bytes, which is 16 bytes of tree header plus the 8-byte key and the 4-byte pointer.

Returns
The table.
Ghidra address:
NTSC-U/C: 0x00381e10
Ghidra address:
PAL: 0x003b2490

◆ ScreenRegistry()

std::map< HxStr, MetScreenEntry > & MetScreen::ScreenRegistry ( )
static

Shared table of live screens, interned under the screen registry key.

The key is the screen class name as a literal, and the literal is authoritative rather than derivable from the class, because at least one screen registers under a spelling that differs from its class name. The table is a function-local static behind the guard flag at 0x006c64dc, with a 16-byte key and value pair and a 0x20-byte node. Its atexit destructor is at 0x00382168.

Returns
The table.
Ghidra address:
NTSC-U/C: 0x003821e0
Ghidra address:
PAL: 0x003b2860

◆ FindScreenByName()

MetScreen * MetScreen::FindScreenByName ( const HxStr & name)
static

Resolve one screen by its registry key.

Parameters
nameThe registry key.
Returns
The screen, or null when no screen has registered under the key.
Ghidra address:
NTSC-U/C: 0x0038ff90
Ghidra address:
PAL: 0x003c1860

◆ FindEndScreen()

MetScreen * MetScreen::FindEndScreen ( MetRenderer * pRenderer,
const HxStr & name )
static

Resolve one end-of-game screen by its registry key, failing fatally when it is absent.

The lookup is FindScreenByName() expanded inline. The failure message is PROBLEM end screen is not found!. Every caller passes the renderer, which the body does not read. The title is inferred.

Parameters
pRendererThe front-end renderer, which is not read.
nameThe registry key.
Returns
The screen.
Ghidra address:
NTSC-U/C: 0x00390000
Ghidra address:
PAL: 0x003c18d0

◆ CreateMainMenuScreens()

void MetScreen::CreateMainMenuScreens ( MetRenderer * pRenderer)
static

Create the main-menu screens.

The set is MetMainScreen, MetTopLogoScreen, MetLeftGizmoSmallScreen, MetLeftGizmoScreen, MetHelpScreen, and MetScreenTitleScreen, each built on the renderer with the rndglobal zone and registered in category 0. An existing entry is overwritten. The arena loader is the one caller. The title is inferred.

Parameters
pRendererThe renderer the screens register on.
Ghidra address:
NTSC-U/C: 0x003848e0
Ghidra address:
PAL: 0x003b50b0

◆ DestroyAllScreens()

void MetScreen::DestroyAllScreens ( )
static

Delete every registered screen and release every container loader.

Walks ScreenRegistry(), deleting each screen through its virtual destructor and erasing its entry, then walks ContainerLoaderMap(), deleting each record's RndAsyncLoader, clearing the record's pointer, and erasing the entry. The MetContainerLoad records themselves are not freed. MetRenderer's destructor is the one caller. The title is inferred.

Ghidra address:
NTSC-U/C: 0x00383700
Ghidra address:
PAL: 0x003b3dc8

◆ CreateStartupScreens()

void MetScreen::CreateStartupScreens ( MetRenderer * pRenderer)
static

Create the four screens the front end needs before its containers have loaded.

Registers MetSonyScreen, MetMemDetectStartup, MetMsgScreen, and MetLogoScreen in ScreenRegistry(), each built by its factory on the renderer with the rndglobal zone. MetRenderer::ResolveSceneViews() is the one caller. The title is inferred.

Parameters
pRendererThe renderer the screens register on.
Ghidra address:
NTSC-U/C: 0x00384300
Ghidra address:
PAL: 0x003b49f0

◆ CreateFrontEndScreens()

void MetScreen::CreateFrontEndScreens ( MetRenderer * pRenderer)
static

Create every remaining front-end screen, once.

Nothing happens when MetLoadGameScreen is already registered. Otherwise 59 screens, from MetLoadPreFabScreen to MetEndGameGizmoScreen, are built on the renderer with the rndglobal zone and registered in category 0. MetSonyScreen::OnFadeOutDone() is the one caller. The title is inferred.

Parameters
pRendererThe renderer the screens register on.
Ghidra address:
NTSC-U/C: 0x00385180
Ghidra address:
PAL: 0x003b5a98

◆ DestroyCategory2Screens()

void MetScreen::DestroyCategory2Screens ( )
static

Delete and unregister every screen in category 2.

The image has no caller, and no recovered registration uses the category. The title is inferred.

Ghidra address:
NTSC-U/C: 0x003822c8
Ghidra address:
PAL: 0x003b2948

◆ DestroyCategory1Screens()

void MetScreen::DestroyCategory1Screens ( )
static

Delete and unregister every screen in category 1.

The image has no caller, and no recovered registration uses the category. The title is inferred.

Ghidra address:
NTSC-U/C: 0x00382978
Ghidra address:
PAL: 0x003b3010

◆ DestroyNonDefaultScreens()

void MetScreen::DestroyNonDefaultScreens ( )
static

Delete and unregister every screen outside category 0, then rewind the rndMetLocAndNet zone.

The image has no caller. The title is inferred.

Ghidra address:
NTSC-U/C: 0x00383020
Ghidra address:
PAL: 0x003b36d8

◆ PollContainerLoads()

void MetScreen::PollContainerLoads ( )
static

Poll every container load that has not finished, and hide the drawables of each that does.

Each record whose mFinished is clear polls its loader. When the poll reports completion the record's mFinished is set and every drawable the load produced is hidden through Rnd::Drawable::SetShowing(). MetRenderer::Update() is the one caller. The title is inferred.

Ghidra address:
NTSC-U/C: 0x00381ef8
Ghidra address:
PAL: 0x003b2578

◆ DeliverCommand()

void MetScreen::DeliverCommand ( const MetScreenCommand * pCommand)

Play the sound one navigation command calls for and then act on the command.

Not a vtable slot. MetRenderer::DispatchPriv at 0x0036c6e8 and three further routines arrive at it with a direct call. A screen whose mAcceptsCommands is clear ignores the command completely, and a screen whose mPlaysCommandSounds is clear skips the sound and acts on the command regardless. The sound is chosen through a six-entry jump table at 0x0080b460 indexed by the command code less one, and every branch of that table passes MetScreenCommand::mPadIndex to the sound slot it runs. Slot 19 then receives the whole record.

Declared public because MetRenderer calls it from outside the hierarchy and the image has no other route to it. A friend declaration fits the image equally well.

Parameters
pCommandThe command the renderer translated from an input message.
Ghidra address:
NTSC-U/C: 0x0038b730
Ghidra address:
PAL: 0x003bcea8

◆ UpdateAnimationFrame()

void MetScreen::UpdateAnimationFrame ( float flTime)

Drive the frame of whichever animation is running and run the idle hook when none is.

Not a vtable slot. MetRenderer::UpdateSimple() at 0x0036b858 is its one caller. A screen still waiting for its container load (the state a set mEnterPending records) does nothing here. Both branches drive mEnterAnim rather than mBackAnim, matching UpdateExitAnimation().

Declared public for the same reason as DeliverCommand().

Parameters
flTimeThe renderer's current animation frame position.
Ghidra address:
NTSC-U/C: 0x00390380
Ghidra address:
PAL: 0x003c1c50

◆ UpdateFrame()

void MetScreen::UpdateFrame ( float flTime)

Advance one screen by one frame.

Not a vtable slot. MetRenderer::Update() at 0x0036b650 is its one caller. The routine has two disjoint halves and mEnterPending selects between them. A screen still waiting for its container load (the state a set mEnterPending records) takes the deferred-entry half and no animation runs. Every other screen takes the animation half.

The deferred half consults the container load interned under mContainerFile. Once that load reports finished, slot 38 resolves the views while mViewsUnresolved is set, the view is handed to the renderer, slot 5 enters the screen, and mEnterPending is cleared. A screen that also has mActivatePending set then becomes the active panel and runs slot 7. While the load is unfinished the half polls the RndAsyncLoader instead and records the completion in the shared load record. The record is the one place MetContainerLoad::mFinished is written after BeginContainerLoad().

The animation half runs slot 32, then slot 26 either when mIdleWhileAnimating is set or when neither animation is running, then slot 29 and slot 35. Slot 26 therefore fires on the same both-times-zero condition that UpdateAnimationFrame() uses for slot 27, which is what pairs the two idle hooks across the renderer's two passes.

The animation half is the common path, not the exceptional one.

Declared public for the same reason as DeliverCommand().

Parameters
flTimeThe renderer's current animation frame position.
Ghidra address:
NTSC-U/C: 0x0038b918
Ghidra address:
PAL: 0x003bd090

◆ PushNamedScreen()

virtual void MetScreen::PushNamedScreen ( const HxStr & name)
virtual

Bring one named screen onto the renderer's screen stack.

Slot 4. The screen is appended to the stack first and only enters once its own slot 14 reports the container load finished. A screen whose load has not finished instead records 1 in mEnterPending and is entered by a later call.

Parameters
nameThe registry key of the screen to push.
Ghidra address:
NTSC-U/C: 0x00390200
Ghidra address:
PAL: 0x003c1ad0

◆ EnterAndShow()

◆ ActivateNamedPanel()

virtual void MetScreen::ActivateNamedPanel ( const HxStr & name)
virtual

Make one named screen the renderer's active panel.

Slot 6. An empty name clears MetRenderer::mPanelActive and does not activate a screen. A screen whose slot 14 reports the load unfinished instead records 1 in its mActivatePending.

Parameters
nameThe registry key of the panel to activate, or an empty string for none.
Ghidra address:
NTSC-U/C: 0x0038b828
Ghidra address:
PAL: 0x003bcfa0

◆ OnPanelActivated()

virtual void MetScreen::OnPanelActivated ( )
virtual

Act on this screen having become the renderer's active panel.

Slot 7. The body is empty. Slot 6 and UpdateFrame() run it with no argument immediately after MetRenderer::SetActivePanel() has made this screen the active panel. The overrides start the screen's interaction, for example MetFreqMakerInventoryScreen returning its grid cursor to the first cell and MetRemixDelScreen running its pending keyboard action.

Ghidra address:
NTSC-U/C: 0x0038fdf8
Ghidra address:
PAL: 0x003c16c8

Reimplemented in MetFreqMakerButtonsScreen, MetFreqMakerInventoryScreen, MetJukeboxBaseScreen, MetJukeboxEditPlaylistScreen, MetMCFreqDelScreen, MetPersonaSaverScreen, MetRemixDelScreen, MetSaveRemixScreen, and MetSoloEndRemixScreen.

◆ ExitScreenByName()

virtual void MetScreen::ExitScreenByName ( const HxStr & name)
virtual

Start one named screen's exit animation.

Slot 8. Writes Exiting screen: s to the memory log first. The resolved screen is used without a null check, so a key that no screen registered under faults.

Parameters
nameThe registry key of the screen to exit.
Ghidra address:
NTSC-U/C: 0x003902d0
Ghidra address:
PAL: 0x003c1ba0

◆ BeginExit()

virtual void MetScreen::BeginExit ( )
virtual

◆ OnUnusedHook()

virtual void MetScreen::OnUnusedHook ( )
virtual

Do nothing.

Slot 10.

The title records the one fact recovered. No routine uses the hook. The body is empty. No derived table among the 78 in the image fills the slot, and no routine in the image dispatches it on a screen. Every one of the 42 sites that loads a table entry at this index dispatches it on the object Globals::GetGameManager() vends or on an unrelated class, and the destructor's direct call to slot 13 has no counterpart here. Neither the purpose nor the argument list is recovered.

Ghidra address:
NTSC-U/C: 0x00390130
Ghidra address:
PAL: 0x003c1a00

◆ OnKeyboardDismissed()

virtual void MetScreen::OnKeyboardDismissed ( )
virtual

Take control back after the keyboard screen has finished.

Slot 11. The body is empty. MetKeyboardScreen::OnExitFinished() at 0x00283b74 is the one caller in the image: once the entered text is committed it resolves the screen whose registry key it recorded, runs this slot on that screen with no argument, and then makes the same key its active panel. MetLoadNewFreqScreen fills the slot at 0x002a3978 and re-pushes two named screens and re-activates its panel, which is what fixes the hook as a resumption rather than a report of the entered text.

Ghidra address:
NTSC-U/C: 0x00390138
Ghidra address:
PAL: 0x003c1a08

Reimplemented in MetLoadNewFreqScreen.

◆ OnDrawPass()

virtual void MetScreen::OnDrawPass ( )
virtual

Contribute to the renderer's draw pass.

Slot 12. The body is empty and no derived table among the 78 fills it, so the hook exists and the shipped game implements it nowhere. MetRenderer::Draw() at 0x003716c8 is the one caller on a screen: it draws its own root drawable, walks the screen vector at +0x84 running this slot on each entry with no argument, and then draws the timing graph and the statistics overlay.

Ghidra address:
NTSC-U/C: 0x0038fe00
Ghidra address:
PAL: 0x003c16d0

◆ OnDestroying()

virtual void MetScreen::OnDestroying ( )
virtual

Release what the screen acquired, ahead of the rest of destruction.

Slot 13. The body is empty and no derived table among the 78 fills it. The destructor at 0x0038a890 is its one caller anywhere in the image, with a direct call and no argument, placed after the screen unregisters from the renderer and before any member is released. A direct rather than dispatched call is what a virtual invoked from a destructor compiles to, because the dynamic type there is this class.

Ghidra address:
NTSC-U/C: 0x003900a0
Ghidra address:
PAL: 0x003c1970

◆ PollContainerLoad()

virtual int MetScreen::PollContainerLoad ( )
virtual

Advance this screen's container load and resolve its views once the load finishes.

Slot 14. The views are resolved only while mViewsUnresolved is set. Slot 38 clears the flag, and the resolution happens once. The report does not depend on mViewsUnresolved.

Returns
Non-zero once the container load has finished.
Ghidra address:
NTSC-U/C: 0x0038b338
Ghidra address:
PAL: 0x003bca70

Reimplemented in MetFreqMakerButtonsScreen, MetFreqMakerCanvasScreen, MetFreqMakerDirectionsScreen, and MetFreqMakerInventoryScreen.

◆ OnMsgScreenDismissed()

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

Act on the choice the user made in a message dialogue.

Slot 15. The body is empty. MetMsgScreen::OnExitFinished() at 0x002f05f4 is the one caller on a screen. Once its exit animation has finished it clears its +0xd8 flag and runs this slot on the screen at its +0xb8, passing the HxStr at its +0xb0 and the integer at its +0xd4. Twenty-three derived tables fill the slot, and each body compares the first argument against dialogue names through HxStr::MatchesLiteral and then branches on the second against 0, 1, and 2. MetExpansionPakScreen at 0x002193e8 matches expansion_prepare, expansion_check, expansion_done, expansion_load, and expansion_retry, and MetMemDetectScreen at 0x002d9e40 matches mem_check, mem_format_check, mem_error, and six further keys. The second argument is which button the user chose, on the evidence that those screens build their dialogues with the button sets CONTINUE/CANCEL/RETRY and YES/NO and then branch on 0, 1, and 2. The MetSaveRemix override at 0x00375590 reads both arguments before writing either, passing the first to HxStr::MatchesLiteral and comparing the second against 1 at 0x003755b4, which confirms the second argument independently of the caller.

Parameters
nameThe dialogue the screen requested, which the message screen reports back.
nChoiceWhich of the dialogue's buttons the user chose, counted from zero.
Ghidra address:
NTSC-U/C: 0x0038fe20
Ghidra address:
PAL: 0x003c16f0

Reimplemented in MetConfigControllerScreen, MetExpansionPakScreen, MetFreqMakerButtonsScreen, MetGlobalSettingsSaverScreen, MetLoadFreqScreen, MetLoadNewFreqScreen, MetLoadPreFabScreen, MetLocPickCharScreen, MetMCFreqDelScreen, MetMemDetectScreen, MetPauseBaseScreen, MetPersonaSaverScreen, MetRemixDelScreen, MetRemixManager, MetRemixTypeScreen, MetSaveRemix, and MetSaveRemixScreen.

◆ OnMsgScreenShown()

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

Act on a message dialogue becoming visible.

Slot 16. The body is empty. MetMsgScreen::OnEnterFinished() at 0x002f0524 is the one caller on a screen. Once its enter animation has finished it sets its +0xd8 flag and runs this slot on the screen at its +0xb8, passing only the HxStr at its +0xb0. No second argument is set. Two derived tables fill the slot. MetExpansionPakScreen at 0x0021d9e0 matches the name against expansion_prepare and expansion_load and records which dialogue is up, and MetRemixDelScreen at 0x003441a0 ignores the argument and activates a named panel.

Parameters
nameThe dialogue the screen requested, which the message screen reports back.
Ghidra address:
NTSC-U/C: 0x0038fe28
Ghidra address:
PAL: 0x003c16f8

Reimplemented in MetExpansionPakScreen, and MetRemixDelScreen.

◆ SetShowing()

virtual void MetScreen::SetShowing ( int nShowing)
virtual

Show or hide the view and every drawable the container loaded.

Slot 17. Forwards to Rnd::Drawable::SetShowing() on mView and then, when mShowsLoadedDrawables is set, on each entry of the drawable list that the loader recorded for mContainerFile. The name is inferred from the Rnd::Drawable virtual it forwards to.

The second half copies RndAsyncLoader::mDrawables out of the interned container load into a temporary and walks it. The helper at 0x0014d560 that the copy expands to is std::list::insert over a range and is library code, so the source wrote a copy construction rather than a call. The view is dereferenced with no null check.

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

Reimplemented in MetJukeboxBaseScreen, and MetJukeboxEditPlaylistScreenDone.

◆ BeginContainerLoad()

virtual void MetScreen::BeginContainerLoad ( const HxStr & directory,
const HxStr & file )
virtual

Intern a container load under this screen's container name and enqueue it.

Slot 18. A separator is appended to the directory before the request is built. The file argument is declared and ignored, because the request is built from mContainerFile instead. When a record is already interned under the name, the call returns without resetting or enqueuing it.

Parameters
directoryThe directory the container loads from.
fileDeclared and ignored.
Ghidra address:
NTSC-U/C: 0x0038aa00
Ghidra address:
PAL: 0x003bc008

◆ HandleCommand()

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

Act on a navigation command.

Slot 19. The body is empty. DeliverCommand() is the one caller, and it passes the whole command record after playing the sound the command code calls for. Fifty-three derived tables fill the slot, more than any other, and every body inspected reads MetScreenCommand::mCommand and branches on it. MetMainScreen at 0x002c6820 routes command 1 to MetButtonList::SelectPrevious(), command 2 to MetButtonList::SelectNext(), command 5 to a named panel, and command 6 elsewhere. MetConfigControllerScreen fills it at 0x00200ba8 and MetKeyboardScreen at 0x00283268.

Parameters
pCommandThe command the renderer translated from an input message.
Ghidra address:
NTSC-U/C: 0x0038fe30
Ghidra address:
PAL: 0x003c1700

Reimplemented in MetArenasScreen, MetConfigControllerScreen, MetConfigGameOptionsScreen, MetConfigOptionsButtonsScreen, MetCreditsScreen, MetFreqCreateScreen, MetFreqMakerButtonsScreen, MetFreqMakerCanvasScreen, MetFreqMakerInventoryScreen, MetGameSkillScreen, MetHelpScreen, MetJukeboxBaseScreen, MetJukeboxEditPlaylistScreen, MetJukeboxEditPlaylistScreenDone, MetJukeboxEditPlaylistScreenLowerLeft, MetJukeboxTopButtonsScreen, MetKeyboardScreen, MetLoadFreqBaseScreen, MetLocNumPlayScreen, MetLocPickCharScreen, MetLogoScreen, MetMainScreen, MetMCFreqDelScreen, MetMemCardLoadScreen, MetMemCardTypeScreen, MetModeScreen, MetMsgScreen, MetMultiEndScreen, MetMultiTipsBaseScreen, MetPauseBaseScreen, MetPauseMultiRemixScreen, MetPauseSoloGameScreen, MetPauseSoloRemixScreen, MetRemixDelScreen, MetRemixLoadScreen, MetRemixTypeScreen, MetSaveRemixScreen, MetSoloLoseScreen, MetSoloStagesScreen, MetSoloWinScreen, MetStageFinishScreen, and MetTutorialScreen.

◆ PlaySlideSound()

virtual void MetScreen::PlaySlideSound ( int nSelector)
virtual

Play the sound that accompanies sliding between screens.

Slot 20. Passes the literal SND_MET_SLIDE to the named-sound player at 0x0012f470. The name is inferred from that literal. MetScreenMultiSoundBank, MetMultiTipsBaseScreen, MetPauseBaseScreen, and MetJukeboxBaseScreen all override this slot, the last three with an empty body, which is what proves the return type is void.

The body ignores its argument. DeliverCommand() routes command 5 to this slot.

Parameters
nSelectorThe controller index the command came from, which an override compares against its own recorded selector.
Ghidra address:
NTSC-U/C: 0x00390140
Ghidra address:
PAL: 0x003c1a10

Reimplemented in MetArenasScreen, MetConfigControllerScreen, MetCreditsScreen, MetFreqMakerInventoryScreen, MetJukeboxBaseScreen, MetJukeboxEditPlaylistScreenDone, MetJukeboxEditPlaylistScreenLowerLeft, MetKeyboardScreen, MetLoadGameScreen, MetLocPickCharScreen, MetLogoScreen, MetMCFreqDelScreen, MetMemCardLoadScreen, MetMemDetectStartup, MetMsgScreen, MetPauseBaseScreen, MetRemixDelScreen, MetRemixLoadScreen, MetSaveRemixScreen, MetScreenMultiSoundBank, MetSoloStagesScreen, and MetSonyScreen.

◆ PlayLeaveSound()

virtual void MetScreen::PlayLeaveSound ( int nSelector)
virtual

Play the sound that accompanies departing a screen.

Slot 21. Passes the literal SND_MET_LEAVE to the named-sound player at 0x0012f470. DeliverCommand() routes command 6 to this slot, loading the controller index into a1 first. The body does not read the selector.

Parameters
nSelectorThe pad index of the command.
Ghidra address:
NTSC-U/C: 0x00390160
Ghidra address:
PAL: 0x003c1a30

Reimplemented in MetConfigControllerScreen, MetFreqMakerInventoryScreen, MetJukeboxBaseScreen, MetJukeboxEditPlaylistScreenDone, MetJukeboxEditPlaylistScreenLowerLeft, MetLoadGameScreen, MetLogoScreen, MetMemDetectStartup, MetMsgScreen, MetMultiEndScreen, MetMultiSaveRemixScreen, MetPauseBaseScreen, MetSaveRemixScreen, MetScreenMultiSoundBank, MetSoloLoseScreen, MetSoloWinScreen, MetSonyScreen, and MetStageFinishScreen.

◆ PlayHighSound()

virtual void MetScreen::PlayHighSound ( int nSelector)
virtual

Play the sound that accompanies the emphasised selection.

Slot 22. Passes the literal SND_MET_HIGH to the named-sound player at 0x0012f470. The body ignores its argument. DeliverCommand() routes commands 1 and 2 to this slot.

Parameters
nSelectorThe controller index the command came from, which an override compares against its own recorded selector.
Ghidra address:
NTSC-U/C: 0x003901c0
Ghidra address:
PAL: 0x003c1a90

Reimplemented in MetConfigControllerScreen, MetCreditsScreen, MetFreqMakerInventoryScreen, MetJukeboxBaseScreen, MetJukeboxEditPlaylistScreenDone, MetJukeboxEditPlaylistScreenLowerLeft, MetKeyboardScreen, MetLoadGameScreen, MetLocPickCharScreen, MetLogoScreen, MetMemCardLoadScreen, MetMemDetectStartup, MetMsgScreen, MetMultiSaveRemixScreen, MetMultiTipsBaseScreen, MetPauseBaseScreen, MetRemixLoadScreen, MetSaveRemixScreen, MetScreenMultiSoundBank, MetSonyScreen, and MetStageFinishScreen.

◆ PlayCycleLeftSound()

virtual void MetScreen::PlayCycleLeftSound ( int nSelector)
virtual

◆ PlayCycleRightSound()

virtual void MetScreen::PlayCycleRightSound ( int nSelector)
virtual

◆ PlayErrorSound()

virtual void MetScreen::PlayErrorSound ( int nSelector)
virtual

Play the sound that accompanies a rejected input.

Slot 25. Passes the literal SND_MET_ERROR to the named-sound player at 0x0012f470. This is the one sound of the six that MetScreenMultiSoundBank does not override. The body ignores its argument, and DeliverCommand() routes no command code to this slot.

Parameters
nSelectorThe controller index the command came from, which an override compares against its own recorded selector.
Ghidra address:
NTSC-U/C: 0x003901e0
Ghidra address:
PAL: 0x003c1ab0

Reimplemented in MetMemDetectStartup, and MetStageFinishScreen.

◆ UpdateIdle()

virtual void MetScreen::UpdateIdle ( float flTime)
virtual

Advance whatever the screen updates once per frame while it is idle.

Slot 26. UpdateFrame() runs it while neither animation is running, or on every frame when mIdleWhileAnimating is set. The overrides blink a caret, advance a fade, or start a scheduled exit. The body is empty here. MetKeyboardScreen fills it at 0x0028c708 with a body that reads its argument out of f12 and compares a float member against it. That comparison fixes the single parameter as a float. Nine further screens fill the slot too. The argument is the renderer time, on the same evidence that fixes it for the two animation slots, because the MetKeyboardScreen body adds a fixed 240 to a recorded value and tests the sum against it.

Parameters
flTimeThe renderer's current animation frame position.
Ghidra address:
NTSC-U/C: 0x0038fe38
Ghidra address:
PAL: 0x003c1708

Reimplemented in MetArenasScreen, MetCreditsScreen, MetExpansionPakScreen, MetGizmoPanel, MetHelpScreen, MetJukeboxBaseScreen, MetJukeboxTopButtonsScreen, MetKeyboardScreen, MetLoadGameScreen, MetLocPickCharScreen, MetLogoScreen, MetMemDetectScreen, MetMemDetectStartup, MetMsgScreen, MetMultiEndRemixScreen, MetRemixDataScreen, MetSoloEndRemixScreen, MetSoloStagesScreen, MetSonyScreen, MetStageFinishScreen, and MetTopLogoScreen.

◆ UpdateIdleAnimation()

virtual void MetScreen::UpdateIdleAnimation ( float flTime)
virtual

Advance whatever the screen animates while it is neither entering nor exiting.

Slot 27. The body is empty. UpdateAnimationFrame() is the one caller on a screen, and it runs the slot only while both mEnterStartTime and mExitStartTime are zero (the interval after the enter animation has finished and before the exit animation starts). Six derived tables fill the slot. MetGizmoPanel at 0x0027b388 forwards to slot 26 unchanged. That forwarding pairs the two hooks and confirms the float. MetLogoScreen at 0x002be5a8 toggles one object every 120 units of renderer time and sets an animation view's frame to the time it received.

Parameters
flTimeThe renderer's current animation frame position.
Ghidra address:
NTSC-U/C: 0x0038fe40
Ghidra address:
PAL: 0x003c1710

Reimplemented in MetGizmoPanel, and MetLogoScreen.

◆ StartRepeatingSound()

virtual void MetScreen::StartRepeatingSound ( float flStartTime,
float flInterval,
Rnd::Button * pButton,
int nCycles )
virtual

Start alternating one button between its states 2 and 1.

Slot 28. A null button records nothing and starts nothing. The start time, the interval, the button, and twice the cycle count are recorded, because one full cycle of the alternation is two steps, and the button is set to state 2 through Rnd::Button::SetState().

Parameters
flStartTimeThe frame position the first step runs at.
flIntervalThe interval between steps.
pButtonThe button whose state alternates.
nCyclesThe number of full cycles to run.
Ghidra address:
NTSC-U/C: 0x00390498
Ghidra address:
PAL: 0x003c1d68

Reimplemented in MetKeyboardScreen.

◆ UpdateRepeatingSound()

virtual void MetScreen::UpdateRepeatingSound ( float flTime)
virtual

Advance the alternation that StartRepeatingSound() started.

Slot 29. Nothing runs while no alternation is recorded, and a step runs only once the frame passes the recorded time plus one interval. Each step alternates the button between states 1 and 2, the odd steps selecting 1. Before the recorded count is reached, the recorded time becomes the current frame plus one interval, so steps after the first run two intervals apart. The last step restores state 1, hands the button to slot 30, and clears the three fields that drive the alternation.

Parameters
flTimeThe renderer's current animation frame position.
Ghidra address:
NTSC-U/C: 0x003904e0
Ghidra address:
PAL: 0x003c1db0

◆ OnRepeatingSoundFinished()

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

Act on the alternation that StartRepeatingSound() started having finished.

Slot 30. The body is empty. Slot 29 passes the button it finished alternating, and MetConfigOptionsButtonsScreen overrides the slot at 0x00207fc0 with a body that copies the HxStr at +0x04 of the same argument.

Parameters
pButtonThe button slot 29 finished with.
Ghidra address:
NTSC-U/C: 0x0038fe48
Ghidra address:
PAL: 0x003c1718

Reimplemented in MetArenasScreen, MetConfigOptionsButtonsScreen, MetFreqCreateScreen, MetFreqMakerButtonsScreen, MetFreqMakerCanvasScreen, MetFreqMakerDirectionsScreen, MetFreqMakerInventoryScreen, MetGameSkillScreen, MetJukeboxEditPlaylistScreenDone, MetKeyboardScreen, MetLoadFreqBaseScreen, MetLocNumPlayScreen, MetMainScreen, MetMemCardLoadScreen, MetMemCardTypeScreen, MetModeScreen, MetMultiEndScreen, MetRemixTypeScreen, MetSaveRemixScreen, MetSoloLoseScreen, MetSoloStagesScreen, MetSoloWinScreen, MetStageFinishScreen, and MetTutorialScreen.

◆ StartEnterAnimation()

virtual void MetScreen::StartEnterAnimation ( float flTime)
virtual

Rewind the enter animation and record the time it starts at.

Slot 31. The exit animation start time is cleared, so the two animations never run together.

Parameters
flTimeThe frame position the animation starts at.
Ghidra address:
NTSC-U/C: 0x003905c0
Ghidra address:
PAL: 0x003c1e90

◆ UpdateEnterAnimation()

virtual void MetScreen::UpdateEnterAnimation ( float flTime)
virtual

Drive the enter animation and finish it once it passes its end.

Slot 32. The end is detected on one call and acted on the next, with mEnterDone recording the end between the two.

Parameters
flTimeThe renderer's current animation frame position.
Ghidra address:
NTSC-U/C: 0x003905f0
Ghidra address:
PAL: 0x003c1ec0

◆ OnEnterFinished()

virtual void MetScreen::OnEnterFinished ( )
virtual

Act on the enter animation having finished.

Slot 33. The body is empty. Slot 32 runs it with no argument once the enter animation has finished, in the same call that sets mAcceptsCommands, and the MetConfigControllerScreen override at 0x002069d0 does not read an argument.

Ghidra address:
NTSC-U/C: 0x0038fe50
Ghidra address:
PAL: 0x003c1720

Reimplemented in MetArenasScreen, MetConfigControllerScreen, MetEndGameGizmoScreen, MetFreqMakerButtonsScreen, MetFreqMakerInventoryScreen, MetJukeboxBaseScreen, MetJukeboxEditPlaylistScreen, MetJukeboxEditPlaylistScreenDone, MetJukeboxEditPlaylistScreenLowerLeft, MetJukeboxTopButtonsScreen, MetKeyboardScreen, MetLoadFreqScreen, MetLoadGameScreen, MetLogoScreen, MetMainScreen, MetMemCardLoadScreen, MetModeScreen, MetMsgScreen, MetMultiTipsBaseScreen, MetRemixDelScreen, MetRemixLoadScreen, MetRightGizmoScreen, MetScreenTitleScreen, MetSoloStagesScreen, MetSoloWinScreen, and MetStageFinishScreen.

◆ StartExitAnimation()

virtual void MetScreen::StartExitAnimation ( float flTime)
virtual

Record the time the exit animation starts at.

Slot 34. Clears the enter animation start time and mAcceptsCommands. The title is inferred to pair with UpdateExitAnimation().

Parameters
flTimeThe frame position the animation starts at.
Ghidra address:
NTSC-U/C: 0x003906a0
Ghidra address:
PAL: 0x003c1f70

◆ UpdateExitAnimation()

virtual void MetScreen::UpdateExitAnimation ( float flTime)
virtual

Drive the exit animation and hide the screen once it passes its end.

Slot 35. The end is detected on one call and acted on the next, through mExitDone. The screen is hidden, erased from the renderer's stack, and then slot 36 runs.

Parameters
flTimeThe renderer's current animation frame position.
Ghidra address:
NTSC-U/C: 0x003906b0
Ghidra address:
PAL: 0x003c1f80

◆ OnExitFinished()

virtual void MetScreen::OnExitFinished ( )
virtual

Act on the exit animation having finished.

Slot 36. The body is empty. Slot 35 runs it with no argument once the exit animation has finished and the screen has exited the renderer's stack. Screens override it to push the screen their exit led to, and the MetConfigControllerScreen override at 0x00201790 does not read an argument.

Ghidra address:
NTSC-U/C: 0x0038fe58
Ghidra address:
PAL: 0x003c1728

Reimplemented in MetArenasScreen, MetConfigControllerScreen, MetConfigGameOptionsScreen, MetConfigOptionsButtonsScreen, MetCreditsScreen, MetFreqCreateScreen, MetFreqMakerButtonsScreen, MetFreqMakerCanvasScreen, MetFreqMakerDirectionsScreen, MetGameSkillScreen, MetHelpScreen, MetJukeboxBaseScreen, MetJukeboxEditPlaylistScreenDone, MetJukeboxEditPlaylistScreenLowerLeft, MetJukeboxTopButtonsScreen, MetKeyboardScreen, MetLoadFreqBaseScreen, MetLocNumPlayScreen, MetLocPickCharScreen, MetLogoScreen, MetMainScreen, MetMCFreqDelScreen, MetMemCardLoadScreen, MetMemCardTypeScreen, MetModeScreen, MetMsgScreen, MetMultiEndRemixScreen, MetMultiEndScreen, MetMultiSaveRemixScreen, MetMultiStatsScreen, MetMultiTips1Screen, MetMultiTips5Screen, MetMultiTipsBaseScreen, MetPauseBaseScreen, MetPauseSoloGameScreen, MetPauseSoloRemixScreen, MetRemixDataScreen, MetRemixDelScreen, MetRemixLoadScreen, MetRemixManager, MetRemixTypeScreen, MetSaveRemixScreen, MetScreenTitleScreen, MetSoloEndRemixScreen, MetSoloLoseScreen, MetSoloStagesScreen, MetSoloWinScreen, MetSonyScreen, MetStageFinishScreen, and MetTutorialScreen.

◆ Draw()

virtual void MetScreen::Draw ( )
virtual

Draw the view.

Slot 37. Forwards to Rnd::Drawable::Draw() on the Drawable subobject of mView, at +0x18 within the view. The name is inferred from the Rnd::Drawable routine it forwards to.

Ghidra address:
NTSC-U/C: 0x00390788
Ghidra address:
PAL: 0x003c2058

◆ ResolveContainerViews()

virtual void MetScreen::ResolveContainerViews ( )
virtual

Resolve the three views the container produced and hide the screen.

Slot 38. The scene root is the object identified by mContainerName with .view appended. A container with no such object stops the machine through Fatal() with the screen s doesn't have a valid view!.

Ghidra address:
NTSC-U/C: 0x0038b1b0
Ghidra address:
PAL: 0x003bc8a8

Reimplemented in MetArenasScreen, MetConfigControllerScreen, MetConfigGameOptionsScreen, MetCreditsScreen, MetExpansionPakScreen, MetFreqCreateScreen, MetFreqMakerButtonsScreen, MetFreqMakerCanvasScreen, MetFreqMakerDirectionsScreen, MetFreqMakerInventoryScreen, MetGameSkillScreen, MetGizmoPanel, MetGlobalSettingsSaverScreen, MetHelpScreen, MetJukeboxBaseScreen, MetJukeboxCustomRemixesScreen, MetJukeboxEditPlaylistScreen, MetJukeboxEditPlaylistScreenDone, MetJukeboxEditPlaylistScreenLowerLeft, MetJukeboxFactoryRemixesScreen, MetJukeboxTopButtonsScreen, MetKeyboardScreen, MetLoadFreqBaseScreen, MetLoadGameScreen, MetLocNumPlayScreen, MetLocPickCharScreen, MetLogoScreen, MetMainScreen, MetMCFreqDelScreen, MetMemCardLoadScreen, MetMemCardTypeScreen, MetModeScreen, MetMsgScreen, MetMultiEndRemixScreen, MetMultiStatsScreen, MetMultiTips1Screen, MetMultiTips2Screen, MetMultiTips3Screen, MetMultiTips4Screen, MetMultiTips5Screen, MetPauseGameScreen, MetPauseMultiRemixScreen, MetPauseSoloGameScreen, MetPauseSoloRemixScreen, MetPersonaSaverScreen, MetRemixDataScreen, MetRemixDelScreen, MetRemixLoadScreen, MetRemixTypeScreen, MetSaveRemixScreen, MetScreenTitleScreen, MetSoloEndRemixScreen, MetSoloStagesScreen, MetSoloStatsScreen, MetSonyScreen, MetStageFinishScreen, MetTopLogoScreen, and MetTutorialScreen.

◆ DispatchPriv()

virtual void MetScreen::DispatchPriv ( Message * pMsg)
protectedvirtual

Act on a message.

The override is empty, so a screen that wants messages overrides the slot again.

Parameters
pMsgThe message.
Ghidra address:
NTSC-U/C: 0x003907a8
Ghidra address:
PAL: 0x003c2078

Implements MsgSink.

Reimplemented in MetLogoScreen, and MetMsgScreen.

◆ ResolveAnimationViews()

void MetScreen::ResolveAnimationViews ( )
protected

Resolves the two animation views from the screen name and records the enter animation's end frame.

Slot 38 and MetTopLogoScreen's slot 38 call it, which is why it is protected. The title is inferred from the two members it writes.

Ghidra address:
NTSC-U/C: 0x0038bd60
Ghidra address:
PAL: 0x003bd538

Member Data Documentation

◆ mAnimEndFrame

float MetScreen::mAnimEndFrame
protected

◆ mEnterStartTime

float MetScreen::mEnterStartTime
protected

◆ mRenderer

MetRenderer* MetScreen::mRenderer
protected

◆ mView

Rnd::View* MetScreen::mView

The container's root view.

Public because MetRenderer::RemoveScreen() at 0x00371a78 reads it directly to detach the view from the screen scene, and the image has no accessor. MetTopLogoScreen's slot 38 also resolves it itself. +0x14

◆ mExitChoice

int MetScreen::mExitChoice
protected

◆ mAcceptsCommands

int MetScreen::mAcceptsCommands
protected

◆ mEnterAnim

Rnd::View* MetScreen::mEnterAnim
protected

◆ mHelpKeys

std::vector<HxStr> MetScreen::mHelpKeys
protected

◆ mViewsUnresolved

int MetScreen::mViewsUnresolved
protected

◆ mEnterPending

int MetScreen::mEnterPending

Set when the screen was pushed before its container load finished.

UpdateFrame() selects its deferred-entry half on this field and clears it once the screen has entered. MetRenderer writes 1 through the screen pointer at 0x0036b28c, 0x0036b3cc, and 0x0037164c, each immediately after dispatching slot 14, so the access rule gives public. A friend declaration for MetRenderer fits the image equally well. +0x4c

◆ mActivatePending

int MetScreen::mActivatePending

Set when the screen was activated as a panel before its container load finished.

Written by MetRenderer at 0x0036b294, 0x0036b3d4, and 0x0037164c on the same three paths as mEnterPending, and public for the same reason. +0x50

◆ mRepeatScale

float MetScreen::mRepeatScale

Scale on the input auto-repeat interval.

The auto-repeat driver at 0x002e55f8 multiplies the field by 50.0f and truncates to an integer, so the initial 1.0f gives a 50 millisecond repeat period. That reader is neither a MetScreen nor a MetRenderer: MetRenderer stores it at its own +0x94. A single friend declaration therefore cannot cover this access and the two above, which is what settles the three as public rather than as friendship. +0x58, starts at 1.0f

◆ mPlaysCommandSounds

int MetScreen::mPlaysCommandSounds
protected

◆ mShowsLoadedDrawables

int MetScreen::mShowsLoadedDrawables
protected

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