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

Credits roll. More...

#include <metcreditsscreen.h>

Inheritance diagram for MetCreditsScreen:
Collaboration diagram for MetCreditsScreen:

Public Member Functions

 MetCreditsScreen (MetRenderer *pRenderer, int nPriority)
 Construct the screen.
virtual ~MetCreditsScreen ()
virtual void EnterAndShow ()
 Rewind the roll, show the screen, and complete the entry at once.
virtual void HandleCommand (const MetScreenCommand *pCommand)
 Begin the exit on the back command.
virtual void PlaySlideSound (int nSelector)
 Play nothing.
virtual void PlayHighSound (int nSelector)
 Play nothing.
virtual void PlayCycleLeftSound (int nSelector)
 Play nothing.
virtual void PlayCycleRightSound (int nSelector)
 Play nothing.
virtual void UpdateIdle (float flTime)
 Advance the animation and the roll.
virtual void OnExitFinished ()
 Hide every credit and return to the options screens.
virtual void ResolveContainerViews ()
 Resolve the view, the animation, and the camera, and build the roll.
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 PlayLeaveSound (int nSelector)
 Play the sound that accompanies departing a screen.
virtual void PlayErrorSound (int nSelector)
 Play the sound that accompanies a rejected input.
virtual void UpdateIdleAnimation (float flTime)
 Advance whatever the screen animates while it is neither entering nor exiting.
virtual void StartRepeatingSound (float flStartTime, float flInterval, Rnd::Button *pButton, int nCycles)
 Start alternating one button between its states 2 and 1.
virtual void UpdateRepeatingSound (float flTime)
 Advance the alternation that StartRepeatingSound() started.
virtual void OnRepeatingSoundFinished (Rnd::Button *pButton)
 Act on the alternation that StartRepeatingSound() started having finished.
virtual void StartEnterAnimation (float flTime)
 Rewind the enter animation and record the time it starts at.
virtual void UpdateEnterAnimation (float flTime)
 Drive the enter animation and finish it once it passes its end.
virtual void 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.

Static Public Member Functions

static MetCreditsScreen * 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

Credits roll.

Its RTTI descriptor is at 0x008ef890. It has MetScreen as its one public non-virtual base at offset 0. New() allocates 0x9c bytes. The 39-entry primary vtable is at 0x007eb4d0, the same length as the MetScreen table, and the class declares no new virtual.

The screen plays the Group_credit.tnm animation from the moment it enters and drives the CreditsRoll along with it. The screen exits 100 frames after the animation's end, or when the back command arrives.

Apart from the type function and the destructor, the slots that differ from the MetScreen table are 5 0x00214e70, 19 0x00214f68, 20 0x00214d58, 22 0x00214d60, 23 0x00214d68, 24 0x00214d70, 26 0x00214ee0, 36 0x00211e40, and 38 0x00211ae8.

Constructor & Destructor Documentation

◆ MetCreditsScreen()

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

Construct the screen.

The screen name is cred, the directory metagame/Shared, and the container credit. MetScreen::mShowsLoadedDrawables is cleared.

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

◆ ~MetCreditsScreen()

virtual MetCreditsScreen::~MetCreditsScreen ( )
virtual
Ghidra address:
NTSC-U/C: 0x00214e00
Ghidra address:
PAL: 0x0021e9e8

Member Function Documentation

◆ New()

MetCreditsScreen * MetCreditsScreen::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: 0x00214d78
Ghidra address:
PAL: 0x0021e960

◆ EnterAndShow()

virtual void MetCreditsScreen::EnterAndShow ( )
virtual

Rewind the roll, show the screen, and complete the entry at once.

There is no enter animation. The fields MetScreen::UpdateEnterAnimation() sets on completion are set directly, the renderer time is recorded as the animation start, and slot 33 runs.

Ghidra address:
NTSC-U/C: 0x00214e70
Ghidra address:
PAL: 0x0021ea58

Reimplemented from MetScreen.

◆ HandleCommand()

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

Begin the exit on the back command.

Every other command is ignored.

Parameters
pCommandThe command.
Ghidra address:
NTSC-U/C: 0x00214f68
Ghidra address:
PAL: 0x0021eb50

Reimplemented from MetScreen.

◆ PlaySlideSound()

virtual void MetCreditsScreen::PlaySlideSound ( int nSelector)
virtual

Play nothing.

Parameters
nSelectorNot read.
Ghidra address:
NTSC-U/C: 0x00214d58
Ghidra address:
PAL: 0x0021e940

Reimplemented from MetScreen.

◆ PlayHighSound()

virtual void MetCreditsScreen::PlayHighSound ( int nSelector)
virtual

Play nothing.

Parameters
nSelectorNot read.
Ghidra address:
NTSC-U/C: 0x00214d60
Ghidra address:
PAL: 0x0021e948

Reimplemented from MetScreen.

◆ PlayCycleLeftSound()

virtual void MetCreditsScreen::PlayCycleLeftSound ( int nSelector)
virtual

Play nothing.

Parameters
nSelectorNot read.
Ghidra address:
NTSC-U/C: 0x00214d68
Ghidra address:
PAL: 0x0021e950

Reimplemented from MetScreen.

◆ PlayCycleRightSound()

virtual void MetCreditsScreen::PlayCycleRightSound ( int nSelector)
virtual

Play nothing.

Parameters
nSelectorNot read.
Ghidra address:
NTSC-U/C: 0x00214d70
Ghidra address:
PAL: 0x0021e958

Reimplemented from MetScreen.

◆ UpdateIdle()

virtual void MetCreditsScreen::UpdateIdle ( float flTime)
virtual

Advance the animation and the roll.

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

Reimplemented from MetScreen.

◆ OnExitFinished()

virtual void MetCreditsScreen::OnExitFinished ( )
virtual

Hide every credit and return to the options screens.

Ghidra address:
NTSC-U/C: 0x00211e40
Ghidra address:
PAL: 0x0021b910

Reimplemented from MetScreen.

◆ ResolveContainerViews()

virtual void MetCreditsScreen::ResolveContainerViews ( )
virtual

Resolve the view, the animation, and the camera, and build the roll.

An inline expansion of MetScreen::ResolveContainerViews() for the fixed view name credit.view, without the null test, the diagnostic, or the call to hide the screen.

Ghidra address:
NTSC-U/C: 0x00211ae8
Ghidra address:
PAL: 0x0021b520

Reimplemented from MetScreen.


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