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

Dialogue that writes a multiplayer remix to a memory card. More...

#include <metmultisaveremixscreen.h>

Inheritance diagram for MetMultiSaveRemixScreen:
Collaboration diagram for MetMultiSaveRemixScreen:

Public Member Functions

 MetMultiSaveRemixScreen (MetRenderer *pRenderer, int nPriority)
 Construct the screen.
virtual ~MetMultiSaveRemixScreen ()
virtual void EnterAndShow ()
 Hide the screen, push the multiplayer end-of-remix screen, and record which players have a formatted memory card.
virtual void OnExitFinished ()
 Start the first save once the exit finishes.
virtual void OnSaveFinished (int bCompleted)
 Go on to the next save, or finish.
virtual void OnHelpRequested ()
 Set mEndScreenExited and exit the end-of-remix screen.
virtual void SetOwnerScreenShowing (int bShowing)
 Store the negation of a flag in mEndScreenExited, and push or exit the end-of-remix screen on it.
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 PlaySlideSound (int nSelector)
 Play the sound that accompanies sliding between screens.
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 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.
virtual void ResolveContainerViews ()
 Resolve the three views the container produced and hide the screen.
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 MetRemixSaver
virtual ~MetRemixSaver ()

Static Public Member Functions

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

Dialogue that writes a multiplayer remix to a memory card.

Its RTTI descriptor is at 0x008ef530. It has two public non-virtual bases at fixed offsets, MetScreen at +0x00 and MetRemixSaver at +140. The 39-entry primary vtable is at 0x007ffb90, the same length as the MetScreen table, and the class declares no new virtual. The five-entry MetRemixSaver table at 0x007ffb60 adjusts this by -140 in every entry. That table is where this screen supplies the three MetRemixSaver pure virtuals.

The constructor at 0x002fa0b0 takes only the renderer and the load priority, and supplies dlg for the screen name, metagame/Shared for the directory, and dialogue for the container, the same container MetGlobalSettingsSaverScreen and MetRemixManager load.

The constructor default-constructs the four vectors from +0x90 through +0xbf, zeroes mSaveCount, and default-constructs a fifth vector at +0xd8. It writes nothing from +0xc0 through +0xd3 and nothing at +0xe4 or +0xe8, which EnterAndShow() and slot 36 fill. The object is 0xec bytes, the size New() allocates.

The destructor at 0x002fa280 tears down the fifth vector first and then the other four in reverse declaration order, restores the MetRemixSaver vptr to 0x007ffcd0, runs the MetScreen destructor, and releases the object with the tag MsgSink. Every part of that teardown is compiler-generated member destruction, so the destructor body is empty.

The screen saves the remix once for each player whose memory card is ready, one after another. EnterAndShow() records which players have a formatted card, slot 36 opens MetSaveRemixScreen for the first, and slot 2, which MetSaveRemixScreen runs when a save ends, opens it for the next. After the last save the screen returns to the remix type screen.

Eight slots differ from the MetScreen table. Slots 21 through 24 sit eight bytes apart at 0x002feda0 through 0x002fedb8, and the declaration order there puts the cycle sounds ahead of high and leave, so the addresses do not ascend with the slot numbers. The others are 5 0x002fa4e8 and 36 0x002fa7c0, and the MetRemixSaver table supplies slots 2 0x002facc0, 3 0x002fee48, and 4 0x002fb248.

Constructor & Destructor Documentation

◆ MetMultiSaveRemixScreen()

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

Construct the screen.

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

◆ ~MetMultiSaveRemixScreen()

virtual MetMultiSaveRemixScreen::~MetMultiSaveRemixScreen ( )
virtual
Ghidra address:
NTSC-U/C: 0x002fa280
Ghidra address:
PAL: 0x0031e430

Member Function Documentation

◆ New()

MetMultiSaveRemixScreen * MetMultiSaveRemixScreen::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: 0x002fedc0
Ghidra address:
PAL: 0x00323310

◆ EnterAndShow()

virtual void MetMultiSaveRemixScreen::EnterAndShow ( )
virtual

Hide the screen, push the multiplayer end-of-remix screen, and record which players have a formatted memory card.

