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

Panel that draws the game logo and waits for the player to start. More...

#include <metlogoscreen.h>

Inheritance diagram for MetLogoScreen:
Collaboration diagram for MetLogoScreen:

Public Member Functions

 MetLogoScreen (MetRenderer *pRenderer, int nPriority)
 Construct the screen.
virtual ~MetLogoScreen ()
 Release the screen.
virtual void EnterAndShow ()
 Enter, and show the four legal texts.
virtual void HandleCommand (const MetScreenCommand *pCommand)
 Start the game on the select command or command 10.
virtual void PlaySlideSound (int)
 Play nothing.
virtual void PlayLeaveSound (int)
 Play nothing.
virtual void PlayHighSound (int)
 Play nothing.
virtual void PlayCycleLeftSound (int)
 Play nothing.
virtual void PlayCycleRightSound (int)
 Play nothing.
virtual void UpdateIdle (float flTime)
 Track the idle time for the attract mode, then blink the start text and play the wave.
virtual void UpdateIdleAnimation (float flTime)
 Blink the start text and play the wave.
virtual void OnEnterFinished ()
 Start the idle count and the blink, and play SND_MET_FREQUENCY, once the enter animation has finished.
virtual void OnExitFinished ()
 Bring up the attract mode or the main menu once the screen has exited, and hide the legal texts.
virtual void ResolveContainerViews ()
 Resolve the animation views, the container view, the start text, the wave view, the version text, and the four legal texts, and hide the screen.
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 PlayErrorSound (int nSelector)
 Play the sound that accompanies a rejected input.
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.

Static Public Member Functions

static MetLogoScreen * 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.

Protected Member Functions

virtual void DispatchPriv (Message *pMsg)
 Record an unlock of the stages.
Protected Member Functions inherited from MetScreen
void ResolveAnimationViews ()
 Resolves the two animation views from the screen name and records the enter animation's end frame.

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 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

Panel that draws the game logo and waits for the player to start.

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

The 39-entry primary vtable is at 0x007fa208, the same length as the MetScreen table, and the class declares no new virtual. It and MetMsgScreen are the only two classes that override slot 3 with a body rather than inheriting the empty MetScreen override. It is also the only class that overrides slot 27.

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

The screen blinks start text.txt every 120 frames and plays wave.view. The select command moves on to MetMainScreen. When the configuration enables it, the screen also counts the time since the last controller press and, once the configured delay passes, exits to the attract mode run by MetLoadGameScreen.

The translation unit spans 0x002ba4a0 to 0x002be968. Besides the members below, it has the type function at 0x002be318, a per-unit copy of MsgSink::HandleDefault, and template library emissions.

The European release adds FadeUser as a second base at +0x8c. Every member before mLastActivityNs sits 4 bytes later, and mFade follows at +0xc0. The object is 0xc8 bytes. An exit with MetScreen::mExitChoice at 0 fades the screen in over 360 frames and removes it from the renderer when the fade finishes.

Constructor & Destructor Documentation

◆ MetLogoScreen()

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

Construct the screen.

Supplies fl for the screen name, metagame/Shared for the directory, and freq_logo_panel for the container, reads the attract delay from configuration code 0x26c, and clears MetScreen::mShowsLoadedDrawables. The European release then builds mFade.

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

◆ ~MetLogoScreen()

virtual MetLogoScreen::~MetLogoScreen ( )
virtual

Release the screen.

The European release first releases mFade without a null test.

Ghidra address:
NTSC-U/C: 0x002be418
Ghidra address:
PAL: 0x002da698

Member Function Documentation

◆ New()

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

Build the screen on the heap.

MetScreen::CreateStartupScreens() registers this factory.

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

◆ EnterAndShow()

virtual void MetLogoScreen::EnterAndShow ( )
virtual

Enter, and show the four legal texts.

Slot 5.

Ghidra address:
NTSC-U/C: 0x002be540
Ghidra address:
PAL: 0x002de248

Reimplemented from MetScreen.

◆ HandleCommand()

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

Start the game on the select command or command 10.

Slot 19. Plays SND_MET_SLIDE, clears MetRenderer::mTitlePromptShowing and the blink, and exits. The European release also sets MetScreen::mExitChoice to 2.

