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

Local-multiplayer screen that picks a character. More...

#include <metlocpickcharscreen.h>

Inheritance diagram for MetLocPickCharScreen:
Collaboration diagram for MetLocPickCharScreen:

Public Member Functions

 MetLocPickCharScreen (MetRenderer *pRenderer, int nPriority)
 Construct the screen.
virtual ~MetLocPickCharScreen ()
virtual void EnterAndShow ()
 Show the pickers, first refilling mPersonas when MetLocNumPlayScreen brought the screen up.
virtual void OnMsgScreenDismissed (const HxStr &name, int nChoice)
 Show the pickers once the probe's last dialogue closes, or defer to the probe.
virtual void HandleCommand (const MetScreenCommand *pCommand)
 Cycle, lock in, or release one player's character, or back out.
virtual void PlaySlideSound (int nSelector)
 Play the slide sound for a player who has not locked a character in.
virtual void PlayHighSound (int)
 Play nothing.
virtual void PlayCycleLeftSound (int nSelector)
 Play the cycle-left sound for a player who has not locked a character in.
virtual void PlayCycleRightSound (int nSelector)
 Play the cycle-right sound for a player who has not locked a character in.
virtual void UpdateIdle (float flTime)
 Count down mExitCountdown one step per frame and exit forwards when it reaches zero, then run the base.
virtual void OnExitFinished ()
 Bring up the next screen once this one has exited.
virtual void ResolveContainerViews ()
 Resolve the base views and the four players' materials, views, buttons, meshes, and burn textures, and the two controller icon materials.
virtual void StartDetect ()
 Show the multi-player detection notice, then run the base probe.
virtual void StartLoadPersonas ()
 Skip the base persona load and go straight to StartSaveSpaceCheck().
virtual void OnNoCard ()
 Offer to retry the probe or to continue without a card.
virtual void OnDetectFinished ()
 Load the personas from every formatted card, or append the saved personas and show the pickers when the front end uses no card.
virtual void OnPersonasLoaded (int nPortSlot, int nStatus)
 Record one card's personas and load the next formatted card, or close the loading notice.
Public Member Functions inherited from MetMemDetectScreen
 MetMemDetectScreen (MetRenderer *pRenderer, int nPriority, const HxStr &name, const HxStr &directory, const HxStr &file)
 Construct the detector.
virtual ~MetMemDetectScreen ()
virtual void OnAllConnectStates ()
 Load the global settings from the card in port 1, or offer to format it.
virtual void OnMinimumSaveSpace (int nPortSlot, int nSpace)
 Warn when the card in port 1 has less free space than a save needs, or show the autosave notice.
virtual void OnCardFormatted (int nPortSlot, int nStatus)
 Report the result of formatting the card in port 1.
virtual void OnGlobalSettingsLoaded (int nPortSlot, int nStatus)
 Run StartLoadPersonas().
virtual void StartSaveSpaceCheck ()
 Check the free space on the card in port 1.
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 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.
Public Member Functions inherited from MemcardUser
virtual ~MemcardUser ()
 Release the receiver.
virtual void OnConnectState (MemcardConnectState state, int nStatus)
 Report the state of one slot.
virtual void OnCardUnformatted (int nPortSlot, int nStatus)
 Report a finished unformat.
virtual void OnPersonasSaved (int nPortSlot, int nStatus)
 Report a finished save of the FreQ roster.
virtual void OnRemixSaved (int nPortSlot, int nStatus)
 Report a finished save of one remix.
virtual void OnGlobalSettingsSaved (int nPortSlot, int nStatus)
 Report a finished save of the global settings.
virtual void OnJukeboxPlayListSaved (int nPortSlot, int nStatus)
 Report a finished save of a jukebox playlist.
virtual void OnRemixesListed (int nPortSlot, int nStatus)
 Report a finished listing of the saved remixes.
virtual void OnRemixLoaded (int nPortSlot, int nStatus)
 Report a finished load of one remix.
virtual void OnJukeboxPlayListLoaded (int nPortSlot, int nStatus)
 Report a finished load of a jukebox playlist.
virtual void OnRemixDeleted (int nPortSlot, int nStatus)
 Report a finished deletion of one remix.
virtual void UnusedFirstReport (int nPortSlot, int nStatus)
 Do nothing.
