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

Screen that announces an unlocked boss song, then moves to boss_journey. More...

#include <bossunlockscreen.h>

Inheritance diagram for BossUnlockScreen:
Collaboration diagram for BossUnlockScreen:

Public Member Functions

 ~BossUnlockScreen () override=default
 Destroy the object.
 BossUnlockScreen (DataArray *pData)
 Construct the screen from its script description, with no song.
bool DispatchPriv (Message *pMsg) override
 Route the end of a transition, and pass on every other message.
void Poll (float fTime) override
 Move to boss_journey half a second after the view stops.
void Exit (UIScreen *pNextScreen, float fTime) override
 Start the exit and stop the view.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Fill the labels with the announcement and the title of mSong.
bool HandleTransitionComplete (UITransitionCompleteMsg *pMsg)
 Start the journey to the boss arena and the view.
const char * GetSong () const
void SetSong (const char *pszSong)
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.
void Exit (UIScreen *pNextScreen, float fTime) override
 Move the projector to the next screen's place and start the exit.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Play the entry sound, show or hide the projector, and start the entry.
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 announces an unlocked boss song, then moves to boss_journey.

The RTTI records the class as deriving from FreqScreen. The object is 0x90 bytes and its vtable is at 0x003cf2a8. The metagame registers the class for the screen type boss_unlock_screen. The screen fills the labels 01, 02, and 03 of the d_launch panel and plays d_launch.view. The destructor at 0x0035eec8 is compiler-generated and has no declaration here.

Constructor & Destructor Documentation

◆ ~BossUnlockScreen()

BossUnlockScreen::~BossUnlockScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035eec8
Ghidra address:
PAL: 0x003ccfa8

◆ BossUnlockScreen()

BossUnlockScreen::BossUnlockScreen ( DataArray * pData)
explicit

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

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x0035ef20
Ghidra address:
PAL: 0x003cd000

Member Function Documentation

◆ New()

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

Create a screen from its script description.

The metagame registers the routine for the entry type boss_unlock_screen.

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

◆ DispatchPriv()

bool BossUnlockScreen::DispatchPriv ( Message * pMsg)
overridevirtual

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

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

Implements MsgSink.

◆ Poll()

void BossUnlockScreen::Poll ( float fTime)
overridevirtual

Move to boss_journey half a second after the view stops.

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

Reimplemented from UIScreen.

◆ Exit()

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

Start the exit and stop the view.

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

Reimplemented from UIScreen.

◆ Enter()

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

Fill the labels with the announcement and the title of mSong.

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

Reimplemented from UIScreen.

◆ HandleTransitionComplete()

bool BossUnlockScreen::HandleTransitionComplete ( UITransitionCompleteMsg * pMsg)

Start the journey to the boss arena and the view.

Parameters
pMsgThe message.
Returns
The result of FreqScreen::HandleTransitionComplete().
Ghidra address:
NTSC-U/C: 0x00198d80
Ghidra address:
PAL: 0x001a02a0

◆ GetSong()

const char * BossUnlockScreen::GetSong ( ) const
inline
Returns
The unlocked boss song, a symbol.

◆ SetSong()

void BossUnlockScreen::SetSong ( const char * pszSong)
inline
Parameters
pszSongThe unlocked boss song, a symbol.

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