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

Screen that picks the number of local players. More...

#include <metlocnumplayscreen.h>

Inheritance diagram for MetLocNumPlayScreen:
Collaboration diagram for MetLocNumPlayScreen:

Public Member Functions

 MetLocNumPlayScreen (MetRenderer *pRenderer, int nPriority)
 Construct the screen.
virtual ~MetLocNumPlayScreen ()
virtual void EnterAndShow ()
 Show the choice last made and start the enter animation.
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)
 Depart once the selected button has finished alternating.
virtual void OnExitFinished ()
 Go on to the screen the exit chose.
virtual void ResolveContainerViews ()
 Build the four 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 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 MetLocNumPlayScreen * 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 number of local players.

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

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

The constructor at 0x002ad7e8 takes only the renderer and the load priority, and supplies mnp for the screen name, metagame/_Local for the directory, and num_players for the container. It writes only +0x8c, into which it allocates a MetButtonList.

It pushes four object names into the container object-name vector that MetScreen owns, loc_2p, loc_3p, loc_4p, and multi_tips. Its own registry key is the literal MetLocNumPlayersScreen, which differs from the class name by three letters, and the five MetMultiTips screens use that literal at both ends of their ring.

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

The destructor is at 0x002b1008.

Apart from the type function and the destructor, the slots that differ from the MetScreen table are 5 0x002ae218, 19 0x002adef0, 23 0x002b0f70, 24 0x002b0f78, 30 0x002ae350, 36 0x002ae4f0, 38 0x002adbf0.

Constructor & Destructor Documentation

◆ MetLocNumPlayScreen()

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

Construct the screen.

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

◆ ~MetLocNumPlayScreen()

virtual MetLocNumPlayScreen::~MetLocNumPlayScreen ( )
virtual
Ghidra address:
NTSC-U/C: 0x002b1008
Ghidra address:
PAL: 0x002cfdd0

Member Function Documentation

◆ New()

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

Build the screen on the heap.

The object is allocated with the tag MsgSink. MetScreen::CreateFrontEndScreens() is the one caller.

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

◆ EnterAndShow()

virtual void MetLocNumPlayScreen::EnterAndShow ( )
virtual

Show the choice last made and start the enter animation.

Slot 5. The title is m_num_p, the renderer accepts four controllers, and the button for MetFrontEndState::mPlayerCount players is selected, the first when the recorded count is outside two through four. The prompt layout is standard_title and the help text follows the selection.

Ghidra address:
NTSC-U/C: 0x002ae218
Ghidra address:
PAL: 0x002ccd70

Reimplemented from MetScreen.

◆ HandleCommand()

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

Act on one navigation command.

Slot 19. Previous and next move the selection and its help text. Select plays the button alternation. Back departs to the main menu with the left gizmo and title screens.

Parameters
pCommandThe command.
Ghidra address:
NTSC-U/C: 0x002adef0
Ghidra address:
PAL: 0x002cc9b0

Reimplemented from MetScreen.

◆ PlayCycleLeftSound()

virtual void MetLocNumPlayScreen::PlayCycleLeftSound ( int nSelector)
virtual

Silence the cycle-left sound.

Parameters
nSelectorNot read. The body is empty.
Ghidra address:
NTSC-U/C: 0x002b0f70
Ghidra address:
PAL: 0x002cfd38

Reimplemented from MetScreen.

◆ PlayCycleRightSound()

virtual void MetLocNumPlayScreen::PlayCycleRightSound ( int nSelector)
virtual

Silence the cycle-right sound.

Parameters
nSelectorNot read. The body is empty.
Ghidra address:
NTSC-U/C: 0x002b0f78
Ghidra address:
PAL: 0x002cfd40

Reimplemented from MetScreen.

◆ OnRepeatingSoundFinished()

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

Depart once the selected button has finished alternating.

Slot 30. Records the exit as a choice and departs with the left gizmo, title, and help screens.

Parameters
pButtonThe button that alternated, ignored.
Ghidra address:
NTSC-U/C: 0x002ae350
Ghidra address:
PAL: 0x002ccee0

Reimplemented from MetScreen.

◆ OnExitFinished()

virtual void MetLocNumPlayScreen::OnExitFinished ( )
virtual

Go on to the screen the exit chose.

Slot 36. Back returns to the main menu. A player count records itself in MetFrontEndState::mPlayerCount and the renderer's controller limit and goes on to MetLocPickCharScreen. The tips button goes on to MetMultiTips1Screen.

Ghidra address:
NTSC-U/C: 0x002ae4f0
Ghidra address:
PAL: 0x002cd0e0

Reimplemented from MetScreen.

◆ ResolveContainerViews()

virtual void MetLocNumPlayScreen::ResolveContainerViews ( )
virtual

Build the four buttons.

Slot 38. Runs MetScreen::ResolveContainerViews() first, then appends 2player.but, 3player.but, 4player.but, and mnp_info.but with the labels loc_2p, loc_3p, loc_4p, and multi_tips.

Ghidra address:
NTSC-U/C: 0x002adbf0
Ghidra address:
PAL: 0x002cc5f0

Reimplemented from MetScreen.


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