virtual void UnusedSecondReport (int nPortSlot, int nStatus)
 Do nothing.
virtual void OnFileLoaded (int nStatus)
 Report a finished load of one file.
virtual void OnFileSaved (int nStatus)
 Report a finished save of one file.

Static Public Member Functions

static MetLocPickCharScreen * New (MetRenderer *pRenderer, int nPriority)
 Build the screen on the heap.
Static Public Member Functions inherited from MetMemDetectScreen
static MetMemDetectScreen * New (MetRenderer *pRenderer, int nPriority)
 Build a detector on the heap with an empty screen name, directory, and container name.
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 MetMemDetectScreen
int mPersonaLoadRequested
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

Local-multiplayer screen that picks a character.

Its RTTI descriptor is at 0x00901bf0. It has MetMemDetectScreen as its one public non-virtual base at offset 0. New() allocates 0x140 bytes. The 44-entry primary vtable is at 0x007f9a88 and the 21-entry MemcardUser table at 0x007f99d8 adjusts this by -140. The primary is the same length as the MetMemDetectScreen table, and the class declares no new virtual.

Each player cycles through mPersonas with the left and right commands and locks a character in with the select command. The list starts with the personas on every formatted card after a probe, or with the saved personas, and ends with the prefabricated identities of MetFreqMakerAssetManager. When every player has picked, the screen copies the choices into MetFrontEndState, hands them to the game manager, and exits five frames later.

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

Constructor & Destructor Documentation

◆ MetLocPickCharScreen()

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

Construct the screen.

Supplies mpc for the screen name, metagame/_Local for the directory, and character_loc for the container, and records the help text loc_pc.

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

◆ ~MetLocPickCharScreen()

virtual MetLocPickCharScreen::~MetLocPickCharScreen ( )
virtual
Ghidra address:
NTSC-U/C: 0x002b19b0
Ghidra address:
PAL: 0x002d0808

Member Function Documentation

◆ New()

MetLocPickCharScreen * MetLocPickCharScreen::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: 0x002b9e60
Ghidra address:
PAL: 0x002d96c8

◆ EnterAndShow()

virtual void MetLocPickCharScreen::EnterAndShow ( )
virtual

Show the pickers, first refilling mPersonas when MetLocNumPlayScreen brought the screen up.

Slot 5. After MetLocNumPlayScreen, a front end that uses a card runs StartDetect() instead, and one without a card appends the saved personas.

Ghidra address:
NTSC-U/C: 0x002b29e8
Ghidra address:
PAL: 0x002d1948

Reimplemented from MetScreen.

◆ OnMsgScreenDismissed()

virtual void MetLocPickCharScreen::OnMsgScreenDismissed ( const HxStr & name,
int nChoice )
virtual

Show the pickers once the probe's last dialogue closes, or defer to the probe.

Slot 15.

Parameters
nameThe message screen that was dismissed.
nChoiceThe chosen button, counted from zero.
Ghidra address:
NTSC-U/C: 0x002ba178
Ghidra address:
PAL: 0x002d98d0

Reimplemented from MetMemDetectScreen.

◆ HandleCommand()

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

Cycle, lock in, or release one player's character, or back out.

Slot 19. A command from a controller beyond mPlayerCount is ignored.

Parameters
pCommandThe command.
Ghidra address:
NTSC-U/C: 0x002b2370
Ghidra address:
PAL: 0x002d1230

Reimplemented from MetScreen.

◆ PlaySlideSound()

virtual void MetLocPickCharScreen::PlaySlideSound ( int nSelector)
virtual

Play the slide sound for a player who has not locked a character in.

Slot 20.

Parameters
nSelectorThe controller, counted from 1.
Ghidra address:
NTSC-U/C: 0x002b9fe8
Ghidra address:
PAL: 0x002d9850

Reimplemented from MetScreen.

◆ PlayHighSound()

virtual void MetLocPickCharScreen::PlayHighSound ( int )
inlinevirtual

Play nothing.

Slot 22. The body is empty.

Ghidra address:
NTSC-U/C: 0x002b9e58
Ghidra address:
PAL: 0x002d96c0

Reimplemented from MetScreen.

◆ PlayCycleLeftSound()

