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

Transition screen shown while a game loads. More...

#include <metloadgamescreen.h>

Inheritance diagram for MetLoadGameScreen:
Collaboration diagram for MetLoadGameScreen:

Public Member Functions

 MetLoadGameScreen (MetRenderer *pRenderer, int nPriority)
 Construct the screen.
virtual ~MetLoadGameScreen ()
virtual void EnterAndShow ()
 Show the loading captions and start the enter animation.
virtual void UpdateIdle (float flTime)
 Wait for the music to fade, then load the level and fade in.
virtual void OnEnterFinished ()
 Start fading the music and arm the wait.
virtual void ResolveContainerViews ()
 Resolve event.txt into mpEvent.
virtual void AssignBurnSlots ()
 Assign the burn slots of the players about to play.
virtual void OnFadeInDone ()
 Start the game once the fade out has finished.
virtual void OnFadeOutDone ()
 Do nothing in the North American release, and run LLEnter() in the European release.
virtual void PlaySlideSound (int)
 Silence the slide sound.
virtual void PlayLeaveSound (int)
 Silence the leave sound.
virtual void PlayHighSound (int)
 Silence the high sound.
virtual void PlayCycleLeftSound (int)
 Silence the cycle-left sound.
virtual void PlayCycleRightSound (int)
 Silence the cycle-right sound.
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 HandleCommand (const MetScreenCommand *pCommand)
 Act on a navigation command.
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 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.
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 FadeUser
virtual ~FadeUser ()

Static Public Member Functions

static MetScreen * New (MetRenderer *pRenderer, int nPriority)
 Produce a load 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.

Public Attributes

int mDemoPlayback
 Set while the screen loads the attract-mode demo rather than a played level.
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.

Additional Inherited Members

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

Transition screen shown while a game loads.

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

The 40-entry primary vtable is at 0x007f5f18, one entry longer than the MetScreen table, so the class declares one virtual of its own, at slot 39.

The four-entry FadeUser table at 0x007f5ef0 adjusts this by -140 in every entry.

The constructor at 0x0028d2c8 takes only the renderer and the load priority. It supplies the empty string at 0x007f5ca8 for the screen name, metagame/Transition for the directory, and loadgame for the container. The empty screen name makes the two animation views resolve as _EE.anim and _BF.anim with nothing before the underscore, which MetMemDetectStartup also does. It zeroes +0x94 through +0xa8, the pair at +0xa0 in one 8-byte store, and then builds mFade.

It declares one new virtual at slot 39, AssignBurnSlots() at 0x0028e158.

The object is 0xb0 bytes, the size New() requests. The last member, mFade, ends at +0xac, and the eight-byte mDeadlineNs gives the class eight-byte alignment.

The destructor at 0x00291a50 releases mFade and then runs the MetScreen destructor. MetFade has no destructor of its own, which is why the release is a bare deallocator call with no null test.

Apart from the type function and the destructor, the slots that differ from the MetScreen table are 5 0x0028d590, 20 0x00291620, 21 0x00291628, 22 0x00291630, 23 0x00291638, 24 0x00291640, 26 0x0028dd38, 33 0x0028dc60, 38 0x0028d4c0, 39 0x0028e158.

Constructor & Destructor Documentation

◆ MetLoadGameScreen()

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

Construct the screen.

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

◆ ~MetLoadGameScreen()

virtual MetLoadGameScreen::~MetLoadGameScreen ( )
virtual
Ghidra address:
NTSC-U/C: 0x00291a50
Ghidra address:
PAL: 0x002ad968

Member Function Documentation

◆ New()

MetScreen * MetLoadGameScreen::New ( MetRenderer * pRenderer,
int nPriority )
static

Produce a load screen on the heap.

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

◆ EnterAndShow()

virtual void MetLoadGameScreen::EnterAndShow ( )
virtual

Show the loading captions and start the enter animation.

Slot 5. Runs LLEnter(). The European release has the body as a separate routine, and the North American release has the body inline.

Ghidra address:
NTSC-U/C: 0x0028d590
Ghidra address:
PAL: 0x002ad9e8

Reimplemented from MetScreen.

◆ UpdateIdle()

virtual void MetLoadGameScreen::UpdateIdle ( float flTime)
virtual

Wait for the music to fade, then load the level and fade in.

Slot 26. Once mWaiting is set and the watchdog time passes mDeadlineNs, the common loads start. An attract run fades in at once. Otherwise the level loads for a net, tutorial, or other game, and polling starts. While polling, the fade in starts once the common and level loads both report done. The fade advances on every call.

