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

Screen that lists the Freq parts a song unlocked, seven to a page, and shows an unlocked prefabricated Freq on a page of its own. More...

#include <partunlockscreen.h>

Inheritance diagram for PartUnlockScreen:
Collaboration diagram for PartUnlockScreen:

Public Member Functions

 ~PartUnlockScreen () override=default
 Destroy the object.
 PartUnlockScreen (DataArray *pData)
 Construct the screen from its script description, listing no item.
bool DispatchPriv (Message *pMsg) override
 Route the end of a transition and a controller button, and pass on every other message.
void Poll (float fTime) override
 Apply the parts of the Freq as they load, and show the next page once its time has come, or move to unlock_parts_done after the last page.
void Exit (UIScreen *pNextScreen, float fTime) override
 Forget the listed items and stop the view.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Find the panel of the Freq and show the first page.
bool AddItem (const UnlockableItem &item)
 Queue an item.
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 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 lists the Freq parts a song unlocked, seven to a page, and shows an unlocked prefabricated Freq on a page of its own.

The RTTI records the class as deriving from FreqScreen. The object is 0xe0 bytes and its vtable is at 0x003cf450. The metagame registers the class for the screen type parts_unlock_screen. Each page plays the view s_unlock.view, and the next page shows unlock_prefab_time milliseconds after the previous one. The destructor at 0x0035e928 is compiler-generated and has no declaration here.

Constructor & Destructor Documentation

◆ ~PartUnlockScreen()

PartUnlockScreen::~PartUnlockScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035e928
Ghidra address:
PAL: 0x003cca08

◆ PartUnlockScreen()

PartUnlockScreen::PartUnlockScreen ( DataArray * pData)
explicit

Construct the screen from its script description, listing no item.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x0035ea68
Ghidra address:
PAL: 0x003ccb48

Member Function Documentation

◆ New()

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

Create a screen from its script description.

The metagame registers the routine for the entry type parts_unlock_screen.

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

◆ DispatchPriv()

bool PartUnlockScreen::DispatchPriv ( Message * pMsg)
overridevirtual

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

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

Reimplemented from FreqScreen.

◆ Poll()

void PartUnlockScreen::Poll ( float fTime)
overridevirtual

Apply the parts of the Freq as they load, and show the next page once its time has come, or move to unlock_parts_done after the last page.

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

Reimplemented from UIScreen.

◆ Exit()

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

Forget the listed items and stop the view.

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

Reimplemented from FreqScreen.

◆ Enter()

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

Find the panel of the Freq and show the first page.

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

Reimplemented from FreqScreen.

◆ AddItem()

bool PartUnlockScreen::AddItem ( const UnlockableItem & item)

Queue an item.

The kinds 4, 6, and 15 are not listed.

Queueing the head gear fm_hg_halo also shows the Freq of the first player with a halo.

Parameters
itemThe item.
Returns
Whether the item was queued.
Ghidra address:
NTSC-U/C: 0x00197f00
Ghidra address:
PAL: 0x0019f420

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