virtual void MetLocPickCharScreen::PlayCycleLeftSound ( int nSelector)
virtual

Play the cycle-left sound for a player who has not locked a character in.

Slot 23.

Parameters
nSelectorThe controller, counted from 1.
Ghidra address:
NTSC-U/C: 0x002b9f48
Ghidra address:
PAL: 0x002d97b0

Reimplemented from MetScreen.

◆ PlayCycleRightSound()

virtual void MetLocPickCharScreen::PlayCycleRightSound ( int nSelector)
virtual

Play the cycle-right sound for a player who has not locked a character in.

Slot 24.

Parameters
nSelectorThe controller, counted from 1.
Ghidra address:
NTSC-U/C: 0x002b9f98
Ghidra address:
PAL: 0x002d9800

Reimplemented from MetScreen.

◆ UpdateIdle()

virtual void MetLocPickCharScreen::UpdateIdle ( float flTime)
virtual

Count down mExitCountdown one step per frame and exit forwards when it reaches zero, then run the base.

Slot 26.

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

Reimplemented from MetMemDetectScreen.

◆ OnExitFinished()

virtual void MetLocPickCharScreen::OnExitFinished ( )
virtual

Bring up the next screen once this one has exited.

Slot 36. MetLeftGizmoScreen always comes up. A back command then returns to MetLocNumPlayersScreen, and a finished pick moves on to MetModeScreen.

Ghidra address:
NTSC-U/C: 0x002b3e18
Ghidra address:
PAL: 0x002d2f90

Reimplemented from MetScreen.

◆ ResolveContainerViews()

virtual void MetLocPickCharScreen::ResolveContainerViews ( )
virtual

Resolve the base views and the four players' materials, views, buttons, meshes, and burn textures, and the two controller icon materials.

Slot 38.

Ghidra address:
NTSC-U/C: 0x002b1e00
Ghidra address:
PAL: 0x002d0c58

Reimplemented from MetScreen.

◆ StartDetect()

virtual void MetLocPickCharScreen::StartDetect ( )
virtual

Show the multi-player detection notice, then run the base probe.

Slot 39. The notice receives MetFrontEndState::mPlayerCount.

Ghidra address:
NTSC-U/C: 0x002b4068
Ghidra address:
PAL: 0x002d3268

Reimplemented from MetMemDetectScreen.

◆ StartLoadPersonas()

virtual void MetLocPickCharScreen::StartLoadPersonas ( )
virtual

Skip the base persona load and go straight to StartSaveSpaceCheck().

Slot 40. Sets mPersonaLoadRequested as the base does.

Ghidra address:
NTSC-U/C: 0x002ba148
Ghidra address:
PAL: 0x002d98a0

Reimplemented from MetMemDetectScreen.

◆ OnNoCard()

virtual void MetLocPickCharScreen::OnNoCard ( )
virtual

Offer to retry the probe or to continue without a card.

Slot 41. Raises mem_check.

Ghidra address:
NTSC-U/C: 0x002b4378
Ghidra address:
PAL: 0x002d35f0

Reimplemented from MetMemDetectScreen.

◆ OnDetectFinished()

virtual void MetLocPickCharScreen::OnDetectFinished ( )
virtual

Load the personas from every formatted card, or append the saved personas and show the pickers when the front end uses no card.

Slot 42. With a card but none formatted, the screen closes the message screen and shows the pickers when the dismissal arrives.

Ghidra address:
NTSC-U/C: 0x002b4738
Ghidra address:
PAL: 0x002d3a40

Reimplemented from MetMemDetectScreen.

◆ OnPersonasLoaded()

virtual void MetLocPickCharScreen::OnPersonasLoaded ( int nPortSlot,
int nStatus )
virtual

Record one card's personas and load the next formatted card, or close the loading notice.

MemcardUser slot 13. mCardPersonaStarts receives the size of mPersonas after the card, or -1 when the load failed. The European release shows the loading notice again, with the next card's name, before loading the next card.

Parameters
nPortSlotThe card the personas came from. The body does not read it.
nStatusThe result, 0 on success.
Ghidra address:
NTSC-U/C: 0x002b4ff0
Ghidra address:
PAL: 0x002d4398

Reimplemented from MetMemDetectScreen.


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