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

Instructions panel of the FreQ maker. More...

#include <metfreqmakerdirectionsscreen.h>

Inheritance diagram for MetFreqMakerDirectionsScreen:
Collaboration diagram for MetFreqMakerDirectionsScreen:

Public Member Functions

 MetFreqMakerDirectionsScreen (MetRenderer *pRenderer, int nPriority)
 Construct the screen.
virtual ~MetFreqMakerDirectionsScreen ()
 Release the screen.
virtual void EnterAndShow ()
 Show the screen and its list entries.
virtual int PollContainerLoad ()
 Report the container load finished once the FreQ maker assets are resident as well.
virtual void PlayCycleLeftSound (int nSelector)
 Play nothing.
virtual void PlayCycleRightSound (int nSelector)
 Play nothing.
virtual void OnRepeatingSoundFinished (Rnd::Button *pButton)
 Make this screen the active panel again, through ActivateNamedPanel() with MetFreqMakerDirectionsScreen.
virtual void OnExitFinished ()
 Hide the list entries.
virtual void ResolveContainerViews ()
 Resolve the base views and build the seven-row directions list.
void ShowPage (int nPage)
 Show one directions page.
virtual int ProvideText (int nItem, int nColumn, Rnd::Text *pText, int nContext)
 Show one cell of the directions page mPage 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 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 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 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 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 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 MetFreqMakerDirectionsScreen * 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

Instructions panel of the FreQ maker.

Its RTTI descriptor is at 0x00901e90. It has two public non-virtual bases at fixed offsets, MetScreen at +0x00, and ListDataProvider at +140.

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

The four-entry ListDataProvider table at 0x007f24d8 adjusts this by -140 in every entry.

The object is 0x9c bytes, which the allocation in New() fixes.

The translation unit spans 0x00262810 to 0x0026a498. Besides the members below, it has the static initialiser at 0x00265f50, which builds the page tables and the mode names, per-unit copies of MsgSink and ListDataProvider routines, and template library emissions.

Apart from the type function and the destructor, the slots that differ from the MetScreen table are 5, 14, 23, 24, 30, 36, and 38.

Constructor & Destructor Documentation

◆ MetFreqMakerDirectionsScreen()

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

Construct the screen.

Supplies fm_directions for the screen name, metagame/persona for the directory, and freq_maker_directions for the container, clears MetScreen::mShowsLoadedDrawables, and starts at the blank page.

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

◆ ~MetFreqMakerDirectionsScreen()

virtual MetFreqMakerDirectionsScreen::~MetFreqMakerDirectionsScreen ( )
virtual

Release the screen.

The scrolling list is not deleted.

Ghidra address:
NTSC-U/C: 0x00269e68
Ghidra address:
PAL: 0x00281770

Member Function Documentation

◆ New()

MetFreqMakerDirectionsScreen * MetFreqMakerDirectionsScreen::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: 0x00269de0
Ghidra address:
PAL: 0x002816e8

◆ EnterAndShow()

virtual void MetFreqMakerDirectionsScreen::EnterAndShow ( )
virtual

Show the screen and its list entries.

Slot 5.

Ghidra address:
NTSC-U/C: 0x00269ed0
Ghidra address:
PAL: 0x002817d8

Reimplemented from MetScreen.

◆ PollContainerLoad()

virtual int MetFreqMakerDirectionsScreen::PollContainerLoad ( )
virtual

Report the container load finished once the FreQ maker assets are resident as well.

Slot 14.

Returns
Non-zero once both loads have finished.
Ghidra address:
NTSC-U/C: 0x00269fc0
Ghidra address:
PAL: 0x002818e8

Reimplemented from MetScreen.

◆ PlayCycleLeftSound()

virtual void MetFreqMakerDirectionsScreen::PlayCycleLeftSound ( int nSelector)
virtual

Play nothing.

Slot 23. The body is empty.