Parameters
pCommandThe command.
Ghidra address:
NTSC-U/C: 0x002be4d8
Ghidra address:
PAL: 0x002de1c0

Reimplemented from MetScreen.

◆ PlaySlideSound()

virtual void MetLogoScreen::PlaySlideSound ( int )
inlinevirtual

Play nothing.

Slot 20. The body is empty.

Ghidra address:
NTSC-U/C: 0x002be368
Ghidra address:
PAL: 0x002de108

Reimplemented from MetScreen.

◆ PlayLeaveSound()

virtual void MetLogoScreen::PlayLeaveSound ( int )
inlinevirtual

Play nothing.

Slot 21. The body is empty.

Ghidra address:
NTSC-U/C: 0x002be370
Ghidra address:
PAL: 0x002de110

Reimplemented from MetScreen.

◆ PlayHighSound()

virtual void MetLogoScreen::PlayHighSound ( int )
inlinevirtual

Play nothing.

Slot 22. The body is empty.

Ghidra address:
NTSC-U/C: 0x002be378
Ghidra address:
PAL: 0x002de118

Reimplemented from MetScreen.

◆ PlayCycleLeftSound()

virtual void MetLogoScreen::PlayCycleLeftSound ( int )
inlinevirtual

Play nothing.

Slot 23. The body is empty.

Ghidra address:
NTSC-U/C: 0x002be380
Ghidra address:
PAL: 0x002de120

Reimplemented from MetScreen.

◆ PlayCycleRightSound()

virtual void MetLogoScreen::PlayCycleRightSound ( int )
inlinevirtual

Play nothing.

Slot 24. The body is empty.

Ghidra address:
NTSC-U/C: 0x002be388
Ghidra address:
PAL: 0x002de128

Reimplemented from MetScreen.

◆ UpdateIdle()

virtual void MetLogoScreen::UpdateIdle ( float flTime)
virtual

Track the idle time for the attract mode, then blink the start text and play the wave.

Slot 26. A controller press in the last poll restarts the idle count. Otherwise, when the attract mode is enabled and has not started, the screen exits once the idle time passes the configured delay. The European release then advances mFade.

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

Reimplemented from MetScreen.

◆ UpdateIdleAnimation()

virtual void MetLogoScreen::UpdateIdleAnimation ( float flTime)
virtual

Blink the start text and play the wave.

Slot 27.

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

Reimplemented from MetScreen.

◆ OnEnterFinished()

virtual void MetLogoScreen::OnEnterFinished ( )
virtual

Start the idle count and the blink, and play SND_MET_FREQUENCY, once the enter animation has finished.

Slot 33. Reads whether the attract mode is enabled from configuration code 0x26b and sets MetRenderer::mTitlePromptShowing.

Ghidra address:
NTSC-U/C: 0x002bae40
Ghidra address:
PAL: 0x002da988

Reimplemented from MetScreen.

◆ OnExitFinished()

virtual void MetLogoScreen::OnExitFinished ( )
virtual

Bring up the attract mode or the main menu once the screen has exited, and hide the legal texts.

Slot 36. In the European release the main menu needs MetScreen::mExitChoice at 2. At 0 the screen fades in through mFade and adds itself to the renderer, and any other value only hides the legal texts.

Ghidra address:
NTSC-U/C: 0x002baf20
Ghidra address:
PAL: 0x002daa68

Reimplemented from MetScreen.

◆ ResolveContainerViews()

virtual void MetLogoScreen::ResolveContainerViews ( )
virtual

Resolve the animation views, the container view, the start text, the wave view, the version text, and the four legal texts, and hide the screen.

Slot 38. The base slot does not run, and the screen resolves MetScreen::mView itself. The European release sets the start text and the four legal texts to their texts in the current language.

Ghidra address:
NTSC-U/C: 0x002ba6d0
Ghidra address:
PAL: 0x002d9f00

Reimplemented from MetScreen.

◆ DispatchPriv()

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

Record an unlock of the stages.

Slot 3. A MetUnlockStagesMsg plays the activate sound and sets MetFrontEndState::mUnlockAll. Every other message is ignored.

Parameters
pMsgThe message.
Ghidra address:
NTSC-U/C: 0x002be6a0
Ghidra address:
PAL: 0x002de3c8

Reimplemented from MetScreen.


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