wavelength 1.0.0
Loading...
Searching...
No Matches
MultiSetupRemixSaveScreen Class Reference

The remix save screen of one player of a local or online game. More...

#include <multisetupremixsavescreen.h>

Inheritance diagram for MultiSetupRemixSaveScreen:
Collaboration diagram for MultiSetupRemixSaveScreen:

Public Member Functions

 ~MultiSetupRemixSaveScreen () override=default
 Destroy the object.
 MultiSetupRemixSaveScreen (DataArray *pData)
 Construct the screen from its script description, for the player its name ends with.
bool DispatchPriv (Message *pMsg) override
 Route the end of the entry, and pass on every other message.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Start the entry and show the number of the player.
void Proceed () override
 Check the name, and show the error of an empty name or of spaces around it, or else save the remix under the name with save_remix.
bool HandleTransitionComplete (UITransitionCompleteMsg *pMsg)
 Note a return from net_share_remix, and pass the message on.
Public Member Functions inherited from SetupRemixSaveScreen
 ~SetupRemixSaveScreen () override=default
 Destroy the object.
 SetupRemixSaveScreen (DataArray *pData)
 Construct the screen from its script description, for the first player.
bool DispatchPriv (Message *pMsg) override
 Route the messages of the screen, and pass on every other message.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Start the entry and show the details of the remix of the game database.
void Proceed () override
 Check the name, and show the error of an empty name or of spaces around it, or else save the remix under the name with save_remix.
int ReceiveKeyboardText (const char *pszText) override
 Store the text typed on the keyboard for the next entry.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Handle the buttons of the screen's player while the name has the focus.
bool HandleTransitionComplete (UITransitionCompleteMsg *pMsg)
 Show the panels again when the discard question closes.
bool HandleTextEntryComplete (UITextEntryCompleteMsg *pMsg)
 Save the remix when a name was typed into the entry.
bool HandleTextEntryInvalid (UITextEntryInvalidMsg *pMsg)
 Play the refusal sound for a character the name entry refused.
Public Member Functions inherited from NeedsDialogScreen
 NeedsDialogScreen (DataArray *pData)
 Construct the screen from its script description.
virtual void SetPanelsShowing (bool bShowing)
 Show or hide every panel of the screen except help and title.
Public Member Functions inherited from FreqScreen
 FreqScreen (DataArray *pData)
 Construct a screen from its script description.
 ~FreqScreen () override
 Destroy the screen.
void Draw () override
 Draw what goes under each panel, then the panels.
void Exit (UIScreen *pNextScreen, float fTime) override
 Move the projector to the next screen's place and start the exit.
virtual const char * Title ()
 Report the localised title of the screen, the token <name>_TITLE.
virtual void PlayButtonSound (int nButton)
 Play the menu sound of a controller button.
bool HandleSelectStart (UIComponentSelectStartMsg *pMsg)
 Play the sound of the button that chooses a component.
bool HandleTransitionComplete (UITransitionCompleteMsg *pMsg)
 Choose the component the shortcuts section of the metagame configuration lists for the screen.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Pass on a controller button of a controller the players use, and swallow any other.
Public Member Functions inherited from UIScreen
 UIScreen (DataArray *pData)
 Construct a screen from its script description.
 ~UIScreen () override
 Destroy the screen.
bool Dispatch (Message *pMsg) override
 Offer a message to the manager, then handle it here, then pass a navigation message on.
bool DispatchPriv (Message *pMsg) override
 Follow the transition of a pressed button or a chosen component.
virtual void Poll (float fTime)
 Advance the panels to a time, and finish the exit or the entry once their animations stop.
virtual void Print (PrnStream &stream)
 Write a description of the screen, its panels, and its transitions.
void ClearTransitions ()
 Empty the transition table.
void AddTransition (const char *pszComponent, int nButton, const char *pszScreen)
 Append an entry to the transition table.
void AddPanel (UIPanel *pPanel)
 Add a panel to the screen.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Follow the transition of a pressed controller button.
bool HandleSelect (UIComponentSelectMsg *pMsg)
 Follow the transition of a component chosen with the cross button.
void SetFocus (UIPanel *pPanel)
 Move the focus to a panel.
UIComponent * FindComponent (const char *pszName)
 Find a component on any of the screen's panels.
Transition * FindTransition (UIComponent *pComponent, bool bFail)
 Find the transition of a component.
Transition * FindTransition (int nButton, bool bFail)
 Find the transition of a controller button.
void Load ()
 Load the panels.
void Unload ()
 Unload the panels.
bool IsLoaded ()
 Report whether every panel has loaded.