Parameters
nSelectorThe value the override compares against its own recorded selector.
Ghidra address:
NTSC-U/C: 0x00269dd0
Ghidra address:
PAL: 0x002816d8

Reimplemented from MetScreen.

◆ PlayCycleRightSound()

virtual void MetFreqMakerDirectionsScreen::PlayCycleRightSound ( int nSelector)
virtual

Play nothing.

Slot 24. The body is empty.

Parameters
nSelectorThe value the override compares against its own recorded selector.
Ghidra address:
NTSC-U/C: 0x00269dd8
Ghidra address:
PAL: 0x002816e0

Reimplemented from MetScreen.

◆ OnRepeatingSoundFinished()

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

Make this screen the active panel again, through ActivateNamedPanel() with MetFreqMakerDirectionsScreen.

Slot 30.

Parameters
pButtonThe button slot 29 finished with, which the body does not read.
Ghidra address:
NTSC-U/C: 0x00269f00
Ghidra address:
PAL: 0x00281808

Reimplemented from MetScreen.

◆ OnExitFinished()

virtual void MetFreqMakerDirectionsScreen::OnExitFinished ( )
virtual

Hide the list entries.

Slot 36.

Ghidra address:
NTSC-U/C: 0x00269fa0
Ghidra address:
PAL: 0x002818c8

Reimplemented from MetScreen.

◆ ResolveContainerViews()

virtual void MetFreqMakerDirectionsScreen::ResolveContainerViews ( )
virtual

Resolve the base views and build the seven-row directions list.

Slot 38. The rows are cloned from fmd_help_line_prototype.view with a pitch of 22 and no highlight or arrows, and the list is given seven items. The European release first fills the page texts with LoadPageTexts() and labels HELP.txt with the directions title.

Ghidra address:
NTSC-U/C: 0x00262998
Ghidra address:
PAL: 0x00279978

Reimplemented from MetScreen.

◆ ShowPage()

void MetFreqMakerDirectionsScreen::ShowPage ( int nPage)

Show one directions page.

The list is refreshed, the page's mode name is posted to the help screen, and the help preset becomes freq_maker_save_button on the save page, only_back_title on the full page, and standard_title otherwise. MetFreqMakerButtonsScreen's routine at 0x0025a5e0 calls it. The title is inferred. The European release looks the mode text and the preset up in the current language.

Parameters
nPageThe page, 0 through 16.
Ghidra address:
NTSC-U/C: 0x00262ad8
Ghidra address:
PAL: 0x00279c40

◆ ProvideText()

virtual int MetFreqMakerDirectionsScreen::ProvideText ( int nItem,
int nColumn,
Rnd::Text * pText,
int nContext )
virtual

Show one cell of the directions page mPage selects.

Each of pages 0 through 15 shows the string at row nItem and column nColumn of its table, and page 16 shows an empty string. The tables are file-scope arrays of seven rows of two HxStr each at 0x006a3a50 through 0x006a414f, built by the unit's static initialiser. On the save page, row 1 is a format that receives FirstCardSlotName(). A page outside the range leaves the cell as it is.

Parameters
nItemThe row.
nColumnThe column.
pTextThe cell.
nContextThe list context, which the body does not read.
Returns
Always 1.
Ghidra address:
NTSC-U/C: 0x00262c28
Ghidra address:
PAL: 0x00279e28

Implements ListDataProvider.

◆ ProvideMesh()

virtual int MetFreqMakerDirectionsScreen::ProvideMesh ( int nItem,
int nColumn,
Rnd::Mesh * pMesh,
int nContext )
virtual

Leave the cell as it is.

Parameters
nItemThe row, which the body does not read.
nColumnThe cell index, which the body does not read.
pMeshThe cell, which the body does not read.
nContextThe list context, which the body does not read.
Returns
Always 0.
Ghidra address:
NTSC-U/C: 0x0026a020
Ghidra address:
PAL: 0x00281948

Implements ListDataProvider.


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