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

The skill menu of a game, with a button for each skill level, the custom remixes, and the power-up tips. More...

#include <metaskillscreen.h>

Inheritance diagram for MetaSkillScreen:
Collaboration diagram for MetaSkillScreen:

Public Member Functions

 ~MetaSkillScreen () override=default
 Destroy the object.
 MetaSkillScreen (DataArray *pData)
 Construct the screen from its script description.
bool DispatchPriv (Message *pMsg) override
 Route a chosen button, a focus change, and the end of the entry, and pass on every other message.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Focus the button of the current skill level, then start the entry.
bool HandleSelect (UIComponentSelectMsg *pMsg)
 Set the skill level of the button chosen with the cross button and go to the next screen.
bool HandleFocusChange (UIComponentFocusChangeMsg *pMsg)
 Show the help text <panel>_<button>_HELP of the button that receives the focus in the panel with the focus.
bool HandleTransitionComplete (UITransitionCompleteMsg *pMsg)
 Focus the focused button of the panel with the focus again once this screen has entered.
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 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 skill menu of a game, with a button for each skill level, the custom remixes, and the power-up tips.

The RTTI records the class as deriving from FreqScreen. The object is 0x70 bytes and its vtable is at 0x003cec60. The metagame registers the class for the screen type meta_skill_screen, and the front-end description's s_g_sel_skill screen is one. The destructor at 0x0035da08 is compiler-generated and has no declaration here.

Constructor & Destructor Documentation

◆ ~MetaSkillScreen()

MetaSkillScreen::~MetaSkillScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035da08
Ghidra address:
PAL: 0x003cbae0

◆ MetaSkillScreen()

MetaSkillScreen::MetaSkillScreen ( DataArray * pData)
explicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x001908a0
Ghidra address:
PAL: 0x00197bb8

Member Function Documentation

◆ New()

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

Create a screen from its script description.

The metagame registers the routine for the entry type meta_skill_screen.

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

◆ DispatchPriv()

bool MetaSkillScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route a chosen button, a focus change, and the end of the entry, and pass on every other message.

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

Reimplemented from FreqScreen.

◆ Enter()

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

Focus the button of the current skill level, then start the entry.

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

Reimplemented from FreqScreen.

◆ HandleSelect()

bool MetaSkillScreen::HandleSelect ( UIComponentSelectMsg * pMsg)

Set the skill level of the button chosen with the cross button and go to the next screen.

The tutorial and the saved remix are cleared first. The custom button loads a saved remix instead. A solo game continues to soloskill2soloarena, a duel to duel2multisong, and any other game to m_powerup. The unlocked arenas are shown before the change.

Parameters
pMsgThe message.
Returns
The result of UIScreen::HandleSelect().
Ghidra address:
NTSC-U/C: 0x00190988
Ghidra address:
PAL: 0x00197ca0

◆ HandleFocusChange()

bool MetaSkillScreen::HandleFocusChange ( UIComponentFocusChangeMsg * pMsg)

Show the help text <panel>_<button>_HELP of the button that receives the focus in the panel with the focus.

Parameters
pMsgThe message.
Returns
False.
Ghidra address:
NTSC-U/C: 0x00190bb0
Ghidra address:
PAL: 0x00197ec8

◆ HandleTransitionComplete()

bool MetaSkillScreen::HandleTransitionComplete ( UITransitionCompleteMsg * pMsg)

Focus the focused button of the panel with the focus again once this screen has entered.

Parameters
pMsgThe message.
Returns
False.
Ghidra address:
NTSC-U/C: 0x00190c60
Ghidra address:
PAL: 0x00197f78

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