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

The jukebox screen jbox_redbook, which lists the songs the first player has finished and plays the chosen ones on redbook_play. More...

#include <jukeboxscreen.h>

Inheritance diagram for JukeboxScreen:
Collaboration diagram for JukeboxScreen:

Public Member Functions

 JukeboxScreen (DataArray *pData)
 Construct the screen from its script description, with an empty playlist.
 ~JukeboxScreen () override
 Destroy the screen.
bool DispatchPriv (Message *pMsg) override
 Route the choices and the controller to their handlers.
void Exit (UIScreen *pNextScreen, float fTime) override
 Exit.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Enter and list the songs, or keep the playlist when the playback returns.
int GetShowAllSongs () const
void SetShowAllSongs (int nShowAllSongs)
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.
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.

Additional Inherited Members

Public Attributes inherited from FreqScreen
Vector3 mGizmoOrig
Quat mGizmoRot
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 jukebox screen jbox_redbook, which lists the songs the first player has finished and plays the chosen ones on redbook_play.

The RTTI records the class as deriving from FreqScreen. The object is 0x90 bytes and its vtable is at 0x003d02b0. The metagame registers the class for the screen type jbox_screen. The first entry of the playlist stands for every song.

Constructor & Destructor Documentation

◆ JukeboxScreen()

JukeboxScreen::JukeboxScreen ( DataArray * pData)
inlineexplicit

Construct the screen from its script description, with an empty playlist.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x001a73f0
Ghidra address:
PAL: 0x001af0e0

◆ ~JukeboxScreen()

JukeboxScreen::~JukeboxScreen ( )
inlineoverride

Destroy the screen.

Ghidra address:
NTSC-U/C: 0x00362010
Ghidra address:
PAL: 0x003d0528

Member Function Documentation

◆ New()

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

Create a screen from its script description.

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

◆ DispatchPriv()

bool JukeboxScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route the choices and the controller to their handlers.

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

Reimplemented from FreqScreen.

◆ Exit()

void JukeboxScreen::Exit ( UIScreen * pNextScreen,
float fTime )
overridevirtual

Exit.

Parameters
pNextScreenThe screen that replaces this one.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x001a7a90
Ghidra address:
PAL: 0x001af780

Reimplemented from FreqScreen.

◆ Enter()

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

Enter and list the songs, or keep the playlist when the playback returns.

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

Reimplemented from FreqScreen.

◆ GetShowAllSongs()

int JukeboxScreen::GetShowAllSongs ( ) const
inline
Returns
Non-zero when every song is listed, finished or not.

◆ SetShowAllSongs()

void JukeboxScreen::SetShowAllSongs ( int nShowAllSongs)
inline
Parameters
nShowAllSongsNon-zero when every song is listed, finished or not.

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