Slot 5. A card at a port-0 slot below the player count marks that player, and a card at the first slot of port 1 marks player 1. When no card is ready the end-of-remix screen is exited again. The screen then begins its exit. The European release does not read the cards and marks every player.

Ghidra address:
NTSC-U/C: 0x002fa4e8
Ghidra address:
PAL: 0x0031e698

Reimplemented from MetScreen.

◆ OnExitFinished()

virtual void MetMultiSaveRemixScreen::OnExitFinished ( )
virtual

Start the first save once the exit finishes.

Slot 36. With no ready card it goes straight to ReturnToRemixType(). Otherwise it records the ready players in mReadyPlayers, gathers every player's appearance, and opens MetSaveRemixScreen for the first ready player on the first card slot, clearing the entered name, then resets mSaveIndex and mEndScreenExited. The European release pushes the left gizmo and help screens before ReturnToRemixType(), and saves the first player to the first slot of port 0 under the name FirstCardSlotName() reports.

Ghidra address:
NTSC-U/C: 0x002fa7c0
Ghidra address:
PAL: 0x0031e8a8

Reimplemented from MetScreen.

◆ OnSaveFinished()

virtual void MetMultiSaveRemixScreen::OnSaveFinished ( int bCompleted)
virtual

Go on to the next save, or finish.

Slot 2 of the MetRemixSaver table. After the last save the end-of-remix screen is exited unless mEndScreenExited is set, and ReturnToRemixType() runs. Otherwise the end-of-remix screen is pushed again when mEndScreenExited is set, and MetSaveRemixScreen opens for the next ready player on the card slot the save index selects, retaining the entered name. The European release builds the location from the save index instead. The second save goes to multitap slot 1-B with a multitap on port 0 and to port 2 without one, the third and fourth go to 1-C and 1-D, and any later save gets the default location.

Parameters
bCompletedNot read.
Ghidra address:
NTSC-U/C: 0x002facc0
Ghidra address:
PAL: 0x0031efd0

Implements MetRemixSaver.

◆ OnHelpRequested()

virtual void MetMultiSaveRemixScreen::OnHelpRequested ( )
virtual

Set mEndScreenExited and exit the end-of-remix screen.

Slot 3 of the MetRemixSaver table.

Ghidra address:
NTSC-U/C: 0x002fee48
Ghidra address:
PAL: 0x00323398

Implements MetRemixSaver.

◆ SetOwnerScreenShowing()

virtual void MetMultiSaveRemixScreen::SetOwnerScreenShowing ( int bShowing)
virtual

Store the negation of a flag in mEndScreenExited, and push or exit the end-of-remix screen on it.

Slot 4 of the MetRemixSaver table.

Parameters
bShowingNon-zero to push the end-of-remix screen.
Ghidra address:
NTSC-U/C: 0x002fb248
Ghidra address:
PAL: 0x0031f6a8

Implements MetRemixSaver.

◆ PlayLeaveSound()

virtual void MetMultiSaveRemixScreen::PlayLeaveSound ( int )
inlinevirtual

Silence the leave sound.

All four overrides are two-instruction stubs, so each was written inline with an empty body.

Ghidra address:
NTSC-U/C: 0x002fedb8
Ghidra address:
PAL: 0x00323308

Reimplemented from MetScreen.

◆ PlayHighSound()

virtual void MetMultiSaveRemixScreen::PlayHighSound ( int )
inlinevirtual

Silence the high sound.

Ghidra address:
NTSC-U/C: 0x002fedb0
Ghidra address:
PAL: 0x00323300

Reimplemented from MetScreen.

◆ PlayCycleLeftSound()

virtual void MetMultiSaveRemixScreen::PlayCycleLeftSound ( int )
inlinevirtual

Silence the cycle-left sound.

Ghidra address:
NTSC-U/C: 0x002feda0
Ghidra address:
PAL: 0x003232f0

Reimplemented from MetScreen.

◆ PlayCycleRightSound()

virtual void MetMultiSaveRemixScreen::PlayCycleRightSound ( int )
inlinevirtual

Silence the cycle-right sound.

Ghidra address:
NTSC-U/C: 0x002feda8
Ghidra address:
PAL: 0x003232f8

Reimplemented from MetScreen.


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