const char * GetName () const
const char * GetGroup () const
UIPanel * GetFocusPanel () const
UIScreen * GetNextScreen () const
UIScreen * GetPrevScreen () const
const std::map< const char *, UIPanel *, StrLess > & GetPanels () const
Public Member Functions inherited from MsgSink
void * operator new (size_t nSize)
 Allocate a sink from the pool heaps under the tag "MsgSink".
void operator delete (void *pBlock)
 Return a sink to the pool heaps.
virtual ~MsgSink ()
void * operator new (size_t size)
 Allocate from the main heap under the name MsgSink.
void operator delete (void *mem)
 Return memory to its heap.
virtual ~MsgSink ()
 Destroy the sink.
Public Member Functions inherited from KeyboardUser
virtual ~KeyboardUser ()
 Destroy the mix-in.

Static Public Member Functions

static UIScreen * New (DataArray *pData)
 Create a screen from its script description.
Static Public Member Functions inherited from SetupRemixSaveScreen
static UIScreen * New (DataArray *pData)
 Create a screen from its script description.
Static Public Member Functions inherited from FreqScreen
static UIScreen * New (DataArray *pData)
 Create a screen from its script description.
Static Public Member Functions inherited from UIScreen
static UIScreen * New (DataArray *pData)
 Create a screen from its script description.

Additional Inherited Members

Public Attributes inherited from FreqScreen
Vector3 mGizmoOrig
Quat mGizmoRot
Protected Attributes inherited from SetupRemixSaveScreen
int mReserved74 [3]
const char * mPanel
int mPlayer
String mTypedTitle
Protected Attributes inherited from UIScreen
const char * mName
const char * mGroup
std::map< const char *, UIPanel *, StrLess > mPanels
UIPanel * mFocusPanel
std::vector< Transition > mTransitions
UIScreen * mPrevScreen
UIScreen * mNextScreen
int mForceEntryExit

Detailed Description

The remix save screen of one player of a local or online game.

The RTTI records the class as deriving from SetupRemixSaveScreen. Its vtables are at 0x003ce618 and 0x003ce5f8. The metagame registers the class for the screen type multi_setup_remix_save_screen. The player is the last digit of the screen's name, such as m_r_end_remix_2. Its panel is m_r_end.

Constructor & Destructor Documentation

◆ ~MultiSetupRemixSaveScreen()

MultiSetupRemixSaveScreen::~MultiSetupRemixSaveScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035c698
Ghidra address:
PAL: 0x003ca770

◆ MultiSetupRemixSaveScreen()

MultiSetupRemixSaveScreen::MultiSetupRemixSaveScreen ( DataArray * pData)
explicit

Construct the screen from its script description, for the player its name ends with.

A name that does not end with 1 to 4 means the first player.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x0018ae20
Ghidra address:
PAL: 0x001913f0

Member Function Documentation

◆ New()

UIScreen * MultiSetupRemixSaveScreen::New ( DataArray * pData)
inlinestatic

Create a screen from its script description.

The metagame registers the routine for the screen type multi_setup_remix_save_screen.

Parameters
pDataThe script description.
Returns
The new screen.
Ghidra address:
NTSC-U/C: 0x0035c7b8
Ghidra address:
PAL: 0x003ca890

◆ DispatchPriv()

bool MultiSetupRemixSaveScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route the end of the entry, and pass on every other message.

Parameters
pMsgThe message.
Returns
Whether the message was handled.
Ghidra address:
NTSC-U/C: 0x0018b330
Ghidra address:
PAL: 0x001919e8

Reimplemented from FreqScreen.

◆ Enter()

void MultiSetupRemixSaveScreen::Enter ( UIScreen * pPrevScreen,
float fTime )
overridevirtual

Start the entry and show the number of the player.

Online, the metagame's flag at +0x144 is cleared.

Parameters
pPrevScreenThe screen this one replaces, or null.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x0018ae98
Ghidra address:
PAL: 0x00191468

Reimplemented from FreqScreen.

◆ Proceed()

void MultiSetupRemixSaveScreen::Proceed ( )
overridevirtual

Check the name, and show the error of an empty name or of spaces around it, or else save the remix under the name with save_remix.

In a local game the save leads to the next player's screen, and online back to the launchpad.

Ghidra address:
NTSC-U/C: 0x0018af50
Ghidra address:
PAL: 0x00191520

Implements NeedsDialogScreen.

◆ HandleTransitionComplete()

bool MultiSetupRemixSaveScreen::HandleTransitionComplete ( UITransitionCompleteMsg * pMsg)

Note a return from net_share_remix, and pass the message on.

Parameters
pMsgThe message.
Returns
The result of SetupRemixSaveScreen::HandleTransitionComplete().
Ghidra address:
NTSC-U/C: 0x0018b398
Ghidra address:
PAL: 0x00191a50

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