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

Screen redbook_play that plays the songs of the jukebox playlist one after another, showing the band of the song that plays on the panel jbox_band. More...

#include <redbookplaybackscreen.h>

Inheritance diagram for RedbookPlaybackScreen:
Collaboration diagram for RedbookPlaybackScreen:

Public Member Functions

 RedbookPlaybackScreen (DataArray *pData)
 Construct the screen from its script description, with no songs.
 ~RedbookPlaybackScreen () override
 Destroy the screen.
bool DispatchPriv (Message *pMsg) override
 Route the controller to HandleJoypad().
void Poll (float fTime) override
 Pick and load the next song once the previous one has finished, or leave once the playback has stopped.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Enter, show the help of the playback, and fade out the menu music.
void ClearSongs ()
 Forget the songs.
void AddSong (const char *pszSong)
 Add a song to the songs to play.
void SetShuffle (int nShuffle)
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 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

Screen redbook_play that plays the songs of the jukebox playlist one after another, showing the band of the song that plays on the panel jbox_band.

The RTTI records the class as deriving from FreqScreen. Its vtable is at 0x003d0310. The songs play in order or in a random order, and the list starts over after the last song. The START button stops the playback, and the screen returns to jbox_redbook once the menu music plays.

Constructor & Destructor Documentation

◆ RedbookPlaybackScreen()

RedbookPlaybackScreen::RedbookPlaybackScreen ( DataArray * pData)
explicit

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

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x001a6d48
Ghidra address:
PAL: 0x001aea38

◆ ~RedbookPlaybackScreen()

RedbookPlaybackScreen::~RedbookPlaybackScreen ( )
inlineoverride

Destroy the screen.

Ghidra address:
NTSC-U/C: 0x00361ed8
Ghidra address:
PAL: 0x003d03f0

Member Function Documentation

◆ New()

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

Create a screen from its script description.

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

◆ DispatchPriv()

bool RedbookPlaybackScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route the controller to HandleJoypad().

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

Reimplemented from FreqScreen.

◆ Poll()

void RedbookPlaybackScreen::Poll ( float fTime)
overridevirtual

Pick and load the next song once the previous one has finished, or leave once the playback has stopped.

Parameters
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x001a7150
Ghidra address:
PAL: 0x001aee40

Reimplemented from UIScreen.

◆ Enter()

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

Enter, show the help of the playback, and fade out the menu music.

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

Reimplemented from FreqScreen.

◆ ClearSongs()

void RedbookPlaybackScreen::ClearSongs ( )

Forget the songs.

The name is inferred.

Ghidra address:
NTSC-U/C: 0x001a6e50
Ghidra address:
PAL: 0x001aeb40

◆ AddSong()

void RedbookPlaybackScreen::AddSong ( const char * pszSong)

Add a song to the songs to play.

The name is inferred.

Parameters
pszSongThe song, a symbol.
Ghidra address:
NTSC-U/C: 0x001a6e80
Ghidra address:
PAL: 0x001aeb70

◆ SetShuffle()

void RedbookPlaybackScreen::SetShuffle ( int nShuffle)
inline
Parameters
nShuffleNon-zero when the songs play in a random order.

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