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

Screen that decrypts the picture of an unlocked bonus, boss, or secret song. More...

#include <songdecryptscreen.h>

Inheritance diagram for SongDecryptScreen:
Collaboration diagram for SongDecryptScreen:

Public Member Functions

 ~SongDecryptScreen () override=default
 Destroy the object.
 SongDecryptScreen (DataArray *pData)
 Construct the screen from its script description, with no song.
void Poll (float fTime) override
 Play the decrypt sound once the reveal reaches the second texture key of the first stage of its keys, and move to song_decrypt_done once it reaches the third.
void Exit (UIScreen *pNextScreen, float fTime) override
 Stop the view and start the exit.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Label the picture with the type of the song, and start the view.
void SetSong (const char *pszSong)
 Choose the song, and the picture the s_g_bonus_pic panel loads.
Public Member Functions inherited from FreqScreen
 FreqScreen (DataArray *pData)
 Construct a screen from its script description.
 ~FreqScreen () override
 Destroy the screen.
bool DispatchPriv (Message *pMsg) override
 Play the sound of a chosen component, follow a shortcut, and keep unused controllers out.
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 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 that decrypts the picture of an unlocked bonus, boss, or secret song.

The RTTI records the class as deriving from FreqScreen. The object is 0x90 bytes and its vtable is at 0x003cf308. The view s_g_bonus.view plays while the material animation band_pic.mnm reveals the picture, and the screen moves to song_decrypt_done once the reveal ends. The destructor at 0x0035ed98 is compiler-generated and has no declaration here.

Constructor & Destructor Documentation

◆ ~SongDecryptScreen()

SongDecryptScreen::~SongDecryptScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035ed98
Ghidra address:
PAL: 0x003cce78

◆ SongDecryptScreen()

SongDecryptScreen::SongDecryptScreen ( DataArray * pData)
explicit

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

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x0035edf0
Ghidra address:
PAL: 0x003cced0

Member Function Documentation

◆ New()

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

Create a screen from its script description.

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

◆ Poll()

void SongDecryptScreen::Poll ( float fTime)
overridevirtual

Play the decrypt sound once the reveal reaches the second texture key of the first stage of its keys, and move to song_decrypt_done once it reaches the third.

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

Reimplemented from UIScreen.

◆ Exit()

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

Stop the view and start the exit.

Parameters
pNextScreenThe screen to change to.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x001988e0
Ghidra address:
PAL: 0x0019fe00

Reimplemented from FreqScreen.

◆ Enter()

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

Label the picture with the type of the song, and start the view.

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

Reimplemented from FreqScreen.

◆ SetSong()

void SongDecryptScreen::SetSong ( const char * pszSong)

Choose the song, and the picture the s_g_bonus_pic panel loads.

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

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