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

The screen that lists saved remixes to choose one to play or to practise. More...

#include <remixselectscreen.h>

Inheritance diagram for RemixSelectScreen:
Collaboration diagram for RemixSelectScreen:

Public Member Functions

 RemixSelectScreen (DataArray *pData)
 Construct the screen from its script description, with no remixes.
 ~RemixSelectScreen () override
 Destroy the screen.
bool DispatchPriv (Message *pMsg) override
 Route the choice and the controller to their handlers.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Enter, list the remixes, and select the first.
virtual void SetRemixes (const std::vector< RemixInfo > &remixes)
 Replace the remixes the screen lists.
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.

Static Public Member Functions

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.

Protected Attributes

std::vector< RemixInfo > mRemixes
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

Additional Inherited Members

Public Attributes inherited from FreqScreen
Vector3 mGizmoOrig
Quat mGizmoRot

Detailed Description

The screen that lists saved remixes to choose one to play or to practise.

The RTTI records the class as deriving from FreqScreen. The object is 0x90 bytes and its vtable is at 0x003ce718. The description's grey_read_only and grey_unplayable grey out the remixes that cannot be changed and the ones that cannot be played, and greyed remixes cannot be chosen. The cross button plays the chosen remix and the square button practises it, both through the load_remix screen.

Constructor & Destructor Documentation

◆ RemixSelectScreen()

RemixSelectScreen::RemixSelectScreen ( DataArray * pData)
explicit

Construct the screen from its script description, with no remixes.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x001898b0
Ghidra address:
PAL: 0x0018fe48

◆ ~RemixSelectScreen()

RemixSelectScreen::~RemixSelectScreen ( )
inlineoverride

Destroy the screen.

Ghidra address:
NTSC-U/C: 0x0035c418
Ghidra address:
PAL: 0x003ca4f0

Member Function Documentation

◆ New()

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

Create a screen from its script description.

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

◆ DispatchPriv()

bool RemixSelectScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route the choice and the controller to their handlers.

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

Reimplemented from FreqScreen.

Reimplemented in SelRemixUploadScreen.

◆ Enter()

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

Enter, list the remixes, and select the first.

The online screen net_custom_load greys out only the remixes that cannot be played, and none in a remix game.

Parameters
pPrevScreenThe screen this one replaces.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x00189938
Ghidra address:
PAL: 0x0018fed0

Reimplemented from FreqScreen.

◆ SetRemixes()

virtual void RemixSelectScreen::SetRemixes ( const std::vector< RemixInfo > & remixes)
inlinevirtual

Replace the remixes the screen lists.

The name is inferred.

Parameters
remixesThe remixes.
Ghidra address:
NTSC-U/C: 0x0035c558
Ghidra address:
PAL: 0x003ca630

Member Data Documentation

◆ mRemixes

std::vector<RemixInfo> RemixSelectScreen::mRemixes
protected

The listed remixes.


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