Parameters
flTimeThe current renderer time.
Ghidra address:
NTSC-U/C: 0x0028dd38
Ghidra address:
PAL: 0x002a9b28

Reimplemented from MetScreen.

◆ OnEnterFinished()

virtual void MetLoadGameScreen::OnEnterFinished ( )
virtual

Start fading the music and arm the wait.

Slot 33. The music fades over two seconds, and mDeadlineNs is set 2.1 seconds past the watchdog time.

Ghidra address:
NTSC-U/C: 0x0028dc60
Ghidra address:
PAL: 0x002a9a50

Reimplemented from MetScreen.

◆ ResolveContainerViews()

virtual void MetLoadGameScreen::ResolveContainerViews ( )
virtual

Resolve event.txt into mpEvent.

Slot 38. Runs MetScreen::ResolveContainerViews() first.

Ghidra address:
NTSC-U/C: 0x0028d4c0
Ghidra address:
PAL: 0x002a9180

Reimplemented from MetScreen.

◆ AssignBurnSlots()

virtual void MetLoadGameScreen::AssignBurnSlots ( )
virtual

Assign the burn slots of the players about to play.

Slot 39, the one virtual this class declares. The game manager's personas take slots in order. An attract run instead picks one prefabricated identity at random, gives it slot 0, and makes it the game manager's only persona. The title is inferred.

Ghidra address:
NTSC-U/C: 0x0028e158
Ghidra address:
PAL: 0x002a9fb8

◆ OnFadeInDone()

virtual void MetLoadGameScreen::OnFadeInDone ( )
virtual

Start the game once the fade out has finished.

FadeUser slot. Clears the background scene, queues a GameManagerDoPlaybackMsg for an attract run and a BeginGameLocalMsg otherwise, removes this screen from the renderer, clears MetFrontEndState::mSettingsDirty, and clears the display to black.

Ghidra address:
NTSC-U/C: 0x0028e018
Ghidra address:
PAL: 0x002a9e78

Implements FadeUser.

◆ OnFadeOutDone()

virtual void MetLoadGameScreen::OnFadeOutDone ( )
virtual

Do nothing in the North American release, and run LLEnter() in the European release.

FadeUser slot. The North American body is empty.

Ghidra address:
NTSC-U/C: 0x00291b80
Ghidra address:
PAL: 0x002adab8

Implements FadeUser.

◆ PlaySlideSound()

virtual void MetLoadGameScreen::PlaySlideSound ( int )
inlinevirtual

Silence the slide sound.

Every one of the five overrides below is a two-instruction stub, so each was written inline with an empty body. A transition screen plays no navigation sound.

Ghidra address:
NTSC-U/C: 0x00291620
Ghidra address:
PAL: 0x002ad518

Reimplemented from MetScreen.

◆ PlayLeaveSound()

virtual void MetLoadGameScreen::PlayLeaveSound ( int )
inlinevirtual

Silence the leave sound.

Ghidra address:
NTSC-U/C: 0x00291628
Ghidra address:
PAL: 0x002ad520

Reimplemented from MetScreen.

◆ PlayHighSound()

virtual void MetLoadGameScreen::PlayHighSound ( int )
inlinevirtual

Silence the high sound.

Ghidra address:
NTSC-U/C: 0x00291630
Ghidra address:
PAL: 0x002ad528

Reimplemented from MetScreen.

◆ PlayCycleLeftSound()

virtual void MetLoadGameScreen::PlayCycleLeftSound ( int )
inlinevirtual

Silence the cycle-left sound.

Ghidra address:
NTSC-U/C: 0x00291638
Ghidra address:
PAL: 0x002ad530

Reimplemented from MetScreen.

◆ PlayCycleRightSound()

virtual void MetLoadGameScreen::PlayCycleRightSound ( int )
inlinevirtual

Silence the cycle-right sound.

Ghidra address:
NTSC-U/C: 0x00291640
Ghidra address:
PAL: 0x002ad538

Reimplemented from MetScreen.

Member Data Documentation

◆ mDemoPlayback

int MetLoadGameScreen::mDemoPlayback

Set while the screen loads the attract-mode demo rather than a played level.

Written 1 by MetLogoScreen's slot 36 at 0x002baf20 before it pushes this screen for the attract mode, and cleared by OnFadeInDone() once the playback message is queued. Public because that write goes through the screen pointer directly. +0x9c


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