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

Screen that picks the game mode. More...

#include <metmodescreen.h>

Inheritance diagram for MetModeScreen:
Collaboration diagram for MetModeScreen:

Public Member Functions

 MetModeScreen (MetRenderer *pRenderer, int nPriority)
 Construct the screen.
virtual ~MetModeScreen ()
 Delete the button list.
virtual void EnterAndShow ()
 Select the button that matches the current play mode, fill the help prompts for a solo or a multiplayer session, set the title, and enter the screen.
virtual void HandleCommand (const MetScreenCommand *pCommand)
 Act on one navigation command.
virtual void PlayCycleLeftSound (int nSelector)
 Silence the cycle-left sound.
virtual void PlayCycleRightSound (int nSelector)
 Silence the cycle-right sound.
virtual void OnRepeatingSoundFinished (Rnd::Button *pButton)
 Leave the screen once a button's alternation finishes.
virtual void OnEnterFinished ()
 Refresh the help prompt for the selected button.
virtual void OnExitFinished ()
 Go on to the next screen once the exit finishes.
virtual void ResolveContainerViews ()
 Resolve the container's views, then add the game and jam 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 SetShowing (int nShowing)
 Show or hide the view and every drawable the container loaded.
virtual void BeginContainerLoad (const HxStr &directory, const HxStr &file)
 Intern a container load under this screen's container name and enqueue it.
virtual void PlaySlideSound (int nSelector)
 Play the sound that accompanies sliding between screens.
virtual void PlayLeaveSound (int nSelector)
 Play the sound that accompanies departing a screen.
virtual void PlayHighSound (int nSelector)
 Play the sound that accompanies the emphasised selection.
virtual void 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 MetModeScreen * 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

Screen that picks the game mode.

Its RTTI descriptor is at 0x008f00f0. It has MetScreen as its one public non-virtual base at offset 0.

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

The constructor at 0x002e72c0 takes only the renderer and the load priority, and supplies smm for the screen name, metagame/Shared for the directory, and sm_mode for the container. It writes only +0x8c, into which it allocates a MetButtonList.

The object is 0x90 bytes, the size New() allocates.

The screen offers two buttons, the game and the jam. Selecting one sets the play mode and goes on to the skill screen or the remix type screen. Backing out returns to the character picker in a local multiplayer session, or to the freq or prefab loader in a solo one.

Apart from the type function and the destructor, the slots that differ from the MetScreen table are 5 0x002e79b8, 19 0x002e7628, 23 0x002eb808, 24 0x002eb810, 30 0x002eb958, 33 0x002eb920, 36 0x002e8008, 38 0x002e7490.

Constructor & Destructor Documentation

◆ MetModeScreen()

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

Construct the screen.

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

◆ ~MetModeScreen()

virtual MetModeScreen::~MetModeScreen ( )
virtual

Delete the button list.

Ghidra address:
NTSC-U/C: 0x002eb8a0
Ghidra address:
PAL: 0x0030eda8

Member Function Documentation

◆ New()

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

Build the screen on the heap.

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

◆ EnterAndShow()

virtual void MetModeScreen::EnterAndShow ( )
virtual

Select the button that matches the current play mode, fill the help prompts for a solo or a multiplayer session, set the title, and enter the screen.

Slot 5.

Ghidra address:
NTSC-U/C: 0x002e79b8
Ghidra address:
PAL: 0x0030ab70

Reimplemented from MetScreen.

◆ HandleCommand()

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

Act on one navigation command.

Slot 19. Previous and next walk the button ring and refresh the help prompt. Select clears the panel and the prompt and starts the selected button's alternation. Back clears the prompt and the panel, clears mExitChoice, exits the title and left gizmo screens, and begins the exit.

Parameters
pCommandThe command.
Ghidra address:
NTSC-U/C: 0x002e7628
Ghidra address:
PAL: 0x0030a728

Reimplemented from MetScreen.

◆ PlayCycleLeftSound()

virtual void MetModeScreen::PlayCycleLeftSound ( int nSelector)
virtual

Silence the cycle-left sound.

Parameters
nSelectorNot read.
Ghidra address:
NTSC-U/C: 0x002eb808
Ghidra address:
PAL: 0x0030ed10

Reimplemented from MetScreen.

◆ PlayCycleRightSound()

virtual void MetModeScreen::PlayCycleRightSound ( int nSelector)
virtual

Silence the cycle-right sound.

Parameters
nSelectorNot read.
Ghidra address:
NTSC-U/C: 0x002eb810
Ghidra address:
PAL: 0x0030ed18

Reimplemented from MetScreen.

◆ OnRepeatingSoundFinished()

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

Leave the screen once a button's alternation finishes.

Slot 30. Stores 2 in mExitChoice, exits the title screen, and begins the exit.

Parameters
pButtonThe button that finished. Not read.
Ghidra address:
NTSC-U/C: 0x002eb958
Ghidra address:
PAL: 0x0030ee60

Reimplemented from MetScreen.

◆ OnEnterFinished()

virtual void MetModeScreen::OnEnterFinished ( )
virtual

Refresh the help prompt for the selected button.

Slot 33.

Ghidra address:
NTSC-U/C: 0x002eb920
Ghidra address:
PAL: 0x0030ee28

Reimplemented from MetScreen.

◆ OnExitFinished()

virtual void MetModeScreen::OnExitFinished ( )
virtual

Go on to the next screen once the exit finishes.

Slot 36. A select, recorded by a non-zero mExitChoice, goes through GoToSelectedMode(). A back returns to the screen the game mode calls for.

Ghidra address:
NTSC-U/C: 0x002e8008
Ghidra address:
PAL: 0x0030b2f8

Reimplemented from MetScreen.

◆ ResolveContainerViews()

virtual void MetModeScreen::ResolveContainerViews ( )
virtual

Resolve the container's views, then add the game and jam buttons.

Slot 38.

Ghidra address:
NTSC-U/C: 0x002e7490
Ghidra address:
PAL: 0x0030a520

Reimplemented from MetScreen.


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